Installation & User Guide

Transcription

1 SharePoint organization chart Web Part Installation & User Guide

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

3 Table of Contents Introduction... 4 Product Overview... 5 Key Features and Benefits 9 Installation Software prerequisites 10 Installation Procedure 10 Post Installation 12 Un-Installation Procedure 13 Component Activation Administrator Guide Introduction 19 Create a data source 20 Define Config. XML file 21 Connect the web part to your data source 22 Component Localization Component Activation FAQ Version Release Notes Version History 35 Technical Support

4 Introduction KWizCom SharePoint Organization Chart web part displays a hierarchical view of organization breakdown structure (OBS), which is based on a SharePoint list, external CSV or XML data files. KWizCom SharePoint Organization Chart web part supports MOSS 2007/WSS 3.0 and SharePoint 2010 Server/Foundation. This document provides all the information necessary to install, evaluate, and deploy this KWizCom product. The document includes: Product Overview Installation Guide Administrator guide Component Activation FAQ Version Release Notes Technical Support 4

5 Product Overview Get a flexible display a of the organization breakdown structure with the KWizCom SharePoint Org. Chart web part: Once a user hovers an employee link, an employee popup card is displayed: 5

6 When you click some employee's presence indicator(*), a standard Office contextmenu is displayed, enabling immediate collaboration actions (instant messaging, send etc.) 6

7 (*) Contact presence context-menu requires Office 2003 on the user's client machine In addition to the hierarchical view, Org. chart provides a flat-tabular view as shown hereunder: Org. chart web part enables you to filter the displayed employees tree/list in 2 ways: Simple, textual filter Enter some string into the text-filter textbox; Only employee records that contain this string in some column will be displayed. 7

8 Advanced, property-based filter You can filter the employee tree/list by defining a criteria based on one of the employees' properties, as shown in the following screenshot: 8

9 Key Features and Benefits Feature Hierarchical/flat (Phone-book) view Connect to local/remote SharePoint list Connect to CSV/XML data files Dynamically configurable view Textual & property-based filtering capabilities Support filtering by URL parameters and by Web Part Connections Customizable layout via CSS Multi-lingual user interface (standard for all KWizCom components) Org. Chart web part 9

10 Installation Software prerequisites Server Requirements 1. SharePoint 2007 / WSS 3.0 or 2. SharePoint Server/Foundation 2010 Client PC Requirements 1. Windows Vista/Windows 7 2. Microsoft Internet Explorer 7,8,9 Installation Procedure SharePoint Log in using SharePoint administrator account to your SharePoint front-end server. 2. Unzip the product installation zipped file on your 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! Your Cascading Lookup Plus Field Type is installed! SharePoint Log in as SharePoint administrator account to your SharePoint front-end server. 2. Download the product s latest evaluation version (zip file) from KWizCom s internet web site. This evaluation version is fully functional for 30 days. 3. Download the KWizCom SharePoint Foundation zip file: 10

11 m%20sharepoint%20foundation.zip REMARK: KWizCom SharePoint Foundation is a WSP package that includes all KWizCom s shared utilities and licensing modules for SharePoint Extract both zip files content into the same folder on your SharePoint s disk. You will need now to install and deploy these standard SharePoint WSP packages. This can be done by using SharePoint s stsadm/powershell tools, according to Microsoft s guidelines for installing WSP packages. 5. For a much quicker automatic installation, right-click the SP-WSPsInstaller.ps1 Powershell script file and select Run with Powershell. This will start the automatic installation and deployment process. At the end of the installation process, you should see all packages deployed in the Central Admin Server Solutions page, and the KWizCom SharePoint Foundation package should be deployed also in the Central Admin s web application. 11

12 Post Installation SharePoint After completion of the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom containing the following programs: About SharePoint Organization Chart web part Display General Information about the component. Activate SharePoint Organization Chart web part This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. 2. A new Organization Chart web part is available in your SharePoint web part gallery. 3. Define your own List/CSV/XML data file format- Please see detailed instructions in the next section (Administration Guide). 4. Run iisreset on your SharePoint server. SharePoint Activate the Organization Chart web part site collection feature in order to make the Org. Chart web part visible in the site collection s web part gallery. 12

13 Un-Installation Procedure SharePoint Log in using SharePoint administrator account to your SharePoint front-end server. 2. Go to Control Panel and double-click Add or Remove Programs. 3. Select product 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 Retract and remove the solution using SharePoint central admin or by using stsadm/powershell command line. 13

14 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: Please use the Activation Request web form, on KWizCom web site to send us 14

15 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 Org. Chart Web Part- > Activate SharePoint Org. Chart Web Part SharePoint 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: 15

16 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: 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 (Farm, Web application, Site Collection). A product code will be generated and displayed as in the following screenshot: 16

17 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 fillout all other form fields, click Send Activation Request button. g. Once your order is confirmed, you will receive the Activation Code for your product by . 17

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

