Connect Salesforce

Connect your Salesforce org to show Salesforce cases in their own tab in the dialog, next to your JSM and Azure DevOps tabs. You create an external client app in Salesforce, copy its keys, and enter them in UniPortal. This takes more steps than connecting JSM, and the Run As (Username) setting is required.

Before you start

• You need administrator permissions in Salesforce and in Jira.
• The URL of your Salesforce instance must use https, have no port, and end in my.salesforce.com, my.salesforce-setup.com, or develop.lightning.force.com.

Create an external client app in Salesforce

1. In Salesforce, select the gear icon in the top right and go to Setup. If you land on a simplified setup screen, select Open Advanced Setup first.

   

2. In the Quick Find box, search for “external client app”, open External Client App Manager, and select New External Client App. Enter a name, for example “UniPortal”, and fill in the other required fields.

   

3. Scroll down to API (Enable OAuth Settings) and turn on Enable OAuth. Salesforce requires a Callback URL, but UniPortal doesn’t use it. Any link that starts with https:// works.

   

4. Under OAuth Scopes, move Manage user data via APIs (api) to Selected OAuth Scopes, and then select Create.

   

Set the Run As user

This step is required for the client credentials flow.

1. Open the app you created, go to the Policies tab, select Edit, and expand OAuth Policies.

2. Under OAuth Flows and External Client App Enhancements, select Enable Client Credentials Flow, and confirm the warning with OK. Then find your Salesforce username, which is not your email address, under your avatar > Settings > Username.

3. Enter it in the Run As (Username) field and select Save. Salesforce uses this user for every request that UniPortal makes.

   

Copy the Consumer Key and Secret

1. Open the app you created, go to the Settings tab, and expand OAuth Settings.

2. Under App Settings, select Consumer Key and Secret. Salesforce sends a verification code to your email.

   

3. Enter the code. Your Consumer Key and Consumer Secret appear on the screen. Keep this screen open, because you need both values in the next step.

   

Connect Salesforce in UniPortal

1. In Jira, select the cog icon and go to Marketplace apps > UniPortal > Connections.

2. Select Connect new tool and choose Salesforce.

3. In the Connect Salesforce window, enter the Consumer Key in Client ID, the Consumer Secret in Client secret, and the URL of your Salesforce instance in Salesforce instance URL, for example https://your-company.my.salesforce.com.

   

4. Select Connect. If UniPortal asks you to allow access to your Salesforce address, select Approve. Without this approval, UniPortal doesn’t save the connection.

   

5. Select the … menu next to the new connection and choose Test connection to check that it works.

Result

Your Salesforce org appears in the Connections table.

The connection name defaults to the URL of your org. Customers see it as the name of the instance tab in the dialog. To show another name, enter an Instance tab name in Configure tabs, for example “Customer Cases”. A newly connected org has no tabs yet, so add one in Request Tabs and choose its object and fields there.