This page relates to version 2.0 of Rich Filters::Time Tracking Dashboards. Documentation for previous versions is available via the documentation index.
Integration with Tempo
Timesheets by Tempo - Jira Time Tracking, also known as Tempo Timesheets or simply Tempo, is a robust and widely-used time tracking Jira app. Among other features, Tempo offers Jira administrators the ability to create additional custom work attributes, which users can fill out when logging time on Jira issues. These attributes act like custom fields for work logs, enabling users to provide additional information about the time logged on an issue. Custom work attributes can be used to indicate work types, like design or development, track costs, or record other specific data. To learn more about configuring these work attributes, please refer to the 'Configuring Work Attributes' section in Tempo's documentation.
Rich Filters::Time Tracking Dashboards offers comprehensive support for Tempo's custom work attributes. More precisely, different types of Tempo work attributes can be used as statistic types or statistic values in rich filter statistics and chart gadgets. Moreover, Tempo's work attributes are also supported in the the Worklog Query Language (WQL).
This documentation section describes the way Rich Filters::Time Tracking Dashboards integrates with Tempo. More precisely:
- Support for Tempo's work attributes in rich filter configuration and gadgets
- Support for Tempo's work attributes in the Worklog Query Language (WQL)
- Worklog visibility permissions
- Worklog timestamp
1. Support for Tempo's work attributes in rich filter configuration and gadgets
Tempo provides several types of work attributes. Below, we list Tempo's work attributes that are currently supported in rich filter configuration and gadgets.
| Work attribute type | Use in rich filter configuration and gadgets |
|---|---|
| Account | Account work attributes can be used in:
|
| Numeric Input Field | Numeric Input Field work attributes can be used in:
|
| Static list | Static list work attributes can be used in:
|
Billable | The Billable work attribute can be used in:
|
Input Field and Dynamic Dropdown work attributes are currently not supported in rich filter gadgets.
2. Support for Tempo's work attributes in the Worklog Query Language (WQL)
Below, we list Tempo's work attributes that are currently supported in the Worklog Query Language (WQL).
| Attribute Type | Supported Operators | Values | Examples |
|---|---|---|---|
| Account |
|
|
|
| Numeric Input Field |
|
| If
|
| Static List |
|
| If
|
| Checkbox |
|
| If
|
| Billable |
|
|
|
Input Field and Dynamic Dropdown work attributes are currently not supported in WQL.
Quote-marks in WQL
Text search queries, date-time and duration values containing spaces (such as '2018/10/25 13:20' or '4w 2d'), and reserved JQL words need to be surrounded by quote-marks (single or double).
Because WQL is always used inside JQL queries, the entire WQL query will already be surrounded by one type of quote-marks. If you used one type of quote-mark (single or double) for the entire query, you should use the other type inside the WQL query. For example:
rfWorklogs ~ "wasUpdated = 'TRUE'"
You can also use the same type of quote-mark inside the WQL if you escape them using the character '\'. For example:
rfWorklogs ~ 'wasUpdated = \'TRUE\''
3. Worklog visibility permissions
Jira and Tempo use different approaches to restrict worklog visibility at worklog level:
- in Jira natively: it is possible to configure the instance in such a way that for each work log, the user can add visibility restrictions based on project roles and/or groups. To learn more about visibility restrictions at worklog level in Jira, please refer to the Atlassian's documentation (Atlassian's KB article mentions only the comments but exactly the same setting applies to work logs too).
- once Tempo is installed on a Jira instance: Jira's native visibility restrictions on work logs are removed/ignored and Tempo provides a different worklog permissions mechanism. To manage worklog visibility rights, Tempo relies on a new project permission called View All Worklogs. Without this permission, users can see only their own work logs. To lean more about visibility restrictions at worklog level, please refer to the View All Worklogs Permissions for a Project in Tempo Timesheets for Server section in Tempo's documentation.
Depending on whether or not Tempo is installed on a Jira instance, Rich Filters::Time Tracking Dashboards respects the worklog visibility restrictions that apply: if Tempo is not installed, then the worklog visibility rules provided by Jira natively are applied; if Tempo is installed, then the worklog visibility restrictions provided by Tempo through the View All Worklogs project permission apply. This applies in all rich filter gadgets and in the Worklog Query Language (WQL).
Currently, when Tempo is installed, Rich Filters::Time Tracking Dashboards provides support for visibility permissions granted through the View All Worklogs project permission only. Visibility permissions provided through Tempo Team permissions are not currently supported.
4. Worklog timestamp
Tempo and Jira have different approaches when it comes to timestamps in work logs. To learn more about these differences, please refer to the Why is there a time difference between my Jira worklog and my Tempo worklog? documentation section provided by Tempo. As a summary:
- in Jira natively: the timestamp for time logged through Jira natively is the precise timestamp as selected by the user in their own time zone.
- once Tempo is installed on a Jira instance: the default timestamp for time logged through Tempo is midnight on the date according to the user’s time zone.
Depending on whether or not Tempo is installed on a Jira instance, Rich Filters::Time Tracking Dashboards complies with the timestamp conventions that apply: if Tempo is not installed, then the worklog timestamp is the one provided by Jira, or if Tempo is installed, then the worklog timestamp is the one provided by Tempo.