27
Virto SharePoint Gantt Chart Web Part for SharePoint 2013 and 2016 Release 4.6.0 User and Installation Guide

Virto SharePoint Gantt Chart Web Part for SharePoint 2013 ... · Virto SharePoint Gantt Chart Web Part for SharePoint 2013 and 2016 Release 4.6.0 User and Installation Guide

Embed Size (px)

Citation preview

Virto SharePoint Gantt Chart

Web Part for SharePoint 2013 and

2016

Release 4.6.0

User and Installation Guide

2

Copyright © 2017 All rights reserved. www.virtosoftware.com

Table of Contents FEATURES LIST ....................................................................................................................................................................................... 3

SYSTEM/DEVELOPER REQUIREMENTS ........................................................................................................................................ 3

OPERATING SYSTEM .............................................................................................................................................................................. 3 SERVER ................................................................................................................................................................................................ 3 BROWSER ............................................................................................................................................................................................. 4

INSTALLATION AND USAGE ......................................................................................................................................................... 5

INSTALLING VIRTO GANTT WEB PART ....................................................................................................................................................... 5 UPGRADING VIRTO GANTT WEB PART ...................................................................................................................................................... 8 UNINSTALLING VIRTO GANTT WEB PART ................................................................................................................................................... 8

PRODUCT DESCRIPTION ............................................................................................................................................................... 9

ADJUSTMENT ........................................................................................................................................................................................ 9 CONFIGURATION OF DATA SOURCES ........................................................................................................................................................ 10 CONFIGURATION OF GANTT CHART VIEW ................................................................................................................................................ 13

USING VIRTO GANTT CHART WEB PART .................................................................................................................................... 16

LAYOUT OF VIRTO GANTT CHART WEB PART ........................................................................................................................................... 16 WORKING WITH TASKS IN VIRTO GANTT CHART WEB PART ......................................................................................................................... 17

Moving Tasks and changing Task Duration .............................................................................................................................. 17 Editing a task .............................................................................................................................................................................. 18 Deleting a task ............................................................................................................................................................................ 18 Creating a Task ........................................................................................................................................................................... 19 Milestone .................................................................................................................................................................................... 20 Child task ..................................................................................................................................................................................... 20 Predecessor and successor tasks ............................................................................................................................................... 21

TIMESCALE .......................................................................................................................................................................................... 22 RESOURCES ......................................................................................................................................................................................... 23 PERCENT COMPLETE ............................................................................................................................................................................. 23

VERSION RELEASE HISTORY ....................................................................................................................................................... 25

3

Copyright © 2017 All rights reserved. www.virtosoftware.com

Virto Gantt Web Part for Microsoft SharePoint 2013 and 2016

Overview

Virto Gantt Web Part is intended to view list items in a Gantt chart to see a graphical representation of how a team's tasks relate over time in Microsoft SharePoint 2013.

Features List

Feature Version

View list items in a Gantt chart v.4.0

Using SharePoint list as a data source v.4.0

Display several lists in one Gantt chart v.4.0

Creating new tasks/milestones right in the Gantt chart v.4.0

Applying different timescales to view items v.4.0

Scrolling Gantt chart to required period of time v.4.0

Scrolling to current day tasks v.4.0

Creating child tasks for selected tasks v.4.0

Changing task duration with drag and drop v.4.0

Adding task resources. v.4.0

Changing percent complete with drag and drop v.4.0

Ability to define read-only settings v.4.0

Ability to define colors for tasks/summary tasks/milestones/percent complete. v.4.0

Export to PDF v.4.6.0

System/Developer Requirements Operating System Microsoft Windows Server 2012, 2012R2

Server SharePoint Release 2013: - Microsoft Windows SharePoint Foundation 2013 or Microsoft Office SharePoint Server 2013; - Microsoft .NET Framework 4.5; Note: This product is not compatible with SharePoint Release 2010, 2007, SPS 2003 and WSS v2.

4

Copyright © 2017 All rights reserved. www.virtosoftware.com

Browser Microsoft Internet Explorer 9 or higher.

5

Copyright © 2017 All rights reserved. www.virtosoftware.com

Installation and Usage This section describes how to install, upgrade, uninstall, or contact Support for the Virto Gantt View.

Installing Virto Gantt Web Part

Before you begin, you need to make sure you have access to the server and your account must have the appropriate administrative privileges to install applications. Virto Gantt Web Part for SharePoint setup program provides links to the various installation components for the calendar. To access Virto Gantt View Setup program download Virto.SharePoint.GanttWebPart.X.X.zip file and unzip it. Run extracted Setup.exe file. The setup wizard window will appear.

