Contact Free trial Login

Salesforce Connector 9.11 Reference - Mule 4

Support Category: Select

Configurations


Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

Fetch All Apex SOAP Metadata

Boolean

If checked then DataSense is performed for all Apex classes in the organization, otherwise it is performed only for the classes in Apex class names. If the organization contains a lot of Apex classes this might cause ConnectionTimeout during DataSense. Default value is false.

false

Fetch All Apex REST Metadata

Boolean

If checked then DataSense will be performed for all Apex classes in the organization else DataSense will be performed only for the classes in Apex class names. If the organization contains many Apex classes this could cause ConnectionTimeout during DataSense. Default value is false.

false

Apex Class Names

Array of String

List of Apex class names involved in metadata retrieval via DataSense.

Connection Types

Username Password (Deprecated)
Parameters
Name Type Description Default Value Required

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user

x

Security Token

String

User’s security token. It can be omitted if your IP has been whitelisted on Salesforce

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.

https://login.salesforce.com/services/Soap/u/47.0

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Pooling Profile

Characteristics of the connection pool

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Session Id

String

This value may be used to specify and identify an active Salesforce session

Service Endpoint

String

Specifies the service endpoint. This value will only be used if the sessionId configuration property is used.

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Basic Username Password
Parameters
Name Type Description Default Value Required

Advanced Reconnection Params

Used to set the time in seconds the connector will hit Salesforce api to maintain the session and Initial delay in seconds the connector will wait until making the first keep-alive request

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user

x

Security Token

String

User’s security token. It can be omitted if your IP has been whitelisted on Salesforce

Authorization URL

String

Web service URL responsible for user authentication. This is the URL for the endpoint that is configured to handle SOAP authentication requests.

https://login.salesforce.com/services/Soap/u/47.0

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Session Id

String

This value may be used to specify and identify an active Salesforce session

Service Endpoint

String

Specifies the service endpoint. This value will only be used if the sessionId configuration property is used.

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

OAuth JWT
Parameters
Name Type Description Default Value Required

Advanced Reconnection Params

Used to set the time in seconds the connector will hit Salesforce api to maintain the session and the initial delay in seconds the connector will wait until making the first keep-alive request

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Consumer Key

String

Consumer key for Salesforce connected app

x

Key Store

String

Path to key store used to sign data during authentication

x

Store Password

String

Password of key store

x

Principal

String

Username of desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

OAuth SAML
Parameters
Name Type Description Default Value Required

Advanced Reconnection Params

Used to set the time in seconds the connector will hit Salesforce api to maintain the session and the initial delay in seconds the connector will wait until making the first keep-alive request

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Consumer Key

String

Consumer key for Salesforce connected app

x

Key Store

String

Path to key store used to sign data during authentication

x

Store Password

String

Password of key store

x

Principal

String

Username of desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

OAuth Username Password
Parameters
Name Type Description Default Value Required

Advanced Reconnection Params

Used to set the time in seconds the connector will hit Salesforce api to maintain the session and the initial delay in seconds the connector will wait until making the first keep-alive request

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Consumer Key

String

Consumer key for Salesforce connected app

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user

x

Security Token

String

User’s security token. It can be omitted if your IP has been whitelisted on Salesforce

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

OAuth v2.0
Parameters
Name Type Description Default Value Required

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Display

Enumeration, one of:

  • PAGE

  • POPUP

  • TOUCH

Tailors the login page to the user’s device type. Can be PAGE, POPUP or TOUCH

x

Immediate

Enumeration, one of:

  • TRUE

  • FALSE

Set to avoid interacting with the user, in case of a previous login or to prompt the user for login and approval

FALSE

Prompt

Enumeration, one of:

  • LOGIN

  • CONSENT

Specifies how the authorization server prompts the user for reauthentication and reapproval

LOGIN

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Pooling Profile

Characteristics of the connection pool

Consumer Key

String

The OAuth consumerKey as registered with the service provider

x

Consumer Secret

String

The OAuth consumerSecret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL

https://login.salesforce.com/services/oauth2/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL

https://login.salesforce.com/services/oauth2/token

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it will default to those in the annotation

Resource Owner Id

String

The resourceOwnerId which each component should use if it doesn’t reference otherwise.

Before

String

The name of a flow to be executed right before starting the OAuth dance

After

String

The name of a flow to be executed right after an accessToken has been received

Listener Config

String

A reference to a <http:listener-config /> to be used to create the listener that will catch the access token callback endpoint.

x

Callback Path

String

The path of the access token callback endpoint

x

Authorize Path

String

The path of the local http endpoint which triggers the OAuth dance

x

External Callback Url

String

If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback

Object Store

String

A reference to the object store that should be used to store each resource owner ID’s data. If not specified, runtime will automatically provision the default one.

OAuth JWT (Deprecated)
Parameters
Name Type Description Default Value Required

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Consumer Key

String

Consumer key for Salesforce connected app

x

Key Store

String

Path to key store used to sign data during authentication

x

Store Password

String

Password of key store

x

Principal

String

Username of desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Pooling Profile

Characteristics of the connection pool

OAuth SAML (Deprecated)
Parameters
Name Type Description Default Value Required

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Consumer Key

String

Consumer key for Salesforce connected app

x

Key Store

String

Path to key store used to sign data during authentication

x

Store Password

String

Password of key store

x

Principal

String

Username of desired Salesforce user to take action on behalf of.

x

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Pooling Profile

Characteristics of the connection pool

OAuth Username Password (Deprecated)
Parameters
Name Type Description Default Value Required

Host

String

Hostname of the proxy. If this property is not set then no proxy will be used, otherwise a proxy will be used, but a proxy host must be specified.

Port

Number

Port of the proxy. If host is set then this property must be set and cannot be a negative number.

Username

String

Username used to authenticate against the proxy. If this property is not set then no authentication is going to be used against the proxy, otherwise this value must be specified.

Password

String

Password used to authenticate against the proxy.

Mutual TLS Keystore Path

String

