A Salesforce connection is configured using the Salesforce connector to establish access with a specific Salesforce instance. Once a connection is established, you can configure one or more Salesforce activities associated with that connection to use as a source or target within an operation. In addition, the Salesforce connection can be used within scripts.
NOTE: Cloud Studio supports Salesforce API version 47 from the Salesforce Winter '20 release.
Creating or Editing a Salesforce Connection
To configure a new Salesforce connection, within the Connectors filter, click the Salesforce connector block:
To configure an existing Salesforce connection, within the Endpoints filter, double-click the Salesforce connection block:
This will open a configuration screen for the Salesforce connection, covered next.
Configuring a Salesforce Connection
Configuration of a Salesforce connection includes these fields:
- Endpoint Name: Enter a name to use to identify the Salesforce connection. The name must be unique for each Salesforce connection and must not contain forward slashes (
/) or colons (
:). As a specific connection and its activities are referred to as an endpoint, this name is also used to identify the Salesforce endpoint.
- Server Host: Enter the URL of the server. If you are using a production instance, leave the default URL as https://login.salesforce.com. If you are using a sandbox instance, select the Sandbox checkbox below.
- Sandbox: If you are using a Salesforce sandbox instance, select this checkbox to toggle the Server Host field above to https://test.salesforce.com.
- User Name & Password: Enter the username and password associated with the Salesforce account you want to use.
Security Token: If required, enter the security token associated with the Salesforce account.TIP: For more information, see Salesforce documentation for Reset Your Security Token.
- Test: Click this button to verify the connection to the Salesforce instance with the provided credentials.
- Save Changes: Click this button to save and close the connection configuration.
- Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.
- Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal).
After configuring a Salesforce connection, you can configure one or more Salesforce activities associated with that connection to use as a source or target within an operation, or you can use the Salesforce connection within a script as described below.
Salesforce activities interact with the Salesforce connection to act as sources (providing data within an operation) or targets (receiving data within an operation). For information, see these activities:
Standard Salesforce Activities
- Query: Queries data from a Salesforce connection and is used as a source in an operation.
- Insert: Inserts new data in a Salesforce connection and is used as a target in an operation.
- Update: Updates existing data in a Salesforce connection and is used as a target in an operation.
- Upsert: Both updates existing data and inserts new data in a Salesforce connection and is used as a target in an operation.
- Delete: Deletes data in a Salesforce connection and is used as a target in an operation.
Bulk Salesforce Activities
Salesforce bulk activities are faster and scale better than non-bulk Salesforce activities, but should be used only if you do not need to use a transformation to change data prior to reaching the target.
- Bulk Query: Queries a large number of records from a Salesforce connection and is used as a source in an operation.
- Bulk Insert: Inserts a large number of new records in a Salesforce connection and is used as a target in an operation.
- Bulk Update: Updates a large number of existing records in a Salesforce connection and is used as a target in an operation.
- Bulk Upsert: Both updates a large number of existing records and inserts a large number of new records in a Salesforce connection and is used as a target in an operation.
- Bulk Delete: Deletes a large number of records form a Salesforce connection and is used as a target in an operation. Deleted records are stored in the Salesforce Recycle Bin prior to being permanently deleted.
- Bulk Hard Delete: Hard deletes a large number of records form a Salesforce connection and is used as a target in an operation. Hard deleted records automatically become eligible for deletion.
Using Salesforce Connections in Scripts
Salesforce connections can be referenced in a script using certain script functions that use a
salesforceOrg as a parameter. For example:
To add a Salesforce connection to a script to be referenced by one of these functions, drag the configured endpoint from the Endpoints tab of the script component palette to the script. Or, if you already know the function you want to use, add it from the Functions tab first; then position the cursor after the opening parenthesis of the function and press
Control+Space to display a list of autocomplete suggestions. Select a connection to insert the connection reference into the script.
Last updated: Dec 16, 2019
- No labels