KWizCom Custom Actions

Transcription

1 KWizCom Corporation KWizCom Custom Actions Admin Guide

2 Copyright KWizCom Corporation. All rights reserved. KWizCom Custom Actions Admin Guide Company Headquarters 95 Mural Street, Suite 600 Richmond Hill, ON L4B 3G2 Canada Web site: Sales Telephone: Copyright KWizCom Corp. All rights reserved. Page 2 of 30

3 CONTENTS Contents... 3 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 SharePoint 2010/ post Installation SharePoint SharePoint 2010/ Upgrade Procedure Un-Installation Procedure SharePoint SharePoint 2010/ Administration Guide Component Activation Creating custom actions for a list Copyright KWizCom Corp. All rights reserved. Page 3 of 30

4 List Custom Action settings page Item Custom Action settings page FAQ What does the KWizCom Custom Actions Feature do? Does this solution work with all SharePoint editions? Copyright KWizCom Corp. All rights reserved. Page 4 of 30

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

6 PRODUCT OVERVIEW KWizCom Custom Actions is part of the KWizCom Forms Enterprise Edition Same SharePoint list forms, but.. Now with the EXACT custom-menus your customers need! With KWizCom 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: And you can also create custom menus in a list-item level: Copyright KWizCom Corp. All rights reserved. Page 6 of 30

7 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. 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! Copyright KWizCom Corp. All rights reserved. Page 7 of 30

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

9 KEY FEATURES Main key features of KWizCom Custom Actions are: Feature Custom item-level actions/menus Custom list-level actions/menus Context-sensitive/conditioned menus Assign permissions to actions Attach a workflow to an action Get/update external data Cross-browser support: IE, Firefox and Google Chrome KWizCom Custom Actions Copyright KWizCom Corp. All rights reserved. Page 9 of 30

10 INSTALLATION GUIDE SOFTWARE REQUIREMENTS SERVER REQUIREMENTS WSS 3.0/SharePoint 2007 Server or SharePoint 2010/2013 Foundation/Server CLIENT REQUIREMENTS Windows 7/8 or MAC OSX V10.9 Microsoft Internet Explorer 9+, Mozilla Firefox (Latest version), Google Chrome (Latest version), Safari (Latest version) INSTALLATION PROCEDURE SHAREPOINT Log in using SharePoint administrator account to your SharePoint front-end server. 2. Download the product s 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. If you have a previous installed version of the product, then uninstall it before you install the new version. 4. Unzip the product s zip file on your SharePoint server. 5. Double-click the.msi file in order to begin the web installation. 6. The installation includes 2 additional optional packages, that are part of the KWizCom Forms Enterprise edition SharePoint List Forms Extensions Feature Enables you to turn the out-of-the-box SharePoint list forms into powerful, feature-rich web forms. SharePoint Mobile Extensions Feature Enables you to publish your custom actions to mobile smartphones and create additional custom mobile pages. 7. When the installation process is complete it will recycle all application pools automatically. Copyright KWizCom Corp. All rights reserved. Page 10 of 30

11 SHAREPOINT 2010/ Log in as SharePoint administrator account to your SharePoint front-end server. 2. Browse the product s page on KWizCom s website and click the Go link under the Install using our Web Installer section. This will start the KWizCom web installer. Note: The KWizCom Web Installer will automatically offer you to upgrade other existing KWizCom products on your farm, in case you have old versions installed. You can check which products you wish to update at this time. 3. In case you prefer just to download the relevant.wsp packages and manually deploy them, then in the web installer UI check the Download only option (3 rd page in the installer s wizard). When the installer finishes you will be able to go to the installer s folder on your server, and install the KWizCom packages by simply running the SP-WSPInstaller PowerShell script. 4. At the end of the installation process, you should see all packages deployed in the Central Admin >System settings>manage Farm Solutions page, and the KWizCom SharePoint Foundation package should be deployed also in the Central Admin s web application. Copyright KWizCom Corp. All rights reserved. Page 11 of 30

12 POST INSTALLATION SHAREPOINT After completing the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following program: KWizCom Custom Actions Under KWizCom Custom Actions entry you ll see the following programs: About KWizCom Custom Actions Display General Information about the component. Activate KWizCom Custom Actions This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. 2. The installation adds a new feature 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: 3. In case you wish this feature to be available only in a specific site collection, disable the farm feature, and enable the site collection feature. 4. If you had a previous version installed, and have been deploying the List Forms Extensions Feature is site collection level, you will need to deactivate the farm level feature (because it is automatically activated during installation). If you leave both the farm-level and the site collection-level features active, you will have duplicated links to the List Forms Extensions settings pages at the list settings pages. Copyright KWizCom Corp. All rights reserved. Page 12 of 30

13 SHAREPOINT 2010/ After you have successfully deployed the required.wsp packages, a new feature is added both to the farm level and to site collection level. By default the Farm level feature should be active, enabling you to start using this feature immediately: 2. If you had a previous version installed, and have been deploying the List Forms Extensions Feature is site collection level, you will need to deactivate the farm level feature (because it is automatically activated during installation). If you leave both the farm-level and the site collection-level features active, you will have duplicated links to the List Forms Extensions settings pages at the list settings pages. UPGRADE PROCEDURE For a detailed upgrade from SP2010 to SP2013 procedure, please refer to this KB article. Copyright KWizCom Corp. All rights reserved. Page 13 of 30

14 UN-INSTALLATION PROCEDURE SHAREPOINT Log in as SharePoint administrator to your SharePoint front-end server. 5. Go to Control Panel and double-click Add or Remove Programs. 6. Select KWizCom Custom Actions entry and click Remove button. 7. Click Yes to approve the removal of the component. 8. Once the product was un-installed, close the Add or Remove Programs screen. SHAREPOINT 2010/ Retract and delete the solution using SharePoint central admin or by using stsadm/powershell command line. Copyright KWizCom Corp. All rights reserved. Page 14 of 30