Keystore file encoded in JKS format

Mutual TLS Keystore Password

String

Password for accessing the Keystore

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

Connection Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

Assignment Rule Id

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule can be active or inactive. Can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned.

Client Id

String

Client ID for partners

Time Object Store

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

Batch Sobject Max Depth

Number

Creating a batch will create SObjects using this value for the MAX_DEPTH check.

5

Api Version

Number

The API version used

47.0

Disable session invalidation

Boolean

If set to true then the session will not be invalidated when the connection pool deems the connection is no longer needed. This could be useful if you use the same username from several applications and get the same session from Salesforce. Default value is false.

false

Allow field truncation support

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier. Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

Use default rule

Boolean

If true, the default (active) assignment rule for a Case or Lead is used. If specified, do not specify an assignmentRuleId. If true for an Account, all territory assignment rules are applied, and if false, no territory assignment rules are applied. Default value is false.

false

Can Clear Fields by Updating Field value to Null

Boolean

If false, then to clear a field its name must be provided in an update request in the fieldsToNull field, otherwise, for clearing a field it can also be simply added to the request with the value null. Default value is false.

false

Consumer Key

String

Consumer key for Salesforce connected app

x

Consumer Secret

String

Your application’s client secret (consumer secret in Remote Access Detail).

x

Username

String

Username used to initialize the session

x

Password

String

Password used to authenticate the user

x

Security Token

String

User’s security token. It can be omitted if your IP has been whitelisted on Salesforce

Token Endpoint

String

URL pointing to the server responsible for providing the authentication token. According to Salesforce it should be https://login.salesforce.com/services/oauth2/token, or, if implementing for a community, https://acme.force.com/customers/services/oauth2/token (where acme.force.com/customers is your community URL).

https://login.salesforce.com/services/oauth2/token

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Pooling Profile

Characteristics of the connection pool

Operations

Abort Job

<salesforce:abort-job>

Aborts an open Job given its ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The Job ID identifying the Job to be aborted.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Abort Job V2

<salesforce:abort-job-v2>

Aborts an ongoing Bulk API V2 Job. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Abort Query Job

<salesforce:abort-query-job>

Aborts a query job, based on its id.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Job Id

String

The id of the query job

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Batch Info

<salesforce:batch-info>

Access latest BatchInfo of a submitted BatchInfo. Allows tracking of the execution status.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch info

The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored

#[payload]

Content type

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

Content type used at job creation. If not provided default value used is ContentType.XML.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Batch Info List

<salesforce:batch-info-list>

Get information about all batches in a job.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job Id

String

id of the job that you want to retrieve batch information for

#[payload]

Content type

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

Content type used at job creation. If not provided default value used is ContentType.XML.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Batch Info

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Batch Result

<salesforce:batch-result>

Access com.sforce.async.BatchResult of a submitted BatchInfo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch To Retrieve

The com.sforce.async.BatchInfo being monitored

#[payload]

Content type

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

Content type used at job creation. If not provided default value used is ContentType.XML.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Batch Result Stream

<salesforce:batch-result-stream>

Access com.sforce.async.BatchResult of a submitted BatchInfo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch To Retrieve

The com.sforce.async.BatchInfo being monitored

#[payload]

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Bulk Info

<salesforce:bulk-info>

Access latest BatchInfo of a submitted BatchInfo. Allows tracking of the execution status.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch info

The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored

#[payload]

Content type

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

Content type used at job creation. If not provided default value used is ContentType.XML.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Bulk Info List

<salesforce:bulk-info-list>

Get information about all batches in a job.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job Id

String

id of the job that you want to retrieve batch information for

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Bulk Result

<salesforce:bulk-result>

Access com.sforce.async.BatchResult of a submitted BatchInfo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch To Retrieve

The com.sforce.async.BatchInfo being monitored

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Bulk Result Stream

<salesforce:bulk-result-stream>

Access com.sforce.async.BatchResult of a submitted BatchInfo.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch To Retrieve

The com.sforce.async.BatchInfo being monitored

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Change Own Password

<salesforce:change-own-password>

Changes the password of the user linked to the connector’s configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Old Password

String

The old password to be changed

x

New Password

String

The new password to be changed

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Close Job

<salesforce:close-job>

Closes an open Job given its ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The Job ID identifying the Job to be closed.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Convert Lead

<salesforce:convert-lead>

Converts a Lead into an Account, Contact, or (optionally) an Opportunity.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Lead Convert Request

Information needed for lead conversion

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create

<salesforce:create>

Adds one or more new records to your organization’s data. When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce. Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2019-12-13" it will be sent to Salesforce as a string and operation will be rejected on the basis that CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object, you can do so using Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2019-12-13")].

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of record to be added

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Batch

<salesforce:create-batch>

Creates a Batch using the given objects within the specified job. The job can be of XML, JSON, or CSV type. This call uses the Bulk API. The operation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

The com.sforce.async.JobInfo in which the batch will be created. Possible values are CSV, JSON, XML, ZIP_CSV, ZIP_JSON, ZIP_XML

x

sObjects

Array of Object

A list of one or more sObject objects. This parameter defaults to payload content. The com.sforce.async.JobInfo in which the batch will be created. The Job can be of XML, JSON or CSV type.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Batch For Query

<salesforce:create-batch-for-query>

Creates a Batch using the given query. This call uses the Bulk API. The operation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

The JobInfo in which the batch will be created.

x

Query

String

The query to be executed.

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Batch Stream

<salesforce:create-batch-stream>

Creates a Batch using the given stream within the specified Job. The stream can have a CSV, JSON, XML, ZIP_CSV, ZIP_JSON, or ZIP_XML format. This call uses the Bulk API. The operation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

The JobInfo in which the batch will be created. This parameter defaults to payload content.

x

Stream

Binary

A stream containing the data. The stream can have a CSV, JSON, XML, ZIP_CSV, ZIP_JSON, ZIP_XML format.

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Bulk

<salesforce:create-bulk>

