How to auto-associate a Salesforce record with a Jira issue upon Jira issue creation in Jira DC

Currently, the connector cannot automatically link a Salesforce record with a Jira issue when it’s created. However, by leveraging the capabilities of the Jira REST API, you can implement automation within the project to facilitate the auto-association process.

To make the automation work, manually add the Salesforce Object ID in a custom field when creating the Jira issue.

Compatibility: This method works with both standard Jira and Jira Service Management (JSM).

Create a new Jira text custom field to add the Object ID. This custom field must be added to the Create screen of the Issue Type. You can also add it to the View and Edit screens (optional).

1. Navigate to Settings > Issues > Custom fields .

2. Click Create custom field select Short Text (plain text only) and click aNext.

3. Name the field, for example, Case ID.

4. Add this field to your Create screen for the relevant Issue Type.

5. (Optional) Add the field to the View and Edit screens.

Jira Automation allows us to automatically send a web request to edit the entity property of the Jira issue and then associate the Salesforce Object.

1. Go to Project > Project Settings > Automation (in the left panel).

2. Click Create Rule.

3. Select the Field value changed option and set it as follows:

   • Fields to monitor for changes: Case ID

   • Change type: Any changes to the field value

   • For: Create issue

Open

4. Click Add Component > IF: Add a condition > {{smart values}} condition. This ensures that our agents/customers add the correct ID of the configured object. In this example, the Case Object is used.

   • First value: {{issue.<customField_Id>}}

   • Condition: Starts with

   • Second Value: Object ID prefix

Open

5. Click Next, then Add an action > Create variable and set the component as follows:

   • Variable name: CaseID

   • Smart value: {{fieldChange.toString}}

This helps update the JSON file in the web request.

Open

5. Click Next > Add Component > IF: Add a condition > {{smart values}} condition and set the component as follows:

   • First value: {{CaseID.length()}}

   • Condition: equals

   • Second value: 18

This helps to verify that the added ID is the correct length.

Open

6. Set the Web Request URL with the URL as follows

   • Jira DC: <JiraBaseURL>/rest/api/2/issue/{{issue.key}}/properties/com.servicerocket.jira.cloud.issue.salesforce.associations

7. Before proceeding further, create an API token using a user with the correct permissions for the project, based on the Manage API tokens for your Atlassian account article (this step is not required for Jira Data Center).

8. Copy the API token and encode it with the username. You can use this third-party site to encode it.

9. In the website's text box, arrange the username and the token in the following format:

   • Jira DC:
     <username>:<password>

10. Click Encode and copy the result to the Jira Automation page.

11. In the Headers section, set the Key name as Authorization.

12. Set the Value by pasting the encoded data from Step 9 in the <encodedToken> portion of the text Basic <encodedToken>.

13. Set the HTTP Method to PUT and select the Delay execution option.

14. Set the Web Request body as Custom data and use the following JSON file in the Custom data field. A Case Object is used in this example.

    { "associations": { "{{CaseID}}": { "son": "Case", "viewOnly": false, "autoPush": true, "autoPull": true } }, "ids": "{{CaseID}}", "types": "Case" }

    The web request component up to this point looks like the following:

    Open

    

15. Click Next > Add Component > THEN: Add an action > Re-fetch issue data.

Overview of the final automation:

Open

Now, if you add the Salesforce Object ID within the Case ID field after creating a Jira issue, the automation associates that Object with the created Jira issue.