Integrating with external task management tools like Jira is essential for efficient privacy and compliance operations. This article explains how to set up and manage the Jira integration, enabling seamless task synchronization and real-time updates.
How do I link my Jira Account?
To authenticate, you will need to provide the following information:
API token
Email address
Jira domain
Requirements & additional Information
Before beginning the setup, please note the following:
In Jira, any user can create an API token, but it will have the same permissions as that user.
For best results, we recommend that the Jira admin connects the account or you are able to obtain the necessary credentials from someone with these permissions.
Step 1. Create an API token in Jira
Go to your profile in Jira in the top right of the screen and click Manage account
.png "image(70).png")
From here, a new window will open. Click now on Security, then on Create and manage API tokens
.png "image(65).png")
Create and copy your new API token. Again, anyone can create the API token, but please remember it's gonna inherit the role/group permissions of that specific user. Hence, we recommend only Admins to perform this step.
Step 2. Navigate to the Integrations Tab in Kertos
Now, return to the Kertos platform. In the navigation bar, locate the Integrations tab and select it. Then, choose the Tasks category to view the available task management tools.
Under the Jira option, click the Setup button to start the integration process.
.png "image(61).png")
Click now on the Setup Configuration button.
Step 3: Enter your Jira domain
A new window will open. Click now on the “Start” Button.
.png "image(62).png")
Please now click on the Next button.
.png "image(63).png")
Enter the URL you use to sign in to your Jira account (e.g., https://yourcompany.atlassian.net) and click Next to proceed with the setup.
.png "image(64).png")
Step 4: Enter your email address
Enter the email address you use to log into Jira and click Next.
.png "image(66).png")
Step 5: Enter your email address
Finally, enter your API token and click Submit. For assistance with creating an API token, refer to Step 1 above.
.png "image(67).png")
Step 6: Email data
This step is only necessary if you need email addresses for your users. Go to Profile and visibility in the top navigation bar.
.png "image(68).png")
To complete the setup, make sure all users have set their email visibility to "Anyone" in their Jira profile settings. This ensures that email addresses are accessible during the integration process, which is essential for smooth synchronization between Kertos and Jira.
.png "image(69).png")
Step 7: Testing the Sync
After completing the setup for the Jira integration, it’s important to test the sync to ensure that tasks and issues are properly connected between Kertos and Jira.
Click again on Setup under the Jira Option.
Initiate Test Sync: In the integration setup screen, click on the Start test sync button. This will trigger a synchronization test to confirm that Jira issues are successfully syncing with Kertos tasks.
.png "image(71).png")
Review Sync Status: During the test, check for any notifications or error messages that might appear. A successful sync will confirm that tasks are correctly mapped and updated in real-time between the two platforms.
Common Sync Errors:
Due Date Field Error: If you receive an error indicating "Field 'duedate' cannot be set. It is not on the appropriate screen, or unknown," this suggests that the due date field in Jira may not be configured to display on the required screens. Check your Jira settings to ensure the due date field is accessible.
Please follow the steps provided in the screenshot below. First go to your Jira Board, click on any issue, then scroll to the bottom where you find "Configure”.Error: The field 'status' could not be synced. Expected value: TicketStatusEnum.OPEN (<enum 'TicketStatusEnum'>), but got: Zu erledigen: If you receive this error, it indicates a mismatch between the expected value for the status field in Jira and the value being used in your system (e.g., "Zu erledigen" instead of "OPEN"). To resolve this, go to your Jira settings and change the language settings to English.
.png "image(77).png")
Now we can configure which fields will be shown. Please move “Due Date” from the suggested field on the right side to the list on the left.
.png "image(78).png")
API Token or Permission Issues: If there is an issue with the API token or account permissions, make sure you’ve used an account with the necessary permissions, ideally the Jira admin account, to avoid access restrictions.
Re-Test if Necessary: If you encounter any errors and have adjusted your Jira settings, click Test sync again to confirm the changes.
Testing the sync helps ensure a smooth integration experience, enabling your team to manage tasks seamlessly across both Kertos and Jira.