Installation & User Guide - SharePoint add-ons and appcatalog.kwizcom.com/sites/pc/Product...

SharePoint organization chart

Web Part

Installation & User Guide

Org. chart web part user guide

Copyright ©2005-2019 KWizCom corp. All rights reserved. www.kwizcom.com

2

Copyright © 2005-2019 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



3

Table of Contents

Introduction ........................................................................................... 4

Product Overview ................................................................................. 5

Installation.............................................................................................. 8

Software prerequisites _______________________________________________ 8

Installation Procedure ________________________________________________ 8

Post Installation ______________________________________________________ 9

Un-Installation Procedure ____________________________________________ 9

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

Administrator Guide .......................................................................... 14

Introduction _________________________________________________________ 14

Web part properties _________________________________________________ 15

Create a csv/xml data source ________________________________________ 31

Advanced layout customizations _____________________________________ 31




4

Introduction

KWizCom SharePoint Organization Chart web part displays a hierarchical view of

organization breakdown structure (OBS), which is based on a SharePoint list,

SharePoint profiles, external CSV or XML data files.

KWizCom SharePoint Organization Chart web part supports SharePoint 2010-

2019 Server.

This document provides all the information necessary to install, evaluate, and deploy

this KWizCom product. The document includes:

▪ Product Overview

▪ Installation Guide

▪ Administration guide

▪ FAQ




5

Product Overview

SharePoint Organization Chart web part connects to various sources and provides

various views for the display of organization breakdown structure (OBS).

Included key features:

Connect to both SharePoint and

external sources

Display your Org. chart based on various

data sources including:

• SharePoint profiles

• SharePoint list

• CSV file

• XML file

This allows you to easily implement your

Org. chart, no matter where your data

resides!

Org. chart dynamic view

Use the Org. chart view to quickly explore

your organization's structure with ability to

drill down and zoom to selected level.


http://staging.kwizcom.com/images/orgchart/

http://staging.kwizcom.com/images/orgchart/orgchartview-big.png



6

Hierarchical tree view

This view allows you to explore the

hierarchy faster, using less UI realestate

than the Org. chart graphical view.

Grid view

Use the Grid view to display your data in a

tabular/table view with your requested

columns.

The view includes sorting, filtering and

paging controls to enable you find the

requested information quicker.

Easily find what you're looking for

Do you have thousands of employees in

your organization?

With the Search box you can easily find

the people you're looking for!

Easily configure which data

columns to display

Simply select the columns that you want to

display in each one of the views, and in the

tooltip. You can further mix these columns

with HTML and javascript to customize the

exact look & feel.


http://staging.kwizcom.com/images/

http://staging.kwizcom.com/images/orgchart/gridview-big.png

http://staging.kwizcom.com/images/orgchart/Search-big.png

http://staging.kwizcom.com/images/orgchart/SelectColumns-big.png



7

Customize the look & feel

according to your brand

Easily change the look & feel by selecting

one of the skins available with the product.

You can also customize/create your own

skin that matches your exact graphic

design requirements.


http://staging.kwizcom.com/images/orgchart/skins-big.png



8

Installation

Software prerequisites

Server Requirements

1. SharePoint Server 2010-2019

Client PC Requirements

1. Windows Windows 7+, Mac OSX10.9

2. Microsoft Internet Explorer (Latest version), Microsoft Edge (Latest version), Firefox (latest version), Google Chrome (Latest version)

Installation Procedure

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 to download the product’s package and deploy it manually,

download the required package (2010/2013/2016) 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.




9

Post Installation

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

Un-Installation Procedure

1. Retract and remove the solution using SharePoint central admin or by using

stsadm/powershell command line.




10

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 product, you will need to follow the following

steps:

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:

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:



mailto:[email protected]



11

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




12

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.

g. Copy the activation code into the “Activation Code” field in the product’s

license management page and click “Activate now!” link.


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



13

That’s it! Your product is now fully activated.




14

Administrator Guide

Introduction

The Org. chart web part displays an organization breakdown structure, based on one

of the following data sources:

• SharePoint profiles (SharePoint server only)

• SharePoint list

• CSV file

• XML file

The web part includes several views, all configurable.

By default, after you add the web part to a SharePoint page, the web part connects

to an existing CSV file data source, which is installed with the products (with some

example data) and displays the following organization chart:




15

Web part properties

In order to configure the web part’s settings edit the web part and click the “Modify

Web Part Settings” button.

This will open the web part’s settings UI, which include several settings pages to

configure the data source and the displayed view.

Data Source settings

Select the data source that contains the hierarchy that you wish to display:

• CSV/XML file – this file can be located in a file share or on any accessible web

server.

• SharePoint list

• SharePoint profile service – this option will not work on SharePoint Foundation.

After selecting the data source type, click the “Connection properties” menu on the

left navigation bar.




16

Connection properties settings This is where you configure the properties of your selected data source, this page

includes different fields depending on the selected data source type:

CSV/xml file

Field Name Explanation

File location Type the url of the source file. This can be any url (not just

SharePoint).

Entity id field Select the name of the data field that contains the entity

identifier (should be unique to properly identify each entity in

the collection).




17


Sort Entity This property allows you to change the displayed order of

entities in the same level.

Entity parent id field Select the name of the data field that contains the entity’s

parent identifier. This enables properly displaying the

configured hierarchy.

Picture URL field Select the name of the data field that contains the entity’s

Picture url.

Hierarchy Top Entity Type the id of the entity which is the starting point of the