Adds one or more new records to your organization’s data. This call uses the Bulk API. The creation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to create

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Bulk For Query

<salesforce:create-bulk-for-query>

Creates a Batch using the given query. This call uses the Bulk API. The operation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

The JobInfo in which the batch will be created.

x

Query

String

The query to be executed.

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Job

<salesforce:create-job>

Creates a Job to perform one or more batches through Bulk API Operations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

Enumeration, one of:

  • insert

  • upsert

  • update

  • delete

  • hardDelete

  • query

The OperationEnum that will be executed by the job.

x

Type

String

The type of Salesforce object that the job will process.

x

Create Job Request

containing: externalIdFieldName Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects (only required for Upsert Operations). contentType The Content Type for this Job results. When specifying a content type different from XML for a query type use queryResultStream(BatchInfo) method to retrieve results. concurrencyMode The concurrency mode of the job, either Parallel or Serial.

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Job Bulk V2

<salesforce:create-job-bulk-v2>

Creates a Bulk API v2 job containing the data needed to be inserted, updated, deleted or upserted. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

Type of object to work with.

x

sObjects

Binary

An array of one or more sObject objects.

#[payload]

Operation

Enumeration, one of:

  • insert

  • update

  • delete

  • upsert

The operation to be executed.

x

Line Ending

String

The lineEnding of CSV data.

LF

Column Delimiter

String

The columnDelimiter of CSV data.

COMMA

Content type(Deprecated)

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

The only value allowed is CSV. If any other value is selected an exception will be thrown

CSV

External Id Field Name

String

Required for upsert operations

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Metadata

<salesforce:create-metadata>

Create metadata: Adds one or more new metadata components to your organization

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The Metadata Type to be created

x

Metadata Objects

Array of Object

A List of Map<String, Object> representing the metadata to be created

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Multiple

<salesforce:create-multiple>

Adds one or more new records to your organization’s data. When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce. Take the CloseDate of an Opportunity as an example, if you set that field to a string of value 2019-12-13 it will be sent to Salesforce as a string and operation will be rejected on the basis that CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object, you can do so using Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2019-12-13")].

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of record to be added

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Multiple Batch

<salesforce:create-multiple-batch>

Creates a Batch using the given objects within the specified job. The job can be of XML, JSON, or CSV type. This call uses the Bulk API. The operation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

The com.sforce.async.JobInfo in which the batch will be created. The job can be of XML, JSON, or CSV type.

x

sObjects

Array of Object

A list of one or more sObject objects. This parameter defaults to payload content. The com.sforce.async.JobInfo in which the batch will be created. The Job can be of XML, JSON or CSV type.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Multiple Batch Stream

<salesforce:create-multiple-batch-stream>

Creates a Batch using the given stream within the specified Job. The stream can have a CSV, JSON, XML, ZIP_CSV, ZIP_JSON, or ZIP_XML format. This call uses the Bulk API. The operation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job info

The JobInfo in which the batch is created. This parameter defaults to payload content.

x

Stream

Binary

A stream containing the data. The stream can have a CSV, JSON, XML, ZIP_CSV, ZIP_JSON, or ZIP_XML format.

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Multiple Bulk

<salesforce:create-multiple-bulk>

Adds one or more new records to your organization’s data. This call uses the Bulk API. The creation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to create

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Query Job

<salesforce:create-query-job>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query

String

x

Operation

Enumeration, one of:

  • QUERY

  • QUERY_ALL

QUERY

Object

String

Column Delimiter

String

COMMA

Line Ending

String

CRLF

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Create Single

<salesforce:create-single>

Adds one new record to your organization’s data. When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce. Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2019-12-13" it will be sent to Salesforce as a string and operation will be rejected on the basis that CloseDate is not of the expected type. The proper way to actually map it is to generate a Java Date object, you can do so using Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2019-12-13")].

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of record to be added

x

Record

Object

record to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Delete

<salesforce:delete>

Deletes one or more records from your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Delete Job V2

<salesforce:delete-job-v2>

Deletes a Bulk API V2 Job. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Delete Metadata

<salesforce:delete-metadata>

Deletes one or more metadata components from your organization, given the object(s) API Name(s)

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to delete

x

Full Names

Array of String

Full names of the components to delete

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Delete Multiple

<salesforce:delete-multiple>

Deletes one or more records from your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Records To Delete Ids

Array of String

Array of one or more IDs associated with the objects to delete.

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Delete Query Job

<salesforce:delete-query-job>

Deletes a query job based on its id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Job Id

String

The id of the query job

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Deploy Metadata

<salesforce:deploy-metadata>

Deploy. File-based call to deploy XML components. Use this call to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Deploy Metadata Request

Data needed by this operation

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Describe Global

<salesforce:describe-global>

Retrieves a list of available objects for your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Describe Metadata

<salesforce:describe-metadata>

Describe metadata: This call retrieves the metadata which describes your organization. This information includes Apex classes and triggers, custom objects, custom fields on standard objects, tab sets that define an app, and many other components

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Describe SObject

<salesforce:describe-sobject>

Describes metadata (field list and object properties) for the specified object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object. The specified value must be a valid object for your organization. For a complete list of objects, see Salesforce Standard Objects.

x

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Find Duplicates

<salesforce:find-duplicates>

Performs rule-based searches for duplicate records. The input is an array of Salesforce objects, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the values to do the search. The output identifies the detected duplicates for each sObject.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Type of sobjects to find duplicates for

x

Criteria

Array of Object

List of SObject used as a criterion when searching for duplicates

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Find Duplicates By Ids

<salesforce:find-duplicates-by-ids>

Performs rule-based searches for duplicate records. The input is an array of IDs, each of which specifies the records for which to search for duplicates. The output identifies the detected duplicates for each object that supplies the duplicate rules. This operation applies the rules to the record IDs to do the search. The output identifies the detected duplicates for each ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

List of object ids used when searching for duplicates

Array of String

List of id’s to find duplicates.

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get All Jobs V2

<salesforce:get-all-jobs-v2>

