Installation & User Guide

Transcription

1 SharePoint List Forms Extensions Feature Installation & User Guide

2 Copyright KWizCom Corporation. All rights reserved. Company Headquarters 50 McIntosh Drive, Unit 109 Markham, Ontario ON L3R 9T3, Canada Web site: Sales Telephone:

3 Table of Contents Introduction... 4 Overview... 5 Field-Level Permissions 6 Field-Level Constraints 9 Default Values 10 Field Grouping 12 View Level Permissions 14 Key Features & Benefits 17 Installation Software prerequisites 19 Installation Procedure 19 Post Installation 20 Component Activation Administration Guide Introduction 24 Field-Level Permissions settings page 25 Field-Level Constraints settings page 27 Defining custom patterns Default Values settings page 29 Field Grouping settings page 30 View Level Permissions settings page 31 FAQ Version Release Notes Version History 35 Technical Support

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 4

5 Overview SharePoint List Forms Extensions Feature is part of the Mobility Bundle SharePoint List Forms Extensions Feature is part of the Forms Bundle Wipe out SharePoint List forms limitations, Real sophisticated Forms - in SharePoint! 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. SharePoint List Forms Extensions Feature 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!) Navigation 5

6 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 list. This enables the list owner to define the visible/active status for every field: 6

7 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: When a manager edits the same task; the "Due Date" will be visible and active: 7

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! 8

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: , field length, ID, equals etc. You can also define any custom regular expression for any required field! 9

10 "Customer " field will be validated for the pattern. 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! 10

11 11

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 12

13 Now the list's "New"/"Edit" form fields are divided between the 2 tabs for much more convenient user interface. 13

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. 14

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. 15

16 Navigation Now you can also easily browse through list items by allowing the display of the navigation links on the view item form: Define the view that will be used to display items for users that did not start the browsing from a specific view of the list 16

17 Key Features & Benefits Feature Display/hide fields from list forms (New/Edit/View item) to specific users or SharePoint groups. Standard edition Professional edition Support for MOSS 2007 / WSS 3.0 New Support for SharePoint 2010 New Integration with SharePoint list custom actions feature New Integration with SharePoint mobile extensions feature 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. 17

18 Cross-browser compatible (IE, Firefox & Google Chrome) Compliant with the web accessibility standard (WCAG) Multilingual (standard for all KWizCom components) Server-side event handler that prevents the updating of defined document properties using webdav (thus bypassing the SharePoint web interface) Support client-side events. True client-side logic (dependency between form fields) can be deployed with no postbacks! Support navigation between list items 18

19 Installation Software prerequisites Server Requirements 1. WSS 3.0/4.0 or SharePoint Server 2007/ NET framework 2 Client PC Requirements 1. Microsoft Windows XP (SP2) /Windows Vista/Windows 7 2. Microsoft Internet Explorer 7,8 / Mozilla Firefox (Latest version) / Google Chrome (Latest version) Installation Procedure SharePoint 2007 Server 1. Log in as local admin to your SharePoint front-end server. 2. Unzip the KWizCom SharePoint List Forms Extensions Feature installation zipped file on your SharePoint 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! SharePoint 2010 server 1. Log in as local admin to your SharePoint front-end server. 2. Unzip the product s zip file on your SharePoint server. 3. Deploy the.wsp solution using SharePoint s stsadm utility. 19

20 Post Installation SharePoint 2007 Server 1. After completing the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following programs: SharePoint Mobile Extensions SharePoint List Custom Actions SharePoint List Forms Extensions REMARK: All those 3 products are included in the SharePoint List Forms Extensions Evaluation installation file, enabling you to check-out the full capabilities of the integrated solution which enables implementing custom-tailored forms for web and mobile solutions. Under SharePoint List Forms Extensions Feature entry you ll see 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. SharePoint List Forms Extensions Resource Editor This utility enables you to translate all user interface to any required language. 2. The installation adds 3 new features in the farm level and in site collection level. By default the Farm level feature should be active, enabling you to start using this feature immediately: 20

21 SharePoint 2010 server 1. The installation adds 3 new features in the farm level and in site collection level, same as in SharePoint 2007 (described above). Uninstallation procedure SharePoint 2007 Server 1. Log in as local admin to your SharePoint front-end server. 2. Go to Control Panel and double-click Add or Remove Programs. 3. Select SharePoint List Forms Extensions entry and click Remove button. 4. Click Yes to approve the removal of the component. 5. Once the product was un-installed, close the Add or Remove Programs screen. 21