hierarchy.

If you leave this field empty, the web part will look for the

1st entity that has no parent node, and will use it as the

hierarchy’s top entity.




18

SharePoint list


Web Site Url Type the url of the site where your list is located. You can also

use one of the supported tokens such as [current site]. This

way you can avoid using hardcoded urls (and be able to easily

deploy the web part as part of a site template)

List Name Select the list.

View Name You can filter the displayed entities by using one of the

available list views.

Entity ID Field Select the name of the data field that contains the entity

identifier (should be unique to properly identify each entity in

the collection).

Sort Entity This property allows you to change the displayed order of

entities in the same level.




19


Entity parent id field Select the name of the data field that contains the entity’s

parent identifier. This enables properly displaying the

configured hierarchy.

Picture URL field Select the name of the data field that contains the entity’s

Picture url.

Hierarchy Top Entity Type the id of the entity which is the starting point of the

hierarchy.

If you leave this field empty, the web part will look for the

1st entity that has no parent node, and will use it as the

hierarchy’s top entity.




20

SharePoint profiles

When connecting to SharePoint Profile service, Org. chart will load the hierarchy based

on Manager and Login fields of the user profiles.

All you have to provide is the Hierarchy Top Entity id, which can be value for any of

the properties that are unique (id, name etc.).




21

Display settings - General This is where you configure the web part’s general display settings which apply to all

the views:


Default View Select the view that should be displayed by the web part by

default.

Skin This list displays all available skins which are installed with the

product. You can add/customize your own skins (information is

available in “advanced layout customizations” section).

Org Chart view

orientation

Select between vertical (default) and horizontal layout for the

Org. Chart view.




22


Template file name For advanced customization, developers can change the

used control template and override it.

Allow user to switch

views

Check this property to allow end-users to switch between

views.

User Picture Settings:

this section includes properties related to displaying employee pictures in the Org. chart

Display user picture Check this property to display user pictures in the chart.

In case the checkbox is checked, the web part will display

pictures based on the url in the “Picture URL” data field

(so you have to make sure you do have this column/field in

your data source)

Enable user picture as

hyperlink

Check property to display the user’s picture as a hyperlink.

Hyperlink Type url.

You can include column values in the url by selecting a column

from the “Insert Column” drop-down and clicking the “Add to

link” link.

Display 'Quick Search'

textbox

Check this property to display a search box above the chart.

Insert Column Use this list to add columns that you want to be displayed

in the “Quick Search” box.

'Quick Search' textbox

template

Use this text area to customize the exact display template

for the “Quick Search” box.

You can mix fields from the data source together with

html tokens to create your exact branded display.




23

Display settings – Tree view This is where you configure the web part’s Tree view:

The settings page includes the following properties:




24



for each node in the tree view.

HTML template Use this text area to customize the exact display template

for each node in the tree view. You can mix fields from

the data source together with html tokens to create your

exact branded display.

Number of Visible Levels Number of tree levels that should be visible by default.

Load on demand Loads a node and displays it only when user clicks the

expand button. Check this property when you have very

big hierarchies which may require longer load time.




25

Display settings – Grid view This is where you configure the web part’s grid view:





26


Displayed Columns Select the columns that you wish to display in the grid.

Enable filtering by

column

Check this property to display filtering controls below the

grid column headers.




27

Display settings – Org. chart view This is where you configure the web part’s Org. chart view:





28



for each node in the org. chart view.


for each node in the org. chart view. You can mix fields

from the data source together with html tokens to create

your exact branded display.

Number of Visible Levels Number of tree levels that should be visible by default.

Allow hierarchy

expand/collapse

Check this property to enable end-users to expand nodes

that have child-nodes.

Allow drill-down Enables end-users to display a selected entity as the top

displayed node.

Load on demand Loads a node and displays it only when user clicks the

expand button. Check this property when you have very

big hierarchies which may require longer load time.




29

Display settings – Tooltip This is where you configure the tooltip which is displayed when you hover over an

entity in the chart:





30


Display tooltip Check this property to display a tooltip when user hover over

an entity.


in the tooltip.


for the tooltip. You can mix fields from the data source

together with html tokens to create your exact branded

display.




31

Create a csv/xml data source

Best way to create a csv/xml data source is simply to use an existing example.

You can find an example for CSV/XML data files on your SharePoint server under the

14/15 hive: \TEMPLATE\LAYOUTS\KWizCom_OrgChart\

File Description

MyCompanyOBS.csv CSV-format file that includes example data for the Org.

Chart web part.

MyCompanyOBS.xml XML-format file that includes example data for the Org.

Chart web part.

Advanced layout customizations

In addition to the configuration options available in the web part, you can customize

the Org. chart layout in the following ways:

• Customize an existing skin or create your own custom skin

All skin folders are available under the [14/15 hive]\

TEMPLATE\LAYOUTS\KWizCom_OrgChart\Skins folder.

Each skin folder includes the relevant html/css/image files. It is a

recommended practice not to change an existing skin but to copy it and create

your own custom skin.

• Customize the Org. chart user controls

Both OrgChartWebPart.ascx and OrgChartTooltip.ascx controls are available

under the [14/15 hive]\TEMPLATE\LAYOUTS\KWizCom_OrgChart folder.


Installation & User Guide - SharePoint add-ons and appcatalog.kwizcom.com/sites/pc/Product...

Documents

Transcript of Installation & User Guide - SharePoint add-ons and appcatalog.kwizcom.com/sites/pc/Product...