Retrieves all Bulk Jobs This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

The desired concurrency mode.

Parallel

Is Pk Chunking Enabled

Boolean

Use the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job.

false

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get All Query Jobs

<salesforce:get-all-query-jobs>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Is Pk Chunking Enabled

Boolean

true

Job Type

Enumeration, one of:

  • BigObjectIngest

  • Classic

  • V2Query

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Parallel

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Bulk Job State Bulk V2

<salesforce:get-bulk-job-state-bulk-v2>

Gets the actual state of a V2 Bulk Job. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Deleted

<salesforce:get-deleted>

Retrieves the list of individual records that have been deleted since a time in the past specified in minutes before now.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Duration

Number

The amount of time, counted from now to some point in the past, for which to return records.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Deleted Range

<salesforce:get-deleted-range>

Retrieves the list of individual records that have been deleted since a time in the past specified in minutes before now.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Start

DateTime

Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

End

DateTime

Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If it is not provided, the current server time will be used.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Query Job Info

<salesforce:get-query-job-info>

Returns the details of a query job based on its id

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Job Id

String

The ID of the query job

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Query Job Results

<salesforce:get-query-job-results>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Job Id

String

x

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:UNKNOWN

Get Server Timestamp

<salesforce:get-server-timestamp>

Retrieves the current system timestamp (Coordinated Universal Time (UTC) time zone) from the API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

DateTime

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Session ID

<salesforce:get-session-id>

Retrieves the Session Id of the current session.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Updated

<salesforce:get-updated>

Retrieves the list of individual records that have been created/updated within the given time frame for the specified object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Duration

Number

The amount of time in minutes, counted from now to some point in the past, to specify the range you want updated records from.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Updated Objects

<salesforce:get-updated-objects>

Retrieves the list of records that have been updated between the last time this method was called and the current server timestamp. Salesforce API ignores the seconds portion of the specified dates so subsequent calls of this operation should take place at a rate of at least one minute, otherwise the operation will not return any results for the subsequent calls.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Initial Time Window

Number

Time window (in minutes) used to calculate the start time (in time range) the first time this operation is called. For example, if Initial Time Window equals 2, the start time is the current time (now) minus 2 minutes, and the range to retrieve the updated object is (now - 2 minutes; now). After the first call, the start time is calculated from the object store getting the last time this operation was executed.

x

Fields

Array of String

The fields to retrieve for the updated objects

x

Update Headers

Salesforce Headers More Info

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get Updated Range

<salesforce:get-updated-range>

Retrieves the list of individual records that have been created/updated within the given time frame for the specified object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Object type. The specified value must be a valid object for your organization.

x

Start

DateTime

Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC).

End

DateTime

Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If it is not provided, the current server time will be used.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Get User Info

<salesforce:get-user-info>

Retrieves personal information for the user associated with the current session.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Hard Delete Bulk

<salesforce:hard-delete-bulk>

Deletes one or more records from your organization’s data. The deleted records are not stored in the Recycle Bin. Instead, they become immediately eligible for deletion. This call uses the Bulk API. The deletion will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to delete

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Hard Delete Multiple

<salesforce:hard-delete-multiple>

Deletes one or more records from your organization’s data. The deleted records are not stored in the Recycle Bin. Instead, they become immediately eligible for deletion. This call uses the Bulk API. The deletion will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to delete

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Invoke Apex Rest Method

<salesforce:invoke-apex-rest-method>

Invokes any operation from an Apex class that is exposed as REST web service

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request

Object

object containing request information

#[payload]

Apex Class Name

String

x

Apex Class Method Name

String

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Invoke Apex Soap Method

<salesforce:invoke-apex-soap-method>

Invokes any operation from an Apex class that is exposed as SOAP web service

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Input

Binary

Input Stream with an XML containing information about the method to be invoked and its parameters. The XML must adhere to the WSDL standards.

#[payload]

Apex Class Name

String

x

Apex Class Method Name

String

x

Apex Headers

Map<String, Object>

A list of headers to be sent along with the apex call as described in the Salesforce documentation. See: https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_api.htm.

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Job Info

<salesforce:job-info>

Access latest JobInfo of a submitted JobInfo id. Allows to track execution status.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

the Job ID of the Job being monitored

x

Content type

Enumeration, one of:

  • XML

  • CSV

  • JSON

  • ZIP_XML

  • ZIP_CSV

  • ZIP_JSON

Content type used at job creation. If not provided default value used is ContentType.XML.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

List Metadata

<salesforce:list-metadata>

Retrieves property information about metadata components in your organization

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type used as criteria when querying for information

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of File Properties

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Merge

<salesforce:merge>

Merge up to three records into one.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Records To Merge Ids

Array of String

A list of ids of the objects to be merged

#[payload]

Type

String

type of record to be merged

x

Master Record

Object

Must provide the ID of the object that other records will be merged into. Optionally, provide the fields to be updated and their values.

x

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Non Paginated Query

<salesforce:non-paginated-query>

Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are String and, if necessary, you can convert them to the apropiate type using for example Weave and Transform Message

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders within salesforceQuery

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Publish Platform Event Message

<salesforce:publish-platform-event-message>

Adds one new platform event to your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Platform Event name

String

name of platform event to create

x

Platform Event Message

Object

PlatformEventMessage to create

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Publish Streaming Channel

<salesforce:publish-streaming-channel>

Creates a streaming channel on which generic, custom messages can be pushed.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Channel name

String

Descriptive name of the StreamingChannel. Limit: 80 characters, must start with "/u/". This value identifies the channel and must be unique.

x

Owner Id

String

Identifier for the channel owner.

Description

String

Description of what kinds of records are returned by the query. Limit: 255 characters

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Publish Topic

<salesforce:publish-topic>

Creates a topic representing a query, which is used to notify listeners when changes are made to records in an organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic Name

String

x

Query

String

x

Description

String

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Push Generic Event

<salesforce:push-generic-event>

Pushes generic streaming custom events to the specified streaming channel.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Events