Virto Gantt Web Part wizard performs a system check prior to the installation. All the system checks must be completed successfully in order to proceed with the installation. After the checks have completed, click “Next”.

6

Copyright © 2017 All rights reserved. www.virtosoftware.com

Check “I accept the terms in the License Agreement” and click “Next”.

7

Copyright © 2017 All rights reserved. www.virtosoftware.com

Select the web application(s) where you want to install the product. Warning: You must be logged in to the SharePoint server with a Site Collection Administrator account to automatically activate this feature.

Then click “Next”.

8

Copyright © 2017 All rights reserved. www.virtosoftware.com

Click “Close” to complete the installation.

Upgrading Virto Gantt Web Part

If you already use Virto Gantt Web Part and need to upgrade it to the latest version, download the.zip file from http://www.virtosoftware.com. Unzip the file and run setup.exe as it is described in the Installing Virto Gantt Web Part section. On the step 3 check the box “Upgrade” and click “Next”. Note: if you have activated Virto ONE license, you do not need to activate it now.

Uninstalling Virto Gantt Web Part

To uninstall the component:

1. Double click the Setup.exe extracted from downloaded Virto.SharePoint.2013.GanttChart Part.X.X.zip file.

2. The program performs the system checks again. Once that has successfully completed, the program prompts you to Repair or Remove the solution. Select Remove, and click “Next”.

9

Copyright © 2017 All rights reserved. www.virtosoftware.com

Virto Gantt Chart Web Part for SharePoint 2013 and 2016.

Product description Virto Gantt Chart Web Part for SharePoint 2013, 2016, SharePoint Online is designed for displaying and managing SharePoint tasks in Gantt view. Virto Gantt Chart Web Part is a highly customizable solution, which includes the following features: displaying several task lists in one view; different (day, week, month, year) time scales; customizable task/milestone color; read only mode; filtering tasks by using list views; displaying several list columns in the left part of the Web Part; editing tasks directly from the Web Part (adding/moving/deleting/resizing); adding child tasks.

Adjustment

When Gantt Chart Web Part is installed, go to required SharePoint site page and add web part through the site settings. Click “Edit” on Page, then press “Insert” on the ribbon and choose “Web Part”.

Select “Virto Solutions” in Categories and then select “Virto HTML5 Gantt” from the list of available web parts.

Now add Gantt Chart Web Part to the SharePoint site page and save the changes on page.

Click on link to configure the Web Part.

Note: an administrator can add the Gantt Chart Web Part to the SharePoint site and adjust it. Then the web part can be saved as a template. Later on this template can be used, and there is no need to adjust the web part every time.

10

Copyright © 2017 All rights reserved. www.virtosoftware.com

Click ”Edit” in the right upper corner of page and edit the web part.

To adjust Gantt view for a SharePoint list, you need to define data source settings first of all. Click on Virto Gantt Chart Web Part icon and open configuration page for data sources.

Configuration of data sources

Data sources configuration page displays list of already configured data sources. This page also contains link for adding new data source. Click on link “Add new Gantt data source” and you will be redirected to the page to adjust a new data source.

11

Copyright © 2017 All rights reserved. www.virtosoftware.com

Required fields for data source are marked with “*” symbol. Add a data source name. Then select site url or click “Refresh” button to choose current site. Select list with tasks, which should be displayed in Virto Gantt Chart Web Part. Any list type can be used. If you want to display tasks in a specific list view, select the required view.

It is also possible to use custom CAML filter by choosing a view.

Select the field that will be displayed as task title. Usually, task name is used, but you can assign any other field according to your project demands.

Select fields those contain task start and end dates. If a list contains field with task’s percents of completion, you can select the field for gantt chart. Select field with task resources (user or several users who are assigned to the task, usually “Assigned To”

12

Copyright © 2017 All rights reserved. www.virtosoftware.com

field). Select field with task predecessor(s). Predecessors and successors are connected through arrows in Gantt chart.

You can define the set of list fields to display on task form, using “Add field” button. The fields set can be also adjusted for child task form and milestone form.

You have to select at least one field, that will be displayed in the left (table) part of the Gantt view. Usually, it is field with the task name.

Assign the background colors for source rows and for tasks. It is also possible to highlight task statuses or categories by a choice field. For example, you can define custom colors to distinguish task priority statuses.

