Salesforce

This is a reference guide for System Administrators to setup and configure your Salesforce data for access by Orbit Connect.

Pre-requisites

Administrator access within your Salesforce Organisation

Finding your Domain URL

To find your domain URL:

1. Log in to your Salesforce account at https://login.salesforce.com/.

2. Ensure you’re accessing the correct Service Setup section.

   

3. From the left-hand content menu, expand Company Settings and select My Domain.

   

In this example, MyDomain is hal9000noodlebar2-dev-ed.develop.my.salesforce.com.

This URL is specified using https:// e.g. https://hal9000noodlebar2-dev-ed.develop.my.salesforce.com.

Finding your Consumer Key and Consumer Secret

A Consumer Key and Consumer Secret may only be accessed if a connected app has been created and configured with API (Enable OAuth Settings) turned on within your Salesforce environment, together with appropriate permissions.

Checking for an existing connected app

To check a connected application is present:

1. Change your view to the Setup page.

   

2. Go to Platform Tools > Apps > Connected Apps > Manage Connected Apps:

   • Any connected Apps present in your environment are listed.

   • In this example I have a connected app named Apteco Connect Salesforce DS.

     

   • If a connected App is present, proceed to the retrieving Consumer Key and Consumer Secret section.

   • If there is no connected app, then proceed to the Creating a connected app section.

Creating a connected App

To create a connected app:

1. Go to Settings > External Client Apps.

2. Toggle on Allow creation of connected apps and click New Connected App.

   

3. A dialogue opens, use the option Create a Connected App and click Continue.

   

4. Fill in details for Connected App Name, API Name and Contact Email. The API Name automatically populates based on the Connected App Name entered.

   

5. Tick the option to Enable OAuth Settings:

   • Tick Enable for Device flow

   • The Callback URL is automatically populated with https://login.salesforce.com/services/oauth2/success

   • Add the OAuth scope Manage user data via APIs (api)

   • Tick Enable Client Credentials Flow

     

6. Assign a user to the Client Credentials flow:

   • Go to Apps > Connected Apps > Manage Connected Apps

   • Click Edit against the app you have created

   • In the Client Credentials Flow section, search for and add your user

     

Retrieving the consumer key and consumer secret

To retrieve your consumer key and secret:

1. Go to Platform Tools > Apps > App Manager.

2. Locate the Custom App from the list.

3. Expand the arrow dropdown on the right and select View.

   

4. In the API (Enable OAuth Settings) section, click Manage Consumer Details.

   

5. Proceed through the Identity Verification steps.

   

6. If successful, you’re redirected to the page where you'll see the buttons to copy the Consumer Key and Consumer Secret.

   

   Note: Once you’ve set up your connected app, you need to define the client credential flows to run as. This is located in Connected Apps OAuth Usage > Connected App > Policies.

You've now successfully set up and configured Salesforce as a data source. For more information on using Salesforce as a data source, see the following user documentation.