The event list

x

Channel Id

String

The streaming channel name

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Query

<salesforce:query>

Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are String and, if necessary, you can convert them to the apropiate type using for example Weave and Transform Message

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

map with values for placeholders within salesforceQuery

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:UNKNOWN

Query All

<salesforce:query-all>

Retrieves data from specified objects, whether or not they have been deleted.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders within salesforceQuery

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:UNKNOWN

Query Multiple Result Stream

<salesforce:query-multiple-result-stream>

Returns an InputStream with the query results of a submitted BatchInfo Internally the InputStreams contained in the sequence will be requested on-demand (lazy-loading). They should be used only with query jobs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch info

The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Query Result Stream

<salesforce:query-result-stream>

Returns an InputStream with the query results of a submitted BatchInfo Internally the InputStreams contained in the sequence will be requested on-demand (lazy-loading). They should be used only with query jobs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Batch info

The org.mule.extension.salesforce.api.bulk.BatchInfo being monitored

#[payload]

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Query Single

<salesforce:query-single>

Executes a query against the specified object and returns the first record that matches the specified criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Salesforce Query

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Query Language (SOQL).

x

Parameters

Object

Map with values for placeholders within salesforceQuery

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Read Metadata

<salesforce:read-metadata>

Returns one or more metadata components from your organization, given the object(s) API Name(s)

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to read

x

Full Names

Array of String

List of full names of the components to read

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Rename Metadata

<salesforce:rename-metadata>

Renames a Metadata component in your organization, given its old API Name and the new name

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to rename

x

Old Full Name

String

The current component full name

x

New Full Name

String

The new component full name

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Reset Password

<salesforce:reset-password>

Resets the password of the user corresponding to the userId provided, or the user linked to the connector’s configuration if userID is null

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

User Id

String

The user to reset the password for. If not set, the current user will be used.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Retrieve

<salesforce:retrieve>

Retrieves one or more records based on the specified IDs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Type

String

Type of record to retrieve

x

Retrieve Request

Must provide the IDs and specify the fields for the records to retrieve

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Retrieve Metadata

<salesforce:retrieve-metadata>

Retrieve. This call retrieves XML file representations of components in an organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Package Names

Array of String

A list of package names to be retrieved. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation.

Specific Files

Array of String

A list of file names to be retrieved. If a value is specified for this property, packageNames must be set to null.

Unpackaged

Binary

A stream containing a list of components to retrieve that are not in a package.

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Retrieve Record Failure Bulk V2

<salesforce:retrieve-record-failure-bulk-v2>

Gets the status of the failed processed sObjects. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Retrieve Record Failure Multiple

<salesforce:retrieve-record-failure-multiple>

Gets the status of the failed processed sObjects. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Retrieve Record Success Bulk V2

<salesforce:retrieve-record-success-bulk-v2>

Gets the status of the successfully processed sObjects. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Retrieve Record Success Multiple

<salesforce:retrieve-record-success-multiple>

Gets the status of the successfully processed sObjects. This call uses the Bulk API v2.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The id of the Job.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

<salesforce:search>

Search for objects using Salesforce Object Search Language. Mimics using the search box inside the Salesforce UI.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Search String

String

Query string that specifies the object to query, the fields to return, and any conditions for including a specific object in the query. For more information, see Salesforce Object Search Language (SOSL).

x

Parameters

Object

Map with values for placeholders within searchString

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Set Password

<salesforce:set-password>

Change the password of a User or SelfServiceUser to a value that you specify.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

User Id

String

The user to set the password for.

x

New Password

String

The new password for the user.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Unauthorize

<salesforce:unauthorize>

Deletes all the access token information of a given resource owner id so that it’s impossible to execute any operation for that user without doing the authorization dance again

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The id of the resource owner which access should be invalidated

For Configurations

Update

<salesforce:update>

Updates one or more existing records in your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of record to be updated

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Update Bulk

<salesforce:update-bulk>

Updates one or more existing records in your organization’s data. This call uses the Bulk API. The creation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to update

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Update Metadata

<salesforce:update-metadata>

Updates one or more metadata components in your organization.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components updated

x

Metadata Objects

Array of Object

A List of Map<String, Object> representing the metadata to be updated

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Update Multiple

<salesforce:update-multiple>

Updates one or more existing records in your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of record to be updated

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Update Multiple Bulk

<salesforce:update-multiple-bulk>

Updates one or more existing records in your organization’s data. This call uses the Bulk API. The creation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

Type of object to update

x

sObjects

Array of Object

An array of one or more sObject objects.

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Update Single

<salesforce:update-single>

Updates one record in your organization’s data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

type of the object to be updated

x

Record

Object

record to be upserted into your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Upsert

<salesforce:upsert>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer #upsert(String, String, List, Map) over #create(String, List, Map), to avoid creating unwanted duplicate records.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.

x

Type

String

type of record to be upserted

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Upsert Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Upsert Bulk

<salesforce:upsert-bulk>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer #upsert(String, String, List, Map) over #create(String, List, Map), to avoid creating unwanted duplicate records. This call uses the Bulk API. The creation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

The type of the given objects. The list of objects to upsert must be homogeneous.

x

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.

x

sObjects

Array of Object

The objects to upsert

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Upsert Metadata

<salesforce:upsert-metadata>

Creates or updates one or more metadata components in your organization

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

The metadata type of the components to create/update

x

Metadata Objects

Array of Object

A List of Map<String, Object> representing the metadata to be upserted

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Upsert Result

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Upsert Multiple

<salesforce:upsert-multiple>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer #upsert(String, String, List, Map) over #create(String, List, Map), to avoid creating unwanted duplicate records.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.

x

Type

String

type of record to be upserted

x

Records

Array of Object

records to be added to your organization

#[payload]

Headers

Object

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Upsert Multiple Bulk

<salesforce:upsert-multiple-bulk>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer #upsert(String, String, List, Map) over #create(String, List, Map), to avoid creating unwanted duplicate records. This call uses the Bulk API. The creation will be done in asynchronous fashion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

