Before creating and using a Connector, please review the following requirements and prerequisites.
Creating and defining a connected application
To use Open Authorization (OAuth) for your Salesforce integration, the following applies:
- To authenticate using OAuth, you must create a connected application to define your application’s OAuth settings for the Salesforce organization.
- Once you have created a connected app (in this case, CIC), it then requires authentication with Salesforce, by defining it as a new connected application within the Salesforce organization; this informs Salesforce of a new authentication entry point.
Once these two processes are complete, the resulting information will be used in the Studio-side of the integration.
- Consumer Key
- Consumer Secret
- Callback URL
Note: In order to obtain this information, you must create and define private, connected applications in Salesforce. See Creating and defining a connected application for additional steps.
Create a Vault Entry for your API Account Authentication
To create a Connector, you must first store the authorization information in an Authorization Vault, which provides a secure storage location for API keys, tokens, username and passwords, headers, and other info used to authorize calls to external Web Services. In order for a Cloud Connector to work, this vault entry must exist and be configured for the external application you wish to communicate with.
Follow the below steps to create a new Vault entry.
- From the Studio, go to File -> New -> Cloud Connector. This opens the Select Vault Entry screen.
Note: The vault entry can be created from both the Admin Console’s Settings | Auth Vault view, or directly from the Cloud Connector wizard (shown below). - Click on the + button to create a new vault entry. Alternatively, you can select an existing vault alias from the list.
- Provide the vault entry alias name and select the environment and hit Next.
- Select Salesforce from the list of Connectors and hit Next.
- Enter the authentication details and hit Next. The authentication details were provided when you created and defined a connected application - see the above steps.
To create a vault entry for the Salesforce application, the following authentication information will be required.
- Consumer Key
- Consumer Secret
- Callback URL
- Login URL
- The login URL is populated with login.salesforce.com by default.
However, as per official Salesforce documentation:- For a sandbox, login.salesforce.com must be replaced with test.salesforce.com.
- For an Experience Cloud site, login.salesforce.com must be replaced with the site’s URL, such Is MyDomainName.my.site.com/.well-known/openid-configuration. The URL must be HTTPS.
- Also, instanced URLs must not be used for Login URL.
- An example of an instanced URL is https://ap2.salesforce.com, which contains the instance ap2.
- If an instanced URL is currently being used for creating vaults, please use My Domain Login URL instead.
- To get your org’s My Domain login URL, from Setup, in the Quick Find box, enter My Domain, and then select My Domain. Find your My Domain login URL in the Current My Domain URL field in the My Domain Details section.
- The login URL is populated with login.salesforce.com by default.
For more information, always refer to the Salesforce developer documentation.
Specialized Licensing Required
The Application Connector requires a specialized server license. See your Customer Account Manager.
Technical Assumption
Effective use of a Connector assumes the following:
- You are familiar with the development and organization of your external application account.
- You know the particulars of your data and the external processes to manage it.
- You have a general understanding of how to create and share resources, and publish (deploy) Projects in CIC Studio.
Comments
0 comments
Please sign in to leave a comment.