Obtaining an API Token
In order to connect Risk Cloud to your Jira instance, you will need to first obtain an API token. This token is essentially a password that allows Risk Cloud to read/write data into your Jira instance.
We recommend that you create a new Jira user specifically for your Risk Cloud integration which will allow you to restrict the user’s access. Note: The account that generates the API token will be listed as the “Reporter” for all Jira tickets created through the Risk Cloud / Jira integration.
After determining which Jira account you will use to make the connection, you can follow these steps to obtain an API token for JIRA Cloud:
1. Navigate to your “Account” page in Jira.
2. Navigate to the “Security” page in Jira.
3. Click “Create and manage API tokens.”
4. Click “Create API token.” The label does not matter, but we suggest you name it something related to LogicGate/Risk Cloud for identification purposes.
5. Click the Copy button. API tokens are only available one time. If you close the window, it will not be available again, but you can just generate a new one.
Risk Cloud's JIRA integration does work with JIRA Server! The key difference between JIRA Cloud and JIRA Server is that for JIRA server you will not use an API token. Instead, you will use the password for the JIRA user. (This is because JIRA Server does not have the API token feature that JIRA Cloud does.) As with JIRA Cloud, we highly recommend using a distinct user account for your Risk Cloud integration.
Connecting the Risk Cloud Integration to Jira
1. Navigate to the Risk Cloud integrations page located in the "Admin" tab of your navigation bar.
2. Make sure the Jira integration is enabled. (If JIRA is disabled, please reach out to your Relationship Management contact.)
3. Click “Edit Configuration” button in the "Jira Software" card.
4. Fill out your Jira instance details, including the API token you generated in Step 1.
Creating a Jira Workflow
1. Navigate to an application.
2. Create a new Jira Workflow.
3. Select a Jira project. The Jira projects available are based on the API token you entered in Step 2.
4. Map the Jira Workflow to a regular Risk Cloud Workflow.
Adding a Jira Workflow to a Step
Now that you have created a Jira workflow, let’s add it to a step so that your end user can access it!
1. Enter the step editor where you want to link your Jira workflow. To learn more about editing a step, you can read this help article.
2. Click the “Link Workflow” button to add a linked workflow, and select the name of your Jira workflow.
3. Select the configuration options for your Jira workflow. You can choose whether end users on this step are allowed to: create a new Jira ticket, search existing Jira tickets to link, and/or unlink Jira tickets. You can also make this section required, so that a user must link or create a Jira ticket before being able to submit.
Creating/Linking a Jira Ticket on a Record
Once you have added a linked workflow section for your Jira workflow you will be able to create and link Jira tickets directly from a Risk Cloud record. At first, no Jira tickets will be linked to your LogicGate record:
However, based on the configuration in Step 3, you can now create a new Jira ticket or link an already existing Jira ticket!
When linking a record, you must search by Jira ticket summary/title and not by ticket number. Once a ticket is linked it will be shown in the Risk Cloud record's linked Jira workflow section. All ticket details, including status, will remain up-to-date and in-sync with the linked Jira ticket.
- The integration cannot support multiple values for fields (such as checkbox/multiselect fields in JIRA).
- The integration cannot support JIRA's type-ahead field (such as typing “Alex” to return a JIRA user for the assignee field).
- For the Sub-task issue type, the Parent field MUST match an existing JIRA issue . It is currently a free text field.
- Non-required fields are not available to users when creating a JIRA issue.
- You cannot change the JIRA project once you create a JIRA workflow. To do that, you need to create a new JIRA workflow.
If you have have any questions about this integration, please reach out to firstname.lastname@example.org.