sObject Type

String

The type of the given objects. The list of objects to upsert must be homogeneous.

x

External Id Field Name

String

Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.

x

sObjects

Array of Object

The objects to upsert

#[payload]

Sobject Max Depth

Number

Async SObject recursive MAX_DEPTH check

5

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates the operation’s output and stores the output in Target Variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

For Configurations

Throws

  • SALESFORCE:CONNECTIVITY

  • SALESFORCE:INVALID_REQUEST_DATA

  • SALESFORCE:INVALID_SESSION

  • SALESFORCE:INVALID_STRUCTURE_FOR_INPUT_DATA

  • SALESFORCE:RETRY_EXHAUSTED

  • SALESFORCE:UNKNOWN

Sources

On Deleted Object

<salesforce:deleted-object>

This source (listener) uses Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs.
For more information, see The Different Types of Object Stores Explained.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

x

Since

String

A date in the YYYY-MM-DD hh:mm:ss format (that is, 2019-03-17 16:30:40). If this field is empty, this operation will retrieve the selected objects from the time the Mule app is started.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

Any

For Configurations

On Modified Object

<salesforce:modified-object>

This source (listener) uses Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs.
For more information, see The Different Types of Object Stores Explained.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

x

Since

String

A date in the YYYY-MM-DD hh:mm:ss format (that is, 2019-03-17 16:30:40). If this field is empty, this operation will retrieve the selected objects from the time the Mule app is started.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

Any

For Configurations

On New Object

<salesforce:new-object>

This source (listener) uses Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to suit your needs.
For more information, see The Different Types of Object Stores Explained.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

String

x

Since

String

A date in the YYYY-MM-DD hh:mm:ss format (that is, 2019-03-17 16:30:40). If this field is empty, this operation will retrieve the selected objects from the time the Mule app is started.

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

Any

For Configurations

Replay Channel

<salesforce:replay-channel>

Subscribe to a streaming channel. First the streaming channel must be published and after that a subscription to that channel created. Attention: Salesforce lets you subscribe to an inexistent streaming channel but won’t send you notifications after the topic is created.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Channel

String

The name of the streaming channel to subscribe to

x

Replay Option

Enumeration, one of:

  • FROM_REPLAY_ID

  • ONLY_NEW

  • ALL

Enum with the following values: ONLY_NEW: -1 Subscriber receives new events that are broadcast after the client subscribes. ALL: -2 Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription. FROM_REPLAY_ID: Subscriber will receive only events with replay id value greater than specified replayId

x

Replay Id

String

Subscriber receives all events after the event specified by its replayId value. The value is ignored if replay option is set on ALL or ONLY_NEW.

Resume from the Last Replay Id

Boolean

if true, when source is started it will start to consume data from when it was left last time

false

The size (in bytes) of the event queue

Number

Default value it’s set to 26 MB, if the messages are not consumed fast enough and the buffer gets filled up it will result in a IllegalStateException

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Any

For Configurations

Replay Topic

<salesforce:replay-topic>

Salesforce stores events for 24 hours and allows you to retrieve stored and new events. Subscribers can choose which events to receive by using replay options.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic

String

The name of the topic to subscribe to

x

Replay Option

Enumeration, one of:

  • FROM_REPLAY_ID

  • ONLY_NEW

  • ALL

Enum with the following values: ONLY_NEW: -1 Subscriber receives new events that are broadcast after the client subscribes. ALL: -2 Subscriber receives all events, including past events that are within the 24-hour retention window and new events sent after subscription. FROM_REPLAY_ID: Subscriber will receive only events with replay id value greater than specified replayId

x

Replay Id

String

Subscriber receives all events after the event specified by its replayId value. The value is ignored if replay option is set on ALL or ONLY_NEW.

Resume from the Last Replay Id

Boolean

if true, when source is started it will start to consume data from when it was left last time

false

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Any

For Configurations

Subscribe Channel

<salesforce:subscribe-channel>

Subscribe to a streaming channel. First the streaming channel must be published and after that a subscription to that channel created. Attention: Salesforce lets you subscribe to an inexistent streaming channel but won’t send you notifications after the topic is created.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Channel

String

The name of the streaming channel to subscribe to

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Any

For Configurations

Subscribe Topic

<salesforce:subscribe-topic>

Subscribe to a topic. First the topic must be published and after that a subscription to that topic created. Attention: Salesforce lets you subscribe to an inexistent topic but won’t send you notifications after the topic is created.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Topic

String

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster

Streaming Strategy

Configure if repeatable streams should be used and their behavior

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Any

For Configurations

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds)

Count

Number

The number of reconnection attempts to make

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread

true

Pooling Profile

Field Type Description Default Value Required

Max Active

Number

Controls the maximum number of Mule components that can be borrowed from a session at one time. When set to a negative value, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted.

Max Idle

Number

Controls the maximum number of Mule components that can sit idle in the pool at any time. When set to a negative value, there is no limit to the number of Mule components that may be idle at one time.

Max Wait

Number

Specifies the number of milliseconds to wait for a pooled component to become available when the pool is exhausted and the exhaustedAction is set to WHEN_EXHAUSTED_WAIT.

Min Eviction Millis

Number

Determines the minimum amount of time an object may sit idle in the pool before it is eligible for eviction. When non-positive, no objects will be evicted from the pool due to idle time alone.

Eviction Check Interval Millis

Number

Specifies the number of milliseconds between runs of the object evictor. When non-positive, no object evictor is executed.

Exhausted Action

Enumeration, one of:

  • WHEN_EXHAUSTED_GROW

  • WHEN_EXHAUSTED_WAIT

  • WHEN_EXHAUSTED_FAIL

Specifies the behavior of the Mule component pool when the pool is exhausted. Possible values are: "WHEN_EXHAUSTED_FAIL", which will throw a NoSuchElementException, "WHEN_EXHAUSTED_WAIT", which will block by invoking Object.wait(long) until a new or idle object is available, or WHEN_EXHAUSTED_GROW, which will create a new Mule instance and return it, essentially making maxActive meaningless. If a positive maxWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThreadWait is a negative value, it will block indefinitely.

