Installation & User Guide

Transcription

1 SharePoint List Menu Editor Installation & User Guide

2 Copyright 2005 KWizCom LTD. All rights reserved. Company Headquarters P.O. Box #38514 North York, Ontario M2K 2Y5 Canada Web site: Sales Telephone: +1- (412)

3 Table of Contents Introduction...4 Overview 5 Key Features & Benefits 7 Installation...8 Software prerequisites 8 Installation Procedure 8 Post Installation 9 Component Activation...10 Administrator Guide...12 Adding a new menu item 12 Using Menu Templates 20 FAQ...22 What exactly does KWizCom SharePoint List Menu Editor do? 22 Do I have to install anything on my company's client-pcs? 22 How do I retrieve a list field values and use it on my menu definition script? 22 Version Release Notes...23 New Added Features 23 This Version's Known Issues/Limitations 23 Technical Support

4 Introduction KWizCom SharePoint List Menu Editor is an MS SharePoint web part that enables adding custom menu items to any list or document library item. This document provides all the information needed to install, evaluate and deploy this KWizCom product: Product overview Installation guide Component activation Administrator guide FAQ Version release notes 4

5 Overview All SharePoint lists have the same drop-down menus, regardless of the lists' type: KWizCom SharePoint List Menu Editor enables SharePoint administrators to add new custom menu items to every required list. These new menu items are managed in a web part scope; this gives the SharePoint administrator the ability to decide to which list to add new custom menus, and on which web part pages these new menu items will be visible. The following example displays 2 new menu items added to a "Meeting Summaries" document library: Send Link by Opens Microsoft Outlook dialog and adds the document as a link. Send Document Properties by Opens Microsoft Outlook dialog and fills the document's properties valudes in the message's body. 5

6 2 custom menus items So, how does it work? In order to add menu items to a certain list/document library, you have to add the SharePoint List Menu Editor to the page. This web part is visible only when the page is in design mode. SharePoint List Menu Editor web part displays javascript editor, that enables you to add new menu items to a specific web part, displaying some SharePoint list. Each time you add a new menu item, a new javascript function is created. You can then change/edit this function anyway you want. Once you turn the page to view mode, the SharePoint List Menu Editor web part will become invisible, and the web part to which it was connected will show the new custom menu items. For detailed instruction, please review the Administrator Guide chapter on this document. 6

7 Key Features & Benefits Enables adding custom menu items to every required list or document library. Enables displaying different menu items for different users, on the same list by defining the custom menu items on a web part level. Custom menu items are defined using script language (javascript) requires no re-compilation etc. Enables saving menu items as templates. These templates can then be used again in other lists/document libraries. No client installation needed easy & fast deployment Multi-lingual (standard for all KWizCom components) 7

8 Installation Software prerequisites Server Requirements 1. Microsoft Windows SharePoint Services (WSS) SP1/SP2 2. Microsoft Office SharePoint Portal Server 2003 (SPS) Client PC Requirements 1. Microsoft Windows XP - SP2 2. Microsoft Internet Explorer 6+ SP1 Installation Procedure 1. Unzip the KWizCom SharePoint List Menu Editor zip file on your WSS/SPS Windows 2003 Server. 2. Double-click the.msi file in order to begin the web installation. 3. When the installation process is complete, you need to restart the IIS Server: Open the Command Prompt on your server. Type iisreset 8

9 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 Menu Editor Display General Information about the component. Activate SharePoint List Menu Editor This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. SharePoint List Menu Editor User Guide Link to user-guide document (.PDF). 9

10 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: 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: Product Code 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. 10

11 4. Activate your installed evaluation version - click Start -> All Programs -> KWizCom -> SharePoint List Menu Editor -> Activate SharePoint List Menu Editor 11

12 Administrator Guide Adding a new menu item This section provides a walkthrough for adding new menu item to a SharePoint list/document library. The following screenshot displays a team site with "Shared Documents" web part. In this walkthrough we will add a new "Send Document as Link" menu item to this web part. 12