13

Copyright © 2017 All rights reserved. www.virtosoftware.com

You can also define colors for progress bar, milestones, summary tasks, and summary task progress bar.

Press “Save” button after filling all desired and required fields. Now you can add another data source, using another list, or proceed to Chart view adjustment.

Configuration of Gantt Chart view

Now you have to go back to the page with Gantt installed and configure the settings.

Click “List of Virto SharePoint Gantts” link when you already have configured data sources. Page with available Gantts will be opened. On this page you can edit/delete existing configured Gantts and add a new Gantt.

14

Copyright © 2017 All rights reserved. www.virtosoftware.com

Click “Add new Gantt” link to add a new Gantt chart.

Required fields are marked with “*” symbol. Add a name for Gantt. Then click “Add new source” button to adding at least one data source to Gantt. Each data source has its own options. You can uncheck box “Show in Virto SharePoint Gantt“ and make data source not available for displaying (save without publishing). Also, you can add data source with read only permission, i.e. user will not be able to create/modify tasks in Gantt Chart Web Part for the data source. Click “Save” button. You can add other data sources to this Gantt as well.

Set height of Gantt in pixels if you want to limit size of Virto Gantt Chart Web Part displayed on site. Default height value is 800px, default width proportion is 100%.

Set splitter position in percents (without “%” symbol). Splitter separates left Gantt table part from right graphical part. Choose default time scale (available values are days, weeks, months, and year). You can check the box to display default SharePoint form to edit tasks.

15

Copyright © 2017 All rights reserved. www.virtosoftware.com

Check option “Show weekends” if you want to display weekends in Gantt Chart Web Part. Weekends are hidden by default.

The “Enable export to PDF” feature allows you to save your Gantt chart as PDF.

This option adds the button on Gantt header; the pdf file with current Gantt table view will be downloaded automatically after clicking this button.

The next feature allows to show summary tasks collapsed by default. Auto schedule feature helps manage successor and predecessor tasks. It is intended to protect from cases when successor task starts before the predecessor.

16

Copyright © 2017 All rights reserved. www.virtosoftware.com

Set the default task duration when you create a new task. You can also predefine standard values for Date format displaying. Date and Time are displayed in left (table) part of the Gantt. It is possible to select the color to highlight Today header. Click “Save” and apply changes.

Using Virto Gantt Chart Web Part

Layout of Virto Gantt Chart Web Part

Virto Gantt Chart Web Part consists of header and Gantt chart. Left part includes list of tasks and the right part shows graphical structure: duration and relations of tasks. When you scroll tasks in the left part, the right part is scrolled accordingly. Header contains navigation buttons and date picker with currently selected date for quick navigation. Use navigation arrow buttons to go to required month. Or select in the date picker a date to navigate to.

Header of Gantt Chart Web Part has buttons for new task adding and for time scale changing. When the Gantt Chart Web Part for SharePoint Online / SharePoint 2013, 2016 is adjusted, it looks like as follows:

17

Copyright © 2017 All rights reserved. www.virtosoftware.com

Working with tasks in Virto Gantt Chart Web Part

You can add/delete/move/resize tasks in Virto Gantt Chart Web Part View. Hover mouse pointer over some task and tooltip with brief task information will appear.

Moving Tasks and changing Task Duration

You can easily change task dates by simple moving. Use your mouse to move tasks to other dates by simple drag

and drop. Task resizing (changing start or end date) is also supported as well. Just drag start or end of a task to

required date and drop it. The same changes will be done in SharePoint list.

18

Copyright © 2017 All rights reserved. www.virtosoftware.com

Editing a task

If you need to edit a task, just double click on task and editing/viewing (if data source is read only) form will be

displayed. If data source is not read only the task can be also deleted by clicking “Delete” button on editing form.

Deleting a task

Task can be deleted (if data source is not read only) by clicking “X” icon in right upper corner of the task.

19

Copyright © 2017 All rights reserved. www.virtosoftware.com

Creating a Task

Virto Gantt Chart Web Part for SharePoint Online / SharePoint 2013 allows users to create task right in the

Web Part. The same changes will be done in SharePoint list.

Clicking “+ Add task” button will open form for creating new task. First drop down list is used for selecting

data source where user wants to add new task.

Type the title (“New task” by default) and define start and end time of your new task.

By default the new task will appear at the end of the list (or on the other position depending of chosen view).

The task will appear in the Gantt Chart on the right as well.

20

