Charts for SharePoint

Transcription

1 KWizCom Corporation Charts for SharePoint Admin Guide

2 Copyright KWizCom Corporation. All rights reserved. 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 40

3 CONTENTS Contents... 3 introduction... 5 General... 5 Product Overview... 6 General... 6 Key Features... 7 Installation Guide... 8 Software Requirements... 8 Server Requirements... 8 Client Requirements... 8 Installation Procedure... 8 SharePoint 2010/ post Installation... 9 SharePoint 2010/ Un-Installation Procedure... 9 SharePoint 2010/ Administration Guide Product Activation Web Part Properties Data source Connection properties SharePoint list Connection properties Excel worksheet Displayed columns General chart settings Copyright KWizCom Corp. All rights reserved. Page 3 of 40

4 Chart Look & Feel X-axis settings Y-axis settings Legend settings Series display settings Tooltips User Actions FAQ What SharePoint edition do I need? To which data sources can the Chart web part connet? Do I need Excel Services in order to display Excel data in the chart? Technical Support Copyright KWizCom Corp. All rights reserved. Page 4 of 40

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 40

6 PRODUCT OVERVIEW GENERAL Charts for SharePoint web part includes unique features that overcome SharePoint s charting limitations as well as provides a charting solution for All SharePoint users, including the many users that use SharePoint Foundation/standard server and do not have Excel Services functionality available. This dynamic, great-looking and interactive chart web part enables users to easily zoom-in and better analyze the displayed data. Copyright KWizCom Corp. All rights reserved. Page 6 of 40

7 KEY FEATURES Feature Chart web part Availability Charts for SharePoint All SharePoint editions SharePoint 2010 out-of-the-box Std/Ent editions SharePoint 2013 out-of-the-box Display charts based on Excel data Only if you have Excel Services Display charts based on SharePoint lists Chart aggregated data (Pro. Edition) End-user can filter the chart using configurable filters (Pro. Edition) Zoom-in functionality Live Chart feature enables displaying dynamic, timedepended series of data Dynamic tooltips Print chart Export to PDF Export to image Copyright KWizCom Corp. All rights reserved. Page 7 of 40

8 INSTALLATION GUIDE SOFTWARE REQUIREMENTS SERVER REQUIREMENTS SharePoint 2010/2013 Foundation/Server CLIENT REQUIREMENTS Windows 7+, Mac OSX10.9 Microsoft Internet Explorer 9+, Firefox (latest version), Google Chrome (Latest version) INSTALLATION PROCEDURE SHAREPOINT 2010/ Log in as SharePoint administrator account to your SharePoint front-end server. 2. Browse the product s Download 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 product s package and deploy it manually, download the required package (2010/2013) from the product s Download page on KWizCom s website. That zip file includes a PoSH script that automatically installs and deploys the product on your farm. Copyright KWizCom Corp. All rights reserved. Page 8 of 40

9 POST INSTALLATION SHAREPOINT 2010/ After you have successfully deployed the required.wsp packages, a new S.C feature is added: Activate this feature to make the Charts for SharePoint web part available in the web part gallery. UN-INSTALLATION PROCEDURE 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 9 of 40

10 ADMINISTRATION GUIDE This section describes all administration activities, including: product localization, product configuration and customization. PRODUCT 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 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: Copyright KWizCom Corp. All rights reserved. Page 10 of 40

11 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. Copy the product code Copyright KWizCom Corp. All rights reserved. Page 11 of 40

12 e. 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. f. Once your order is confirmed, you will receive the Activation Code for your product by . Copyright KWizCom Corp. All rights reserved. Page 12 of 40

13 g. 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 13 of 40

14 WEB PART PROPERTIES In order to configure the web part s settings click on Modify Web Part Settings button: This will open the following toolpart: Copyright KWizCom Corp. All rights reserved. Page 14 of 40

15 The toolpart includes a left navigation bar that displays what you need to configure. Click each of the left banner s categories according to their display order and update the setting pages. Once you finished configuring all the settings pages click OK or Apply to save your settings. The following sections describe each of the categories and settings pages. DATA SOURCE Use this settings page to connect the web part to a data source. You can select one of the following data source types: SharePoint list connect to a local or remote SharePoint list. Excel worksheet connect to an Excel file that contains the data that you wish to display in the chart. Copyright KWizCom Corp. All rights reserved. Page 15 of 40

16 CONNECTION PROPERTIES SHAREPOINT LIST Use this page to configure the connection properties for your SharePoint list. The page includes the following properties: Web site url List name Type the list s site url and then click Load to load all the available lists in that site. Select the list that you wish to display in the chart, Copyright KWizCom Corp. All rights reserved. Page 16 of 40

17 View name Apply item limit defined in the selected view Select a view that will be used to filter the displayed data from the list. Check this property if the selected view includes an item limit, and you want this limit to be applied in the chart. CONNECTION PROPERTIES EXCEL WORKSHEET Copyright KWizCom Corp. All rights reserved. Page 17 of 40