Initialisation Policy

Enumeration, one of:

  • INITIALISE_NONE

  • INITIALISE_ONE

  • INITIALISE_ALL

Determines how components in a pool should be initialized. The possible values are: INITIALISE_NONE (will not load any components into the pool on startup), INITIALISE_ONE (will load one initial component into the pool on startup), or INITIALISE_ALL (will load all components in the pool on startup)

Disabled

Boolean

Whether pooling should be disabled

Advanced Reconnection Params

Field Type Description Default Value Required

Maintain Session Request Frequency

Number

Time in seconds the connector will hit Salesforce api to maintain the session

60

Initial Delay

Number

Initial delay in seconds the connector will wait until making the first keep-alive request, default is 480, that is the minimum amount of time the session can be updated for a session of 15 minute

480

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

ObjectStore

The object store where the redelivery counter for each message is going to be stored.

Repeatable In-Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File-Store Stream

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Job Info

Field Type Description Default Value Required

Apex Processing Time

Number

Api Active Processing Time

Number

Api Version

Number

Assignment Rule Id

String

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Content Type

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

Created By Id

String

Created Date

DateTime

External Id Field Name

String

Fast Path Enabled

Boolean

Id

String

Number Batches Completed

Number

Number Batches Failed

Number

Number Batches In Progress

Number

Number Batches Queued

Number

Number Batches Total

Number

Number Records Failed

Number

Number Records Processed

Number

Number Retries

Number

Object

String

Operation

Enumeration, one of:

  • delete

  • hardDelete

  • insert

  • update

  • upsert

  • query

State

Enumeration, one of:

  • Open

  • Closed

  • Aborted

  • Failed

System Modstamp

DateTime

Total Processing Time

Number

Bulk Job State

Field Type Description Default Value Required

Apex Processing Time

Number

Api Active Processing Time

Number

Api Version

String

Column Delimiter

String

Concurrency Mode

String

Content Type

String

Created By Id

String

Created Date

String

Error Message

String

External Id Field Name

String

Id

String

Job Type

String

Line Ending

String

Number Records Failed

Number

Number Records Processed

Number

Object

String

Operation

String

Retries

Number

State

String

System Modstamp

String

Total Processing Time

Number

Query Job Info

Field Type Description Default Value Required

Api Version

String

Column Delimiter

String

Concurrency Mode

String

Content Type

String

Created By Id

String

Created Date

String

Id

String

Job Type

String

Line Ending

String

Number Records Processed

Number

Object

String

Operation

String

Retries

Number

State

String

System Modstamp

String

Total Processing Time

Number

Batch Info

Field Type Description Default Value Required

Apex Processing Time

Number

Api Active Processing Time

Number

Created Date

DateTime

Id

String

Job Id

String

Number Records Failed

Number

Number Records Processed

Number

State

Enumeration, one of:

  • Completed

  • Failed

  • InProgress

  • NotProcessed

  • Queued

State Message

String

System Modstamp

DateTime

Total Processing Time

Number

Batch Result

Field Type Description Default Value Required

Partial Result

Boolean

Result

Array of Result

Result

Field Type Description Default Value Required

Errors

Array of Error

Id

String

Success

Boolean

Error

Field Type Description Default Value Required

Duplicate Result

Fields

Array of String

Message

String

Status Code

String

Duplicate Result

Field Type Description Default Value Required

Allow Save

Boolean

Duplicate Rule

String

Duplicate Rule Entity Type

String

Error Message

String

Match Results

Array of Match Result

Match Result

Field Type Description Default Value Required

Entity Type

String

Errors

Array of Simple Error

Match Engine

String

Match Records

Array of Match Record

Rule

String

Size

Number

Success

Boolean

Simple Error

Field Type Description Default Value Required

Fields

Array of String

Message

String

Status Code

String

Match Record

Field Type Description Default Value Required

Additional Information

Field Diffs

Array of Field Diff

Match Confidence

Number

Record

Object

Additional Information Map

Field Type Description Default Value Required

Name

String

Value

String

Field Diff

Field Type Description Default Value Required

Difference

Enumeration, one of:

  • DIFFERENT

  • NULL

  • SAME

  • SIMILAR

Name

String

Bulk Operation Result

Field Type Description Default Value Required

Id

Any

Items

Array of Bulk Item

Successful

Boolean

Bulk Item

Field Type Description Default Value Required

Exception

Any

Id

Any

Message

String

Payload

Status Code

String

Successful

Boolean

Lead Convert Result

Field Type Description Default Value Required

Account Id

String

Contact Id

String

Errors

Array of Error

Lead Id

String

Opportunity Id

String

Success

Boolean

Lead Convert Request

Field Type Description Default Value Required

Contact Id

String

ID of the Contact into which the lead will be merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact.IMPORTANT if you are converting a lead into a person account, do not specify the contactId or an error will result. Specify only the accountId of the person account. If no contactID is specified, then the API creates a new contact that is implicitly associated with the Account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read/write access to the specified contact. The contact name and other existing data are not overwritten (unless overwriteLeadSource is set to true, in which case only the LeadSource field is overwritten). For information on IDs, see ID Field Type.

Account Id

String

ID of the Account into which the lead will be merged. Required only when updating an existing account, including person accounts. If no accountID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read/write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type.

Send Email To Owner

Boolean

Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default).

false

Opportunity Name

String

Name of the opportunity to create. If no name is specified, then this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If doNotCreateOpportunity argument is true, then no Opportunity is created and this field must be left blank; otherwise, an error is returned.

Do Not Create Opportunity

Boolean

Specifies whether to create an Opportunity during lead conversion (false, the default) or not (true). Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default.

false

Over Write Lead Source

Boolean

Specifies whether to overwrite the LeadSource field on the target Contact object with the contents of the LeadSource field in the source Lead object (true), or not (false, the default). To set this field to true, the client application must specify a contactId for the target contact.