22 SharePoint 2010 server 1. Use SharePoint s stsadm utility to uninstall the.wsp package. 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 2. Send us the installed evaluation version's Product Code (you will see the Product Code on the "About" product page: 22

23 Note: Use the Activation Request web form, on KWizCom web site to send us your product code. 3. Get the component activation key this key will be sent to you by 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 23

24 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: This will open the SLFE configuration interface which includes the following configuration pages: 24

25 Field-Level Permissions settings page The Field-Level Permissions settings page includes the following fields: Field Field Description Pick a field that you wish to define permissions for. 25

26 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 Apply permissions to the following item pages Conditions Enter user/sharepoint group names. Select the list item form (New/Edit/View) where the defined field level permissions should be applied. 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 Support client side validation 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. If this checkbox is checked all permission rules will be processed on the client browser without any post back to the server. After you have defined all the controls described above, click the "OK" button to apply this configuration. 26

27 Field-Level Constraints settings page The Field-Level Constraints settings page includes the following fields: Field Field Conditions Description Pick a field that you wish to define permissions for. 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. 27

28 This will add the rule to the "Current field rules" grid at the bottom of the page. Validation rules Add field-level validation rule Define a field 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: 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: 28

29 Default Values settings page The Default Values settings page includes the following fields: Field Field Users/Group Default value Add default value rule Description Pick a field that you wish to define permissions for. Enter user/sharepoint group names. Define the default value 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 of the page. After you have defined all the controls described above, click the "OK" button to apply this configuration. 29

30 Field Grouping settings page The Default values settings page includes the following fields: Field Tabs Add new tab Unassociated fields/selected tab fields *Custom CSS Path Description List of defined page tabs. Enables you to add a new tab After selecting a tab in the top-most control, select which fields should be displayed in that tab (page). Enter the URL of a custom CSS file where you can override the default tab style. 30

31 After you have defined all the controls described above, click the "OK" button to apply this configuration. View Level Permissions settings page 31

32 The Default values settings page includes the following fields: Field View Permission Type Users/Group Add View-Level Permissions Rule Redirect page settings Description Select the view/s for which you want to define permissions. Select the type of permission (hide or show). Enter user/sharepoint group names. 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. 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. 32

33 Navigation settings page The Navigation settings page includes the following fields: Field Display Next & Previous navigation links in View Item form Previous link caption Next link caption Check this if you wish to keep the current tab when you navigate through items Navigation through view: Description Check this checkbox to allow navigation between list items Choose a different title for the previous item button Choose a different title for the next item button In order to browse a certain tab of the items view forms check this checkbox, Otherwise clicking next or previous will bring you to the first tab of the next or previous items view form This section enables you to define a view using which the items will be displayed in navigation if the user did not start browsing the items from a certain view in the list After you have defined all the controls described above, click the "OK" button to apply this configuration. 33

34 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. 34

35 Version Release Notes Primary Software Version (SharePoint 2007) (SharePoint 2010) Base version Release date March Sub-Modules Module Version n/a n/a Version History CR # Description Version , March Add a new SharePoint List Custom Actions feature and a Mobile extensions feature to the product installation 89 Add support for SharePoint Fixed bug: When Tab name in in Arabic it shows "?" instead of text after save 114 Fixed bug: Error when creating a folder after accessing SLFE 134 Fixed bug: Default values do not get set for some choice fields since it was case sensitive. Version , November Bug Fix: no alert for changing the Support client side validation checkbox and the navigating away from the page without saving Bug Fix: no warning appears if a user creates a rule and edits a condition without clicking the add condition button then adds the rule, also no warning appears when a user creates and wants to edit a rules parameters, adds a conditions and then goes on to saving without clicking the add rule button Bug Fix: unable to edit task items after configuring a permission level rule- unexpected error Bug Fix: a redundant "The current permission has not been added" message when saving a rule with no conditions defined Enable "Next" and "Previous" navigation between list items in list item 35

36 view form Bug Fix: page reloads when changing a value of a field that doesn t apply to any rule condition Enable to keep current view item form tab while navigating through list items Version , August Enable processing field permission rules on the client side Bug Fix: upgrading from version 1.1 to 1.2 field permissions are not upgraded Bug Fix: Field constraints issue, if you have more then 1 constraints on a field it will only test the first rule for it. 90 Enable attaching a field to several tabs (Groups) Version , May 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 Enable providing permissions for attachments and calculated fields in display mode Bug Fix: Condition with [Me] value doesn't work on a "Person" field with multiple selection allowed 41 Support View permissions Version , December Enable saving a list with field level permission settings as a template 2 Bug Fix: Enable support for [Today]+X terms Version , December Base version. 36

37 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website: 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. 37