18 Use this page to configure the connection properties for your Excel file. The page includes the following properties: Excel file url Worksheet Select named entity Type the url of your Excel file. Example: documents/sales vs. profit.xlsx This drop-down will display all the available worksheets in your selected Excel file. The Select named entity drop-down displays the available named entities in the selected worksheet, you need to select the one that you wish to connect to. If you have no idea what an Excel named entity is: The Chart web part displays Excel tables. An Excel Table is an enhanced way to manage your data ranges in Excel each such table includes a name that can be referenced (named entity) and additional data manipulation features (sorting, filtering and more). For additional information about Excel tables: This means that you have to make sure your Excel data (which you wish to display in a chart) is organized in Excel tables. You can easily convert your data range in Excel to a table by marking the range and then clicking the Format as table ribbon button. Copyright KWizCom Corp. All rights reserved. Page 18 of 40

19 DISPLAYED COLUMNS After you ve configured your data source, now you define which data columns should be displayed. The page includes the following properties: X axis source Select the data column that you wish to be displayed as the X-axis in the chart web part. Copyright KWizCom Corp. All rights reserved. Page 19 of 40

20 Y-series source columns Live chart mode The left list displays all the available data columns from the data source. Select the columns that you wish to display as Y-series in the chart, and move them to the list on the right side. In Live Chart mode, the chart will automatically generate the X-series based on the real-time, and will query the data source only for each series single point of data (the last one). Use this mode when you want to display time-depended live data. Copyright KWizCom Corp. All rights reserved. Page 20 of 40

21 GENERAL CHART SETTINGS This page includes the following general chart layout properties: Chart title Title location Chart subtitle Chart main title (see example chart screenshot below). Select where you d like to have the title displayed. Chart sub-title (see example chart screenshot below). Copyright KWizCom Corp. All rights reserved. Page 21 of 40

22 Wrap text Chart orientation Chart size Check this property if you don t want a long title to increase the width of the chart web part. Horizontal layout (default) = X-axis is the horizontal axis and Y the vertical. Vertical layout = Y-axis is the horizontal axis and X the vertical. Select if you wish the chart to automatically resize to the web part zone size, or if you prefer a fixed web part size that you will manually set. Chart title Chart subtitle Copyright KWizCom Corp. All rights reserved. Page 22 of 40

23 CHART LOOK & FEEL Use this page to select a chart skin or to customize an existing skin to create your own custom skin. Chart skin Customize Select one of the out-of-the-box skins for your chart. You can further customize the chart look & feel by overriding the selected skin s definitions with custom definitions for selected chart Copyright KWizCom Corp. All rights reserved. Page 23 of 40

24 Plot image url Title font Title font size Chart title color Subtitle font Subtitle font size Chart Subtitle color Legend font Legend font size Chart legend color Custom Theme filename properties. When checking this property the following additional properties appear: Specify if you would like an image as a plot background. Customize the chart s title font Customize the chart s title font size Customize the chart s title color Customize the chart s subtitle font Customize the chart s subtitle font size Customize the chart s subtitle color Customize the chart s legend font Customize the chart s legend font size Customize the chart s legend color Type the name of the custom theme that will store all your customizations. Copyright KWizCom Corp. All rights reserved. Page 24 of 40

25 X-AXIS SETTINGS Use this page to configure various properties of the chart s X-axis. Show X-axis X-axis label X-axis display format Check to have X-axis visible in the chart. Type the displayed X-axis label Select the format in which you want your X-axis values to be rendered. Copyright KWizCom Corp. All rights reserved. Page 25 of 40

26 X-axis scale In case X-axis column is numeric, select the required display scale. Allow zoom-in Check this property to allow end-users to zoom-in to a part of the X- axis, by dragging the mouse. This option is relevant to Numeric or Date/Time X-series. Advanced layout settings Grid lines color Axis line color Step X-Axis Labels Rotation Margin X-Axis Min Value X-Axis Max Value Show First Label Click to expand the advanced layout settings which include the following properties: Select the color of the chart grid (applies to themes that include a grid) Select the color of the chart s x-axis line. In case your x-axis labels overlap, you can show only every n'th label on the axis, by setting the Step value to n. Setting the step to 2 shows every other label. Rotation of the labels in degrees. Defaults to 0. The pixel distance between the axis labels or line and the X-axis title. Defaults to 0. The minimum value of the axis. If empty the min value is automatically calculated. The max value of the axis. If empty the min value is automatically calculated. Whether to show the first tick label. Copyright KWizCom Corp. All rights reserved. Page 26 of 40

27 Y-AXIS SETTINGS Use this page to configure various properties of the chart s X-axis. Show primary Y-axis Y-axis label Y-axis display format Check to have Y-axis visible in the chart. Type the displayed Y-axis label Select the format in which you want your Y-axis values to be rendered. Copyright KWizCom Corp. All rights reserved. Page 27 of 40