13 Adding a new menu item to a web part displaying some SharePoint list is done in the following way: 1. Insert the SharePoint List Menu Editor into the web part page, by browsing to the "Virtual Server Gallery" and dragging the web part onto the page: The SharePoint List Menu editor web part will display the following message: "Connect the web part by select [Connections->Connect to List] in the web part menu". 2. Connect SharePoint List Menu Editor web part to the "Shared Documents" web part: Select the web part's "Connections" menu, and then select "Connect to List > Shared Documents" as shown on the screenshot bellow. 13

14 The SharePoint List Menu Editor is now connected to the "Shared Documents" web part. 3. After connecting the two web parts, SharePoint List Menu Editor displays the following user interface: 14

15 Toolbar javascript editor The web part's toolbar contains the following commands: Add Menu Add a new menu item definition. Clicking this button will prompt with the following dialog: Menu displayed caption Javascript function name Menu item icon url Add Separator Adds a separating line between menu items Templates Enables loading a menu item definition from existing templates, 15

16 and to save current edited menu definition as a template for future use. Save Saves the current menu definition to the connected web part. After saving completes, the new defined menu items should appear in the web part's drop-down menu. 4. Let's add now a new "Send Document Link by " menu item: Click "Add Menu" and fill the following dialog as displayed: Click "Save and Close". The following code will be added to the javascript editor: 16

17 CAMOpt(m, p_caption, p_action, p_imgurl) is the javascript function which actually adds a new menu. It receives 4 parameters: Parameter Type Description m reference This is a reference to the SharePoint menu object. DO NOT change it. p_caption String Menu item's displayed caption p_action String javascript function name. This function is the event handler of the menu click event. You shlud implement this function. P_ImgUrl String URL of the displayed menu icon. If left empty then no icon will be displayed. Implement the javascript function Now we have to implement the javascript function that handles the menu click event: CAMOpt(m, "Send Link By ", "SendDocLink()", "/_layouts/images/eml16.gif"); this.senddoclink = SendDocLink; function SendDocLink() { var surl = "[(EncodedAbsUrl)]"; var sdata = "<a href='" + surl + "'>" + surl + "</a>"; try { var olapp = new ActiveXObject('outlook.application'); var oitem = olapp.createitem(0); oitem.subject = 'Take a look at this document'; oitem.htmlbody = sdata; oitem.display(true); } catch(e) 17

18 { window.navigate('mailto:%20?subject=take a look at this document...&body=" + sdata + "') } } // add a separator to the menu CAMSep(m); That's it! Now save the menu definition by clicking Save menu. Now, select one of the documents on the "Shared Documents" web part and you'll see the new defined menu appearing as the 1 st menu item: 18

19 Set the page mode back to View mode, and the SharePoint List Menu Editor will become invisible. 19

20 Using Menu Templates SharePoint List Menu Editor enables you to save menu definitions as templates and then reuse them on other lists/document libraries. Saving a menu definition as template After you finish coding a menu definition, simply click "Templates > Save as Template" on the web part's toolbar: Loading a menu template Click "Templates > Load Template" on the web part's toolbar. The following popup window is displayed: Select a desired menu template and click "Save and Close". The selected 20

21 menu definition (javascript code) will be added to the last line on the Menu list editor web part. 21

22 FAQ What exactly does KWizCom SharePoint List Menu Editor do? This web part enables SharePoint administrators add new custom menu items to any required SharePoint list or document library. These new menu items can be added to the list's page or to a web part that displays a certain list. Do I have to install anything on my company's client-pcs? No. KWizCom SharePoint List Menu Editor is a server installation. How do I retrieve a list field values and use it on my menu definition script? Please review the following Microsoft article: 22

23 Version Release Notes Primary Software Version Base version n/a Release date Jan Sub-Modules Module Version n/a n/a New Added Features n/a This Version's Known Issues/Limitations CR # Description 23

24 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at contains the most updated 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 fill in our support web form on our web site For more information on technical support, please review our support programs page. 24