Read data from Salesforce SOQL using SOQL and write data using the Salesforce Bulk API.

SalesforceReader Properties

  • query (Inline Only): Salesforce SOQL dialect query for accessing data.
  • password (Inline Only): The password+security token of the Salesforce user. Please use bearerToken authentication from the environment when possible.
  • useBearerToken (Inline Only): Authenticate to org using credentials from the environment. (Recommended)
  • username (Inline Only): The username of the Salesforce user. Please use bearerToken authentication from the environment when possible.
  • isSandbox (Inline Only): Specify if the org is a sandbox or production.
Example with Environment Credentials
-
    name: myConnectorName
    type: SalesforceReader
    properties:
      query:  SELECT id, name FROM Contact 
      useBearerToken:  true  # optional 
      isSandbox:  false 
    #schemaRef: schemaName # optional from "schemas:"
Example with Inline Credentials
-
    name: myConnectorName
    type: SalesforceReader
    properties:
      query: SELECT id, name FROM Contact 
      password: xxx  # optional 
      username: xxx  # optional 
      isSandbox: false 
    #schemaRef: schemaName # optional from "schemas:"

SalesforceWriter Properties

  • sfObject (Inline Only): The Salesforce object name
  • batchSize (Inline Only): The Bulk API batch size. Defaults 10,000. For HEDA recommend 200.
  • password (Inline Only): The password+security token of the Salesforce user. Please use bearerToken authentication from the environment when possible.
  • useBearerToken (Inline Only): Authenticate to org using credentials from the environment. (Recommended)
  • username (Inline Only): The username of the Salesforce user. Please use bearerToken authentication from the environment when possible.
  • isSandbox (Inline Only): Specify if the org is a sandbox or production.
Example with Environment Credentials
-
    name: myConnectorName
    type: SalesforceWriter
    properties:
      sfObject:  Myobject__c 
      batchSize:  10000  # optional 
      useBearerToken:  true  # optional 
      isSandbox:  false 

Example with Inline Credentials
-
    name: myConnectorName
    type: SalesforceWriter
    properties:
      sfObject:  Myobject__c 
      batchSize:  10000  # optional 
      password:  xxx  # optional 
      username:  xxx  # optional 
      isSandbox:  false