Salesforce

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the connection.

Username and password connection type

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Actions

This connector lets you perform insert, delete, update, and read operations on Salesforce data. To execute custom SQL queries, the connector provides the Execute custom query action.

To create a custom query, follow these steps:

1. Follow the detailed instructions to add a connectors task.
2. When you configure the connector task, in the type of action you want to perform, select Actions.
3. In the Action list, select Execute custom query, and then click Done.

   

4. Expand the Task input section, and then do the following:
   1. In the Timeout after field, enter the number of seconds to wait till the query executes.

      Default value: 180 seconds.

   2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.

      Default value: 25.

   3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.

      

   4. In the Script editor dialog, enter the SQL query and click Save.

      You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column:

      SELECT * FROM Employees where LastName=?

   5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

      

      To add query parameters, do the following:

      1. From the Type list, select the data type of the parameter.
      2. In the Value field, enter the value of the parameter.
      3. To add multiple parameters, click + Add Query Parameter.

This section lists the actions supported by the Salesforce connector. To understand how to configure the actions, see Action examples.

CreateJobv2 action

Use this action to create a Job.

Input parameters of the CreateJobV2 action

For example on how to configure the CreateJobV2 action, see Examples.

UploadJobDataV2 action

Use this action to upload a Job file in CSV format to Salesforce.

Input parameters of the UploadJobDataV2 action

For example on how to configure the UploadJobDataV2 action, see Examples.

CreateBatch action

This action creates a Salesforce batch.

Input parameters of the CreateBatch action

Output parameters of the CreateBatch action

For example on how to configure the CreateBatch action, see Examples.

CreateJob action

This action adds a Salesforce object entry.

Input parameters of the CreateJob action

Output parameters of the CreateJob action

For example on how to configure the CreateJob action, see Examples.

GetBatch action

This action gets information about a Salesforce batch.

Input parameters of the GetBatch action

Output parameters of the GetBatch action

For example on how to configure the GetBatch action, see Examples.

GetJob action

This action gets information about a Salesforce job.

Input parameters of the GetJob action

Output parameters of the GetJob action

For example on how to configure the GetJob action, see Examples.

UploadAttachment action

This action uploads an attachment and associates it with an entity in Salesforce.

Input parameters of the UploadAttachment action

Output parameters of the UploadAttachment action

For example on how to configure the UploadAttachment action, see Examples.

GetBatchResults action

This action gets the results of a Salesforce batch.

Input parameters of the GetBatchResults action

Output parameters of the GetBatchResults action

For example on how to configure the GetBatchResults action, see Examples.

Action examples

Example - CreateJobV2

This example creates a Job.

1. In the Configure connector task dialog, click Actions.
2. Select the CreateJobV2 action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then you must enter a value similar to the following in the Default Value field:

    {
     "ObjectName": "Contact",
     "Action": "insert"
    }

If the action is successful, the CREATEJOBV2 task's connectorOutputPayload response parameter will have a value similar to the following:

 
  [{
  "ID": "750dM000005HjdnQAC",
  "State": "Open",
  "JobType": null,
  "ContentUrl": "services/data/v43.0/jobs/ingest/750dM000005HjdnQAC/batches",
  "ContentType": "CSV",
  "CreatedDate": "2024-08-07T09:16:16.000+0000",
  "CreatedById": "005dM0000061WSFQA2",
  "ConcurrencyMode": "Parallel",
  "SystemModStamp": "2024-08-07T09:16:16.000+0000"
  }] 

Example - UploadJobDataV2

This example uploads a Job file to Salesforce.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadJobDataV2 action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

    {
     "Content":   "FirstName,LastName,Email,MobilePhone,External_Id__c\\nGinelle,Merioth,[email protected],851-555-8435,4d13cac0-2c11-48e9-891d-49ee9508a6c7\\nDalli,Tumilson,[email protected],881-555-6742,38bcb24b-247f-498b-9502-c98995a1e04b\\nRobbin,Purveys,[email protected],732-555-6909,35d96c7a-3856-4809-8c49-35ddb9fa7dd9\\nLothaire,Ivanchenkov,[email protected],144-555-1959,75f63f26-6f4a-406f-a9f4-807f4a8a7b51",
     "ContentUrl": "services/data/v43.0/jobs/ingest/750dM000005HjdnQAC/batches"
    }

