Installation

The widgets are standard polarion extensions,  you need to follow a standard Polarion procedure to install the extensions.


PREREQUISITE. Download the distribution  from https://gantt.nextedy.com/download/ and unpack it. (You will find the installation instructions there as well).


  1. Unpack / Unzip the downloaded work_items_gantt.zip

  2. Copy `com.nextedy.polarion.gantt` folder into `POLARION_INSTALL_LOCATION/polarion/extension` folder.

  3. If you already have production license, please copy the `gantt_lic.json` file to `[POLARION_INSTALL]/polarion/license`

  4. Delete `[POLARION_INSTALL]/data/workspace/.config`
    Make sure you perform this step also when updating the Nextedy plugins. .config does not hold any other data that caches about the installed plugins, it does NOT make polarion slower in any way as well. This step is actually recommended by Polarion support.

  5. Restart Polarion server


Setup  Gantt View

There are two Live-Report widgets available


Setup Work Items Gantt

Check following screenshot and "Work Items Gantt" in "Work Items" category. Gantt


All the configuration options are described on Gantt Widget Parameters page.


Full-page Report Gantt

The most common approach to show Work Items Gantt is to create a single LiveReport page, call it for example Gantt, and put the Work Items Gantt Widget as single widget there.


In this case, we recommend to activate the following widget property:

  • Advanced > Maximize - set the Maximize property of the widget to 'yes'


This will make the widget size equal to working area size. Please make sure there are no additional empty paragraphs or other whitespace content around the widget.

Gantt Maximize Widget Property

Sometimes it is more useful to embed the Gantt widget to an existing report, together with other reporting widgets. In such case make sure that Maximize property is turned off.


WarningCurrently, it is possible to have only one Work Item Gantt widget on a page. Please do not add more of them on a single page.


Data Mapping

Once you have the widget on your page, you need to configure where to store scheduling information. The Gantt model is storing the following data:

  • Start Date (Date)
  • End Date (Date)
  • Duration (Number of days)
  • Progress (Float from 0 .. 1)

You should select a combination of : Start Field & Duration Field , End Field & Duration Field, or Start Field & End Field"

You can configure the mapping using the Data Mapping Widget parameters:

  • Start Field - the name of the custom field, that stores the information when the work item starts.
    The type of the custom field can be any of these: Date, Date-Time or String.
    If such custom field does not exist, the value will be stored in String ad-hoc custom field. For production use, we recommend using a Date (Only) custom field.
  • End Field - the name of the custom field, that stores the information when the work item ends.
    The type of the custom field can be any of these: Date, Date-Time or String.
    If such custom field does not exist, the value will be stored in String ad-hoc custom field. For production use, we recommend using a Date (Only) custom field.
  • Duration Field - the name of the custom field, that stores the information about the work item duration as the number of days.
    The type of the custom field can be any of these: Integer or String.
    If such custom field does not exist, the value will be stored in String ad-hoc custom field. For production use, we recommend using an Integer custom field.
  • Progress Field - the name of the custom field, that stores the progress of the work item progress as Float (multiply by 100 to get % of completion).
    The type of the custom field can be any of these: Float or String.
    If such custom field does not exist, the value will be stored in String ad-hoc custom field. For production use, we recommend using a Float custom field.

Hierarchy

The hierarchy of items on the Gantt chart is derived from work item links. This is controlled by Parent Role widget parameter:

  • Parent Role - select what Work Item link roles should be used to detect the parent-child relationships. If empty, no hierarchy is shown.

Dependencies

The dependency links are also derived from the work item links. This is controlled by Dependency Role widget parameter:

  • Dependency Role - select what Work Item link roles should be used to detect Depends-on relationships. If empty, no dependencies will be shown.
    If you select multiple link roles, the first role is used when creating new links.

If you do not want to let the user create dependency links, put following property to Advanced > Gantt Config Script parameter:

    gantt.config.drag_links = false;

Time Range

By default the Gantt chart shows the time range as small as to fit the items.


If you want to set the start and end date manually, for example to allow the dragging of the items to future, set following properties in Advanced > Gantt Config Script (both need to be set).


gantt.config.start_date = new Date(2018, 12, 10);
gantt.config.end_date = new Date(2020, 08, 20);

More

There are more configuration options available, see Work Items Gantt Widget Parameters page for the full list.