15 ADMINISTRATION GUIDE This section describes all administration activities related to KWizCom 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. An evaluation version for each KWizCom component contains all features of the component's production version. The only difference is that an evaluation version is time-limited, and will operate for a period of one month. Once you decide to order a KWizCom component, you will need to follow the following steps: SharePoint 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: Copyright KWizCom Corp. All rights reserved. Page 15 of 30

16 Please 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 Feature -> Activate SharePoint List Forms Extensions Feature SharePoint 2010/ Order the product on the KWizCom website or contact our sales team at sales@kwizcom.com. 2. After the order was made, you can activate your installed evaluation version. Activation is done by the following steps: a. Open SharePoint Central Admin. On the main Central Administration page, you will see the KWizCom Features Administration icon: b. Click the KWizCom Features Administration icon. You will be redirected to a page that allows you to manage all your installed KWizCom products licenses: Copyright KWizCom Corp. All rights reserved. Page 16 of 30

17 c. Click the Manage License link next to the product that you wish to activate. You will be redirected to that product s license management page: d. Click on the Request product code and start your evaluation now link, under the required license type. A product code will be generated and displayed as in the following screenshot: Copyright KWizCom Corp. All rights reserved. Page 17 of 30

18 e. Copy the product code. f. Browse the Product Activation Request page on KWizCom s web site: Copy your Product Code into the Product Code field, and after you fill-out all other form fields, click Send Activation Request button. Copyright KWizCom Corp. All rights reserved. Page 18 of 30

19 g. Once your order is confirmed, you will receive the Activation Code for your product by . h. Copy the activation code into the Activation Code field in the product s license management page and click Activate now! link. That s it! Your product is now fully activated. Copyright KWizCom Corp. All rights reserved. Page 19 of 30

20 CREATING CUSTOM ACTIONS FOR A LIST Once the KWizCom Custom Actions feature has been activated, every list and library should have a new KWizCom Custom Actions settings link: Click the KWizCom Custom Actions link to go into the custom actions configuration page: Copyright KWizCom Corp. All rights reserved. Page 20 of 30

21 The KWizCom Custom Actions configuration 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 settings pages. Copyright KWizCom Corp. All rights reserved. Page 21 of 30

22 LIST CUSTOM ACTION SETTINGS PAGE This settings page enables you to define custom actions (menus) in the list/library level. These actions are visible in the list views, as new buttons in the ribbon. When creating a custom list action, you define the following: In which actions group the action will appear (actions are displayed in the ribbon in groups) Action properties (title, icon, description and more) Visibility who should see the action and in which list views What should happen when user clicks the action/menu an action can create a new item in the list, auto-populate selected fields, trigger selected workflows and redirect the user to requested URL. Here s a detailed description of the settings page: Copyright KWizCom Corp. All rights reserved. Page 22 of 30

23 Property Description Actions group title Add new list action List Actions Action title Action description Confirmation message Action icon Url (16X16) Redirect on complete Type the name of the ribbon group that you wish this action to appear in. To add a new list action, enter its name and click the Add Action button. This list shows the existing custom actions. You can create several actions (menus) and also define the display order of these menus. 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 your action creates a new item, then you can also redirect to that item s Edit/View form by using these tokens: [Edit Item] redirects to new created item s Edit Item page [View Item] redirects to new created item s View Item page Use this action as the default New Item form Check this checkbox if you wish this action to be triggered when user clicks the New item ribbon button. The first action in the list that applies to the current user will be used. Copyright KWizCom Corp. All rights reserved. Page 23 of 30

24 Users/groups Show action in these views only Create a new list item 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. Check this property if you want the custom action to create a new list item and autipopulate some of its fields. If you check the Create a new list item property, additional set of properties will appear: Property Description Content type Auto update fields If the list supports multiple content types choose the content type of the new created list item. 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. Copyright KWizCom Corp. All rights reserved. Page 24 of 30

25 Visible field groups Initiate workflows This property is available only if you have KWizCom Forms deployed, and you have configured tabs for your list form. You can define which of the tabs should be displayed as the New Item form, for the new created item. 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 25 of 30

26 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 Actions group title Add new item action Item Actions Type the name of the ribbon group that you wish this action to appear in. To add a new item action, enter its name and click the Add Action button. 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 26 of 30

27 Action title Action description Confirmation message Action icon Url (16X16) Redirect on complete Use this action as the default Edit Item form Users/groups Conditions 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. Check this checkbox if you wish this action to be triggered when user clicks the Edit Item ribbon button. 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 27 of 30

28 Property Description Edit list item Change item s content type to Auto update fields 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. If the list supports multiple content types, choose the content type of the updated item (you can change the item s content type). 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 you have KWizCom Forms deployed, and you have configured tabs for your list form. You can define which of the tabs should be displayed as the Edit Item form, for the new created item. In case you checked the Edit list item property, you can also initiate requested workflows for the current list item. This enables implementing more complex scenarios that require performing several operations once a menu is clicked by the user. Copyright KWizCom Corp. All rights reserved. Page 28 of 30

29 Once you finish defining all action s settings click Apply or OK button to save those settings. Copyright KWizCom Corp. All rights reserved. Page 29 of 30

30 FAQ WHAT DOES THE KWIZCOM CUSTOM ACTIONS FEATURE DO? KWizCom Custom Actions enables site owners 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? KWizCom Custom Actions works with WSS and SharePoint Server, supporting both the 2007 and the 2010/2013 versions. Copyright KWizCom Corp. All rights reserved. Page 30 of 30