Enzyme allows a two-way integration with Jira so you can pull data from Jira directly into Enzyme. Users with the permission level of Quality Owner can set up the integration. Users with other permission levels will be able to see the integrations under the Jira tab.
The Enzyme-Jira integration uses separate Webhook and API integrations to achieve two functionalities:
- API: Enzyme will push updates back to Jira as comment issues pushed in via Webhook.
- Webhook: push updates from Jira to Enzyme, where they get recorded.
- Go to Enzyme > User Settings Menu > Integrations > Jira tab and you’ll see the screen below.
- Click on the name of the product you would like to target and the menu will expand.
- To create a secure connection, retrieve your API key from Atlassian's account management panel on the API Tokens tab: https://id.atlassian.com/manage/api-tokens
- Return to the integrations section in Enzyme.
- Paste in the API key, your email, and your Jira instance URL.
- Then click "Link Jira" and observe the following screen appears.
Enzyme will now generate a PRODUCT specific Webhook, to ensure you are targeting the correct product.
- The Enzyme generated webhook will allow Jira to push messages to Enzyme.
- Next, navigate to this admin panel in Jira: https://[yourcompany].atlassian.net/plugins/servlet/webhooks
- Click "Create a Webhook".
- Enter in a descriptive name, and paste in the URL from Enzyme.
- In Issue related events, make sure to select all of the following events:
- Then click Create and confirm the Webhook looks similar to this one:
Configuring the Design Control Integrations
Enzyme allows you to configure important parameters, the import of links among issues in Jira as tracing dependencies, Enzyme-driven transition in Jira, and customer-driven refresh of the integration.
Next, we will use Jira Query Language (JQL) to set a series of filters that will help Enzyme parse the data delivered to the Webhook above from Jira.
Linking a project in Jira to a Product in Enzyme
- Click on the Edit icon under Project jql.
- Type in the JQL Query that corresponds to your project in Jira.
Example: 'project = cbc'
Note: You can find the Project Key next to your Jira project
Mapping: Specifying Jira label-to-Enzyme Design Control behavior
Enzyme will populate each mapping with default values for each column of design control. If your project will be using the same terminology as Enzyme, then there will be no need to modify.
You can specify compound conditions to precisely select combinations of state in your project. Possible parameters include:
- Label: edit the table ensuring that cases match. Enzyme will help you confirm your syntax by showing the set of Jira issues that match your filter. It will alert red for invalid syntax.
- Issue Type: This includes the standard-issue types; story, task, bug, epic, test.
- Issue Status: This includes standard statuses and any customization your Jira admin makes. Confirm your custom statuses in Jira by clicking Cog Icon > Issues > Find Statuses (details)
- Custom Fields: This includes all custom fields you have created for your project board in Jira. JQL for custom fields: CF[#####] = "text you want". [#####] can be found from the last digits of the custom field URL. How to create a custom field in Jira.
Example: CF = passed
- To modify labels listed above, click on Edit button for the design control you would like to modify
- Write a JQL Query to map Jira issue & Enzyme design control.
Example: If you only want to import issues with the label userneeds and that Labels = userneeds AND issuetype = Story
Custom fields can be displayed in the desired design control card in Enzyme.
- To add display fields, find the field URL ID Number Administration > Issues, Select Fields > Custom Fields > Select on the field > Edit Details and copy the last digits in the URL
- In Enzyme, add customfield_XXXX with the ID # from the previous step to display in Enzyme.
Using the PHA and FMEA Integration (via Fields tab)
- Enable the PHA and FMEA for risk models.
- Create issues in Jira and apply the appropriate labels to them and relationships.
- If you have any custom fields you want to test, create them in Jira, and ensure that you enter the linking relationships into Enzyme (in the Jira integration settings).
- The syntax to get them to fill in is customfield_XXXX, where XXXX is the custom field ID, which you can find by clicking on the custom field details in the URL. It’s the last digits.
The linking relationships of issues in Jira can be imported into Enzyme and shown as tracing dependency. You need to make sure that the link relationship in Enzyme is identical to that displayed in Jira.
- To see issue links, in Jira navigate to the issue settings (Cog -> Issues -> Linking).
- Here you can modify existing relationships and create new ones
- Create a new field, add the name of the relationship, Outward Link Description (Relationship Name), and Inward Link Description (is Relationship Name by).
- Once a new field is created in Jira, enter the desired relationship to Enzyme under the integrations section.
For example, the Implement relationship was created in Jira. In Enzyme, we see that there are many combinations of item types from the Design Control. The implement relationship can be used to trace Design outputs.
- To link an issue to a design control card, create or modify an issue in Jira.
- Click the Link Issue button.
- Select the relationship link.
- Select the issue you would like to link.
Example of a completed Requirement
In Enzyme, when a design control card changes state, the corresponding transition will occur in Jira.
- In Jira, go to Projects >Project settings > Workflows > (pencil icon) Edit > View Transition IDs
- Identify the transition that you wish to use to change the state.
For example, if I want a user to be approved when the source card transitions to Done, then the ID would be 41.
- Copy and paste the Transition ID into Enzyme.
Your integration is now ready!
If you have any questions, you can reach us through the in-app chat or email us at firstname.lastname@example.org.