false

Opportunity Id

String

The ID of an existing opportunity to relate to a lead during lead conversion.

Create Job Request

Field Type Description Default Value Required

External Id Field Name

String

Content Type

Enumeration, one of:

  • CSV

  • JSON

  • XML

  • ZIP_CSV

  • ZIP_JSON

  • ZIP_XML

Concurrency Mode

Enumeration, one of:

  • Parallel

  • Serial

Query Job State

Field Type Description Default Value Required

Api Version

String

Column Delimiter

String

Concurrency Mode

String

Content Type

String

Created By Id

String

Created Date

String

Id

String

Line Ending

String

Object

String

Operation

String

State

String

System Modstamp

String

Deploy Metadata Request

Field Type Description Default Value Required

Stream

Binary

A stream containing the data. This parameter defaults to payload content.

x

Ignore Warnings

Boolean

Indicates whether a warning should allow a deployment to complete successfully (true) or not (false).

false

Purge On Delete

Boolean

If true, the deleted components in the destructiveChanges.xml manifest file aren’t stored in the Recycle Bin. This option only works in Developer Edition or sandbox organizations; it doesn’t work in production organizations.

false

Rollback On Error

Boolean

Indicates whether any failure causes a complete rollback (true) or not (false).

true

Describe Global Result

Field Type Description Default Value Required

Encoding

String

Max Batch Size

Number

Sobjects

Describe Global SObject Result

Field Type Description Default Value Required

Activateable

Boolean

Createable

Boolean

Custom

Boolean

Custom Setting

Boolean

Deletable

Boolean

Deprecated And Hidden

Boolean

Feed Enabled

Boolean

Key Prefix

String

Label

String

Label Plural

String

Layoutable

Boolean

Mergeable

Boolean

Mru Enabled

Boolean

Name

String

Queryable

Boolean

Replicateable

Boolean

Retrieveable

Boolean

Searchable

Boolean

Triggerable

Boolean

Undeleteable

Boolean

Updateable

Boolean

Describe Metadata Result

Field Type Description Default Value Required

Metadata Objects

Organization Namespace

String

Partial Save Allowed

Boolean

Test Required

Boolean

Describe Metadata Object

Field Type Description Default Value Required

Child Xml Names

Array of String

Directory Name

String

In Folder

Boolean

Meta File

Boolean

Suffix

String

Xml Name

String

Describe SObject

Field Type Description Default Value Required

Action Overrides

Array of Action Override

Activateble

Boolean

Child Relationships

Compact Layoutable

Boolean

Createable

Boolean

Custom

Boolean

Custom Setting

Boolean

Deletable

Boolean

Deprecated And Hidden

Boolean

Feed Enabled

Boolean

Fields

Array of Field

Key Prefix

String

Label

String

Label Plural

String

Layoutable

Boolean

Mergeable

Boolean

Mru Enabled

Boolean

Name

String

Named Layout Infos

Network Scope Field Name

String

Queryable

Boolean

Record Type Infos

Array of Record Type Info

Replicateable

Boolean

Retrieveable

Boolean

Search Layoutable

Boolean

Searchable

Boolean

Triggerable

Boolean

Undeletable

Boolean

Updateable

Boolean

Url Detail

String

Url Edit

String

Url New

String

Action Override

Field Type Description Default Value Required

Available In Touch

Boolean

From Factor

String

Name

String

Page Id

String

Url

String

Child Relationship

Field Type Description Default Value Required

Cascade Delete

Boolean

Child S Object

String

Deprecated And Hidden

Boolean

Field

String

Relationship Name

String

Field

Field Type Description Default Value Required

Autonumber

Boolean

Byte Length

Number

Calculated

Boolean

Case Sensitive

Boolean

Controller Name

String

Createable

Boolean

Custom

Boolean

Default Value Formula

String

Defaulted On Create

Boolean

Dependent Pick List

Boolean

Deprecate And Hidden

Boolean

Digits

Number

Display Location In Decimal

Boolean

Encrypted

Boolean

Extra Type Info

String

Filterable

Boolean

Filtered Lookup Info

Formula

String

Groupable

Boolean

High Scale Number

Boolean

Html Formatted

Boolean

Id Lookup

Boolean

Inline Help Text

String

Label

String

Length

Number

Mask

String

Mask Type

String

Name

String

Name Field

Boolean

Name Pointing

Boolean

Nullable

Boolean

Permissible

Boolean

Picklist Values

Array of Pick List Entry

Polymorphic Foreign Key

Boolean

Precision

Number

Reference Target Field

String

Reference To

Array of String

Relationship Name

String

Relationship Order

Number

Restricted Picklist

Boolean

Scale

Number

Search Filterable

Boolean

Sortable

Boolean

Type

Enumeration, one of:

  • ADDRESS

  • ANY_TYPE

  • BASE64

  • BOOLEAN

  • COMBOBOX

  • COMPLEX_VALUE

  • CURRENCY

  • DATA_CATEGORY_GROUP_REF

  • DATE

  • DATETIME

  • DOUBLE

  • EMAIL

  • ENCRIPTED_STRING

  • ID

  • INTEGER

  • LOCATION

  • MULTIPICKLIST

  • PERCENT

  • PHONE

  • PICKLIST

  • REFERENCE

  • STRING

  • TEXTAREA

  • URL

Unique

Boolean

Updateable

Boolean

Write Requires Master Read

Boolean

Filtered Lookup Info

Field Type Description Default Value Required

Controlling Fields

Array of String

Dependent

Boolean

Optional Filter

Boolean

Pick List Entry

Field Type Description Default Value Required

Active

Boolean

Default Value

Boolean

Label

String

Valid For

Binary

Value

String

Named Layout Info

Field Type Description Default Value Required

Name

String

Record Type Info

Field Type Description Default Value Required

Available

Boolean

Default Record Type Mapping

Boolean

Id

String

Master

Boolean

Name

String