If the action is successful, the UploadJobDataV2 task's connectorOutputPayload response parameter will have a value similar to the following:

 
  [{
  "Uploaded": "true"
  }]

Example - CreateBatch

1. In the Configure connector task dialog, click Actions.
2. Select the CreateBatch action, and then click Done.
3. In the Data Mapping section Open Data Mapping Editor and then enter a value similar to the following in the Input field:

   {
   "JobId": "750dL000007EipxQAC",
   "Aggregate": "\n    Walter\n    White\n  \n  \n    Rob\n    Brown\n  \n",
   "ContentType": "XML"
   }

If the action is successful, the CreateBatch task's connectorOutputPayload response parameter will have a value similar to the following:

 
[{
  "ID": "751dL000003ziC5QAI",
  "JobID": "750dL000007EipxQAC",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "CreatedDate": "2024-09-03T04:48:53.000Z",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "State": "Queued",
  "StateMessage": null,
  "SystemModstamp": "2024-09-03T04:48:53.000Z",
  "TotalProcessingTime": "0"
}]

Example - CreateJob

1. In the Configure connector task dialog, click Actions.
2. Select the CreateJob action, and then click Done.
3. In the Data Mapping section Open Data Mapping Editor and then enter a value similar to the following in the Input field:

   {
     "ObjectName": "Campaign",
     "Action": "insert"
   }

If the action is successful, the CreateJob task's connectorOutputPayload response parameter will have a value similar to the following:

 
 [{
  "ID": "750dL000007GgD7QAK",
  "JobID": "750dL000007GgD7QAK",
  "ObjectName": "Campaign",
  "Operation": "insert",
  "ApiVersion": "56.0",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "AssignmentRuleId": null,
  "ConcurrencyMode": "Parallel",
  "ContentType": "XML",
  "CreatedById": "005dL000007CalFQAS",
  "CreatedDate": "2024-09-03T05:31:41.000Z",
  "ExternalIdFieldName": null,
  "NumberBatchesCompleted": "0",
  "NumberBatchesQueued": "0",
  "NumberBatchesFailed": "0",
  "NumberBatchesInProgress": "0",
  "NumberBatchesTotal": "0",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "NumberRetries": "0",
  "State": "Open",
  "SystemModStamp": "2024-09-03T05:31:41.000Z",
  "TotalProcessingTime": "0"
}]

Example - GetBatch

1. In the Configure connector task dialog, click Actions.
2. Select the GetBatch action, and then click Done.
3. In the Data Mapping section Open Data Mapping Editor and then enter a value similar to the following in the Input field:

   {
     "BatchId": "751dL000003yKlJQAU",
     "JobId": "750dL000007EipxQAC"
   }

If the action is successful, the GetBatch task's connectorOutputPayload response parameter will have a value similar to the following:

 
[{
  "ID": "751dL000003yKlJQAU",
  "JobID": "750dL000007EipxQAC",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "CreatedDate": "2024-09-02T11:44:15.000Z",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "State": "Failed",
  "StateMessage": "InvalidBatch : Failed to parse XML. Unexpected XML element 'sObject' found at  START_TAG seen ... @1:9 it should be 'sObjects'",
  "SystemModstamp": "2024-09-02T11:44:15.000Z",
  "TotalProcessingTime": "0"
}]

Example - GetJob

1. In the Configure connector task dialog, click Actions.
2. Select the GetJob action, and then click Done.
3. In the Data Mapping section Open Data Mapping Editor and then enter a value similar to the following in the Input field:

   {
     "JobId": "750dL000007EipxQAC"
   } 

