KWizCom Charts for SharePoint admin guide€¦ · Admin KWizCom Corporation Charts for SharePoint Guide. Charts for SharePoint Admin Guide Copyright © 2005-2015 KWizCom Corp. All

KWizCom Corporation

Charts for SharePoint

Admin Guide

Charts for SharePoint Admin Guide

Copyright © 2005-2015 KWizCom Corp. All rights reserved. www.kwizcom.com | Page 2 of 47

Copyright © 2005-2016 KWizCom Corporation. All rights reserved.

Company Headquarters

95 Mural Street, Suite 600

Richmond Hill, ON

L4B 3G2 Canada

E-mail: [email protected]

Web site: http://www.KWizCom.com

Sales

E-mail: [email protected]

Telephone: +1-905-370-0333

http://www.kwizcom.com/

http://www.kwizcom.com/ProductReg



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/2013 ........................................................................................................................................... 8

post Installation ......................................................................................................................................................... 9

SharePoint 2010/2013 ........................................................................................................................................... 9

Un-Installation Procedure.......................................................................................................................................... 9

SharePoint 2010/2013 ........................................................................................................................................... 9

Administration Guide .................................................................................................................................................. 10

Product Activation ................................................................................................................................................... 10

Web Part Properties ................................................................................................................................................ 14

Data source .......................................................................................................................................................... 15

Connection properties – SharePoint list .............................................................................................................. 16

Connection properties – Excel worksheet ........................................................................................................... 17

Displayed columns ............................................................................................................................................... 19

General chart settings ......................................................................................................................................... 21




Chart Look & Feel ................................................................................................................................................ 23

X-axis settings ...................................................................................................................................................... 25

Y-axis settings ...................................................................................................................................................... 27

Legend settings .................................................................................................................................................... 29

Series display settings .......................................................................................................................................... 31

Tooltips ................................................................................................................................................................ 34

User Actions ......................................................................................................................................................... 37

Charting filtered and aggregated data .................................................................................................................... 39

Configure the Charts web part ............................................................................................................................ 40

Configure the List Filter Plus web part................................................................................................................. 42

FAQ .............................................................................................................................................................................. 46

What SharePoint edition do I need?........................................................................................................................ 46

To which data sources can the Chart web part connet? ......................................................................................... 46

Do I need Excel Services in order to display Excel data in the chart? ...................................................................... 46

Technical Support ........................................................................................................................................................ 47




INTRODUCTION

GENERAL

This document provides all the information needed to install, evaluate and deploy this KWizCom

product:

Introduction

Installation Guide

Administrator Guide

FAQ




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.




KEY FEATURES

Feature Charts for SharePoint

SharePoint 2010

out-of-the-box

SharePoint 2013

out-of-the-box

Chart web part Availability All SharePoint editions

Std/Ent editions

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, time-depended series of data

√

Dynamic tooltips √

Print chart √

Export to PDF √

Export to image √




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/2013

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




POST INSTALLATION


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


1. Retract and delete the solution using SharePoint central admin or by using stsadm/powershell

command line.




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/2013

1. Order the product on the KWizCom website – www.KWizCom.com, or contact our sales team at

[email protected].

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:


mailto:[email protected]




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




e. Browse the Product Activation Request page on KWizCom’s web site:

http://www.kwizcom.com/ProductReg.

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

email.


http://www.kwizcom.com/objects/KWizCom%20SharePoint%202010%20Foundation/KWizCom%20SharePoint%20Foundation.zip



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.




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:




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.




CONNECTION PROPERTIES – SHAREPOINT LIST

Use this page to configure the connection properties for your SharePoint list.

The page includes the following properties:

Property Explanation

Web site url Type the list’s site url and then click “Load” to load all the available lists in that site.

List name Select the list that you wish to display in the chart,





View name Select a view that will be used to filter the displayed data from the list.

Apply item limit defined in the selected view

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




Use this page to configure the connection properties for your Excel file.



Excel file url Type the url of your Excel file.

Example: https://portal/shared documents/sales vs. profit.xlsx

Worksheet This drop-down will display all the available worksheets in your selected Excel file.

Select named entity 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:

http://office.microsoft.com/en-001/excel-help/overview-of-excel-tables-HA010048546.aspx

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.






DISPLAYED COLUMNS

After you’ve configured your data source, now you define which data columns should be displayed.



