Necessary Prerequisites
The DYCE Time Tracking extension for Jira only works if Time Tracking is fully set up. This includes the creation of at least one environment or company. The necessary steps are described in the following sections:
Once DYCE Time Tracking is fully set up, the Jira extension can be installed and set up, as well.
Since Jira Software and Jira Work Management are very similar with regard to the DYCE Time Tracking extension, but Jira Work Management is less common, both tools will be included in the rest of this documentation whenever Jira Software is mentioned.
Installation
Install the extension via the Atlassian Marketplace in your organization. Once the installation is complete, DYCE Time Tracking is generally available. However, before the extension can be used for time tracking, it must be selected for this purpose in the global settings. This can be done at any time, as the other settings of DYCE Time Tracking do not depend on this.
To determine which time tracking is to be used, open the settings (administration icon, cogwheel) in the top right-hand corner of the screen and select Issues. In the page that opens, you will find the Time tracking item in the menu on the left (under Issue Features). Select DYCE Time Tracking as the Time tracking provider. Check and, if necessary, change the other settings in the Global time tracking settings section before you access the further DYCE Time Tracking settings via the DYCE Time Tracking settings link. This is located in slightly different places depending on the Jira product (Service Management or Software). In Service Management, the page is opened in the Project via Project settings/DYCE Time Tracking, in Software via Project settings/Apps/DYCE Time Tracking. To access and edit this page, you must have the required permissions (Admin role) in Jira and the Admin role in DYCE Time Tracking.
If the Time Tracking add-in is not displayed, pop-ups must be allowed.
Different project structures in Service Management and Software
Projects are available in both Jira Service Management and Jira Software, but they behave slightly differently in detail.
If the Service Portal from Jira Service Management is in use, the tickets of all accounts (= customer logins) can be created for the same project, or separately for one customer project at a time. To map both scenarios, the mapping runs via the customer themselves. At the same time, Jira Service Management recognizes the principle of a customer. A pre-assignment of customer, project, project task and activity for time recordings can therefore be made within a (service) project per customer.
Jira Software, on the other hand, does not recognize the principle of a customer. The mapping for time recordings can therefore only be made per (customer) project. We therefore recommend creating a separate project for each customer and making the pre-assignment in each project.
Pre-assignment of time recordings
In Jira Service Management, time recordings are pre-assigned per customer, in Jira Software per project.
Jira Software
In the Project settings in Jira Software under Apps/DYCE Time Tracking, in the company assignment area, select the company to which the time recordings for this project should be made. All available companies are listed in the selection field, grouped by environment.
The Project-Assignment tab can be used to predefine Customer, Project, Project Task and Activity. It is not always necessary to predefine all fields.
Jira Service Management
In the Project settings in Jira Service Management for DYCE Time Tracking in the company assignment area, select the company to which the time recordings for this project should be made. All available companies are listed in the selection field, grouped by environment.
The Customer-Assignment tab shows all customers (grouped according to the domain of the logins). The displayed name, which is predefined via the domain, can be changed individually. For each customer, Customer, Project, Project Task and Activity can be predefined here. It is not always necessary to predefine all fields.
In addition to the pre-assignments for customers, a pre-assignment can also be made for internal purposes. If Jira is used internally, a pre-assignment can be created in the same way as for customers. The pre-assignment is displayed in the same area, if Display internally is set to YES. The domain can be used to determine, whether it is an internal issue. If the employee who creates the issue logs in with the same domain, that is used for Jira, it is an internal employee and the issue runs on the internal pre-assignment (if available).
The selection determines the company in which the time recordings are synchronized. If the company is changed, all time recordings remain unchanged and are not assigned to the new company.
The pre-assignment of Customer, Project, Projecttask and Activity is not valid for the new company. Please create a new pre-assignment for the new Company.
Create WebHook
The Create action in the DYCE Time Tracking integration area opens a dialog. A valid client key must be entered in this dialog. The key can be created in the Clients view in the administration area of the web app. The link from the dialog leads directly to the corresponding client. The client key requires neither a role nor a resource. In this case, it is also recommended not to specify an expiration date. A WebHook is created that reacts to the following events:
- Create Issue synchronizes newly created issues.
- Update Issue synchronizes changes to the issues.
- Delete Issue deletes the issue in the DYCE backend and Dynamics 365 Business Central.
Please check the company before creating a client key. The key only works if the Jira Project is linked to the same company.
The WebHook must be recreated, if the company has been changed. Please create a new client key in the new company and use it to set up the WebHook.
User and login
The user must be assigned both the Time Recording role and a resource via the Web App.