Adding and configuring the connector
To add this connector, go to Catalog > Connectors > Jira Software > Add a connector.
🔎 For more information on what this connector offers, hover over the lightbulb icon when your cursor is on the relevant connector.
You can complete this information by following these links:
JIRA Documentation
JIRA Documentation for SNC environments
For dedicated environments, the link to follow will be https://yourcustominstancename.tenacy.io/doc/jira
Once the connector has been added, you must configure it before running the first test.
⚠️ Warning: the ticket type chosen during configuration must have both summary and description fields as mandatory.
⚠️ You can use either a scoped or unscoped Jira API token. If you configure a scoped API token, you must configure the following elements on the Jira side:
read:jira-work
read:jira-user
read:issue:jira
write:jira-work
Running your first test
Once the connector is properly configured according to the chosen module(s), test the integration by creating a new action or a new test task in Tenacy. This new creation triggers the execution of the connector.
To verify that it is working correctly, go to ⚙️ > Connectors > Click on your JIRA connector > then click on the last execution line to check whether it worked successfully.
💡 Feel free to contact Tenacy support if you have any questions on this topic.
How the connector works
As soon as a new object is created in Tenacy in the register configured in the connector, the connector runs to push the information to JIRA. For the rest, Tenacy stores the identifier of these tickets to check their status regularly (once per hour). If the ticket is closed, Tenacy updates the status of the recurring task or action to match the ticket's status.
In both cases, if a user is assigned on the Tenacy side, a search is performed in JIRA based on their email address to assign the ticket accordingly.
🔎 Important notes:
Recurring tasks and actions created via automatic plans in Tenacy are not synchronized in JIRA.
JIRA tickets already present in the project before the connector was set up in Tenacy are not synchronized.
Actions and recurring tasks already existing in Tenacy before the connector was set up are not created in JIRA.
Recurring tasks
Upon creation of a recurring task, if a completion (status "to do") is required for the current period (based on the task's start date), a ticket is created in the JIRA project and linked to this recurring task.
For each new period start (and for each period type), a new ticket is created in JIRA.
🔎 A monthly recurring task starting on 01/01/24 therefore creates a JIRA ticket at the beginning of each month.
JIRA ticket statuses are checked regularly (once per hour). The Jira ticket status is retrieved:
If the Jira ticket is not found, the link is deleted and the completion is considered unspecified.
If the status is in the list of those identified as "Done," the completion is recorded as completed.
If the status is in the list of those identified as "Not done," the completion is recorded as not completed.
As soon as the recurring task status moves to "Done" or "Not Done," Tenacy retrieves the following from the JIRA ticket:
Files present in comments are downloaded into the attachments of the current completion of the recurring task.
URLs are included in the URL links of the recurring task. Only one link is returned. This URL must be entered in the last comment of the Jira ticket at the time of synchronization.
If the task name and description are modified on the Tenacy side, these changes are reflected in Jira. In all other cases, nothing is modified on the Tenacy side.
Actions
When an action is created in Tenacy, a ticket is automatically created in JIRA and linked to this action.
When an action is completed (manually on the Tenacy side), cancelled, or deleted, the corresponding JIRA ticket is also deleted.
Regularly (once per hour), open actions (to be planned, planned, on hold, in progress) associated with Jira tickets are checked. The Jira ticket status is retrieved:
If the Jira ticket is not found, the link is deleted and the action remains unchanged.
If the status is in the list of those identified as "completed" in the connector settings, the action is recorded as completed.
If the status is in the list of those identified as "not done" in the connector settings, the action is recorded as cancelled.
As soon as the action status moves to "Completed" or "Cancelled," Tenacy retrieves the following from the JIRA ticket:
Files present in comments are downloaded into the action's attachments.
URLs are included in the URL links of the action. Only one link is returned. This URL must be entered in the last comment of the JIRA ticket at the time of synchronization. If a URL already existed, it will be overwritten.
If the action name and description are modified on the Tenacy side, these changes are reflected in JIRA.
💡 Recommendations
In terms of best practices, it is therefore recommended to:
Create a blank JIRA project
Set up the JIRA connector in Tenacy
Create actions / recurring tasks in Tenacy — these will then be synchronized into your JIRA project
Update actions / recurring tasks from JIRA
Note that updating actions / recurring tasks from Tenacy will result in the deletion of tickets in JIRA
Note that creating an action from the JIRA project will not create an action in Tenacy