19 Administrator Guide Introduction The Org. chart web part displays an organization breakdown structure, based on one of the following data sources: SharePoint list Excel (CSV file) XML file By default, after you add the web part to a SharePoint page, the web part connects to an existing CSV file data source and displays the following organization chart: In order to display your organization s chart you need to configure the web part. Configuration tasks include: 1. Create your data source SharePoint list / CSV file / XML file 2. Create/Update an XML configuration file that stores all display parameters (This step is needed only when you are using a CSV/XML file as your data source). 3. Connect the web part to your data 19

20 Create a data source Best way to create a data source is simply to use an existing example. You can find an example for CSV/XML data files and a list template (.stp) file on your SharePoint server in: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\wpresources\KWizCom.SharePoint.WebParts.HierarchyViewer\ fb4ddbec95ff8f: File MyCompanyOBS.stp MyCompanyOBS.csv MyCompanyOBS.xml Description List template file that includes example data for the Org. Chart tree web part. CSV-format data file that includes example data for the Org. Chart tree web part. XML-format data file that includes example data for the Org. Chart tree web part. For SharePoint list You have 2 options to create a list with data: 1. Upload the list template to your SharePoint gallery and then create a new list from that template. The new list will have sample data that you can override with your own data. 2. Open the MyCompanyOBS.csv file in MS EXCEL and update the file with your company data. Then Create a new list by importing the excel file (by using SharePoint s Import Spreadsheet list creation option. For CSV/XML data file copy the existing file to a new file, and override it with your own data. 20

21 REMARKS: 1. You can use your own data file/list that includes different field names. By using the example data file/list template you simply avoid additional configuration that will be needed when you change/add additional fields to the data files/sharepoint list. 2. The data files (for Excel/XML data sources) must reside on the WFE server/s, or on a network drive accessible from all WFE servers. Define Config. XML file This section applies only to Excel (CSV)/XML file data sources (when you are using a SharePoint list as your data source you do not need to configure this XML file). After you have created a data file (CSV or XML format), you have to create a configuration xml file that defines all the web part's parameters. Best thing to do is simply to copy one of the sample config. Files and override with your changes: OrgChartConfig-Excel.xml - Sample config. file that defines an Excel data file OrgChartConfig-XML.xml - Sample config. file that defines an Excel data file These files are well documented, and contain detailed explanation for each parameter. These files are located in C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\wpresources\KWizCom.SharePoint.WebParts.HierarchyViewer\ fb4ddbec95ff8f folder in the WFE where you have installed the web part, and should be copied to each of the other WFE servers in your SharePoint farm. 21

22 Connect the web part to your data source Add the Org. chart web part to the page and edit the web part s settings: The web part includes the following properties: Source Type: select in this drop-down the type of data source that you wish to connect the web part to: o o o Excel (CSV file) XML (XML file) List (A SharePoint list) Default view mode: The web part has 2 view mode: Tree and Flat. Select which one should be displayed by default (end user can toggle between these views in run-time) Config file: In case you selected Excel or XML source types, this property is relevant. Type here the name of your XML configuration file (or leave as-is if you are using the xml configuration files that are installed with the web part). 22

23 In case you choose the List source type, another tab will appear in the web part settings window: This tab contains a set of properties that enable you to define the various fields that will appear in the Org. chart web part. Field Name Web site url List name Employee name field Employee ID field Explanation Type the url of a SharePoint site where your list that stores company OBS is located. You can also use tokens such as [current site]. Select the list that stores your company OBS. Select the field that stores the employee name. Select the field that stores the employee unique id. This can be any field that you want, but just keep in mind that the values in 23

24 Field Name Explanation this field should be unique per employee. Employee field Division name field Employee role field Manager s id field Site country field Site field Picture URL field Picture s on-click URL field Select the field that stores the employee . Select the field that stores the employee s division/department name. Select the field that stores the employee s role/job title. Select the field that stores the manager s id. This field enables connecting employees to managers (which are also employees in the same list). Select the field that stores the employee s location (country). Select the field that stores the employee s office/branch name. Select the field that stores the employee s picture url. Select the field that stores URL address to which the user will be redirected when clicking an employee s link/picture on the web part. 24

25 Field Name Hierarchical view start point Explanation Type the employee id that you wish to display at the top level of the company OBS. If you leave this field empty, the web part will automatically select an employee that has no managers and will display it at the top hierarchy level. Flat view fields Simple filter fields Select the columns that will be displayed in Flat view mode. Select the columns that will be searched when end-user types search keywords in the text search field: 25

26 Field Name Explanation Advanced filter fields Select the columns that will be displayed in the drop-down filter (available when end-user selects property-based filter mode): Popup fields Select the columns that will be displayed in the floating card that is displayed when hovering over an employee s name: Show more details message Check this property if you wish to display a link that redirects to some custom web page. When end users click that line they will be redirected to your custom web page, and you can use that page to display additional information about the viewed employee (all employee s properties are added to the page url as query 26

27 Field Name Explanation string parameters). More details message The caption that will be displayed for the link in the Employee floating popup: After you update the properties click OK to save settings. 27

28 Component Localization Every KWizCom component comes with localization utility called "Resource File Editor" that enables translation of the component user interface to any required language. This section describes this utility and the translation process. Resource File Editor utility structure This utility displays the following dialog that enables the administrator to translate every displayed string (captions, menu items, user-messages) to the required target language. The application displays 2 controls: _ "Select Culture" drop-down contains a list of target languages. _ Strings grid This grid contains all the strings displayed by the component. The grid includes 3 columns: a. Internal Name This column displays the internal name of each string (read only). b. Default Value The default displayed value in English (read only). c. Localized Value The translated value in the selected language. This is where you enter the required translated value. Once you finish translating all the component strings, click "Create" and a resource file will be created. This resource file will automatically be used by the component upon changing the user language on your server. For example: In an MS SharePoint-based component, you should create a site using your required SharePoint Language Pack. According to the SharePoint site language, the relevant language's resource file will be The application displays 2 controls: _ "Select Culture" drop-down contains a list of target languages. _ 28

29 The application displays 2 controls: "Select Culture" drop-down contains a list of target languages. Strings grid This grid contains all the strings displayed by the component. The grid includes 3 columns: a. Internal Name This column displays the internal name of each string (read only). b. Default Value The default displayed value in English (read only). c. Localized Value The translated value in the selected language. This is where you enter the required translated value. Once you finish translating all the component strings, click "Create" and a resource file will be created. This resource file will automatically be used by the component upon changing the user language on your server. For example: In an MS SharePoint-based component, you should create a site using your required SharePoint Language Pack. According to the SharePoint site language, the relevant language's resource file will be used by the component. Translating a KWizCom component SharePoint On your Windows task bar, select: Start->All Programs->KWizCom-> SharePoint Org. Chart Web Part Resource Editor 2. Select your target language on the "Select Culture" drop-down list. 3. Translate all the displayed strings in the strings grid by entering a 29

30 translated value in the "Localized Value" column. 4. Click the "Create"/"Update" button in order to create/save a resource 5. file for the selected target language. If you want to create additional resource files for more target languages, simply repeat stages 2-4 for each language. 6. Close the utility by clicking the "Close" button. SharePoint Go to: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\Resources. 2. Copy the product s resource file: KWizCom.SharePoint.WebParts.OrgChart.resx to a new resource file, and add to its name the requested language s suffix. Example: to create a French resource file, copy the file to the following file name: KWizCom.SharePoint.WebParts.OrgChart.fr-FR.resx 3. Update the copied resource file and replace the English strings with the translated strings. The translatable strings are located inside the <data name> nodes, in their <value> attributes. Example: <data name="btnaccept" xml:space="preserve"> <value>accept Changes</value> </data> 4. Save the new resource file. Use the component in your preferred language All KWizCom components use.net localization mechanism. This means that a KWizCom component will automatically use a language resource file according to the displayed application's language (this is true for all types of components). 30

31 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. Evaluation versions of KWizCom components contain all the features of the component's production version. The only difference between the two versions is that the evaluation version is time-limited to operate for a period of one month. Once you decide to order a KWizCom component, you will need to complete the following steps: 5. Order the component on the KWizCom website 6. Send us the installed evaluation version's product Code (you will see the product Code on the "About" product page: Please use the Activation Request web form, on KWizCom web site to send us your product code! 31

32 7. Get the component activation key this key will be sent to you by once your order is processed. 8. Activate your installed evaluation version - click Start ->All Programs ->KWizCom ->SharePoint Org. Chart web part -> Activate SharePoint Org. Chart web part 32

33 FAQ What does the Org. Chart web part do? Org. Chart web part displays organization breakdown structure (OBS) in hierarchical/flat view, based on Excel/XML data file. How can I integrate Org. Chart web part with our corporate HR system? All you have to do is implement an export process that will create the Excel/XML data file and save it in some file system share that is accessible from your SharePoint server. Do I need to install anything on my company's client-pcs? If you want the presence indicator to function, you will need Microsoft Office 2003 to be installed on your client PC. How can I dynamically at run-time filter the displayed employee tree/list? Org. Chart web part can be filtered at run-time using URL parameters. The syntax is as follows: page url]?filterfield=[field name]&filtervalue=[value] Can I change the web part's layout? You can fully customize the web part's graphic layout, by customizing the.css files located bellow: C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\wpresources \KWizCom.SharePoint.WebParts.HierarchyViewer\ 33

34 fb4ddbec95ff8f folder: Tree.css style sheet for tree view Popup.css style sheet for employee card popup page Flat.css style sheet for flat view Filter.css style sheet for filter row 34

35 Version Release Notes Primary Software Version (SharePoint 2007) (SharePoint 2010) Base version Release date Oct Sub-Modules Module Version n/a n/a Version History CR # Description Version , Oct Issues connecting to Excel data source in SP bit 1900A Upgrade to SharePoint

36 Technical Support Technical support is available via any of the following: The KWizCom Web site The KWizCom website, contains the most current information, including: o o Answers to frequently asked questions (FAQ's) about our products, their usability, and technical questions. Product updates, which include bug fixes and new features. The Web Form For technical support via the Internet, fill in the support web form on our web site. For further technical support, please review our support programs page. 36