This guide takes you through setting up Salesforce for use with Cyclr.
It applies to any Cyclr Connectors that use the common “Salesforce authentication”, such as these:
- Salesforce
- Salesforce Marketing Cloud
- Salesforce Service Cloud
You will require a Salesforce account to create what’s called a Connected App.
If you don’t have a Salesforce account, you can register for a free Salesforce Developer Edition account through the Salesforce website.
Warning: You can use any Salesforce account to create your Connected App, but note that Sandbox accounts destroy Connected Apps when they are refreshed.
Salesforce’s own documentation on creating Connected Apps can be found here.
Setup & Authentication
Remote Setup
The process of creating a Connected App within Salesforce varies slightly depending on whether you use Salesforce Classic or Lightning Experience.
Salesforce Classic
- Log into your Salesforce account.
- Select Setup in the top right of the page.
- From the menu on the left, go to Build > Create > Apps.
- From the Connected Apps table, select New.
Lightning Experience
- Log into your Salesforce account.
- Select Setup in the top right of the page.
- From the menu on the left, go to Platform Tools > Apps > App Manager.
- Select New Connected App.
Enter basic information
Whether you are using Salesforce Classic or Lightning Experience, when the New Connected App screen is shown, complete the form as follows:
- Connected App Name: enter a name for your application
- API Name: this will default to the same value as your Connected App Name
- Contact Email: your email address
API (Enable OAuth Settings)
Select the Enable OAuth Settings box to display further options.
- Callback URL: set this to your Cyclr Partner Console’s Callback URL.
- Selected OAuth Scopes: you need to add the following 2 Scopes to enable Cyclr to use your App:
- Full access (full), or if you know which data you wish to restrict, you can select from this list.
- Perform requests on your behalf at any time (
refresh_token, offline_access).
- Require Secret for Refresh Token Flow: make sure to clear this checkbox.
Your OAuth settings should look like the following image:
Note: To enable increased security between Cyclr and Salesforce when authenticating, enable the Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows on your Connected App in Salesforce.
That appears as a tickbox beneath the Selected OAuth Scopes settings – see screenshot above.
Obtain authentication values
When you save the settings, you need to request access to view the consumer key and secret immediately. To request access, go to the API (Enable OAuth Settings) section and select the Manage Consumer Details button. Salesforce then emails you with a verification code that you can use to reveal the authentication values.
Make a note of the Consumer Key and Consumer Secret values as you’ll need them in order to authenticate the connector with Cyclr.
Warning: It can take up to 10 minutes for a new Connected App to be functional in Salesforce, or for changes to be updated and active.
During this time you may encounter errors when installing the Connector similar to this:
Expired access/refresh token errors
Salesforce only allows up to five unique access/refresh token pairs to be issued for each user in a Connected App. Older tokens will be automatically revoked by Salesforce. More information.
Cyclr Partner Console Setup
Having created a Connected App within Salesforce to obtain a Consumer Key and a Consumer Secret, go into your Cyclr Partner Console:
- Go to Connectors > Application Connector Library.
- Use the search box to find the Salesforce connector.
- Select the Setup Required icon.
- Enter the below values:
| Property | Description |
|---|---|
| Client ID | The Consumer Key from your Salesforce Connected app. |
| Client Secret | The Consumer Secret from your Salesforce Connected app. |
| Is Sandbox? | Whether the Salesforce accounts to be accessed by the Connector are sandbox accounts or production accounts. * true – for sandbox accounts * false – for production accounts (typical setting) Can be overridden on a specific Account Connector using the Cyclr API. Contact Cyclr Support for more information. |
| Disable Adding Options to Custom Fields? | Whether to remove picklist values from custom fields. * true – removes values from picklists for custom fields. * false – keep values for picklists for custom fields.Defaults to ‘false’. |
- Select Save Changes.
Note: If you leave these values blank, they must be provided each time a Salesforce connector is installed.
Cyclr Connector Installation
When installing a Salesforce connector, the user will be taken to a Salesforce login page to sign in and give consent for your Connected App to access their data.