Available with the Deployment Teams or Deployment Enterprise licences.
Gearset's Salesforce Object ticket integration allows linking records in Salesforce objects (these can be standard objects such as Cases or custom objects, including those installed by Agile Accelerator) to feature branches and pull requests in Gearset Pipelines. You also have the option for Gearset to automatically update a status field in those records based on the environment to which they are promoted.
It makes tracking the status of your user stories and/or support tickets faster and easier when this process is managed in Salesforce.
Setting up the connection
Configuring the user in Salesforce (Recommended)
In the Salesforce organisation where the ticketing is managed, we recommend you create a service user that has access to only the object type used for ticket/issue tracking. This is to ensure that you only grant us access to the intended object for the purpose of ticket tracking and avoid displaying sensitive information in Gearset.
To configure this user in Salesforce:
Create a specific permission set for the user and allow the following:
System Permissions -> View Setup and Configuration (automatically includes View Roles and Role Hierarchy). This is needed for Gearset to access your organisation information.
Object Settings -> [Your Salesforce Ticketing Object] -> Enable Read, Edit, View all Records
Object Settings -> [Your Salesforce Ticketing Object] -> Ensure you have configure access to the columns that describe:
The ID - read;
The Title - read;
The Status - read (write if update of status from Gearset is needed).
Create a Salesforce Tickets service User and the new Permission Set to it.
Adding the connection in Gearset
Note: Only one Salesforce organisation per team can be used for the issue/ticket tracking.
In Gearset, add the above Salesforce organisation (managing organisations) as a team-owned connection using the newly created service account.
Click on the newly created Salesforce connection and select the Issue Tracking option under the connection:
Configure the properties listed and select Save:
Click on Delegate access on the same Salesforce organisation:
Give at least Comparison access to all users who are allowed to link and view Salesforce record information:
Enabling Salesforce issue tracking in Pipelines
Once the connection for issue/ticket tracking has been configured as described above, the integration can be enabled in Pipelines by:
In the pipeline, Edit pipeline details:
Go to the Salesforce Tickets section and toggle Enable Salesforce tickets. This allows linking of Salesforce tickets to features and pull requests in Gearset:
[Optional] Set up the configuration to update the status of a linked Salesforce record when a pull request is promoted to an environment:
Linking Salesforce records to feature branches
Once the integration has been switched on in your pipeline settings, the Salesforce records can be linked to new features upon creation.
On a developer sandbox, click New Feature:
Select a Salesforce record to link, optionally filtering or searching to limit your options:
Continue creating your feature by committing the necessary changes. Once done, the linked record is shown on your feature branch:
Once a pull request is created, the linked Salesforce record is shown in the pull request details:
We also display Salesforce records in the Salesforce tickets section when PRs are added to a release:
Linking Salesforce records directly to pull requests
Salesforce records can also be linked to existing pull requests, if these were not linked at the time of feature creation.
On the pull request details on the right, click Add ticket under the Salesforce Tickets section.
Select a Salesforce record to link:
The linked Salesforce record is now shown in the pull request details.
