Creating a Salesforce Connector Project

The Connector Wizard helps to generate a Cloud Application Connector Project containing the necessary resources and objects than can be used in an integration Project. These steps take place from within the CIC Studio.

1. Select Cloud Connector from the main menu.

   

2. Set the vault entry that contains auth information for your Salesforce application. If you haven’t already created one, you can use the Add button. See Creating a Vault Entry for instructions.

   Note: A vault entry must exist in order to proceed.

3. Provide the name for the Cloud Connector Project to be created (and click Finish).

   Results:

   • Your Salesforce account will be authenticated, and required JavaScript and Salesforce resources are generated.
   • Within the Project, Packages are automatically created for each Salesforce operation (create, delete, query, update, and upsert).
   • Each package contains a Business Process (to call the operation), and two Schemas (to be used to create a Ruleset).

   The image below shows a typical Cloud Connector Project, with each package highlighted and expanded.

   

   Note that the Cloud Connector Wizard has also created request and response Connector Schemas (salesforce.objSchema).

   

   Each package also contains a configured Business Process to call the related Salesforce Operation.

   

   Note: Cleo recommends following your normal back up process with regards to this Project.

   Creating and defining a connected application

   The steps to create a connected application in Salesforce follow this basic process:

   1. In Salesforce, create an application in the Apps page (Connected Apps section). All required basic information must be provided.
   2. Enable OAuth settings. This controls how the app communicates with Salesforce. Additional fields should display when enabled.
   3. Enter the Callback URL. This is the call-back endpoint that Salesforce will call back during the OAuth process. This URL is typically the one that a user’s browser is redirected to after successful authentication.

      Note: This URL can be used: (https://login.salesforce.com/services/oauth2/success)

      • Access and manage your data (api)
      • Perform requests on your behalf at any time (refresh_token, offline_access)
      • Provide access to your data via the Web (web)OAuth Scopes refer to permissions given by the user running the connected app. The OAuth token name is in parenthesis. From the list of Available OAuth Scopes, select the following scopes (required):

      (The selected OAuth Scopes are shown below.)

      

      Note: Once complete, save your changes. Salesforce indicates a time range for this process to complete. Please wait for this to complete in Salesforce before continuing with the steps below.

   Define the connected application

   The steps to create a connected application in Salesforce follow this basic process.

   1. From the Connected Apps section of Salesforce, locate the app created in the task above.
   2. Click on the actual Connected App Name. This opens the application editor.

      

   3. From the API (Enable OAuth Settings) section, next to Consumer Secret, click the link to reveal the secret value. The Consumer Key and the Callback Url are also displayed.

      

   4. Copy these from Salesforce and enter them in the Studio's Cloud Connector Wizard, shown here. Proceed through the Wizard, which is described in step 4 of Creating a Salesforce Connector Project.

      

      Note: Salesforce indicates a time range for this process to complete. (Somewhere from 2 to 10 minutes); a “page not found” screen may display in the Cloud Connector Wizard if attempting to connect before the update completes.

      Please refer to your Salesforce Developer documentation on Connected Apps for more information.

   Configuring Salesforce to allow the Upsert Operation in Clarify

   When calling an upsert for Salesforce, there is some configuration required beforehand.

   The following information must be available.

   • An external ID defined for the object you’re going to upsert;
   • The actual name of the id.

   When configuring in the CIC Studio, the Field Label must be represented as the operation name. The example below, from Salesforce, shows both. Note the “__c” appended to the API Name. Salesforce uses this to identify all custom fields. This is required.

   

   These custom fields/objects come into play when using the Cloud Connector-related Schemas and Rulesets.

   Set the external ID in your Business Process

   When using a Business Process to launch an Upsert Business Process, the API Name must be set in the externalIdFieldName parameter in your Business Process. An example from the Studio is shown here.