- Created by Yves YANG, last modified on Mar 21, 2016
1. Overview
In JIRA server, one project may contain a lot of issues over time. Loading all issues of a given projects
presents several problems:
- Performance
- Readability
- Memory limitation
- etc..
Therefore, JIRA Gantt-chart Project is designed to provide a set of tools to minimize the issues to load such as Timespan and display resolution, powerful filters, and cache board management.
1.1. Board Management
A Board (known as Context in previous version JIRA 5.x and JIRA 6.x) keeps all configuration information about Gantt-chart. It consists of :
- Filters
- Timespan
- Display mode
- Columns
- Sorting
- Group By
When you start the gantt-chart for the first time, a default board is used; its configuration is preset as following:
Name | Description | Value |
---|---|---|
Loading Scope | Used to find the initial issues. | -4w to +4w |
Filter - Projects | Criterion is used for the issue loading. | For Time Plan, it is the current Project. For Project Portfolio, it is None. |
Filter - Assignee |
| For Time Plan and Project Portfolio, it is Current User. |
Filter - Issue Type |
| All |
Filter - Components |
| All |
Filter - Versions |
| All |
Filter - Status |
| All status except Resolved and Closed |
Filter - Labels |
| All |
Filter - Indications |
| All |
Timespan |
| Month Timespan |
Compare Mode |
| false |
Read-Only |
| false |
Outline |
| Outline by GroupBy |
Sorting | Use to set the sorting mode: Disable, Column-value and Manual Sorting | Disable |
Sorting data | Sorting data when the sorting is enabled. |
|
Group By |
| Version |
Spreadsheet - Hidden Column |
| none |
Spreadsheet - Column Width |
| none |
Spreadsheet - Column Display order |
| none |
Sorting enabled |
| false |
Sorting setting |
| Property: Name |
Gantt-chart display mode |
| Spreadsheet and Gantt-chart |
SpreadSheet width | The width spreadsheet is managed to display all columns by default. User can fix it by Drag and Drop the Splitter. The value and state can be changed via the Board Setting Panel. | Auto |
Date format |
| If the global data format is set to "Automatic", the Date format corresponding to the current language will be used: English: d/m/Y (ex: 23/11/2001) |
Open Link |
| In Dialog |
Maximum Issues to load | The maximum Issues to load in a gantt-chart to prevent the overloading | 100 |
Scroll current Date at refresh | Automatically scroll to the current date when the gantt-chart gets refreshed | false |
Scroll current Date at opening | Automatically scroll to the current date when the gantt-chart gets started | false |
Setting mode | This mode is used to change the configuration parameters of gantt-chart. In this mode, no issues will be loaded. | false |
Enable Auto refresh | Automatically synchronize the gantt-chart with JIRA server. | false |
Refresh interval | If the "Enable Auto refresh" is enabled, this parameter determines the interval of each refresh. | 5 minutes |
Progress Scope | This option deals with the computing of progress state for tracking. There are two methods: "Loading Scope" and "Server Scope". The "Loading Scope" calculates the progress based on the sum of Spent time over the sum of Origial Estimation of all loaded issues. The "Server Scope" uses the same method of JIRA Agile to calculate the progress on number of issues: Resolved issues / total issues | Loading Scope |
At any moment, you can save the current board using the menu entry "Copy as", A prompt dialog will request a name for this board. The new board will be saved in the local storage of Web Browser.
Once a named board gets copied, it is displayed in the top part of the Board menu.
You can also go back to default setting by the menu "Reset".
1.1.1. JIRA Named Filter as Board input
It is also possible to use a JIRA named Issue Filter to load the issue. You should use the JIRA tools to create a Named Filter:
If there is a named filter, the menu entry "Named Fllter" will be enabled. When you click on it, a dialog will be displayed:
You can find detail information about "Issue Filter" in JIRA User's Guide.
When you save the selection, a board will be created with the name of "Named Filter". The board button is displayed as NF - <Named Filter>.
Board is hold by the Web browser locally. One user can use the same board only on the machine with the same web browser.
In Gantt-Chart Project, the following kinds of Gantt-chart are available:
Gantt-chart | Purpose | Projects | Storage |
---|---|---|---|
Time Plan | Plan | Current Project | Per user |
Progress Tracking | Tracking | Current Project | Per user |
Reporter Tracking | Tracking | Current Project | Per user |
Resource Plan | Plan | Multiple Projects | Per user |
Project PortFolio | Plan | Multiple Projects | Per user |
Resource Tracking | Tracking | Multiple Projects | Per user |
PortFolio Tracking | Tracking | Multiple Projects | Per user |
Reporter Tracking | Tracking | Multiple Projects | Per user |
Gadget - Assignee to Me in Gantt-chart | Tracking | Multiple Projects | Per Gadget |
Gadget - PortFolio Tracking | Tracking | Multiple Projects | Per Gadget |
The configuration of each gantt-chart, known as Board, is independent. Each Gantt-chart except Gadgets has its own storage repository per user. The same Gantt-chart has a different configuration for each user.
But it is different for Gadget. Each Gadget has its own storage repository independent of the user. Precisely, it is possible to create any number of gadgets of same type as you want. But each gadget instance has its own Board. They are independent of users and the type of gadget. In other words, the board of a gadget is shared between users. Only the user with the administration rights can modify the board.
1.1.2. Board Storage
The board data is managed in two levels: JIRA server and Web browser. The private boards are stored in the local storage of Web browser, and the shared boards are managed by the server. At the first access of each gantt-chart, a default board will be used, and this board is kept only in the local storage of Web browser. You should keep in mind that when you change Web browser, you change the local storage as well.
1.1.3. Shared boards
In general, a board is managed per user and per kind of gantt chart and stored in the local stoarge of Web Browser. It is possible to share a board between users. The shared boards are always stored in JIRA server. A shared board should be created by system administrators using the "Shared Boards" panel provided by this plugin. There are two possibilities to acces this panel:
- "Shared Boards" menu under the "Gantt Chart" main menu
- The Add-on administration pane lof JIRA
Select the "Add-on" of JIRA
And then select the "Shared Data" entry under "GANTT CHART PROJECT FOR JIRA"
- "Shared Boards" menu under the "Gantt Chart" main menu
On this panel, you can create a shared board per kind of gantt chart:
Once it is created, you can grant the access for users or groups of user. For each group or user, you can indicate the read-only or modification. By default, it is read-only.
From users' perspective, the shared board is accessible via the pop down menu of board sama as JIRA Filter board:
1.2. Timespan configuration
JIRA Gantt-chart project presumes all important issues are around to the current time.The time period is used to load the issue, named as Timespan. By default, it will load all issues scheduled 4 weeks before and after the current time, including the non-scheduled issues. You can change these default value using the Board Setting Panel.
A configuration of chart display consists of the following information:
Name | Description |
---|---|
Scope | The time period |
Header | Indication about time unit |
Shift Unit | The time duration is used to move the display region of gantt chart to left or to right. |
Resolution | It is Snap time unit in Gantt-Chart, which is used to calculate the size and time during the Drag and Drop for moving and resizing respectively. |
The time display configuration is named as Timespan in short.
5 Timespans are provided and accessible via the Tool Bar of Gantt Chart.
Here are the definition of each Timespan:
| Name | Display Time Scope | Header | Shift Unit | Resolution |
---|---|---|---|---|---|
Day Timespan | 1 day | Day | 1 day | 15 minutes | |
Week Timespan | 1 Week | Week | 1 day | 1 hour | |
Month Timespan | 1 Month | Month | 5 Weeks | 1 day | |
Quarter Timespan | 3 Months | Month | 5 Weeks | 1 day | |
Semester Timespan | 6 Months | Year | 3 Months | 1 day | |
Year Timespan | 1 year | Year | 3 Months | 1 day | |
Full Timespan | Dynamic | Dynamic | Dynamic | Dynamic |
Once the Gantt-Chart is displayed, you can change the timespan using directly these tools or zoom tools.
Full timespan is special timespan, it loads the issues without the limitation of time scope. Display time scope, Header, Shift unit and Resolution depend on the time scope of loaded issues.
1.3. Filter or Data Input
Our plugin provides a powerful filter solution that allows you to find the issues easily. All filter settings are kept automatically in the current Board of User. Some filters have an additional rule on the query of issues, named Data Input. The reset of board has no effect on Data Input.
1.3.1. Projects
This filter is available if a gantt-chart contains issues from multiple projects. The availability and rule of this option is listed in the following table:
Gantt-chart | Rule | Default Value | Description |
---|---|---|---|
Time Plan Progress Tracking Reporter Tracking Sprint Plan | Data Input | Current Project | By default, it is mono project. Therefore, this option is hidden in general. |
Resource Plan Resource Tracking | Filter | All | Available |
Project Portfolio Portfolio Tracking | Data input | None | Available. |
1.3.2. Assignee
This filter is available in all gantt-charts. The rule of this option is listed in the following table:
Gantt-chart | Rule | Default Value | Description |
---|---|---|---|
Time Plan ProgressTracking Reporter Tracking | Filter | Current User |
|
Resource Plan Resource Tracking | Data input | None | This gantt-chart uses this information to find issues from JIRA Server. |
Project Portfolio Project Tracking Sprint Plan | Filter | All |
|
1.3.3. Issue Type
This filter is available in all gantt-charts. The rule of this option is listed in the following table:
Gantt-chart | Rule | Description |
---|---|---|
Time Plan Progress Tracking Reporter Tracking Sprint Plan | Filter | The default value is All. |
Resource Plan Resource Tracking | Filter | The default value is All. |
Project Portfolio project Tracking | Filter | The default value is All. |
It is used to filter or display issues by the type.
1.3.4. Component
This filter is available in Time Plan if it is mono-project. Otherwise, it is hidden. It is used to filter or display the issues by Component. The default value is All.
1.3.5. Version
This filter is available in Time Plan if it is mono-project. Otherwise, it is hidden.The default value is All, and the option "Show released versions" is unchecked. It is used to filter or display issues by Version.
1.3.6. Status
This filter is available in all gantt-charts.
1.3.6.1. The version 3.4.41 for JIRA 6.x and 2.4.41 for JIRA 5.x
A special option"Show Fixed Tasks" is available. It gets replaced a "Resolution" filters since then. It divides the issues in two categories: unresolved and resolved.
This option relies the filtering on the field "Resolution". It is a generic solution to identify the resolution state of issue regardless the status. By default, a resolved issue includes the status "Resolved" and "Closed". It is possible to custom the workflow and define some custom status.
In general, the resolved issues are not the most important for plan and tracking. The default setting filters them out. By default, the standard "Resolved" and "Closed" are hidden.And all other status are turn "on" and the option "Show Fixed Tasks" is off. To show the "Resolved" and "Closed" issues, you need to turn on the "Show Fixed Tasks".
1.3.6.2. The new version 3.5.0 +
A special option "Show Fixed Tasks" gets replaced by the "Resolution" filters. The default of this filter is "All".
1.3.7. Resolution
This filter is available in all gantt-charts since the version 3.5.0 for JIRA 6.x and 2.5.0 for JIRA 5.x. It is used to filter issues by the value of field Resolution.
1.3.8. Label
This filter is available in all gantt-charts. The default value is all. It is used to filter issues by the selected labels.
1.3.9. Indications
This filter is available in all gantt-charts. The default value is all. It is used to filter issues by the state of consistency checking..
1.3.10. Search Text
This filter data is not kept in the board. It allows to filter issues by text matching with the value of Name and Key column. All issues whose value of Name and Key matches with the input value will be kept in gantt-chart.
1.4. Columns
The following table summaries the properties of each column.
Column | JIRA Property | Link | Editable | Ordering | Resize | Hide |
---|---|---|---|---|---|---|
Index |
| false | false | false | auto-resize | false |
Indicators |
| false | false | false | true | true |
Name | summary | true | Only for all issues with JIRA Edit Issues permission | true | true | true |
Key | key | false | false | true | true | true |
Priority | priority | false | Only for all issues with JIRA Schedule Issues permission | true | true | true |
Duration | Original Estimate | false | Leaf issue only with Schedule Issues permission | true | true | true |
Created | Created | false | false | true | true | true |
Start | Custom Field Start | false | Leaf issue only with Schedule Issues permission and without working-log | true | true | true |
End | Custom Field End | false | Leaf issue only with JIRA Schedule Issues permission and without working-log | true | true | true |
Parent Key | Key of parent issue | false | false | true | true | true |
Done | Custom Field | false | Leaf issue only with JIRA Work On Issues permission | true | true | true |
Units | Custom Field | false | Leaf issue only with JIRA Edit Issues permission | true | true | true |
Successors | Keys of dependences | false | Only for all issues with JIRA Schedule Issues and Link permission | true | true | true |
Predecessors | Keys of dependences | false | Only for all issues with JIRA Schedule Issues and Link permission | true | true | true |
Assignee | Assignee | false | Leaf issue only with JIRA Assign Issues permission | true | true | true |
Status | Status | false | Leaf issue only with JIRA Resolve Issue permission | true | true | true |
Rank | Custom Field | false | false | true | true | true |
Reporter | Reporter | false | false | true | true | true |
Sprint | Custom Field | false | false | true | true | true |
Labels | Labels | false | false | true | true | true |
Components | Components | false | false | true | true | true |
Versions | Versions | false | false | true | true | true |
Reporter | Reporter | false | false | true | true | true |
Custom column | JIRA field | false | Possible to several types: Date time, Date Picker, Number, and text with JIRA Edit Issues permission | true | true | true |
1.4.1. Width Resizing
The column width can be changed by dragging the right border of the column header:
This change is kept in the current Board.
1.4.2. Column Ordering
The columns can be reordered by dragging the column header at the desired position:
Two arrows indicate the target location. This change is kept in the current Board.
1.4.3. Show/Hide
The column show and hide can be changed using the popup menu of a column header:
This change is kept in the current Board.
1.5. Sorting
The sorting allows users to put issues in sequence order through a value. The sorting is applied both in the Spreadsheet and Gantt-chart. Three modes of sorting are supported:
Sorting Mode | Icon | Description |
---|---|---|
Disable sorting | No sorting at all. All Issues are listed in the order of query from database. | |
Column-Value sorting | Sorting based on column value. | |
Manual sorting | The sorting defined by user. |
The mode can be changed via the tool bar of each gantt-chart:
1.5.1. Disable sorting
In this sorting mode, a default sorting based one dependency is applied; the isolated issues are sorted by issue key.
1.5.2. Column-Value sorting
The sorting with one criterion is supported. A criterion is defined by two elements:
Field | Description |
---|---|
Property | It is the property of associated column |
Direction | Two values possible: Ascending and Descending |
There are two ways to define the sorting criterion. The first way is to simply click on the header of column. The second way is the column menu. An arrow is displayed in the column header at the right of label to indicate the activation of sorting and its direction.
Click again the column header to change the sorting direction. Another solution is to use the popup menu of column header on the right:
1.5.3. Manual sorting
In this mode, the sorting is defined by user. The change of order by DnD or rows are kept between page refreshes or reloading. It is part of the current board.
1.6. Plan/Activity compare
When this option is enabled, the gantt-chart is displayed in baseline mode.
In this baseline mode, the top bar represents the plan and bottom bars display the working logs.
This option is kept in the current board. This option is activated by default for all tacking gantt-charts, and it is disabled for all plan ones.
1.7. Auto-Scroll display
This option provides a facility to scroll a desired issue to display the whole issue in the visible region of gantt-chart. It occurs by a simple click on the row.
This option is kept in the current board. This option is not activated by default.
1.8. Lock
To prevent any change by accident, we provide a lock mode. When it is enabled, the whole gantt-chart and spreadsheet become read-only.
This option is kept in the current board. This option is not activated by default.
1.9. Manual refresh
This button refreshes the entire gantt-chart from server.
This option is kept in the current board. This option is not activated by default.
1.10. Auto-Scheduling
Our plugin supports four types of dependencies. A powerful Auto-scheduling mechanism is provided to schedule automatically some issues through the dependencies and the priority of issues. And the detail description about Auto-scheduling engine can be found on this page Auto Scheduling. This mechanism applies only on the issues in Auto-scheduled state. The detail information about Auto-scheduled state can be found on this page - Auto-Scheduled Issue.
Contrary to Auto-scheduled issue, it is the Manual-scheduled one. A Manual-scheduled issue has a fixed start or end time. The detail information about Manual-scheduled state can be found on this page - Manual-Scheduled Issue. An Auto-scheduled issue can becomes Manual-scheduled when we move it by the mouse dragging or set the start or end time in the tree Spreadsheet. Some boat menus are provided to make the state of the selected issue:
Vice and versa, you can change the Manual-scheduled state to Auto-scheduled state if the selected issue has no working log.
1.11. Group By
"Group By" is another powerful displaying solution; it provides an easy way to group issues by category. There are three kinds of GroupBy:
- Elementary GroupBy
- Non GroupBy
- Custom GroupBy
1.11.1. Elementary GroupBy
This feature by combining Drag and Drop provides a set of powerful and interactive editing capability.
These operations respect the JIRA Permission control.
Category | Description | Drag and Drop | Permission |
---|---|---|---|
Assignee | Group issues by Assignee | Compatible | Assign Issue or Administrator |
Reporter | Group issues by Reporter | NA | NA |
Issue Type | Group issues by Issue Type | Compatible | Edit Issue or Administrator |
Component | Group issues by Components | Compatible | Edit Issue or Administrator |
Version | Group issues by Fix Versions | Compatible | Administrator |
Status | Group issues by Status | Compatible | Assigned User or Administrator |
Resolution | Group issues by Resolution It is available only in the recent versions (3.5.0+) | NA | NA |
Label | Group issues by Label | Compatible | Edit Issue |
1.11.1.1. Resolution GroupBy
The standard nodes of Resolution GroupBy is indicated by following icons:
Resolution | Icon | Availability |
---|---|---|
Fixed | ![]() | JIRA OnPromise and Cloud |
Won't Fix | ![]() | JIRA OnPromise and Cloud |
Cannot Reproduce | ![]() | JIRA OnPromise and Cloud |
Incomplete | ![]() | JIRA OnPromise and Cloud |
Duplicated | ![]() | JIRA OnPromise and Cloud |
Done | ![]() | JIRA Cloud only |
Won't Done | ![]() | JIRA Cloud only |
Others | ![]() | |
Unresolved | ![]() | JIRA OnPromise and Cloud |
1.11.2. None GroupBy
None GroupBy is special GropBy. It is in fact no GroupBy at all. All issues are displayed without GroupBy Node.
1.11.3. Custom GroupBy
Custom GroupBy is a composite of primitive GroupBys to privide a user-define and flexible multiple level GroupBy,
Category | Description | Drag and Drop | Permission |
---|---|---|---|
Custom | It is possible to define mutilple level GroupBys as you want by the combination of the above elementary GroupBy. | Not yet | Edit Issue |
When you select the "Custom" menu, a dialog shows up to enable you to setup a list of Elementary GroupBy by moving the available GroupBys to Selected list.
The List of GroupBy corresponds the level of GroupBy nodes in the hierarchy in Spreadsheet.
1.12. Outline
Outline tasks in Spreadsheet to organize your list of project tasks and make it more readable. These groups of tasks can then be collapsed and expanded making the list of tasks easier to work with. Outline provides a easy way to display them by level.
Menu Item | Description |
---|---|
Outline All | Expands all levels |
Outline level GroupBy | Expands all parent items of GroupBy node and GroupBy nodes its-self. All items under the GroupBy is collapsed and all other levels are hidden. |
Outline level 1 | The level 1 is collapsed and all other levels are hidden. |
Outline level 2 | Expands the level 1. The level 2 is collapsed and all other levels are hidden. |
Outline level 3 | Expands the levels 1 and 2. The level 3 is collapsed and all other levels are hidden. |
Outline level 4 | Expands the levels from 1 to 3. The level 4 is collapsed and all other levels are hidden. |
Outline level 5 | Expands the levels from 1 to 4, The level 5 is collapsed and all other levels are hidden. |
Outline level 6 | Expands to level from 1 to 5, The level 6 is collapsed and all other levels are hidden. |
Outline level 7 | Expands to level from 1 to 6, The level 7 is collapsed and all other levels are hidden. |
Outline level 8 | Expands to level from 1 to 7, The level 8 is collapsed and all other levels are hidden. |
By default, the default value of Outline is "Outline level GroupBy". It can be changed via the popup menu.
The change of Outline will be kept in the current board.
1.13. Timespan display and issue loading
By default, Gantt-chart loads and displays only one period of timespan to minimize the resource consumption and to show directly the most pertinent issues. The period is defined by each timespan configuration.
It is necessary to provide the following tools to change the default period.
Tool | Tip | Description |
---|---|---|
Scroll previous | Scroll backwards the display timespan of Gantt Chart with a period setup by the current timespan configuration.
| |
Scroll next | Scroll forwards the display timespan of Gantt Chart with a period setup by the current timespan configuration. This operation may invoke the loading of issues if it exceeds the loading timespan. | |
Zoom to fit | Display all loaded issues in the display timespan. | |
Free selection zoom | Zoom out freely by drag | |
Zoom out | Zoom out by extending the same timespan before and after of the current timespan. | |
Zoom in | Zoom in |
1.14. Issue Context Menu
The context menu is available both one Spreadsheet view and Gantt-chart view. You just need to right click on an issue:
Each menu is described in the below sessions.
1.14.1. Undo & Redo
They are same as the Undo & Redo buttons in the toolbar to cancel the previous operation or replay the cancel operation respectively.
1.14.2. Open Issue in JIRA View
There is a menu "Open" and a submenu "Open...". The "Open" is the default open option selected by user in the Board Setting. The Submenu "Open..." contains all possible options such as "Open in dialog", "Open in a New Tab" and "Open in a New Window".
These "Open" option opens the selected issue in a JIRA standard browse view.
1.14.3. Edit Issue in JIRA View
Same as "Open Issue", there is a menu "Edit" and a submenu "Edit...". The "Edit" is the default editing option selected by user in the Board Setting. The Submenu "Edit..." contains all possible options such as "Edit in dialog", "Edit in a New Tab" and "Edit in a New Window".
These "Edit" option opens the selected issue in a JIRA standard editing view.
1.14.4. Issue Creation
Right click on an element in Spreadsheet, if you have the permission, you can find an entry "Add Issue".
This menu opens a dialog for the issue creation:
The selected element will be used to fill the Issue creation field. In the above example, the selected element is a version 1.0.1, which is taken in the field Versions for the new issue.
In the same way, we can create a Version, Milestone and Successor of Dependency.
1.14.5. Version Creation
In the same way as Issue Creation, if you have the project administration permission, this menu is enabled to create a version.
1.14.6. Milestone Creation
In the same way as Issue Creation, if you have the project administration permission, this menu is enabled to create a Milestone.
1.14.7. Issue Creation with Dependency
This menu is a derived menu of "Issue Creation" above. It will create an issue via a dependency with the selected issue.
1.14.8. Copy & Paste
You can copy one or more select issues in Clipboard, and then paste in a project to clone the issues.
1.14.9. Issue Deletion
The deletion is possible using the context menu. Here are the steps to delete an issue.
- Click on a task using mouse.
- Right click to open the context popup menu.
- Select the Delete menu.
- Confirm to the coming dialog.
The deletion operation deletes all direct or indirect children.
It is possible to select the multiple issues and delete them in one shot. The multiple selection can be done by keeping the Shift or Control key down during the selection with mouse...
1.14.10. Indent/Outdent
Once you start creating your own project plans, you can create a structure of summary issue and sub tasks by using indenting and outdenting context menu.
Generally you should create all tasks with the structure organization of summary tasks and sub tasks relatively early in the project creation process before creating links between tasks. This way, you can happily add, delete or change task order until you are happy with all planned tasks without affecting any task relationships. The context menu "Indent" and "Outdent" are used to change the parent ship.
An alternative solution is the drag and drop.
The Indent and Outdent can be used only on issues. They are disabled for the groupby nodes such as version, component, user, project, status, labels etc.
1.14.10.1. Indent issues
If you create additional tasks at the end of a list of tasks, and the tasks above are indented, then the additional tasks will be indented to the same level. If this is not what you want, you could select some tasks under the same parent, then call the context menu "indent" to change them as child of the task above.
If you indent a summary issue, then the issue will move one level to the right and all its subtasks will all move one level, maintaining the same summary issue and subtask structure.
1.14.10.2. Outdent issues
The "Outdent" is the opposite operation of the "Indent". If you outdent a summary issue, then the issue will move one level to the left and all its sub-tasks will all move one level, maintaining the same summary issue and subtask structure.
1.14.11. Tools
From the scheduling point of view, an issue may have several state: Manual Scheduled, Auto-Scheduled, FreeTime and Working time. You can use these menus to change the state of selected issues `
Menu | Availability | Description |
---|---|---|
FreeTime issue | When the issue(s) is(are) in Working-time. | Remove the constraint of the working schedule |
Working time issue | When the issue(s) is(are) in FreeTime. | Set the constraint of the working schedule |
Manual Scheduling | When the issue(s) is(are) auto-scheduling. | Convert to Manual Scheduling by setting the current Start or End date in the issue. |
Auto scheduling | When the issue(s) is(are) in manual-scheduling issue. Of course, none of the selected issue hasn't a working log. | Convert to Auto Scheduling by remove the current Start or End time in the issue. |
Reschedule Issues | If the selected issues are Manual Scheduling. Of course, none of the selected issue hasn't a working log. | For the Auto scheduling on the selected issues. |
Link | If the selected elements are issues. | Link the selected issues with Finish-Start dependency. |
Unlink | If the selected elements are issues. | Unlink the selected issues by removing all dependencies between them. |
1.15. Spreadsheet Editing
1.15.1. Cell Editing
Some leaf cells in Spreadsheet are modifiable such as Start Date, End Date, Duration, Units, Priority, Assignee, etc. A complete list can be found in the "Columns" paragraph above. To edit the value, double click on the cell.
1.15.2. Issue creation
There are two ways to create a new issue:
- Using the context menu (see the "Issue Creation" in the session "Issue Context Menu")
- Chain Creation
The Issue creation operation requires the "Create Issue" permission. Otherwise, this operation is disabled.
1.15.2.1. Chain Creation
Another solution is more easy to create issues in chain. There are two ways to enter in the chain creation mode:
- By double click on the empty space of Spreadsheet on the bottom.
- Type Return key when the focus is in the Spreadsheet.
A new issue is created temporarily and a cell editor opens.
When you valid the input data by typing the key Return, a JIRA Issue will be created. The creation of an issue will chain to a new one automatically. However, if you leave the field empty or type the key Escape, the current creation operation will be cancelled.
The issue is initialized following the precedence from left to right:
Field | Filter | Parent Value | Default Value |
---|---|---|---|
Assignee | The first assignee except All | In Assignee GroupBy | The current user |
Type | The first issue type except All | In Type GroupBy | Default Issue type or Default Sub Task |
Version | The first version except All | In Version GroupBy | None |
Component | The first component except All | In Component GroupBy | None |
Hence, it'd better to set these values before entering into the chain creation mode.
1.15.3. Drag and Drop
By dragging one or more issues in the index column, you can move them to change the project, version, assignee, version, status, etc. It depend the current GroupBy. This is a very powerful and fastest solution to modify a set of issues by one operation.
1.15.4. Dependency editing
Two columns about dependency can be edited directly: Predecessors and Successors. You just need to input the index numbers of depended issues. In case there are several depended issues, the indexes should be separated by the character COMMA ','.
It is possible that a depended issue has not an index; it is the case when the issue is not yet loaded in gantt-chart. Or it is loaded, but it is not yet displayed under its parent issue, version, or project. In this case, the issue key is displayed in the dependency fields. When you modify the values, you can provide the indexes or issue-keys.
By default, the dependency type is the FS: Finish to Start. It is possible to indicate the other types of dependency with the following suffixes
Keyword | Description | Examples |
---|---|---|
FF | Finish to finish | 1FF |
SF | Start to finish | 2SF |
SS | Start to start | 5SS |
FS | Finish to start default value. | 5 or 5FS |
If the "Scroll to display automatically" is enabled,
After each modification, the gantt-chart scrolls to first early issues among all relative depended issues.
The Spreadsheet editing supports only Finish-Start dependency.
1.15.5. Working Log
In the Spreadsheet, a shortcut is available to add quickly a working log in the selected issue. This feature is available if you have the WORKING permission.
To access this tool, you need to move over the Done column of an issue. When you click on the button, a JIRA Work log opens in dialog.
1.15.6. Keyboard shortcuts
When the input focus is in the spreadsheet, the following keys are available to perform some most useful operations:
Key | Operation | Description | Permission |
---|---|---|---|
Control+c | Copy | Copy the selected issues in clipboard. | None |
Control+v | Paste | Paste the copied issues in clipboard as children of the selected issue. | Create Issue |
Control+z | Undo | Undo the previous operation. |
|
Control+y | Redo | Redo the previous undone operation. |
|
Control+a |
| Select all | None |
Insert | Create | Create new Issues in chain. | Create Issue |
Control+Tab | Indent | Change the selected issues to be children of the last above issue. | Edit Issue |
Control+Shift+Tab | Outdent | Turn the selected issues as sibling of the their parent. | Edit Issue |
Enter | Edit | Edit the Name field. | Edit Issue |
Delete | Delete | Delete the selected issues. | Delete Issue |
Space |
| Toglle the selection state |
|
Arrow Up |
| Move the selection up |
|
Arrow Down |
| Move the selection down |
|
Arrow Left |
| Expand the node |
|
Arrow Right |
| Collapse the node |
1.16. Gantt-chart Editing
1.16.1. Issue Moving by Drag and Drop
1.16.2. Dependency editing
The Dependency creation in gantt-chart is an interactive solution. You need to link the start or end ball of an issue to another issue using the mouse to drag one ball to another:
To delete a dependency, you need to select a relevant issue, and click on the right button of mouse to call the context menu. You should find a menu "Delete Dependency".
Under this menu, you will find all menu items corresponding to the dependencies. The name of the relevant issue is displayed for each dependency. The type of dependency is decorated by an icon. When you move over the item, the corresponding dependency link gets highlighted.
1.17. Consistence Checking
1.17.1. Rules on Plan
Item | Scope | Description | Kind |
---|---|---|---|
Over Charge | User | Units > 100 per day | Error |
Under estimation | Issue | The scheduled issue has a child of dependent target in auto-scheduling that has a dependency consistency. For example, A -> B in FS and B is auto-scheduling, but B starts before the end of A. The parent of B is under estimated. | Error |
Dependency Scheduling | Issue | A FS B, B can't start before A is finished | Error |
Parent Overdue | Issue | The child should end before the end of parent. | Error |
Current time Overdue | Issue | The child should end before the current time. | Error |
Dependency Loading | Issue | If the issue is auto-scheduling and it has a missing predecessor in the gantt chart, the auto-scheduling will be done without this dependency. | Warning |
Task on Non-Working Day | Issue | An issue is scheduled on non-working days. | Error |
Scheduled in past | Issue | An issue is scheduled to start in past.. | Error |
1.17.2. Rules on Tracking
Item | Scope | Description | Kind |
---|---|---|---|
Log Overdue | Issue | Log end is after the end of task | Error |
Spent Time Overdue | Issue | Total spent time is great than Estimate | Error |
Remaining Time Overdue | Issue | The remaining time is not enough to complete the task in time | Warning |
Delayed | Issue, Version & Project | A Critical task gets delayed. | Warning |
Parent Resolution | Issue | Conatiern is resolved, but not its children. | Error |
1.17.3. Rules on Statistic
(Not yet implemented)
Item | Scope | Description |
---|---|---|
Under estimation | Issue Version | Spent < Original Estimated * tolerance |
Over estimation | Issue | Spent > Original Estimated * tolerance |
Each checking rule can be enabled or disabled in the Setting Panel. The setting is saved in each Context.
1.18. Highlight
The Highlight displays some issues with a visible way comparing others.
1.18.1. Critical Path Displaying
The critical path for your project helps you to determine which tasks can affect your project's finish date and whether your project will finish on time. The tasks in the Critical Path are named as Critical Task. Those tasks cannot be delayed without affecting the project finish date are the critical tasks.
In a typical project, many tasks have some slack and can therefore be delayed a little without delaying other tasks or affecting the project finish date.
If it's important for your project to finish on schedule, pay close attention to the tasks on the critical path and the resources assigned to them. These elements determine whether your project will finish on time. A series of tasks is generally interrelated by task dependencies. Although there are likely to be many series of interrelated tasks in your project plan, the series of tasks that will finish the latest is the project's critical path.
To switch the Critical Path displaying, click on the button . The Critical Tasks will be displayed in highlight as below:
Clicking on it again will go back to normal task display.
Please not that the state of Critical Path is not part of Context.
1.19. Export
1.19.1. Export to Excel
It is possible to export the content of Spreadsheet to a Excel file using the tool "Excel Export":
It doesn't export all fields of the issues, only the fields displayed in the Spreadsheet.
There are two menu entries:
Menu Entry | Description |
---|---|
Using Excel Group | The Group By is exported in Excel Group |
Without Excel Group | Export to static content in an Excel file. |
Exported file can be read by Microsoft Office 2007 and 2010.
1.19.2. Project Plan Export
This menu is available only the following gantt chart:
- Time Plan
- Progress Tracking
- Project Portfolio
- Portfolio Tracking
This menu exports the content of your gantt-chart in a XML file of MS Project using the menu as below:
It doesn't export all fields of the issues, only the fields displayed in the Spreadsheet.
A option dialog will show, it allows you to select a or some projects.
When the option "Export GroupBy issue" is enabled, all GroupBy nodes, such as Versions, will be exported as a container issues. It is enabled by default. When it is disabled, the GroupBy nodes will be left out. The contained issues will be exported anyway.
This option "Round Trip" indicates to keep the id of JIRA issue in the task of exported file. This information will be used to update the existing JIRA issue in the next import, instead of new creation of issue.
The result is a zip file, which contains a XML file for each project.
This feature is available neither for Resource Plan, nor for Resource Tracking.
And custom fields are not supported.
The user name cannot contain the list separator characters like ';' and ';', which are required by MS Project. Otherwise, you get this message during the loading in MS Project:
1.19.3. Print and Image/PDF/XPS export
Detail information about Print and image/PDF/XPS export can be found on this page
1.20. Import
1.20.1. Project Plan Import
Same as the Project Export, this menu is available only the following gantt chart:
- Time Plan
- Progress Tracking
- Project Portfolio
- Portfolio Tracking
This tool is independent solution from Microsoft project. Meanwhile, it allow users to keep their preferable project management tools for project plan and then import to JIRA for development management.
The selection of this button opens the import launch dialog,
In this dialog, you need to provide some mandatory parameters and options :
Option | Description | Cardinality |
---|---|---|
1. Path of the Project file to import | The file contains the plan tasks. | 1 |
2. Target project | The project in which the tasks will be imported. | 1 |
3. Target Version | The value is a list of versions, in which the tasks will be created. The combo box supports multiple selection capability. | |
4. Target Component | The value is a list of Components, in which the tasks will be created. The combo box is multiple selections capability. | |
5. Root Task Mapping | The root task can be mapped to the selected type such as Version and Component. | |
6. Task Type | The task type of JIRA will be used. | 1 |
7. Subtask Type | The subtask type of JIRA will be used. | 1 |
8. Labels | Some labels can be set in all created tasks. It is possible to provide multiple labels, each label should be separated by the separator comma ",", for example, "Iteration2, QA" Label is very useful to keep the imported tasks in group. | 0...* |
9. Round Trip | This option indicates to use the JIRA issue id of the task to update the existing JIRA issue, instead of new creation of issue. It could be possible if the file is exported from JIRA with the "Round Trip" option enabled. | 0...* |
After clicking the button "Import", it will take a while to perform the importation in JIRA. The time depends on the number of tasks in the file. When this operation is over, a summary dialog shows up:
If the option "Change the timespan to display all issues" is checked, the start and end date of Gantt chart will be changed using the ones of imported tasks respectively. And all issues will be highlighted and selected.
If the option "Root Task Mapping" is selected as Version or Component with a level, the root nodes of imported tasks of selected levels will be mapped to Version or Component respectively. The Versions or Components will be created there is no such element with the same name in JIRA.
The following formats are supported:
- MPP: The MPP file format is Microsoft's proprietary way of storing project data.
- XML: The MSPDI file format is Microsoft's XML file format for storing project data.
- MPD: The MPD file format is an Access database file format used to store one or more projects.
- PLANNER: Planner is an Open Source project management tool.
- XER: Primavera is a high end project plan tool favored by users with complex plan requirements.
- MPX: The MPX file format can be read by all versions of Microsoft Project, And written by all versions up to Microsoft Project 98.
If you meet a problem, please check the issues on our FAQ about MS Project Import & Export.
1.20.1.1. Task Mapping
During the import, a JIRA Task is created for each task from project file.
Task in file | JIRA Task | Default Value |
---|---|---|
Name | Summary |
|
Notes | Description | Empty |
| Priority | Blocking |
| Status | Open |
| Issue type | Use Input parameter. The default value is Task for root task it is part of the task types of the project.. The same solution is used for subtask. |
Work, Duration | Original Estimate | If the Work is set, it will be used to calculate the Original Estimate. Otherwise, the Duration will be used. |
Created | Created |
|
Start Date | Custom Field "Start date" if it is not configured. Otherwise, ignore since it can be calculated using the Working Agenda and Duration. |
|
End date | Due date if the Custom Field "End date" is not selected. Otherwise, use Custom Field "End date" |
|
| Reporter | Current user |
Resource | If there is a JIRA User with the same name. | Default Assignee or Unsignee if it is enabled. |
Actual Work | SpentTime |
|
Remaining Work | Remaining Estimate |
|
Auto-Scheduling supported by MS Project 2010 | Auto-Scheduling |
A Milestone is mapped to a Task with "Original Estimate" = 0, which is supported by JIRA Gantt Chart Project.
1.20.1.2. Sub-task
By default, JIRA does support the sub-task concept. But it supports only one level of sub-task. This concept can be disabled in the Administration.
This plugin by passes this limitation to support N-level sub-task if one of the following condition is true
- There is at least one Sub-task type usable in the project
- The custom link of Parent-Child is setup in the administration of JIRA Gantt Chart Project
Please reference this page for the detail setting about the Sub-task management by this plugin.
1.20.1.3. Dependency
All four kinds of dependency are supported and mapped directly to the dependencies defined by our plugin.
Dependency in File | JIRA dependency | Description |
---|---|---|
FF | FF-Dependency | Finish to Finish Dependency |
FS | FS-Dependency | Finish to Start Dependency |
SS | SS-Dependency | Start to Start Dependency |
SF | SF-Dependency | Start to Finish Dependency |
1.20.1.4. Resource Mapping
Since a JIRA issue can have only one assigned user, only one resource will be taken during the import if there is a user with the same name in JIRA and this user is assignable in the target project. If there is no corresponding user found for the resources and if the JIRA enable the option Unassignee, the Assignee of this task will be "Unassignee". Otherwise, the current user will be set as assignee.
1.20.1.5. Duration
In MS Project, the duration can be expressed in difference units. Only the following time units are supported in Duration and Work fields:
Name | Abbreviation | Description |
---|---|---|
Minutes | min/mins | Duration in minute |
Hours | hr/hrs | Duration in hour |
Days | day/days | Duration in day |
Weeks | wk/wks | Duration in week |
1.20.1.6. Performance
If others time units are used in your plan file, you need to change it before the import in JIRA. A quick benchmark is done to test the performance and scalability with MS Project. Here is our result:
Tasks | 100 | 500 | 1000 | 2000 |
---|---|---|---|---|
Loading Time (s) | 30 | 150 | 290 | 580 |
1.21. JIRA Agile Aware
The integration of this plugin with JIRA Agile consists of the following aspects:
- NonWorkingDay setting
- Start Date of a version in JIRA Agile will be used ad Start Time in Gantt-chart
- End Date of a version in JIRA Agile will be used ad End Time in Gantt-chart
- Version parent relationship aware to display the version in tree
- Component parent relationship aware to display the version in tree
- A delegate gantt-chart for Sprint
1.21.1. Working schedule
When a project is enabled for JIRA Agile, an option "Enable Integeration with JIRA Agile" is available in the Global administration panel of the plugin.
This option is enabled by default.
And when this option s enabled, the option "Use JIRA Agile Calendar" is available in the Working Schedule panel of the plugin to merge the Non WorkingDay of JIRA Agile into a group Calendar.
1.21.2. Version hierarchy
The parent relationship between versions defined in GreenHopper will be displayed as tree structure in Gantt-Chart.
1.21.3. Component hierarchy
The parent relationship between components defined in GreenHopper will be displayed as tree structure in Gantt-Chart.
1.21.4. Sprint Gantt-chart
A delegate gantt-chart is provided in the integration of GreenHopper to enable the Sprint plan.
Here is an example of GreenHopper sprint boards with two sprints in Plan mode : one sprint "Specification" is started, another is in waitting.
Only started sprints are visible in gantt-chart. The auto-scheduled issues are planned on Rank value per assignee resource.
This feature is available only with GreenHopper of version 6 or newer.
1.22. Board setting
The Borad Setting tool is used to configure:
• The current Gantt-chart setting.
• Board data used for all Gantt-charts The tool is accessible via the following toolbar button:
1.22.1. General Setting
1.22.1.1. Loading Scope
If the scope of issue loading is defined as -4w and +4w by default. When you change the timespan Preset and ff the scope defined in timespan Preset is wider, the later will be used. In other words, the wide scope between the one of timespan Preset and used-defined is always used.
1.22.1.2. Setting Mode
In case of the failure or overloading, the gantt-chart can run into the waiting mode forever with a "Please wait..." message as following:
We need a solution to break the blocking loop. The Setting Mode is for this purpose, in which Gantt-chart doesn't load any issues. It allows only the changes of context setting. The Setting mode is indicated by a dedicated icon at right corner of each gantt-chart:
It is in fact a button that allows exiting the Setting Mode.
1.22.1.3. Go into Setting Mode
There are two ways to go in Setting mode:
Tropic | Description |
---|---|
Loading Timeout | When the loading of gantt-chart exceeds 5 minutes, a dialog will be displayed to ask you to go in Setting Mode |
Using Setting Panel | Each Gantt-chart has a Setting Panel where you can find an option "Setting Mode". The change of this value to true makes the gantt-chart in Setting Mode |
1.22.1.4. Exit Setting Model
When you identity the problems of setting and fix them, you can go back to normal mode by clicking on the Setting Model button.
1.22.2. Consistence Checking
This session allows the configuration of the checking rules of the current gantt-chart.
1.22.3. Working Schedule
This session allows the configuration of the working schedule of the current user. The configuration relies on the team working schedule. The user can override it by simple click on the calendar.
The setting is used for all gantt-charts of the current users.
1.23. Loading Recovery
It is possible the loading of Gantt chart fails for a wrong parameter setting of the current context. There is a timeout setup up in Setting Panel. When the loading takes more time than the parameter "timeout", a dialog will be displayed to help you to get rid of the blocking situation:
In this dialog, three options are proposed:
Option | Text | Description |
---|---|---|
1 | Switch the context to | This option switches the current context to another. |
2 | Reset the current context | If the option 1 is selected, this option will reset the selected context above. If the option 1 is not selected, this option will reset the current context. |
3 | Go into Setting Mode | If the option 1 is selected, this option will set the selected context above in setting mode. If the option 1 is not selected, this option will set the current context in setting mode. |
1.24. Progress Scope
This option deals with the computing of progress state for tracking.
There are two methods provided: "Loading Scope" and "Server Scope". The "Loading Scope" calculates the progress based on the sum of Spent time over the sum of Origial Estimation of all loaded issues. The "Server Scope" uses the same method of JIRA Agile to calculate the progress on number of issues:
Resolved issues / total issues
The default value is "Loading Scope". And the "Server Scope" is time comsumming.It may descrease the performance when there are a lot of issues.
1.25. Hot Cache
To minimize the data transfer from JIRA server, a sophisticate cache mechanism is implemented. The cache data is managed per user. By default, this mechanism is enabled and managed automatically. In some special case, you can change the default setting. There are two ways to manage the setting :
- via JIRA User Profile:
- via Context popup menu of Gantt Chart
1.25.1. JIRA User Profile
This option is available only for JIRA OnPromise. It is not yet supported in JIRA Cloud.
.
You can find a panel of Gantt Chart Project for Java under the Preferences:
You can enable/disable the cache mechanism by clicking the check button, and you can reset the cache content by clicking the button "Reset".
1.25.2. Context popup menu
A short-cut is available in the popup menu of Context:
2. JIRA Cluster
Since the version 3.4.0, Gantt chart Project for JIRA is JIRA Cluster compliant. It works transparently without any additional setting.
3. Plan Gantt-chart
These gantt-charts are configured specially for project plan..
3.1. Time Plan
"Time Plan" is a Gantt-chart view designed to help the project plan of current project.
3.2. Project Portfolio
"Project Portfolio" is a Gantt-chart view designed to collectively manage and analyze the plan of a group of projects. It is very similar to "Time Plan", except the issue scope on multiple projects instead of the current project.
The access of projects respects the JIRA security scheme. The projects are all projects accessible by the current user.
3.3. Resource Plan
This Gantt-chart provides a view of issue management from the point of view of assigned resources.
The main data input is the selected resources. The user list respects the JIRA Security Scheme. The list should contain all users of accessible projects.
4. Tracking Gantt-chart
These gantt-charts are configured specially for issue tracking.
4.1. Column configuration
Column | Displaying |
---|---|
Indications | Show |
Name | Show |
Start time | Show |
Key | Hidden |
Done | Show |
4.1.1. Gantt chart display
Item | Default value |
---|---|
Log display | Enabled |
|
|
4.1.2. Consistence Checking
Rule | Enabled |
---|---|
|
|
|
|
|
|
4.2. Progress Tracking
The Progress Tracking is a gantt-chart configured to track the issues of the current project under the system menu "Projects".
4.3. Reporter Tracking
Reporter Tracking is a special gantt-chart to display the progress state of all issues reported by the current user. It loads only the issues reported by the current user.
4.4. Resource Tracking
Like Reousrce Plan, Resource Tracking is a special gantt-chart to display the issues per Assignee, but for the tracking purpose.
4.5. Project Portfolio Tracking
Like Progress Tracking, Project Portfolio Tracking is a special gantt-chart to to track the issues of several selected projects.
4.6. Gadget - Assignee to Me in Gantt-chart
This gadget provides a view to track all issues of the current users.
The administrators can create any number of Gadgets they want using the System Dashboard:
4.7. Gadget - Project Portfolio
This gantt-chart has the same features and behaviors as Project Portfolio Tracking, but bundled in Gadget.
The administrators can create any number of Gadgets they want using the System Dashboard:
Only administrators can change its context. The context of a gadget is linked to each gadget instance,
it is shared between users.
- No labels