Copyright © 2017 All rights reserved. www.virtosoftware.com

Milestone

When task start date equals task end date the task is displayed as milestone.

If you create new task as described in previous section and define equal start and end date and time, it will be

shown as milestone - task with zero duration.

Child task

Sometimes you need to define parent-child relations between tasks in the Gantt Chart Web Part. If tasks list is selected as data source, user can select some task in Virto Gantt Chart Web Part and add child task to it. If task has child task it is displayed as a summary task.

If you want to make selected task a child task (sub-task), highlight the parent task which will contain new child task and use “+ Add child task” button. In this case SharePoint list data source must be also a task list. You can select more than one task and make all of them child-tasks with “+ Add child task” action.

21

Copyright © 2017 All rights reserved. www.virtosoftware.com

Predecessor and successor tasks

Virto Gantt Chart Web Part for SharePoint Online / SharePoint 2013 allows users to display successors and predecessors relationship. Predecessor and successor tasks are connected through arrows. Successor will start after predecessor.

Virto Gantt Chart Web Part allows users to define finish-to-start relations between tasks and create successors

and predecessors by simple arrows drag-and-drop. Just click a task that will be a predecessor and drag the arrow

to a task which you want to make a successor.

22

Copyright © 2017 All rights reserved. www.virtosoftware.com

To delete the dependency just click and select the arrow and then press “Delete” on keyboard.

Timescale

You can easily switch to required timescale in Gantt Chart Web Part. Click “Timescale” and select required scale

view for the chart. The following options are available: “Days”, “Weeks”, “Months” and “Year”.

23

Copyright © 2017 All rights reserved. www.virtosoftware.com

Resources

Users assigned to a task are displayed near corresponding tasks in the chart, if this column added to

data source view (see Web Part settings to adjust).

Users will be taken from SharePoint list. To assign a new user, just double click task and select required

user. The same changes will be done in SharePoint list.

Percent Complete

The percent complete is displayed as different color area of the task body.

Percent complete can be changed by drag & drop percent complete icon.

24

Copyright © 2017 All rights reserved. www.virtosoftware.com

25

Copyright © 2017 All rights reserved. www.virtosoftware.com

Version Release History

Release

Date Version Description

06/26/2017 4.6.0 [+] Option for export to PDF has been added. [+] Gantt is automatically scrolled to today after initial loading.

04/11/2017 4.5.4 [-] Bug in updating events on different site collection is fixed.

09/06/2016 4.5.3 [+] Option for displaying summary tasks collapsed has been added.

09/01/2016 4.5.2 [*] Unnecessary option for gantt width has been removed. [-] Issue with option for gantt height has been fixed.

07/06/2016 4.5.1 First public release for SharePoint 2016 [-] Bug in loading events using SharePoint list view has been fixed.

12/28/2015 4.5.0 [+] Auto schedule option has been added to gantt options. [+] Button "Scroll to Today" has been added. [*] Internal logic of working with tasks has been changed. [*] Some unnecessary (because of new logic) options have been removed.

09/15/2015 4.3.0 [+] Dynamic data filtering has been added.

07/13/2015 4.1.0 [+] Option for adding custom CAML filter to data source has been added.

06/25/2015 4.0.5 [-] Bug with missing Gantt in some cases after publishing page has been fixed.

06/24/2015 4.0.4 [-] Java-script error when list view is selected has been fixed.

06/19/2015 4.0.3 [-] Bug with failed update of task percent complete field when the field is not specified in data source settings has been fixed.

06/16/2015 4.0.2 [+] Support for working with external lists has been added.

12/05/2015 4.0.1 [-] Bug with missing configuration links on web part page has been fixed.

09/10/2013 3.0.0 Added new license manager.

06/13/2012 2.0.0 Added abilities to move (reorder) tasks. Go to Web Part settings and activate Moving Task feature. Added Show the Outline Number (WBS) web part property. Allows showing the Outline Number (WBS) next to the task name. Added WBS virtual column. Added "Fit Start Date, End Date in N Minutes" web-part property. Added "Real Time Synchronization" web-part property in Gantt settings section. Allows configuring real time data synchronization between multiple people working on the tasks. Added "change case" functionality for TextBox, like word has with Shift+F3. Switching between Upper -> lower -> Title Case. Added "Summary Task Background Row Color" property in Gantt settings section. Added "Summary Task Foreground Row Color" property in Gantt settings section. Updated "SharePoint's New Task Form" can create Summary Folder and Sub-Tasks. Fixed if I change the start date, the duration is changed. Fixed lookup column to date-time column source. Fixed allow the user to set the end date of the task before the start date.