X axis source Select the data column that you wish to be displayed as the X-axis in the chart web part.





Y-series source columns 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.

Live chart mode 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.




GENERAL CHART SETTINGS

This page includes the following general chart layout properties:


Chart title Chart main title (see example chart screenshot below).

Title location Select where you’d like to have the title displayed.

Chart subtitle Chart sub-title (see example chart screenshot below).





Wrap text Check this property if you don’t want a long title to increase the width of the chart web part.

Chart orientation 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.

Chart size 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




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 Select one of the out-of-the-box skins for your chart.

Customize You can further customize the chart look & feel by overriding the selected skin’s definitions with custom definitions for selected chart





properties. When checking this property the following additional properties appear:

Plot image url Specify if you would like an image as a plot background.

Title font Customize the chart’s title font

Title font size Customize the chart’s title font size

Chart title color Customize the chart’s title color

Subtitle font Customize the chart’s subtitle font

Subtitle font size Customize the chart’s subtitle font size

Chart Subtitle color Customize the chart’s subtitle color

Legend font Customize the chart’s legend font

Legend font size Customize the chart’s legend font size

Chart legend color Customize the chart’s legend color

Custom Theme filename Type the name of the custom theme that will store all your customizations.




X-AXIS SETTINGS

Use this page to configure various properties of the chart’s X-axis.


Show X-axis Check to have X-axis visible in the chart.

X-axis label Type the displayed X-axis label

X-axis display format Select the format in which you want your X-axis values to be rendered.





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 Click to expand the advanced layout settings which include the following properties:

Grid lines color Select the color of the chart grid (applies to themes that include a grid)

Axis line color Select the color of the chart’s x-axis line.

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

X-Axis Labels Rotation

Rotation of the labels in degrees. Defaults to 0.

Margin The pixel distance between the axis labels or line and the X-axis title. Defaults to 0.

X-Axis Min Value The minimum value of the axis. If empty the min value is automatically calculated.

X-Axis Max Value The max value of the axis. If empty the min value is automatically calculated.

Show First Label Whether to show the first tick label.




Y-AXIS SETTINGS



Show primary Y-axis Check to have Y-axis visible in the chart.

Y-axis label Type the displayed Y-axis label

Y-axis display format Select the format in which you want your Y-axis values to be rendered.





Y-axis display scale In case Y-axis column is numeric, select the required display scale.

Advanced layout settings Click to expand the advanced layout settings which include the following properties:

Grid lines color Select the color of the chart grid (applies to themes that include a grid)

Axis line color Select the color of the chart’s y-axis line.

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

Y-Axis Labels Rotation

Rotation of the labels in degrees. Defaults to 0.

Margin The pixel distance between the axis labels or line and the Y-axis title. Defaults to 0.

Y-Axis Min Value The minimum value of the axis. If empty the min value is automatically calculated.

Y-Axis Max Value The max value of the axis. If empty the min value is automatically calculated.

Show First Label Whether to show the first tick label.

Show Secondary Y-Axis Check to display a second Y-axis which will be displayed on the right side of the chart.




LEGEND SETTINGS



Show legend Check to make the chart legend visible.

Location Select from various locations, relative to the chart area.





Layout The layout of the legend items. Can be one of "horizontal" or "vertical". Defaults to horizontal.

Wrap text Check this property if you don’t want a long title to increase the width of the legend area.

Custom legend captions 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.




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.





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

Stack data by X-Axis values 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







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.





