Rational Team Concert (RTC) has a built-in feature to view the history of a work item. But especially for work items with many changes, it is hard to follow the Status of a work item over time. That's why we created this small extension. It shows all Status changes since the creation of the work item in form of a timeline.
The default mode of the plug-in (timeline = USER), uses the profile picture of the user in the left hand circle of the timeline. So the picture of the user is more dominant than the rest of the information. In some cases, it is more interesting to focus on the Status. To do so, set the configuration to STATUS mode (timeline = STATUS) (view example of Status Mode)
RTC allows you to customize the user interface of the work item editor to your needs, for example by writing own presentations.
This plug-in is a good starting point to learn from if you want to build your own Non-Attribute-based Presentation for RTC, as there seems to be no other example on the web on how to do this up until now.
Grab the latest release from our Releases Page.
If you are upgrading from Version 1.0.0, take notice that there was a breaking change in between.
Deploy it into RTC just like any other update-site. Instructions on how to do this can be found e.g. here.
- In the Web UI (the Eclipse Client does NOT work for this), open the RTC project area where you want to add the Status History presentation
- Navigate to the project area administration page and click on
Work Itemsin the menu on the left side - In the sub-navigation, choose
Editor Presentations
- Select the presentation for which you want to add the Status History Plug-in.
- Add a new section and give it a name, e.g. Status History (optional)
- Within the desired section, click on the green Plus icon, switch to
non-Attribute-based Presentationand set the selection of Kind to our Status History Plug-in
- Make sure that you save your configuration changes and repeat the steps for any other Editor Presentation.
The plug-in has a few configuration possibilities. They can be changed by opening the Editor Presentation in the Eclipse Client (the WEB UI does NOT work for this).
| Key | Value | Default Value |
|---|---|---|
| timeline | STATUS, USER | USER |
| largeIcons | true, false | false |
| largeIconsSuffix | (string) | _large |
| enableDetailedHistory | true, false | false |
| soonDays | ( JSON ) |
To enable large icons, set largeIcons to true. Additionally, you need to add larger icons to your process. To do so, add the respective images as a process attachment to your project area process. The search scope of the plug-in is limited to the path /workflow/, so your icons need to be provided in there.
With version 2.3.0, the detailed history, shown when hovering over an entry, is replaced with a simple version that doesn't make any additional requests. (See Issue #17 for more details). The details of the state change can still be seen in the "History" tab. To reenable this feature, you need to set the "enableDetailedHistory" key to "true".
The "soonDays" feature allows you to show a colored indicator when the work item comes close to the 'end date' or when it's over the 'end date'.
If no configuration is found this feature will be ignored.
The configuration requires the 'id' of the severity as it's key. For the value the amount of days ( number ) will be used. The value defines when the minimal difference in days before the indicator will be displayed in an orange color and showing the remaining days.
For a more dynamic use you can also define how many percentage points should be left, before showing the indicator. You can do that by using the "%" character.
If you want to use different values based on when the "Due Date" or "Planned For" is selected for the calculation you can wrap the value in a JSON-Object. The JSON-Object needs to contain the "due" and "planned" key.
{
"severity.literal.l0": {
"due": 7,
"planned": "20%"
}
}Example: Between start and the end date are 10 days. We've set the value to "20%". This will make the indicator start to be shown 2 Days before the end date is reached.
If the 'end date' has surpassed the current date, the indicator will turn red and display the time past.
In order for the 'soonDays' feature to enable the following conditions need to be met:
- A 'end date' needs to be defined. One of the following will be used
- The 'due date' of the work item
- The 'End Date' of the 'Planned For'
- A configuration was defined under the 'soonDays' key
- The severity must be able to be resolved by the configuration
- The work item can't be resolved
{
"severity.literal.l0": 0.5,
"severity.literal.l1": 4,
"severity.literal.l2": "20%"
}The 'start date' is only needed if the value is a percentage. The system will use the 'creation date' of the work item as the 'start date'. If the work item has a 'planned for' will that be used instead.
If a 'due date' is set it will be used as the 'end date'. If the work item has a 'Planned for' and the date of the 'Planned for' is before the 'due date', the 'end date' of the 'Planned for' will be used instead.
If the system can't find the 'severity' in the configuration it will try to use the fallback value. You can define this by setting "*" as the key in the configuration.
{
"*": 5
}{
"severity.literal.l3": 20,
"severity.literal.l4": 30,
"*": 5
}This plug-in has been verified to work on RTC 6.0.3 and onward. According to our information, the mechanism for creating non-attribute-based presentations has not changed since one of the first releases of RTC, so we expect it to work with any version of RTC. If not, we would appreciate your feedback.
Please use the Issue Tracker of this repository to report issues or suggest enhancements.
For general contribution guidelines, please refer to CONTRIBUTING.md
Copyright (c) Siemens AG. All rights reserved.
Licensed under the MIT License.
The calendar icon by Font Awesome is used under CC BY 4.0 (color has been changed)