If the action is successful, the GetJob task's connectorOutputPayload response parameter will have a value similar to the following:

 
[{
  "ID": "750dL000007EipxQAC",
  "JobID": "750dL000007EipxQAC",
  "ObjectName": "Campaign",
  "Operation": "insert",
  "ApiVersion": "56.0",
  "ApexProcessingTime": "0",
  "ApiActiveProcessingTime": "0",
  "AssignmentRuleId": null,
  "ConcurrencyMode": "Parallel",
  "ContentType": "XML",
  "CreatedById": "005dL000007CalFQAS",
  "CreatedDate": "2024-09-02T11:17:42.000Z",
  "ExternalIdFieldName": null,
  "NumberBatchesCompleted": "0",
  "NumberBatchesQueued": "0",
  "NumberBatchesFailed": "2",
  "NumberBatchesInProgress": "0",
  "NumberBatchesTotal": "2",
  "NumberRecordsFailed": "0",
  "NumberRecordsProcessed": "0",
  "NumberRetries": "0",
  "State": "Open",
  "SystemModStamp": "2024-09-02T11:17:42.000Z",
  "TotalProcessingTime": "0"
}]

Example - UploadAttachment

1. In the Configure connector task dialog, click Actions.
2. Select the UploadAttachment action, and then click Done.
3. In the Data Mapping section Open Data Mapping Editor and then enter a value similar to the following in the Input field:

   {
     "ObjectId": "001dL00000SC6j7QAD",
     "FileName": "My files/salesforce/con.csv",
     "Base64Data": "Y29ubmVjdG9ycyBpcyBiYWNr"
   }

If the action is successful, the UploadAttachment task's connectorOutputPayload response parameter will have a value similar to the following:

 
[{
  "Id": "00PdL000000EJUDUA4"
}]

Example - GetBatchResults

1. In the Configure connector task dialog, click Actions.
2. Select the GetBatchResults action, and then click Done.
3. In the Data Mapping section Open Data Mapping Editor and then enter a value similar to the following in the Input field:

   {
     "BatchId": "751dL000004D17FQAS",
     "JobId": "750dL000007XKUhQAO",
     "ContentType": "XML"
   }

If the action is successful, the GetBatchResults task's connectorOutputPayload response parameter will have a value similar to the following:

 
[{
  "ID": null,
  "Created": "false",
  "Success": "false",
  "Errors_Fields": "LastName",
  "Errors_Message": "Account: bad field names on insert/update call: FirstName, LastName",
  "Errors_StatusCode": "INVALID_FIELD_FOR_INSERT_UPDATE"
}, {
  "ID": null,
  "Created": "false",
  "Success": "false",
  "Errors_Fields": "LastName",
  "Errors_Message": "Account: bad field names on insert/update call: FirstName, LastName",
  "Errors_StatusCode": "INVALID_FIELD_FOR_INSERT_UPDATE"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - Create an attachment

Entity create attachment only creates an attachment with no content file in it. In order to add a file we need to perform Upload Attachment action by giving a file context in the input.

1. In the Configure connector task dialog, click Entities.
2. Select Attachment from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

   {
     "Name": "New Attachment",
     "Description": "New created attachment",
     "ParentId": "001dL00000SC6j7QAD",
     "Body": "Body"
   }
   

5. Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
     "Id": "00PdL000000EJKXUA4"
   }
   

Example - Update an attachment

Entity update attachment only updates the attachment name or description. In order to add a file we need to perform Upload Attachment action by giving a file context in the input.

1. In the Configure connector task dialog, click Entities.
2. Select Attachment from the Entity list.
3. Select the Update operation, and then click Done.
4. Set the entity ID to Update an Attachment. To set the entity ID, in the Data mapper section of the Tasks, click EntityID and then enter 00PdL000000EJKXUA4 in the given field.
5. In the Data mapper section of the Task click OpenDataMapping editor and then enter a value similar to the following in the field:

   {
     "Name": "New Attachment",
     "Description": "New updated attachment",
     "Body": "Body"
   }
   

Alternately, instead of specifying the entityId, you can also set the filterClause to 00PdL000000EJKXUA4.

6. Running this example, returns a response similar to the following in the Connector task's connectorOutputPayload output variable:

   {
     "Id": "00PdL000000EJKXUA4"
   }