This is a Beta Release feature. Configuration and functionality may be modified before formal release.
The Gantt Chart section provides a dynamic Gantt chart that allows configurability beyond that provided by the Gantt visualization toggle available with Shibumi lists and views.
The display of the Gantt Chart is configurable when the section is added to a template tab, dashboard, or presentation. With the Gantt, in addition to visually depicting the milestones and durations of tasks, you can adjust item dates or percentage complete values directly from the Gantt chart.
Note: The Gantt section is available and fully supported but the Workplan Gantt has a richer set of functionality. Future enhancements will be applied to the Workplan Gantt and are not guaranteed to be applied to this Gantt section.
To include a Gantt Chart section in your solution:
- On a template tab, dashboard or presentation, from Design mode, click Add Section.
- Select the Category of the Gantt Chart section (this is configurable but is typically: Visualizations).
- Click on the Gantt Chart option to add it to the layout.
- Click on the Settings gear in the top right corner of the section to open the Settings dialog.
- Modify the settings to define the behavior of the Gantt Chart.
Section
This section defines the title for the Gantt Chart and also allows you to specify a Filter section that will be applied to the Gantt content.
- Title: A section title is optional. If there is no title, the Gantt Chart contents will fill the full section real estate. Toggle between a text value or an expression resulting in the title by clicking on the text/expression icon at the right of the field.
- Filter Id. This setting is optional. If a Filter section is included on the same managed layout (i.e., tab, dashboard, or presentation), the Workplan Gantt Chart can reference the Filter section. Any values entered on the filter section can be applied to the Gantt content.
- Note: if you include a Filter section, all filter fields from the Filter section must be mapped as filters for the Gantt. I.e., if you map only a subset of the Filter section fields, the Gantt will not react to the Filter section values.
Datasources
This section defines the data to be included on the Gantt Chart. Click the Add Datasource button to define the data to be retrieved into the Gantt Chart.
Note: By default, one Datasource is included to provide an example of the values needed for each setting. You can either delete the default Datasource or replace the values for each setting.
- Context: Defines the scope of content to be included on the Gantt.
| This <work item> | Descendants of the current work item will be retrieved into the chart. |
| From An Ancestor | Allows for selection of an ancestor template. Descendants of the ancestor work item will be retrieved into the chart.
Note: this option will not be available if there are no ancestors for the current template. |
| From Another App | Allows for reference to an explicit work item. Descendants of the identified work item will be retrieved into the chart. |
- Root Template: When a “From Another App” app name is selected as the Context, the content of the Gantt chart is scoped to descendants of a specific work item instance. The Root Template allows you to select the template of the work item instance.
- ID: When a “From Another App” app name is selected as the Context, the content of the Gantt chart is scoped to descendants of a specific work item instance. The ID allows you to specify the Shibumi-generated ID number for the specific work item.
- Type: Defines the descendent template or backreference association whose instances will populate the Gantt chart.
Default Filters
Defines filters that are applied to the retrieval of data for the chart. I.e., this filter is included in the database query to apply an initial filter to the retrieved content.
- Type: Defines the data type of the attribute which will be used for the filter logic. The selection made in the Type setting determines the options available in the Filter API Name field and determines which other settings are available.
- Filter API Name: The attribute whose value will be compared to the filter logic.
- Type = Text
- Default Filter Value: The value that must be matched to retrieve a record. Toggle between a text value or an expression resulting in the filter value by clicking on the text/expression icon at the right of the field.
- Type = SingleSelect
- Default Selection: The value that must be matched to retrieve a record.
- Type = MultiSelect
- Click the plus button to add filter fields. The filter criteria defined for a MultiSelect are applied as an “or” filter. Returned records must match at least one of the criteria but do not need to match all of the criteria.
- Option Value: The value that must be matched to retrieve a record.
- Type = Date
- Start Range Date: Toggle between a date value or an expression resulting in the date filter value by clicking on the text/expression icon at the right of the field. Returned work items must have a date value later than the value in this field. Note: a filter value must be entered into the End Date Range setting in order to define the date range.
- End Range Date: Toggle between a date value or an expression resulting in the date filter value by clicking on the text/expression icon at the right of the field. Returned work items must have a date value earlier than the value in this field. Note: a filter value must be entered into the Start Date Range setting in order to define the date range.
- Notes
- For Text, SingleSelect, and MultiSelect, when comparing against a name/value picklist attribute, the default comparison will be against the name.
- For SingleSelect and MultiSelect, do not include quotation marks around your entered text.
- Add Default Filter button: Click this button to add additional default filters. All defined default filters must be satisfied to retrieve a record.
Filter Mappings
If a Filter ID was specified on the Section page, the Filter Mappings section enables you to map the filter variables from the Filter section to the attributes that they should be applied to. I.e., define the attributes that will react to user-entered filter values.
Note: All filter fields included on the Filter section must be mapped on the Gantt settings.
If a Filter ID was not specified on the Section page (i.e., if it was left blank), the Filter Mappings section enables you to map the page-level filter variables to the attributes that they should be applied to. I.e., define the attributes that will react to the page-level filter values.
Whether from a Filter section or from page-level filters, the filter settings are:
- Filter Variable Name: Identifies the page-level filter variable that the attribute will react to.
- Mapping API Name: Defines the attribute that will be used to filter the content returned to the Gantt.
- Add Filter Mapping button: Click this button to add additional filters.
Item
Defines the display settings for the task (bar) or milestone (diamond) included on the Gantt chart.
- Title: Provides a picklist of attributes that allow you to define the attribute that will be displayed as a label for the bar/diamond.
- Optional Color: Provides a picklist of attributes that allow you to define the color that should be displayed for the Gantt bar/diamond. The selected attribute should resolve to a Hex code for a color (e.g., #000000 for black). If this setting is left empty, Shibumi will group using a black bar and will display all bars and diamonds blue.
- Note: a recommended implementation would define a calculated attribute that resolves to a hex code based on details of the work item (e.g., if the Urgency of a milestone is “High” the milestone bar color is red, hex code #ff0000, else the milestone bar color is blue, hex code #0000ff).
- Start Date: A picklist of date attributes. The selection in this setting determines the Start Date for the bar or diamond.
- Note: selecting the OOTB startDate, dueDate, and finishDate attributes in the Start and End Date settings will not work. The values in these settings must be custom attributes.
- End Date: A picklist of date attributes. The selection in this setting determines the End Date for the bar or diamond. If this setting is empty, the Gantt object will default to milestone and will be displayed as a diamond.
- Duration: A picklist of numeric attributes. The selection in this setting indicates the duration (in days) between the Start and End dates.
- Note: a recommended implementation would define a calculated attribute that determines the duration between the Start and End dates included on the Gantt.
Grouping
- Group By: Identifies grouping levels for the content in the Gantt chart.
- Notes: The attributes available on this picklist are all attributes of the template defined as the Descendent API. If you want to group your content by an ancestor template value, you must set up a calculated attribute on the Descendent API template that is populated by the ancestor value.
- Group By Type: Defines whether the attribute being used for grouping is a Text or Date attribute.
- Group By Format: This setting is only used when the Group By Type is DATE and defines the date format (e.g., yyyy-MM-dd would resolve to 2022-06-15 for June 15, 2022) for the group value.
- Note: For additional help defining date formats, reference the patterns described for the formatDate function.
- Optional Color: Hex color code to use for the bar representing the group on the chart. Toggle between a text value or an expression resulting in the title by clicking on the text/expression icon at the right of the field.
- Add Group By button: Click this button to add group levels.
- Note: At least one Group level is required.
- Add Datasource button: Click this button to add an additional datasource. If multiple datasources are included, the content will be ordered by datasource within the Gantt chart.
Table Columns
This section defines the columns displayed to the left of the Gantt chart.
- Column Header: Text displayed in the header for the column.
- Column API Name: Attribute API name of the attribute value to be displayed in the column
- Note: Entering “text” in the API name column retrieves the work item name attribute and makes it a hyperlink. Entering “name” in the API name column retrieves the work item name attribute without making it a hyperlink.
- Width: Determines the static column width (pixels)
- Alignment: Determines whether the value should be left, right or center aligned.
- Add Column button: Click the Add Column button to add additional columns
- Notes:
- The Workplan Gantt section can only retrieve values from the template specified on the Datasources tab (Type setting).
- Date columns will be displayed in ISO date formats.
- The recommended minimum width for the left-most column is 250.
- Columns must be added in the desired left to right order. Once added, they cannot be dynamically re-ordered. To re-order, the columns must be deleted (trash icon) and re-added.
Markers
This section allows you to define date markers that will be displayed as vertical lines on the Gantt chart.
- Name: Determines the label displayed on the marker. Toggle between a text value or an expression resulting in the Name by clicking on the text/expression icon at the right of the field.
- Date: Determines the date on which the vertical marker will be displayed. Toggle between a date value or an expression resulting in the Date by clicking on the text/expression icon at the right of the field.
- Color: Enter the hex color code that to define the color of the vertical marker.
6. Save the settings.
Note: There is no validation within the fields that accept expressions. If the expression is not entered correctly, the section will display an error on the instance, dashboard or presentation.
If the section is being configured on a template, publish and create an instance to view the customized Workplan Gantt Chart. If it’s being configured on a dashboard or presentation, click Stop Editing to view the rendered section.
Prerequisite
The Workplan Gantt section must be registered in the App.