28 Y-axis display scale Advanced layout settings Grid lines color Axis line color Step Y-Axis Labels Rotation Margin Y-Axis Min Value Y-Axis Max Value Show First Label Show Secondary Y-Axis In case Y-axis column is numeric, select the required display scale. Click to expand the advanced layout settings which include the following properties: Select the color of the chart grid (applies to themes that include a grid) Select the color of the chart s y-axis line. In case your x-axis labels overlap, you can show only every n'th label on the axis, by setting the Step value to n. Setting the step to 2 shows every other label. Rotation of the labels in degrees. Defaults to 0. The pixel distance between the axis labels or line and the Y-axis title. Defaults to 0. The minimum value of the axis. If empty the min value is automatically calculated. The max value of the axis. If empty the min value is automatically calculated. Whether to show the first tick label. Check to display a second Y-axis which will be displayed on the right side of the chart. Copyright KWizCom Corp. All rights reserved. Page 28 of 40

29 LEGEND SETTINGS Use this page to configure various properties of the chart s X-axis. Show legend Location Check to make the chart legend visible. Select from various locations, relative to the chart area. Copyright KWizCom Corp. All rights reserved. Page 29 of 40

30 Layout Wrap text Custom legend captions The layout of the legend items. Can be one of "horizontal" or "vertical". Defaults to horizontal. Check this property if you don t want a long title to increase the width of the legend area. Use this section to define custom captions for your legend items (instead of displaying the Y-series column names). To define a custom legend caption for a Y-series, simply select the series, type the requested custom caption and then click the Add button. Copyright KWizCom Corp. All rights reserved. Page 30 of 40

31 SERIES DISPLAY SETTINGS In this section you configure how each of the Y-series will be displayed in the chart. Displayed Data Series Use this section to configure the chart type for each of the displayed data series. To do that, select the Y-series column, select the chart type, select on which Y-axis you want it to be displayed and finally select the displayed color. Then click the Add button to add this setting. Repeat this for each of the data series that you want to display in the chart. Copyright KWizCom Corp. All rights reserved. Page 31 of 40

32 Group data by X-Axis values Stack data by X-Axis values Check this property if you want series values that correspond to the same X-series value, to be grouped and display as a single point of data. Check this property if you want multiple series' values to be stacked to the same X-series value, this will show the series as a single stack. Display series data label values Check this property if you would like to see the data labels for each point in the chart. When you check this property, you can: Further specify the exact data label format in the Data label format property. Align the data labels with the chart s data points Copyright KWizCom Corp. All rights reserved. Page 32 of 40

33 Copyright KWizCom Corp. All rights reserved. Page 33 of 40

34 TOOLTIPS A Tooltip is displayed when an end-user hovers over or clicks a data point in the chart. You can configure the displayed tooltip by using free text, html tags and pre-defined dynamic token. On Hover Tooltip Type the tooltip s content. The tooltip can include a mix of static text and dynamic data. To include dynamic data, you can use the following tokens: {series.name} = Renders the hovered series caption as it appears in the legend. Copyright KWizCom Corp. All rights reserved. Page 34 of 40

35 {x} = Renders the X-value of the hovered data point. {y} = Renders the Y-value of the hovered data point. You can also include HTML tags to format the content of the tooltip. Use a shared tooltip for multiple series Shared Category Title Check this property to display a single tooltip for all the displayed series. This shared tooltip is displayed whenever the user hovers over the chart area, and will display all series values for the hovered X-Axis point. If you check this property, the following additional property will appear: When you choose to display a shared tooltip for multiple series you can display a shared title on this tooltip, so when hovering over the chart you will see in the tooltip the shared tooltip content and then the On hover tooltip content, for each of the data series. Example: We have the following tooltip configuration: When hovering over the chart, the following tooltip appears: Copyright KWizCom Corp. All rights reserved. Page 35 of 40

36 Copyright KWizCom Corp. All rights reserved. Page 36 of 40

37 USER ACTIONS Select chart actions that will be available to end-users. Print Download Chart Change chart type Display the chart in a print-friendly layout and print it. End-user will be able to download the displayed chart in one of the following formats:.jpg,.pdf or.svg (vector image). End-user will be able to switch between chart types. Copyright KWizCom Corp. All rights reserved. Page 37 of 40

38 Refresh Position Clicking the Refresh button will make the chart re-query its data source and refresh the displayed chart. Select the position where you d like to see the action buttons. Copyright KWizCom Corp. All rights reserved. Page 38 of 40

39 FAQ WHAT SHAREPOINT EDITION DO I NEED? Any edition will do, including SharePoint Foundation. The product is available both for SharePoint 2010 and SharePoint TO WHICH DATA SOURCES CAN THE CHART WEB PART CONNET? The Charts for SharePoint web part can connect to SharePoint lists, Excel files and can also aggregate data from multiple SharePoint lists (Pro. Edition). DO I NEED EXCEL SERVICES IN ORDER TO DISPLAY EXCEL DATA IN THE CHART? No. The Chart for SharePoint web part connects directly to your Excel files, so Excel Services are not required. Copyright KWizCom Corp. All rights reserved. Page 39 of 40

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