SharePoint List Custom Actions Feature

Transcription

1 KWizCom Corporation SharePoint List Custom Actions Feature User Guide

2 Copyright KWizCom Corporation. All rights reserved. SharePoint List Custom Actions User Guide Company Headquarters KWizCom 50 McIntosh Drive, Unit 109 Markham, Ontario ON L3R 9T3, Canada Web site: Sales Telephone: Copyright KWizCom Corp. All rights reserved. Page 2 of 24

3 CONTENTS introduction... 5 General... 5 Product Overview... 6 The Business Need... 7 Who needs it?... 8 Key Features... 9 Installation Guide Software Requirements Server Requirements Client Requirements Installation Procedure SharePoint 2007 server SharePoint 2010 server post Installation SharePoint 2007 server SharePoint 2010 server Un-Installation Procedure SharePoint 2007 server SharePoint 2010 server Administration Guide Component Activation Creating custom actions for a list List Custom Action settings page Item Custom Action settings page Copyright KWizCom Corp. All rights reserved. Page 3 of 24

4 FAQ What does the sharepoint list custom action feature do? Does this solution work with all SharePoint editions? After i installed this solution, I see a Sharepoint list forms extensions feature. What is that? Version Release Notes... Error! Bookmark not defined. Version History... Error! Bookmark not defined. Copyright KWizCom Corp. All rights reserved. Page 4 of 24

5 INTRODUCTION GENERAL This document provides all the information needed to install, evaluate and deploy this KWizCom product: Introduction Installation Guide Administrator Guide FAQ Version Release Notes Copyright KWizCom Corp. All rights reserved. Page 5 of 24

6 PRODUCT OVERVIEW SharePoint List Custom Actions Feature is part of the Mobility Bundle SharePoint List Custom Actions Feature is part of the Forms Bundle Same SharePoint list forms, but.. Now with the EXACT custom-menus your customers need! With SharePoint List Custom Actions You can easily create customized list menus and produce much more convenient and user-friendly solutions! You can add these custom menus on a list-level: List-level custom menus Copyright KWizCom Corp. All rights reserved. Page 6 of 24

7 And you can also create custom menus in a list-item level: List item-level custom menus Both the list-level and the item-level custom actions are dynamic, smart-menus which include the following capabilities: You can define permissions on a menu (make it available only to specific users/groups) A menu can initiate workflow processes You can define field-based conditions that define a menu s visibility THE BUSINESS NEED SharePoint list forms are all generic forms, including generic menus ( Edit, Delete, New etc.). Customers however, need to use SharePoint to implement their specific business needs, which require customized forms with custom menus that perform various custom actions. Copyright KWizCom Corp. All rights reserved. Page 7 of 24

8 With SharePoint out-of-the-box capabilities you must use additional tools such as InfoPath forms, SharePoint Designer (which unghosts your pages) or do some custom development which costs more money. KWizCom s Custom List Actions Feature enable non-technical implementers to fully customize SharePoint list form menus in just few minutes easy and immediate! WHO NEEDS IT? We all do! No matter which solution you re trying to implement, the out-of-the-box SharePoint list menus never cover your specific application s needs. Now you can create powerful custom menus and provide better SharePoint solutions to your customers! Copyright KWizCom Corp. All rights reserved. Page 8 of 24

9 KEY FEATURES Main key features of SharePoint List Custom Actions are: Feature Support WSS 3.0/4.0 and MOSS 2007/2010 Custom item-level actions/menus SharePoint List Custom Actions SharePoint 2007/2010 out-of-the-box Custom list-level actions/menus Context-sensitive/conditioned menus Assign permissions to actions Attach a workflow to an action Cross-browser support: IE, Firefox and Google Chrome partial Copyright KWizCom Corp. All rights reserved. Page 9 of 24

10 INSTALLATION GUIDE SOFTWARE REQUIREMENTS SERVER REQUIREMENTS WSS 3.0/4.0 or SharePoint Server 2007/2010.NET framework 3.5 SP2 CLIENT REQUIREMENTS Microsoft Internet Explorer 7+, 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. Download KWizCom SharePoint List Forms Extension latest evaluation version from KWizCom s internet web site. This evaluation version is fully functional for 30 days. Further details about product activation can be found in the Administrator guide (next section). 3. Unzip the product s zip file on your SharePoint server. 4. Double-click the.msi file in order to begin the web installation. 5. When the installation process is complete it will recycle all application pools automatically. SHAREPOINT 2010 SERVER 1. Log in as local admin to your SharePoint front-end server. 2. Download the product s latest version from KWizCom s internet web site web site. This is an evaluation version which is fully functional for 30 days. Further details about product activation can be found in the Administrator guide (next section). 3. Unzip the product s zip file on your SharePoint server. 4. Deploy the.wsp solution using SharePoint s stsadm utility. Copyright KWizCom Corp. All rights reserved. Page 10 of 24