26

Copyright © 2017 All rights reserved. www.virtosoftware.com

Fixed Group name is empty if task title was not added to grid. Fixed Create new task in parent task from context menu. Fixed connecting multiple filters with Gantt View Web Part. Fixed problem with Click and drag Finish to Start feature in the Gantt Chart if browser zoom level is not equal 100%.

12/26/2011 1.9.0 Added Czech localization. Added "Gantt Chart View Width" web part property. Allows setting width of Gantt Chart horizontally scrollable view. Default value: 2000. Min value: 1024. Max value: 5120. Added "Paging Mode" web part property. Allows configure page size when you clicking the previous or next page button. Added Support scroll with the mouse wheel in Gantt Chart, which is equivalent to pressing an arrow key or to clicking the arrow button on a scrollbar. Improved performance. Fixed "Sometimes, Gantt UI is frozen after making a relation between tasks" problem. Fixed "[IsolatedStorage_StoreNotOpen]" exception.

11/23/2011 1.7.0 Added Navigation panel. Added Duration virtual column. Support "Average Rating" field type. Modified Filter panel. Fixed task title disappear if print. Fixed ArgumentOutOfRange exception if start and end date is empty. Fixed New Task button is disabled.

10/25/2011 1.6.0 Added Save splitter position into Silverlight Application storage. Added "Show horizontal lines" web part property. Shows horizontal lines in Gantt chart. Default value is false. Added "Default Task Duration" web part property. Sets default task duration for new task. Default value is 72 hours. Updated Virto New Task Form. Updated control UI. Updated Virto New Task Form. Added a required field validator. Updated Virto New Task Form. Virto New Task Form is resizable.

08/30/2011 v. 1.5.0 Added Task color coding settings. Added Task color coding legend. Fixed minor bugs.

06/03/2011 v. 1.3.0 Support Summary Task as Parent Folder. (For SharePoint 2010) Added Create a new task Modes: Create task automatically, Show Virto's New Task Form, Show SharePoint's New Task Form and Disable. Added "Default Values for New Task" web part property. You can set default property values for new task. Use FieldName=FieldValue format. Added "Multiple lines of text" inline editor. Added Scroll To Task Modes: Middle of the View, Begin of the View. Support "Virto Cross Site and Cascaded Look up" field type. Support "Dependent Lookup" field type. Updated Gantt Resources. Support all column types. Fixed Default view doesn't work correctly. Fixed Task sorting if SharePoint Filter Provider is set. Fixed Empty Gantt View for Arabic localization.

27

Copyright © 2017 All rights reserved. www.virtosoftware.com

Fixed minor bugs.

04/12/2011 v. 1.2.3 Added "Calculate summary task progress automatically" web-part property. Specifies whether the parent/summary task progress will be calculated automatically based on the child tasks.

04/11/2011 v. 1.2.2 Updated find and filter engine. Improve performance. Updated "Percent Complete Column" for parent task is auto-calculated. Fixed find child task if Parent column was set.

03/23/2011 v. 1.2.0 Added connect to external SharePoint Filter Providers. Use to consume a filter expression from a Web Part that has implemented an IFilterProvider interface. Added "Find and Filter Bar". Added support custom filter expressions. Added "Show Find And Filter Bar" web part property. Added "Show Attachments Icon" web part property. Added "First Day of Week" web part property. Added "First Week of Year" web part property. Added "Show Week Numbers in Weeks Timescale" web part property. Added grid column with preview for "Multiple Text" field type. Added remember current filter in Silverlight Application Storage. Added remember Find and Filter Bar position in Silverlight Application Storage.

12/27/2010 v. 1.1.0 Added Support list view. Added "Allow change view" property. User could change view from client control. Added "Stop Expand Level" property. 0 - expand all. 1 .. N - don't expand task from this level Added Load Date or Date-Time field format from list settings. Added "Edit item" context menu. Opens task edit page. Added Save current view in Silverlight Application Storage. More info http://www.microsoft.com/getsilverlight/resources/documentation/AppStorage.aspx Added Remember the expand/collapse state in Silverlight Application Storage. Added Support group by field. Added Full-Screen Mode. Added "Action/Outline" menu. Added Support "Hyperlink and Image" field. Updated Use "Del" button to clear Date-Time value in data grid.

10/15/2010 v. 1.0.0 First public release.