How to Connect a YouTrack Project
This article explains how to connect a YouTrack Project to a project in Enji to build project reports. By connecting the task-tracking system, Enji gets regular updates, including new worklogs and status changes.
Creating an Enji Workflow
To make the YouTrack integration with Enji work, configure an Enji Workflow. This setup is done once, and the integration will work for all YouTrack Projects.
1. Log in to a YouTrack account. Go to Settings -> Workflows and click Add Workflow.
2. Select Upload ZIP File and upload the archive with the Enji Workflow configuration.
3. In the Workflows list, select for_enji. There is a section on the right with details and settings for for_enji. Go to the Projects tab, enable Auto-attach, and click Manage Projects.
4. Select all the projects that should work with Enji and Save.
5. The Enji Workflow setup is now complete. When adding new YouTrack projects, for_enji will automatically be added to them.
Custom Fields (Mandatory!)
If a user does not set up the custom field Changes for a YouTrack project, Enji will not be able to receive updates about the worklog and comment changes.
This setup is required for each new YouTrack project.
1. Go to Settings -> Custom Fields and click Add Field to Project.
2. Complete the fields as shown below:
- Field Name: changes.
- Type: integer.
- Aliases: leave empty.
- Can be empty: check and leave the input empty.
- Make Private: do not check.
3. Click Add Field. The added field will appear in the list of all available project fields.
4. Make sure to add the changes field to all projects!
Recommendation: When adding the changes field to other projects, use it as a template in the Use Existing tab to automatically copy all values.
How to add a YouTrack project to an Enji Project
With the YouTrack settings complete, a YouTrack Project can now be linked to an Enji project.
1. Open Enji -> Settings -> Project List and click on the ID of the project where a YouTrack Project will be added.
2. Go to the PM Tools tab and select "+".
3. Complete the fields:
- PM Site: Select the required YouTrack PM Site from the dropdown list. Add a new PM Site if you do not find a corresponding source in the list.
- Project Key: Enter the Project ID. You can find it in your YouTrack project settings.
- Board name: Enter any name. This name will be displayed in the PM Tools list.
- Username: Enter your email/username associated with the YouTrack account.
- Token: Paste the token.
How to get a token in YouTrack
Go to Profile -> Account Security and click New Token.
- Name – give any name to the token;
- Scope – select YouTrack from the list.
Click Create.
Copy the token.
- Is active: Check the box.
- Auth-type: Leave this field empty.
Click Test Connection to ensure the provided information is correct and access to the YouTrack Project is available. Save the changes.
Parser processes run every 2 hours, parsing data from the YouTrack Project into Enji.
If data still does not appear on the Project -> Worklogs page after an hour, a manual account mapping may be necessary.