11 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 programs 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 Custom Actions entry you ll see the following programs: About SharePoint List Custom Actions Display General Information about the component. Activate SharePoint List Custom Actions This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. 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: In case you wish this feature to be available only in a specific site collection, disable the farm Copyright KWizCom Corp. All rights reserved. Page 11 of 24

12 feature, and enable the site collection feature. 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). UN-INSTALLATION 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 Custom Actions 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. SHAREPOINT 2010 SERVER 1. Use SharePoint s stsadm utility to uninstall the.wsp package. Copyright KWizCom Corp. All rights reserved. Page 12 of 24

13 ADMINISTRATION GUIDE This section describes all administration activities related to SharePoint List Custom Actions, including: product activation, product configuration and customization. COMPONENT ACTIVATION KWizCom components are available for evaluation prior to purchase. This way you can try our components and verify that they indeed meet your needs. Each evaluation version contains all features of the component's production version. The only difference between the versions is that the evaluation version is time-limited and will operate for a period of one month. Once you decide to purchase a KWizCom component you will need to order and then to activate the product. The steps that need to be taken next are listed below: 1. Order the component on the KWizCom website or contact our sales team at sales@kwizcom.com. 2. After the order was made, send us the installed evaluation version's Product Code (you will see the product code on the "About" product page: Product Code Please note: Use the Activation Request web form, on the KWizCom web site to send us your product code. Copyright KWizCom Corp. All rights reserved. Page 13 of 24

14 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 Custom Actions -> Activate SharePoint List Custom Actions CREATING CUSTOM ACTIONS FOR A LIST Once the SharePoint List Custom Actions feature has been activated, every list and library should have a new SharePoint list custom actions link: Click the SharePoint list custom actions link to go into the custom actions configuration page: Copyright KWizCom Corp. All rights reserved. Page 14 of 24

15 REMARK: As you can see, this management page includes also the management sub-pages of SLFE (SharePoint List Forms Extensions Feature), which can be used if that feature is also activated. The List Custom Actions management interface includes 2 pages (see 2 last menus on the left side of the screenshot above): List custom actions Use this page to create list-level menus. Item custom actions Use this page to create menus that will appear in a list item s view/edit forms. The following sections provide details on each of those management pages. Copyright KWizCom Corp. All rights reserved. Page 15 of 24

16 LIST CUSTOM ACTION SETTINGS PAGE This management page enables you to define custom actions (menus) in the list level. Property Description Copyright KWizCom Corp. All rights reserved. Page 16 of 24

17 List Actions Add new list action Action title Action description Confirmation message Action icon Url (16X16) Redirect on complete This list shows the existing custom actions. You can create several actions (menus) and also define the display order of these menus. To add a new list action, enter its name and click the Add Action button. This is the caption of the menu that will be displayed to users. Enter the text you want to be displayed as tooltip when users hover over this menu. You can prompt the user with a question to validate the operation before the action is activated. Enter the url of a 16X16 image that will display as part of this menu. First you will have to upload that image to some SharePoint library and then copy its url to this field. Once this action is complete, you can have it redirect the user to some preferred page. (By the way, you can create an action that does nothing but redirect to some required page) You can use various tokens such as: [View name] redirects to this list s requested view page. [Default view] redirects to this list s default view page. [Home] redirects to the current site s home page. If you configured this action to create a new list item (you can do it further down in this management page), then you can make this action also redirect the user to the new created list item s view/edit form by using the *View item+ and *Edit item+ token. Users/groups Show action in these views only You can make an action be visible only to selected users/groups. If you do not select any users/groups, the action will be visible to all users. You can define in which list views the action will be visible. If you do not select any view, the action will be visible in all the list view pages. Copyright KWizCom Corp. All rights reserved. Page 17 of 24

18 Property Description Create a new list item Auto update fields Define visible field groups Initiate workflows Check this checkbox if you want the action to create a new list item. Once you check this option, other related options are displayed. In case you checked the Create new list item property, you can also define which of this new item s fields will be automatically filled with data. To define auto-update for a field, select the field; fill the value that you wish it to have and click the Add button. This property is available only if the SharePoint List Forms Extensions (SLFE) feature is active. SLFE enables you to add some advanced Form capabilities, such as field groups (dividing a long form with many fields to several subforms, each groups a set of fields). If you have SLFE activated, you can also define which of the list-item form fields-groups should be visible after the item is created. In case you checked the Create new list item property, you can also initiate requested workflows for the new created list item. This enables implementing more complex scenarios that require performing several operations once a menu is clicked by the user. Once you finish defining all action s settings click Apply or OK button to save those settings. Copyright KWizCom Corp. All rights reserved. Page 18 of 24

19 ITEM CUSTOM ACTION SETTINGS PAGE This management page enables you to define custom actions (menus) in the list-item level. These custom menus appear in the list-item s View/Edit forms, just above SharePoint out-of-the-box list item menus. Property Description Item Actions This list shows the existing custom item actions. You can create several actions (menus) and also define the display order of these menus. Copyright KWizCom Corp. All rights reserved. Page 19 of 24

20 Add new item action Action title Action description Confirmation message Action icon Url (16X16) Redirect on complete Users/groups Conditions To add a new item action, enter its name and click the Add Action button. This is the caption of the menu that will be displayed to users. Enter the text you want to be displayed as tooltip when users hover over this menu. You can prompt the user with a question to validate the operation before the action is activated. Enter the url of a 16X16 image that will display as part of this menu. First you will have to upload that image to some SharePoint library and then copy its url to this field. Once this action is complete, you can have it redirect the user to some preferred page. (By the way, you can create an action that does nothing but redirect to some required page) You can use various tokens such as: [View name] redirects to this list s requested view page. [Default view] redirects to this list s default view page. [Home] redirects to the current site s home page. [View item] redirects to the current list item s view form. [Edit item] redirects to the current list item s edit form. You can make an action be visible only to selected users/groups. If you do not select any users/groups, the action will be visible to all users. You can define property-based condition for displaying the list-item action to users. Copyright KWizCom Corp. All rights reserved. Page 20 of 24

21 Property Description Edit list item Auto update fields Define visible field groups Initiate workflows Check this checkbox if you want the action to update the current list item. Once you check this option, other related options are displayed. In case you checked the Edit list item property, you can also define which of the current item s fields will be updated. To define auto-update for a field select the field, fill the value that you wish it to have and click the Add button. This property is available only if the SharePoint List Forms Extensions (SLFE) feature is active. SLFE enables you to add some advanced Form capabilities, such as field groups (dividing a long form with many fields to several subforms, each groups a set of fields). If you have SLFE activated, you can also define which of the list-item form fields-groups should be visible after the item is updated. In case you checked the Edit list item property, you can also initiate requested workflows for the current list item. This enables implementing Copyright KWizCom Corp. All rights reserved. Page 21 of 24

22 more complex scenarios that require performing several operations once a menu is clicked by the user. Once you finish defining all action s settings click Apply or OK button to save those settings. Copyright KWizCom Corp. All rights reserved. Page 22 of 24

23 FAQ WHAT DOES THE SHAREPOINT LIST CUSTOM ACTION FEATURE DO? The SharePoint List Custom Actions feature enables non-technical SharePoint administrators to add custom menus to lists and to list items. This enables you to use SharePoint list forms to provide your customers with custom solutions that include the exact menus they need. DOES THIS SOLUTION WORK WITH ALL SHAREPOINT EDITIONS? The SharePoint List Custom Actions feature works with WSS and SharePoint Server, supporting both the 2007 and the 2010 versions. AFTER I INSTALLED THIS SOLUTION, I SEE A SHAREPOINT LIST FORMS EXTENSIONS FEATURE. WHAT IS THAT? The SharePoint List Custom Actions feature is actually a part of a broader solution that provides a complete solution for creating SharePoint-based custom application for WEB/mobile clients. The SharePoint List Forms Extensions Feature (SLFE) is the main infrastructure of this broader solution. It provides powerful form capabilities that you do not have in SharePoint out-of-the-box, such as: fieldlevel security, view-level security, conditioned field visibility, powerful field validations, field grouping and more. You can purchase each product separately, or as a bundle at a reduced price. Copyright KWizCom Corp. All rights reserved. Page 23 of 24

24 VERSION RELEASE NOTES Primary Software Version (SharePoint 2007) (SharePoint 2010) Base Version Release Date Sub-Modules n/a April Module n/a Version VERSION HISTORY CR# Description Version , April Base version Copyright KWizCom Corp. All rights reserved. Page 24 of 24