Salesforce Details on Jira

Published Date: 05-08-2024

Read Time:

We do realize it is not feasible to pass every bit of information from Salesforce to Jira. So in case, your engineers want to access details of cases, they can do it without logging into Salesforce.

This is a one-time setup that needs to be done from Salesforce. Once enabled and configured, Jira users can view the details about the Salesforce records linked to Jira.

Note: This configuration will not change anything about how the current Salesforce detail pages are set up.

Records like Salesforce Domain, Create links, and Timestamps should exist in your Salesforce instance in order to enable the Salesforce Details page. Setting up these records is categorized under custom settings. Apart from configuring the custom settings, a Jira field should be dedicated to storing the links in the Salesforce instance (This field can vary for each project).

Setting up the Custom settings

Step 1: From ‘Setup’, enter ‘custom settings’ in the ‘Quick Find’ box and click on it from search results. Then click ‘JiraSalesforcedetail’.

Step 2: Click ‘Manage’.

Step 3: Click ‘New’.

Step 4: Fill in the record details. Enter ‘SalesForceDomain’ in the ‘Name’ field. Fill in the description and in the ‘Value’ field, insert the ‘Site User URL’.

Step 5: Create another record in ‘JiraSalesforecDetail’.

Step 6: Enter ‘CreateLinks’ in the name field and enter ‘Salesforce’ or ‘Encrypted’ in the value field.

  • ‘Salesforce’ to create links that direct back to the Salesforce Detail page/record.
  • ‘Encrypted’ to create links that direct to the custom detail page.

Step 7: Click ‘Save’.

Step 8: Create one more record under ‘JiraSalesforceDetail’.

Step 9: Enter ‘Timestamp’ in the name field. Fill in the description and add the time duration for which the link will remain active in the Jira instance in the value field. If the link is not accessed within the set time limit, it gets expired and a new link gets generated automatically while clicking on the ‘View Jira’ link on the object-related list. The Timestamp is required if you are using encrypted links.

Step 10: Click ‘Save’.

Dedicating Jira Field

A Jira field is dedicated to storing the links (directing from Jira to the Salesforce Detail page). This field can be different for each project. For example, Case Number (Jira Field) is the dedicated field in the below screenshot.

Showcase only case number field on the Jira page

You need to map the Salesforce and Jira fields from the Admin Settings first in order to enable the display of case numbers on the Jira page. In the below screenshot ‘Case Number’ Jira field is mapped with the ‘Case Number’ Salesforce field.

You have the choice to showcase the case number, case number links, or both on the Jira page.

For making only the case numbers visible on the Jira instance, follow the given steps:

Step 1: Search for Jira project mapping from the app launcher.

Step 2: Click ‘Jira_projectsFieldMapping’. A list of all Jira fields will appear.

Step 3: Search for the ‘Case Number’ Jira field.

Step 4: Edit the CaseNumber Field.

Step 3: Scroll down on the edit page. Locate ‘IsReporting enabled’ and ‘Enable Name linking’ fields. Enable the fields.

Step 4: Save the changes.

Refer to the screenshot below to view how the fields will look on the Jira Page.

Showcasing ‘CaseNumber Links’ on the Jira Page

Additionally, if you want to showcase the case links on the Jira page, follow the given steps:

NOTE: Configuring the ‘Case Number’ field first is mandatory to show the ‘Case Number links’ on the Jira Page.

Step 1: You have to map the ‘Case Number Links’ Jira field with the Salesforce Case number field. Refer to the screenshot below:

Step 2: Edit the field Case Number links Field.

Step 3: Scroll down on the edit page, locate the ‘enable record mapping’ field. Enable this field and Save the changes.

Refer to the screenshot below, to view how the fields will appear on the Jira page.

Showcasing both ‘Case Number’ and ‘Case Number links’ fields on Jira

In case you want to enable both the options, follow the above steps for both the fields; Showcase case links and Showcase case numbers. Refer to the screenshot below, how the fields will appear on the Jira page.

Create records in ‘Detail Page Fields’ Custom Setting for Salesforce Detail Page

Note: You need to create the records in ‘Detail Page Fields’ only if you are using encrypted links for viewing the Salesforce record details.

This custom setting is used to decide the fields that should be visible on the Jira detail page. For example, If you want to see some case fields like CaseNumber, Subject, and Description on Jira then those fields should be added as a record under this custom setting.

Step 1: Enter ‘Custom settings’ in the Quick Find box.

Step 2: Navigate to ‘Detail Page fields’ and click on it.

Step 3: Click ‘Manage’.

Step 4: Create a new record by clicking on the ‘New’ button.

Step 5: Fill in the details like :

  1. Name: Give a serial number to the field
  2. Field Label: Give a unique label to the field. Like in the screenshot below we have added CaseNumber
  3. Field API Name: Enter the API name of the field
  4. ObjectName: Enter the object name to which the field belongs
  5. Order: You can define the order of the fields. Like in the screenshot below, in the order field we have added ‘1’, which means CaseNumber will be the first field on the detail page.

Step 6: Save the changes.

Step 7: All the fields defined for the Jira detail page can be viewed on the ‘Detail Page Fields’ custom setting page. Refer to the screenshot below.

Viewing the Salesforce details (Via Encrypted Link Setting)

Step 1: On the Jira instance, click ‘View’ next to the field (on which Salesforce mapping is enabled). The view link will remain active only for the time as defined in the timestamp record. Users will be sent a warning message when the link gets expired. The link gets renewed automatically.

Step 2: Case detail screen appears consisting of the fields defined.

Viewing the Salesforce Record details (Via Salesforce link setting)

In case the admin has configured the value of ‘Create Link’ custom setting to ‘Salesforce’, then on clicking the view link the user will be directed to the Salesforce detail page.

Refer to the screenshot below to view the Salesforce Detail page.