kwizcom sharepoint list forms extensions feature user guide
TRANSCRIPT
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
2
Copyright © 2005-2009 KWizCom Corporation. All rights reserved.
Company Headquarters
50 McIntosh Drive,
Unit 109Markham,
Ontario ON L3R 9T3, Canada
E-mail: [email protected]
Web site: http://www.KWizCom.com
Sales
E-mail: [email protected]
Telephone: +1-905-370-0333
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
3
Table of Contents
Introduction ......................................................................................................... 4
Overview ............................................................................................................... 5
Field-Level Permissions _______________________________________________ 5
Field-Level Constraints ________________________________________________ 9
Default Values ______________________________________________________ 10
Field Grouping ______________________________________________________ 12
View Level Permissions _____________________________________________ 14
Key Features & Benefits _____________________________________________ 16
Installation ......................................................................................................... 18
Software prerequisites ______________________________________________ 18
Installation Procedure ______________________________________________ 18
Post Installation ____________________________________________________ 19
Component Activation .................................................................................... 20
Administration Guide ...................................................................................... 22
Introduction ________________________________________________________ 22
Field-Level Permissions settings page _______________________________ 23
Field-Level Constraints settings page _______________________________ 25 Defining custom patterns .......................................................................................... 26
Default Values settings page ________________________________________ 27
Field Grouping settings page ________________________________________ 29
View Level Permissions settings page _______________________________ 30
FAQ ........................................................................................................................ 32
Version Release Notes ................................................................................... 33
Version History _____________________________________________________ 33
Technical Support ............................................................................................ 35
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
4
Introduction
KWizCom SharePoint List Forms Extension Feature wipes out the
limitations of SharePoint list forms, adding exciting new features with
advanced capabilities. KWizCom has turned SharePoint List Forms into
powerful application forms, customizable to suite your needs!
This document provides all the information needed to install, evaluate and
deploy KWizCom's SharePoint List Forms Extension Feature:
Product Overview
Installation Guide
Component Activation
Administrator Guide
FAQ
Version Release Notes
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
5
Overview
KWizCom SharePoint List Forms Extensions Feature
wipes out SharePoint List forms limitations!
Need web form capabilities?
Now you can have what you need, in SharePoint!
You no longer need to purchase additional Forms solutions, no need to
purchase forms applications or custom develop them. With a little help
from KWizCom you can enjoy real forms functionality using WSS/MOSS!
KWizCom's SharePoint List Forms Extensions Feature bridges the
gap between the SharePoint list forms you are familiar with
(New/Edit/View forms) and standard form features, enhancing the current
SharePoint form features with the missing features of the classical web
form.
The new version 1.2.00 includes the following exciting web forms
features:
Field level permissions
Field level constraints
Default values
Field grouping
View level permissions (Yes , permissions for list views!)
Field-Level Permissions
Now you can define the visibility of specific list form fields to specific
users/groups!
We added a new "Field-Level Permissions" management page to every
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
6
list. This enables the list owner to define the visible/active status for every
field:
After the fields' permissions settings are saved, the form starts to
behave differently for different users. In the following example - the
"Due Date" field is disabled for all "KWizCom Members" group members:
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
7
When a manager edits the same task; the "Due Date" will be visible and
active:
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
8
Field permissions enable user specific modification of forms - you can
prevent users from seeing or updating specific fields and provide
different forms for different employees/roles.
But wait…that's not all!
You can also define dynamic, field-based rules for hiding/disabling form
fields; this turns the SharePoint list forms into full-featured forms with
intrinsic field logic!
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
9
Now you can easily use simple SharePoint lists WITHOUT any additional
development to handle scenarios such as:
Help-Desk form submissions – the user and the technician utilize different fields – each sees what's relevant to their task
Purchase order approval forms – the manager sees different fields than the employee
Field-Level Constraints
Easily define field-validation constraints to enforce input patterns
according to required form logic: Email, field length, ID, equals etc.
You can also define any custom regular expression for any required field!
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
10
Default Values
You can define default values for field types that out of the box SharePoint
does not enable (such as "Person" or "Lookup" fields). You can define
different default values for different users/groups as well!
"Customer Email" field
will be validated for the
email pattern.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
12
Field Grouping
Ever tried to create a SharePoint list with 20 fields/columns? You end up
with an endless form with what could be called a large pile of fields,
lacking any logical grouping/categorization. No More!
SharePoint List Forms Extensions feature enables division of list fields into
logical groups/sections displayed in different tabs.
We defined 2
tabs for the
"Tasks" list form
These are the fields
that will be displayed in the "new" tab
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
13
Now the list's "New"/"Edit"
form fields are divided
between the 2 tabs for
much more convenient
user interface.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
14
View Level Permissions
Yes... you can also define list views access permissions:
We have defined that all
users but one cannot
see the "Active Tasks"
view.
Define the various
messages
presented to an
unauthorized user
trying to access a view.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
15
The "Active Tasks" doesn't
show in the list "Views" drop-down.
A configurable error page
displayed to unauthorized
users trying to directly
browse the view page.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
16
Key Features & Benefits
Feature Standard
edition
Professional
edition
Display/hide fields from list forms
(New/Edit/View item) to specific users or SharePoint groups.
Support MOSS 2007 / WSS 3.0
Disable fields for specific users or SharePoint groups.
Hide/Disable fields according to a criteria based on list fields' values (the item's
status)
Support [Me] and [Today] SharePoint tokens
in field-based criteria for hiding/disabling fields
Enable defining field validation rules (constraints) including custom regular
expressions.
Enable defining field validation rules,
depending on other field values (dynamic rules).
Enable defining custom field default values, depending on the current user.
Enable dividing list form's fields into several pages (tabs).
Support list view permissions.
Cross-browser compatible (IE, Firefox & Google Chrome)
Compliant with the web accessibility standard (WCAG)
Multilingual (standard for all KWizCom components)
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
17
Server-side event handler that prevents the
updating of defined document properties using webDav (thus bypassing the SharePoint
web interface)
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
18
Installation
Software prerequisites
Server Requirements
1. Microsoft Windows SharePoint Services 3.0 (WSS 3.0) Or
2. Microsoft Office SharePoint Server 2007 (MOSS 2007)
Client PC Requirements
1. Microsoft Windows XP (SP2) or Windows Vista
2. Microsoft Internet Explorer 6+ / Mozilla Firefox 2+ /Google Chrome
Installation Procedure
1. Log in as local administrator to your SharePoint server.
2. Unzip the KWizCom SharePoint List Forms Extensions Feature
installation zipped file on your WSS server.
3. Double-click the .msi file in order to begin the installation.
When the installation process is complete it will recycle all
application pools automatically.
4. That's it!
The installation is installed and will activate the new "SharePoint List
Forms Extensions" feature.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
19
Post Installation
1. After completion of the installation, you will see a new KWizCom entry
in Windows Start -> All Programs -> KWizCom containing the
following programs:
About SharePoint List Forms Extensions
Display General Information about the component.
Activate SharePoint List Forms Extensions
This utility enables you (the SharePoint Administrator) to activate the
downloaded evaluation version.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
20
Component Activation
KWizCom components are available for evaluation prior to purchase. You
are welcome to try our components and verify that they indeed meet your
needs. Each KWizCom component evaluation version contains all features
included in the component's production version. The only difference
between the versions is that the evaluation version will time-out after one
month.
Congratulations!
You have decided to order a KWizCom component.
The next steps to take are detailed below
1. Order the component on the KWizCom website –
www.KWizCom.com.
2. Send us the installed evaluation version's Product Code (you will
see the Product Code on the "About" product page:
Note: Use the Activation Request web form, on KWizCom web site
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
21
to send us your product code.
3. Get the component activation key – this key will be sent to you by
email once your order is processed.
4. Activate your installed evaluation version -
click Start -> All Programs -> KWizCom -> SharePoint List
Forms Extensions -> Activate SharePoint List Forms
Extensions
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
22
Administration Guide
Introduction
This chapter describes the SharePoint List Extensions Feature
configuration pages.
In order to define field-permissions for a list, simply browse that list's
management page and click the "SharePoint list forms extensions" link:
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
23
This will open the SLFE configuration interface which includes the following
configuration pages:
Field-Level Permissions settings page
The Field-Level Permissions settings page includes the following fields:
Field Description
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
24
Field Pick a field that you wish to define permissions
for.
Permission type Choose the permission type you want to define
for the selected field:
Show – show that field
Hide – the field will not be displayed
Disable – the field will be visible but inactive (read only).
Users/Group Enter user/SharePoint group names.
Apply permissions to the following
item pages
Select the list item form (New/Edit/View) where the defined field level permissions should be applied.
Conditions This part exists ONLY in the professional
edition of this add-on.
Define property-based criteria for the selected
permission. You can add several conditions to a rule.
In order to add a rule, define the criteria and
then click the 'Add field permission rule" button. This will add the rule to the "Current field rules"
grid at the bottom of the page.
Add field-level
permission rule
In order to add a rule, click the 'Add field
permission rule" button. This will add the rule to the "Current field rules" grid at the bottom of the page.
After you have defined all the controls described above, click the "OK"
button to apply this configuration.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
25
Field-Level Constraints settings page
The Field-Level Constraints settings page includes the following fields:
Field Description
Field Pick a field that you wish to define permissions for.
Conditions This part exists ONLY in the professional edition of this add-on.
Define property-based criteria for the selected
field constraints. You can add several conditions to a rule.
In order to add a rule, define the criteria and then click the 'Add field permission rule" button.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
26
This will add the rule to the "Current field rules"
grid at the bottom of the page.
Validation rules Define a field validation rule.
Add field-level validation rule
In order to add a rule, click the 'Add field validation rule" button. This will add the rule to
the "Current list rules" grid at the bottom of the page.
After you have defined all the controls described above, click the "OK"
button to apply the configuration you defined.
Defining custom patterns When you select the "Custom Pattern" validation rule you can to define a
custom regular expression*. A regular expression is a special text string
for describing a string pattern. It enables you to define the exact pattern
you wish to validate. For more information about the regular expressions
syntax, please browse:
http://www.regular-expressions.info/index.html
In the following screenshot, a "[1-9][0-9]" regular expression is used to
define a new validation rule for numbers in the range of 10-99:
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
27
Default Values settings page
The Default Values settings page includes the following fields:
Field Description
Field Pick a field that you wish to define permissions
for.
Users/Group Enter user/SharePoint group names.
Default value Define the default value
Add default
value rule
In order to add a rule, click the 'Add default
value rule" button. This will add the rule to the "Current default value rules" grid at the bottom
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
28
of the page.
After you have defined all the controls described above, click the "OK"
button to apply this configuration.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
29
Field Grouping settings page
The Default values settings page includes the following fields:
Field Description
Tabs List of defined page tabs.
Add new tab Enables you to add a new tab
Unassociated fields/Selected
tab fields
After selecting a tab in the top-most control, select which fields should be displayed in that
tab (page).
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
30
*Custom CSS
Path
Enter the URL of a custom CSS file where you
can override the default tab style.
After you have defined all the controls described above, click the "OK"
button to apply this configuration.
View Level Permissions settings page
The Default values settings page includes the following fields:
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
31
Field Description
View Select the view/s for which you want to define permissions.
Permission Type Select the type of permission (hide or show).
Users/Group Enter user/SharePoint group names.
Add View-Level
Permissions Rule
In order to add a rule, click the "Add View-Level
Permissions Rule" button. This will add the rule to the "Current list view rules" grid at the bottom of the page.
Redirect page settings
This section enables you to define a custom error page to which users trying to access a
view they are not authorized to view, will be redirected.
After you have defined all the controls described above, click the "OK"
button to apply this configuration.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
32
FAQ
What does the SharePoint List Forms
Extension Feature do?
The feature enhances WSS/MOSS list pages, giving them added web form
features and capabilities. This is a pocket friendly solution that saves you
the expense of buying Form generators/servers.
Does it work also with document libraries?
Because item fields can be edited directly from Office applications, we
cannot enforce these rules for document libraries. However, the
SharePoint List Form Extensions feature includes a server-side event
handler that can prevent users from updating fields that are defined as
hidden or disabled.
Can I also define permissions on views?
Yes!
You can define access permissions to list views.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
33
Version Release Notes Primary Software
Version 1.2.10
Base version 1.2.00
Release date June-05-2009
Sub-Modules
Module Version
n/a n/a
Version History
CR # Description
Version 1.2.10, June-05-2009
70 Fixed Bug: When deleting a field which used in Tab Grouping the "New
Form" and "Disp Form" pages stop to work as well as SLFE Field Group
page
71 Fixed Bug: [Today] token gives Illegal value
72 Fixed Bug: Anonymous user cannot enter the list views / list item view
page
73 Add "All fields" tab to tabbed item forms
74 Fixed Bug: when field fails validation in other tab (not the current) the
page does not switch to that tab automatically
Version 1.2.00, May-20-2009
6 Support AD groups
8 Support Field groups/sections
9 Support field constraints (field validation rules)
22 Support accessibility standards (WCAG)
31 Enable defining field permissions on multiple fields at a time
33 Bug Fix: [Me] Token does not work
34
Enable providing permissions for attachments and calculated fields in
display mode
39
Bug Fix: Condition with [Me] value doesn't work on a "Person" field
with multiple selection allowed
41 Support View permissions
Version 1.1.01, December-31-2008
1 Enable saving a list with field –level permission settings as a template
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
34
2 Bug Fix: Enable support for [Today]+X terms
Version 1.1.00, December-18-2008
Base version.
Copyright © 2005-2009 KWizCom Corp. All rights reserved. www.KWizCom.com
35
Technical Support
You can obtain technical support using any of the following methods:
The KWizCom Web site
The KWizCom website: www.KWizCom.com contains up-to-date, valuable
information, including:
Answers to frequently asked questions (FAQ's) about our products –
usability and technical questions.
Product updates, which provide you with bug fixes and new
features.
The Web Form
For technical support through the Internet, please complete and submit
our support web form on our web site
For more information on technical support, please review our support
programs page.
KWizCom's global network of experts is always standing by, waiting to
provide a rapid response for each customer query.