Salesforce Details on Jira.

The introduction of Sinergify’s Jira Plugin offers a flexible way for Jira users to see Salesforce Information.

For e.g. If the Case object is mapped with Jira, Jira admins can configure what Case Information should be visible to users on Jira side. To know more about Jira Plugin, Use Cases and how to configure it for your Jira End users, follow this link.

Jira Cloud Guide

Jira Server/Datacenter Guide

Note: Jira Plugin is capable of bringing all the Jira fields into Salesforce. Jira users can view the details about the Salesforce records linked to Jira using the Jira plugin.

The Salesforce object details can now be accessed without logging into the Salesforce platform by Jira users. Users can view the details of the Salesforce Object records that are relating to Jira issues using two Features.

  1. Name Linking

  2. Record Mapping

A. Name Linking

The Name Linking feature allows users to establish or remove links from Jira. Based on the unique identifier like account number, case number or any other custom field that stores a unique identifier.

Applicability

  • The Salesforce data to be stored/accessible inside Jira fields

  • To run Jira reports or Automations based on Salesforce details

  • To update Salesforce unique record number , example ‘Case number’ .

  • When Name Linking is enabled, adding a label (such as the Case number, account name, or any custom field) by Jira teams establishes a direct link between the Jira issue and the relevant Salesforce object; however, if a Jira engineer accidentally removes the label, it results in the Jira issue being unlinked from Salesforce.

Defining a field in Jira.

Step 1. Log in to your Jira Account and click on the settings gear icon located in the top-right corner.

Step 2. From the dropdown menu, select "Issues."

Step 3. In the left sidebar, under "Fields," click on "Custom fields."

Step 4. Click on the "Add Custom Field " button.

Step 5. Choose the type of custom field “Label” then click “Next”.

Step 6. Fill in the necessary details for the custom field. Once done click Create.

  1. Name: Give your custom field a descriptive name.

  2. Description: Optionally, provide a brief description to explain the purpose of the field. For example we have used the Custom Jira field to store the Salesforce Case Number.

Step 7. Select the context in which you want the field to be available. You can choose to make it available globally or restrict it to specific projects or issue types. Once done click”Update”.

Note: To view the ‘Case Number’ field in Salesforce, click on the Sync Configuration from Sinergify Admin settings. See the reference Document.

In order to effectively utilize the field dedicated to storing case numbers, it is crucial to enable reporting capabilities. This allows for the tracking and analysis of case-related data, providing valuable insights for decision-making and performance evaluation.

Showcasing Only the Case Number Field on the Jira Page

To display the Case Number field on the Jira page, it is essential to first map the corresponding Salesforce and Jira fields through the Admin Settings. This ensures that case numbers become visible on the Jira interface.

Step1. Go to the Sinergify Admin settings.

Step 2. Go to the Field Configuration > Project Mapping.

Step 3. Map the Case Number fields, and click on the “Add”. See the screenshot below.

Step 4. Click on the gear icon located in front of the field. See the below screenshot.

Step 5. A new window will appear. Check the box labeled "Enable the Name Linking" to enable this feature.

Step 6. Once done click “Save”.

Steps to Enable Reporting

Step 1. Go to the “Sinergify Admin settings”.

Step 2. Go to the “Field Configuration” tab from the left panel and click on the “Reporting”.

Step 3. Locate the "Case Number" field, and click the checkbox labeled "Reporting".

By enabling the Case Number field checkbox, you will be able to generate reports effectively.

Note :

  • Make sure the Field-level permissions are granted to all Salesforce internal users. Also, both “Read” and “Edit” permissions for this field to guest users.

  • If you want to populate the linked case number on the Jira for only Reporting perspective and do not want to update the field through front end then you can create a Read only field in Jira.

Refer to the below screenshot how Case Number will be Visible on the Jira Page.

B. Record Mapping

This feature is used to show the hyperlinks with Case Numbers. For this you have to create a “Case Number links” (Currently we have used the Case Number links you can use another object ) field in Jira. The Data Type of this field is “Rich Text”.

Applicability

This feature is used to see the linked Salesforce object details through Jira by redirecting to the salesforce or  viewing the salesforce particular fields using the salesforce sites.

Follow the Steps to Create a Custom field Data Type label.

Step 1. Log in to your Jira Account and click on the settings gear icon located in the top-right corner.

Step 2. From the dropdown menu, select "Issues."

Step 3. In the left sidebar, under "Fields," click on "Custom fields."

Step 4. Choose the Field Type as “ Rich Text”.

Step 5. Choose “Next”.

Step 6. Give the Name “Case Number “ and click on the Create button.

Step 7. Select the context in which you want the field to be available. You can choose to make it available globally or restrict it to specific projects or issue types. Once done click ”Update”. A “Case Number” field will be created.

Step 8. Now go to the Sinergify Admin settings and Click on the “Sync Configuration” to see the field in Salesforce.

Step 9. Now go to the Field Configuration > Project Mapping.

Step 10. Map the Case Number field, and click on the “Add”. See the screenshot below.

Step 11. Click on the gear icon located in front of the field. See the below screenshot.

Step 12. A new window will appear. Check the box labeled "Enable Record Mapping" to enable this feature.

Step 13. Once done click “Save”.

Setting up a Custom settings

Step 14. From the ‘Setup’, enter the ‘Custom Settings’ in the ‘Quick Find’ box and click on it from search results. Then click ‘JiraSalesforcedetail’.

Step 15. Click “Manage”.

Step 16. You will see all the Jira instances that you have added in your Salesforce Org. Edit the Jira instance for which you want to configure the settings. For example in the below screenshot, we will be configuring changes for Jira Cloud.

Step 17. On the “JiraSalesforcedetail” Edit page, enter values in the following fields:

  • SalesforceDomain: Insert Salesforce domain URL

Step 18. In the createLinks field: Enter either Salesforce or Encrypted.

  1. ‘Salesforce’ to create links that direct back to the Salesforce Detail page/record.

  2. ‘Encrypted’ to create links that direct to the custom detail page.

Step 19. In the Timestamp field: Add the time duration (in minutes) for which the link will remain active in the Jira instance. If the link is not accessed within the set time limit, it expires 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 20. Once done, click “Save”.

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.

  • From the Setup page, Enter ‘Custom Settings’ in the Quick Find box and click on it from the results.

  • Navigate to ‘Detail Page fields’ and click on it.

  • Click ‘Manage’.

  • Create a new record by clicking on the ‘New’ button.

  • Fill in the below details.

  • Name: Give a serial number to the field

  • Field Label: Give a unique label to the field. Like in the screenshot below we have added CaseNumber

  • Field API Name: Enter the API name of the field

  • ObjectName: Enter the object name to which the field belongs

  • 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.

  • Save the changes.

  • 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)

  • On the Jira instance, click ‘View’ next to the field (for 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 expires. The link gets renewed automatically.

  • This is how the Case detail screen appears after the clicking on the view button using encrypted links.