{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

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:

Shared Category Title

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:








USER ACTIONS

Select chart actions that will be available to end-users.


Print Display the chart in a print-friendly layout and print it.

Download Chart End-user will be able to download the displayed chart in one of the following formats: .JPG, .PDF or .SVG (vector image).

Change chart type End-user will be able to switch between chart types.





Refresh Clicking the “Refresh” button will make the chart re-query its data source and refresh the displayed chart.

Position Select the position where you’d like to see the action buttons.




CHARTING FILTERED AND AGGREGATED DATA

Charts for SharePoint Pro. Edition includes an additional web part called List Filter Plus web part.

By connecting the List Filter Plus web part to the Charts web part you can connect your chart to multiple

lists, aggregate data according to your required query, and also enable end-users to filter the displayed

data in run-time.

Example:

The following screenshot displays the List Filter Plus web part connected to the Chart web part:

The filter web part is fully customizable, so you can configure which exact filtering controls will be visible

to end-users.

In this example the List Filter Plus web part is configured to aggregate data from several Tasks lists. The

aggregated data is then sent to the Chart web part, which is configured to display the amount of tasks

per each status.

End-users can also filter the displayed tasks by Due Date range and by tasks priority.


http://www.kwizcom.com/sharepoint-add-ons/sharepoint-list-filter-plus/overview/



We will not explain how to configure the List Filter Plus and the Charts web parts to enable charting

aggregated data, we will use the example above (display aggregated tasks).

After adding the Charts and the List Filter Plus web parts to the page, follow these configuration steps:

CONFIGURE THE CHARTS WEB PART

Configure the Charts web part and connect it to one of the Tasks lists that you are going to aggregate. It

doesn’t really matter to which of the lists you connect the chart web part because this connection is

used only to configure which columns are displayed in the chart. As mentioned before, the actual data

will come from the List Filter web part (after we connect it to the Charts web part), which serves as the

data aggregator.

Getting back to our example: we wish to display a pie chart that displays the amount of charts in each

status, so the configuration will be as follows:

Displayed Columns settings page

We picked on of the columns (ID) as the displayed column. Actually it doesn’t matter which column we

choose because in our example we do not display the column data, we display the amount of items.




X-Axis settings page

We selected “Status” column as the x-axis column because the chart should display the amount of task items per-status.

Y-Axis settings page

Y-axis is configured to display numeric data (the amount of items which is a numeric data type).




Series display settings page

Here you can see that we selected a Pie chart type. We display the ID column and the main thing: we checked the “Group data by X-axis values”, which enables us to aggregate tasks items that correspond to the same Status value, into a single point on the chart, using one of the available grouping operators. In this case we selected the “Count” grouping operator which simply counts the amount of items which have the same “Status” value.

That’s it! You can save the Chart settings and continue now to the List Filter Plus web part’s settings.

CONFIGURE THE LIST FILTER PLUS WEB PART

Configuring the List Filter Plus web part includes the following configuration steps:

1. Connect the List Filter Plus web part to the Charts web part

Edit the web part and then click the “Connections” web part menu:




Click to select the “Send DataTable To” sub-menu and then click the “KWizCom Charts for

SharePoint Web Part” sub-menu.

This will make the 2 web parts connected, where the List Filter Plus web part serves as a data

provider for the Charts web part.

2. Edit the List Filter Plus web part – Table Viewer properties

Edit the web part, then scroll down and get to the “Table Viewer Properties” section:

Click “Modify Web Part Settings” to open the toolpart.




3. The toolpart displays the following window:

This is where you configure the data aggregation parameters: Aggregation source, scope of

aggregation, type of lists to aggregate and which columns to aggregate. In our example we

aggregate all Tasks lists from the current site and all sub-sites, the aggregated data include the

following columns: Title, Status and Priority.

Click” OK” to save the settings.

OK, so up until now we’ve configured the List Filter Plus web part to aggregate the data that we want to

chart. Next, we’ll configure the Filter web part to display a filtering form with the filtering controls that

we want to display to end-users:

1. Again, edit the List Filter Plus web part.

2. Under the “Filter” toolpane, connect the filter to one of the Tasks lists and then add the columns

that you want to filter.

For more details about List Filter Plus settings, please refer to the user guide.


http://catalog.kwizcom.com/sites/pc/Product%20Documentation/SharePoint_List_Filter_web_part_User_Guide.pdf



After saving the settings you’re done. You should now have a chart displaying aggregated tasks data,

filtered by the customized filtering form above it.




FAQ

WHAT SHAREPOINT EDITION DO I NEED?

Any edition will do, including SharePoint Foundation. The product is available both for SharePoint 2010

and SharePoint 2013.

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.




TECHNICAL SUPPORT

You can obtain technical support using any of the following methods:

The KWizCom Web site

The KWizCom website: www.KWizCom.com 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.



http://www.kwizcom.com/ContentPage.asp

http://www.kwizcom.com/?PageId=57?PageId=57

KWizCom Charts for SharePoint admin guide€¦ · Admin KWizCom Corporation Charts for SharePoint Guide. Charts for SharePoint Admin Guide Copyright © 2005-2015 KWizCom Corp. All

Documents