Salesforce Connector 10.8 Reference - Mule 4
Default Configuration
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 to provide to this configuration. |
x |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
0 |
|
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
SECONDS |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
|||
Fetch All Apex SOAP Metadata |
Boolean |
If checked, 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 can cause ConnectionTimeout during DataSense. Default value is false. |
false |
|
Fetch All Apex REST Metadata |
Boolean |
If checked, 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 can 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. |
||
Include null values |
Boolean |
Include null values in the Apex Rest API request. This parameter applies to the Invoke Apex Rest Method operation only. |
false |
Connection Types
Basic Authentication
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
Specifies the amount of time that the consumer attempts to establish a connection before it times out. Works in tandem with Time unit. Values less than one millisecond are converted to 0. |
0 |
|
Time unit |
Enumeration, one of:
|
Time unit to use for the Connection Timeout parameter |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
Object TTL |
Number |
Specifies the amount of time an object in the Connections pool lives if it was not used. |
30 |
|
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Object TTL |
SECONDS |
|
Max Entries |
Number |
Specifies the amount of objects that live in the pool at a specific moment. When this number is reached and a new object is needed, no new object will be created and the application waits until a connection is released. |
10 |
|
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 allowlisted 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. Defaults to the URL containing the latest api version supported by the connector. For example: |
||
Session Id |
String |
Value that identifies an active Salesforce session |
||
Service Endpoint |
String |
Specifies the service endpoint. This value will only be used if the sessionId configuration property is used. |
||
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
OAuth v2.0
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
Specifies the amount of time that the consumer attempts to establish a connection before it times out. Works in tandem with Time unit. Values less than one millisecond are converted to 0. |
0 |
|
Time unit |
Enumeration, one of:
|
Time unit to use for the Connection Timeout parameter |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
Object TTL |
Number |
Specifies the amount of time an object in the Connections pool lives if it was not used. |
30 |
|
Time unit |
Enumeration, one of:
|
Time unit that qualifies the Object TTL |
SECONDS |
|
Max Entries |
Number |
Specifies the amount of objects that live in the pool at a specific moment. When this number is reached and a new object is needed, no new objects will be created and the application waits until a connection is released. |
10 |
|
Api Version |
Number |
The API version used. Defaults to the latest api version supported by the connector. |
||
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
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 |
|
|
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
|
|
Scopes |
String |
The OAuth scopes to request during the OAuth dance. If not provided, it defaults to the OAuth scopes in the annotation. |
||
Resource Owner Id |
String |
The resourceOwnerId that each component should use if it doesn’t reference otherwise. |
||
Before |
String |
The name of a flow to execute immediately before starting the OAuth dance |
||
After |
String |
The name of a flow to execute right after an accessToken has been received |
||
Listener Config |
String |
A reference to an |
x |
|
Callback Path |
String |
The path of the access token callback endpoint |
x |
|
Authorize Path |
String |
The path of the local HTTP endpoint that 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
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
Specifies the amount of time that the consumer attempts to establish a connection before it times out. Works in tandem with Time unit. Values less than one millisecond are converted to 0. |
0 |
|
Time unit |
Enumeration, one of:
|
Time unit to use for the Connection Timeout parameter |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
Object TTL |
Number |
Specifies the amount of time an object in the Connections pool lives if it was not used. |
30 |
|
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Object TTL |
SECONDS |
|
Max Entries |
Number |
Specifies the amount of objects that live in the pool at a specific moment. When this number is reached and a new object is needed, no new object will be created, and the application waits until a connection is released. |
10 |
|
Api Version |
Number |
The API version used. Defaults to the latest API version supported by the connector. |
||
Consumer Key |
String |
Consumer key for the Salesforce-connected app |
x |
|
Key Store |
String |
Path to the keystore used to sign data during authentication |
x |
|
Store Password |
String |
Password of keystore |
x |
|
Certificate Alias |
String |
Alias of the certificate |
||
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 |
|
|
Audience Url |
String |
The URL that identifies the authorization server as an intended audience. The authorization server must verify that it is an intended audience for the token. Use the authorization server’s URL for the audience value if implementing for a community: |
||
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
OAuth Username Password
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
Specifies the amount of time that the consumer attempts to establish a connection before it times out. Works in tandem with Time unit. Values less than one millisecond are converted to 0. |
0 |
|
Time unit |
Enumeration, one of:
|
Time unit to use for the Connection Timeout parameter |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
Object TTL |
Number |
Specifies the amount of time, an object in the Connections pool will live if it was not used. |
30 |
|
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Object TTL |
SECONDS |
|
Max Entries |
Number |
Specifies the amount of objects that live in the pool at a specific moment. When this number is reached and a new object is needed, no new object will be created and the application waits until a connection is released. |
10 |
|
Api Version |
Number |
The API version used. Defaults to the latest api version supported by the connector. |
||
Consumer Key |
String |
Consumer key for the 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 allowlisted 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' |
|
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
OAuth SAML
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Connection Timeout |
Number |
Specifies the amount of time that the consumer attempts to establish a connection before it times out. Works in tandem with Time unit. Values less than one millisecond are converted to 0. |
0 |
|
Time unit |
Enumeration, one of:
|
Time unit to use for the Connection Timeout parameter |
SECONDS |
|
Proxy configuration |
Proxy configuration for the connector. |
|||
Object TTL |
Number |
Specifies the amount of time, an object in the Connections pool will live if it was not used. |
30 |
|
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Object TTL |
SECONDS |
|
Max Entries |
Number |
Specifies the amount of objects that live in the pool at a specific moment. When this number is reached and a new object is needed, no new object will be created and the application waits until a connection is released. |
10 |
|
Api Version |
Number |
The API version used. Defaults to the latest api version supported by the connector. |
||
Consumer Key |
String |
Consumer key for the Salesforce-connected app |
x |
|
Key Store |
String |
Path to the keystore used to sign data during authentication |
x |
|
Store Password |
String |
Password of keystore |
x |
|
Certificate Alias |
String |
Alias of the certificate |
||
Principal |
String |
Username of desired Salesforce user to take action on behalf of. |
x |
|
Token Endpoint |
String |
URL that points to the server responsible for providing the authentication token. According to Salesforce, it is |
|
|
TLS configuration |
Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the |
|||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
Sources
On Deleted Object
<salesforce:deleted-object-listener>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
x |
||
Since |
String |
Specify a date in the |
||
Primary Node Only |
Boolean |
Indicates whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
Configures the scheduler that triggers the polling |
x |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
On Modified Object
<salesforce:modified-object-listener>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
x |
||
Since |
String |
Specify a date in the |
||
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
Configures the scheduler that triggers the polling |
x |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
On New Object
<salesforce:new-object-listener>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
x |
||
Since |
String |
Specify a date in the |
||
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster. |
||
Scheduling Strategy |
Configures the scheduler that triggers the polling |
x |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Replay Channel Listener
<salesforce:replay-channel-listener>
Subscribe to a streaming channel. First, the streaming channel must be published, and after that, a subscription to that channel created. 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:
|
Enum with the following values:
|
x |
|
Replay Id |
String |
Subscriber receives all events after the event specified by its replayId value. The value is ignored if the replay option is set to ALL or ONLY_NEW. |
||
Resume from the Last Replay Id |
Boolean |
If true, when the source is started it starts to consume data from when it was left last time |
false |
|
The size (in bytes) of the event queue |
Number |
Default value is 26 MB. If the messages are not consumed fast enough and the buffer fills up, the operation returns IllegalStateException. Maximum value for the event size is 2147483647 |
||
Primary Node Only |
Boolean |
Indicates whether this source should only be executed on the primary node when running in a cluster. |
true |
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed, if the organization daily limit for events processing is exceeded. |
false |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
#[message.attributes] |
Replay Topic Listener
<salesforce:replay-topic-listener>
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:
|
Enum with the following values:
|
x |
|
Replay Id |
String |
Subscriber receives all events after the event specified by its replayId value. The value is ignored if the replay option is set to 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. |
true |
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed, if the organization daily limit for events processing is exceeded. |
false |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
#[message.attributes] |
Subscribe Channel Listener
<salesforce:subscribe-channel-listener>
Subscribe to a streaming channel. First, the streaming channel must be published and after that, a subscription to that channel created. 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. |
true |
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded. |
false |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
#[message.attributes] |
Subscribe Topic Listener
<salesforce:subscribe-topic-listener>
Subscribe to a topic. First, the topic must be published and after that, a subscription to that topic created. 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. |
true |
|
Throw Exception When Organization Daily Limit Exceeded |
Boolean |
Specifies whether the connector throws an exception when the application is deployed if the organization daily limit for events processing is exceeded. |
false |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
|||
Attributes |
Object |
#[message.attributes] |
Operations
Abort Job
<salesforce:abort-job>
Aborts an open Job given its ID.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use |
x |
|
Job ID |
String |
Job ID that identifies the Job to abort |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
Time unit that qualifies the Read Timeout |
||
Target Variable |
String |
Name of a variable that stores the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Abort Job Bulk Api V2
<salesforce:abort-job-bulk-api-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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Abort Query Job Bulk Api V2
<salesforce:abort-query-job-bulk-api-v2>
Abort the indicated query 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 |
|
Id |
String |
The ID of the query job to be aborted |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Batch Info
<salesforce:batch-info>
Access the latest BatchInfo
of a submitted BatchInfo
. Allows you to track the execution status.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Batch info |
The BatchInfo being monitored |
|
||
Content type |
Enumeration, one of:
|
Content type used at job creation. If not provided, the default value used is |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
x |
|
Content type |
Enumeration, one of:
|
Content type used at job creation. If not provided default value used is |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Batch Info |
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 |
|
||
Content type |
Enumeration, one of:
|
Content type used at job creation. If not provided default value used is |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs |
||
Output Encoding |
String |
The encoding of the payload that this operation outputs |
||
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 the objects need to match the expected type of the object at Salesforce. For example, if you set the CloseDate field of an Opportunity to a string of value "2011-12-13", it is sent to Salesforce as a string. The operation will be rejected because the CloseDate is not of the expected type. The correct way to map it is to generate a Java Date object. You can do so using the Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2011-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 add |
x |
|
Records |
Array of Object |
Records to add to your organization |
#[payload] |
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create Batch
<salesforce:create-batch>
Creates a Batch using the given objects within the specified Job. The Job can be of XML or CSV type. This call uses the Bulk API. The operation is performed asynchronously.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job info |
The |
x |
||
SObjects |
Array of Object |
A list of one or more sObject objects. This parameter defaults to the payload content. |
|
|
SObject Max Depth |
Number |
Async SObject recursive MAX_DEPTH check |
5 |
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create Batch For Query
<salesforce:create-batch-for-query>
Creates a Batch using the given query. This call uses the Bulk API. The operation is performed asynchronously.
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 execute. |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create Batch Stream
<salesforce:create-batch-stream>
Creates a Batch using the given stream within the specified Job. The stream can have a CSV, XML, ZIP_CSV, or ZIP_XML format. This call uses the Bulk API and is performed asynchronously.
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 the payload content. |
x |
||
Stream |
Binary |
A stream containing the data. The stream can have a CSV,XML, ZIP_CSV or ZIP_XML format. |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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:
|
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 |
||||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create Job Bulk Api V2
<salesforce:create-job-bulk-api-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. |
|
|
Operation |
Enumeration, one of:
|
The operation to execute. |
x |
|
Line Ending |
String |
The lineEnding of CSV data. |
LF |
|
Column Delimiter |
String |
The columnDelimiter of CSV data. |
COMMA |
|
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 |
||
Headers |
Object |
Salesforce headers. For information, see Create a Job in the Salesforce documentation. |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create Metadata
<salesforce: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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Metadata Result |
Create Query Job Bulk Api V2
<salesforce:create-query-job-bulk-api-v2>
Creates a query 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 |
|
Query |
String |
The query used to create the job |
x |
|
Operation |
Enumeration, one of:
|
The operation used |
QUERY |
|
Column Delimiter |
String |
Type of delimiter used |
COMMA |
|
Line Ending |
String |
The line editing used |
CRLF |
|
Headers |
Object |
Salesforce headers. For information, see Create a Query Job in the Salesforce documentation. |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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. |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Delete Job Bulk Api V2
<salesforce:delete-job-bulk-api-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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Delete Metadata
<salesforce:delete-metadata>
Deletes one or more metadata components from your organization, given the API name of the objects.
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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Metadata Result |
Delete Query Job Bulk Api V2
<salesforce:delete-query-job-bulk-api-v2>
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 |
|
Id |
String |
The ID of the query job |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Deploy Metadata
<salesforce:deploy-metadata>
A 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 |
x |
||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Describe Metadata
<salesforce:describe-metadata>
This call retrieves the metadata that 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 |
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
x |
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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. findDuplicates()
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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Find Duplicates Result |
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. findDuplicatesByIds() 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 |
|
Ids List |
Array of String |
List of IDs to find duplicates. |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Find Duplicates Result |
Get All Jobs Bulk Api V2
<salesforce:get-all-jobs-bulk-api-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:
|
The desired concurrency mode. |
Parallel |
|
Pk Chunking |
Boolean |
Uses the PK Chunking request header to enable automatic primary key (PK) chunking for a bulk query job. |
false |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Bulk Job V2 Result |
Get All Query Jobs Bulk Api V2
<salesforce:get-all-query-jobs-bulk-api-v2>
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Pk Chunking |
Boolean |
If true, enables automatic primary key chunking for a bulk query job |
true |
|
Job Type |
Enumeration, one of:
|
|||
Concurrency Mode |
Enumeration, one of:
|
Parallel |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Query Jobs Info Result |
Get Deleted
<salesforce:get-deleted>
Retrieves the list of records deleted from a particular time in the past (specified in minutes).
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Object type. The specified value must be a valid object for your organization. |
x |
|
Start Date |
DateTime |
Starting date/time (Coordinated Universal Time (UTC)) 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). |
x |
|
End Date |
DateTime |
Ending date/time (Coordinated Universal Time (UTC)) 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). |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get Job State Bulk Api V2
<salesforce:get-job-state-bulk-api-v2>
Gets the 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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get Query Job Info Bulk Api V2
<salesforce:get-query-job-info-bulk-api-v2>
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 |
|
Id |
String |
The ID of the query job |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get Query Job Results Bulk Api V2
<salesforce:get-query-job-results-bulk-api-v2>
Returns the results 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 |
|
Id |
String |
The ID of the query job |
x |
|
Max Records Per Page |
Number |
How many records are on each page retrieved from the API. This number influences the number of API requests and the memory used by the connector to handle the results. |
2000 |
|
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get Server Timestamp
<salesforce:get-server-timestamp>
Retrieves the current system timestamp (Coordinated Universal Time (UTC)) from the API.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Get updated objects
<salesforce:get-updated>
Retrieves the list of individual records that have been created/updated between the specified start and end date.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object Type |
String |
Object type. The specified value must be a valid object for your organization. |
x |
|
Start Date |
DateTime |
Starting date/time (Coordinated Universal Time (UTC)) 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. |
x |
|
End Date |
DateTime |
Ending date/time (Coordinated Universal Time (UTC)) 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 a value is not provided, the current server time is used. |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Invoke Apex Rest Method
<salesforce:invoke-apex-rest-method>
Invokes any operation from an Apex class that is exposed as a 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, some of which can include object
|
|
|
Apex Class Name |
String |
x |
||
Apex Class Method Name |
String |
x |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Invoke Apex Soap Method
<salesforce:invoke-apex-soap-method>
Invokes any operation from an Apex class that is exposed as a 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 XML that contains information about the method to be invoked and its parameters. The XML must adhere to the WSDL standards. |
|
|
Apex Headers |
Object |
Parameters specifying the SOAP Headers to be sent to the API. For more information about the supported headers check SOAP API and SOAP Headers for Apex. |
||
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Apex Class Name |
String |
x |
||
Apex Class Method Name |
String |
x |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Job Info
<salesforce:job-info>
Access the latest JobInfo of a submitted JobInfo ID. This operation enables you to track the 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:
|
Content type used at job creation. If a value is not provided. the default value used is |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of File Properties |
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 |
|
|
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 |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Merge Multiple
<salesforce:merge-multiple>
Combines up to three records of the same type into one record. The input is an array of MergeRequest elements, each of which specifies the records to combine.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use |
x |
|
Master Record |
Map<String, Object> |
Master record that contains at least the ID and type of the object that other records will merge into. Optionally, provide the fields and their values to update. |
x |
|
Record To Merge Ids |
Array of String |
Additional records to merge into the master record. Minimum of one record and maximum of two records. |
x |
|
Additional Information Map |
Map<String, String> |
A field-value map. When a portal user ID is merged, it must contain two entries: |
||
Headers |
Map<String, Object> |
Declares the request headers to use with this operation |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in readTimeoutUnit, that the connector waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the readTimeout |
||
Target Variable |
String |
Name of a variable that stores the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Output
Type |
Array of Merge Result |
Limitations
-
The only supported object types are:
-
Lead
-
Contact
-
Account
-
Person Account
-
Individual
-
Only objects of the same type can be merged. For example, merge Leads only with Leads.
-
The Merge Multiple operation enables you to specify a list of a maximum of 200 Merge Requests.
-
A Merge Request can contain a maximum of three IDs:
-
The master record ID
-
Up to two IDs for the records to merge into the master
-
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 |
Array of Object |
List<PlatformEventMessage> to create |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Result |
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 |
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 |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
Array of Generic Streaming Event |
The event list |
|
|
Channel Id |
String |
The streaming channel name |
x |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Push Event Result |
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 appropriate type using for example DataWeave 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 how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 are requested on-demand (lazy-loading). They should be used only with query jobs.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Batch info |
BatchInfo to monitor. |
|
||
Content type |
Enumeration, one of:
|
Content type used at job creation. If not provided, the default value is used. |
ContentType.XML |
|
Output Mime Type |
String |
MIME type of the payload output of this operation |
||
Output Encoding |
String |
Encoding of the payload output of this operation |
||
Streaming Strategy |
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output. |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Read Metadata
<salesforce:read-metadata>
Returns one or more metadata components from your organization, given the objects' API names.
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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Reset Password
<salesforce:reset-password>
Resets the password of the user corresponding to the provided user ID, or the user linked to the connector’s configuration, if the User ID field 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. |
||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, that the consumer waits for a response before it times out |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Retrieve Job Failed Results Bulk V2
<salesforce:retrieve-job-failed-results-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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Job Failed Record Results |
Retrieve Job Successful Results Bulk V2
<salesforce:retrieve-job-successful-results-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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Job Successful Record Result |
Retrieve Metadata
<salesforce:retrieve-metadata>
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 how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
|||
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Search
<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 |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Unauthorize
<salesforce:unauthorize>
Deletes all of the access token information of a given resource owner ID so that it’s impossible to execute an operation for that user without performing the OAuth dance.
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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Metadata Result |
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, use #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 |
|
Object Type |
String |
Type of record to be upserted |
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 |
|
Records |
Array of Object |
Records to be added to your organization |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
|
|
Headers |
Object |
|||
Read Timeout |
Number |
Specifies the amount of time, in the unit defined in Time unit, for which the consumer waits for a response before it times out. |
||
Time unit |
Enumeration, one of:
|
A time unit that qualifies the Read Timeout |
||
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. The expression outcome is stored in the target variable. |
|
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Output
Type |
Array of Upsert Metadata Result |
Types
Proxy Configuration
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Host where the proxy requests is sent. |
x |
|
Port |
Number |
Port where the proxy requests is sent. |
x |
|
Username |
String |
The username to authenticate against the proxy. |
||
Password |
String |
The password to authenticate against the proxy. |
TLS
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which is resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which is resolved relative to the current classpath and file system, if possible) of the keystore. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the keystore. |
||
Algorithm |
String |
The algorithm used by the keystore. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
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 fails 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 in milliseconds to reconnect. |
||
Count |
Number |
How many 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 |
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:
|
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 |
Object Store |
The object store where the redelivery counter for each message is stored. |
Repeatable In Memory Stream
When streaming in this mode, Mule never uses the disk to buffer the contents. If you exceed the buffer size, the message fails.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
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 the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which these attributes are expressed |
Repeatable File Store Stream
File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
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 content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
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:
|
|||
Content Type |
Enumeration, one of:
|
|||
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:
|
|||
State |
Enumeration, one of:
|
|||
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:
|
|||
State Message |
String |
|||
System Modstamp |
DateTime |
|||
Total Processing Time |
Number |
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 |
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 |
Array of Additional Information Map |
|||
Field Diffs |
Array of Field Diff |
|||
Match Confidence |
Number |
|||
Record |
Object |
Field Diff
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Difference |
Enumeration, one of:
|
|||
Name |
String |
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 |
Name of the field on this object. Use the external ID field attribute for custom objects or the idLookup field property for standard objects (only required for Upsert Operations). |
||
Content Type |
Enumeration, one of:
|
Content type for the job results. When specifying a content type different from XML for a query type, use the queryResultStream(BatchInfo) method to retrieve results. |
||
Concurrency Mode |
Enumeration, one of:
|
Concurrency mode of the job. |
Metadata Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Errors |
Array of Error |
|||
Full Name |
String |
|||
Id |
String |
|||
Success |
Boolean |
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 |
Array of Describe Global S Object Result |
Describe Global S Object 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 |
Array of Describe Metadata Object |
|||
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 S Object Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Action Overrides |
Array of Action Override |
|||
Activateble |
Boolean |
|||
Child Relationships |
Array of Child Relationship |
|||
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 |
Array of Named Layout Info |
|||
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 |
|||
Permissionable |
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 |
|||
Required |
Boolean |
|||
Restricted Picklist |
Boolean |
|||
Scale |
Number |
|||
Search Filterable |
Boolean |
|||
Sortable |
Boolean |
|||
Type |
Enumeration, one of:
|
|||
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 |
Record Type Info
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Available |
Boolean |
|||
Default Record Type Mapping |
Boolean |
|||
Id |
String |
|||
Master |
Boolean |
|||
Name |
String |
Find Duplicates Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Duplicate Results |
Array of Duplicate Result |
|||
Errors |
Array of Error |
|||
Success |
Boolean |
Bulk Job V2 Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Api Version |
String |
|||
Column Delimiter |
String |
|||
Concurrency Mode |
String |
|||
Content Type |
String |
|||
Content Url |
String |
|||
Created By Id |
String |
|||
Created Date |
String |
|||
External Id Field Name |
String |
|||
Id |
String |
|||
Job Type |
String |
|||
Line Ending |
String |
|||
Object |
String |
|||
Operation |
String |
|||
State |
String |
|||
System Modstamp |
String |
Query Jobs Info Result
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 |
|||
Object |
String |
|||
Operation |
String |
|||
State |
String |
|||
System Modstamp |
String |
Get Deleted Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Deleted Records |
Array of Deleted Record |
|||
Earliest Date Available |
DateTime |
|||
Latest Date Covered |
DateTime |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances initially allowed to keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of |
|
|
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
|
|
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Objects |
Number |
The maximum number of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Get Updated Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Ids |
Array of String |
|||
Latest Date Covered |
DateTime |
Get User Info Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Accessibility Mode |
Boolean |
|||
Currency Symbol |
String |
|||
Org Attachment File Size Limit |
Number |
|||
Org Default Currency Iso Code |
String |
|||
Org Default Currency Locale |
String |
|||
Org Disallow Html Attachments |
Boolean |
|||
Org Has Person Accounts |
Boolean |
|||
Organization Id |
String |
|||
Organization Multi Currency |
Boolean |
|||
Organization Name |
String |
|||
Profile Id |
String |
|||
Role Id |
String |
|||
Session Seconds Valid |
Number |
|||
User Default Currency Iso Code |
String |
|||
User Email |
String |
|||
User Full Name |
String |
|||
User Id |
String |
|||
User Language |
String |
|||
User Locale |
String |
|||
User Name |
String |
|||
User Time Zone |
String |
|||
User Type |
String |
|||
User Ui Skin |
String |
File Properties
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Created By |
String |
|||
Created By Name |
String |
|||
Created Date |
DateTime |
|||
File Name |
String |
|||
Full Name |
String |
|||
Id |
String |
|||
Last Modified By Id |
String |
|||
Last Modified By Name |
String |
|||
Last Modified Date |
String |
|||
Manageable State |
Enumeration, one of:
|
|||
Namespace Prefix |
String |
|||
Type |
String |
Merge Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Errors |
Array of Error |
|||
Id |
String |
|||
Merged Record Ids |
Array of String |
|||
Success |
Boolean |
|||
Updated Related Ids |
Array of String |
Push Event Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fanout Count |
Number |
|||
User Online Status |
Object |
Generic Streaming Event
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Payload |
String |
|||
User Ids |
Array of String |
Retrieve Request
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fields |
Array of String |
|||
Ids |
Array of String |
Job Failed Record Results
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Error Message |
String |
|||
Id |
String |
|||
Original Fields |
Object |
Job Successful Record Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Created |
Boolean |
|||
Id |
String |
|||
Original Fields |
Object |
Search Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Query Id |
String |
|||
Search Records |
Array of Search Record |
|||
Search Results Metadata |
Search Record
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Record |
Object |
|||
Search Record Metadata |
||||
Snippet |
Search Snippet
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Text |
String |
|||
Whole Fields |
Array of Name Value Pair |
Search Results Metadata
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Label Metadata |
Array of Labels Search Metadata |
|||
Entity Metadata |
Array of Entity Search Metadata |
Labels Search Metadata
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Field Labels |
Array of Name Value Pair |
|||
Entity Name |
String |
Entity Search Metadata
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Entity Name |
String |
|||
Field Metadata |
Array of Field Level Search Metadata |
Field Level Search Metadata
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Label |
String |
|||
Name |
String |
|||
Type |
String |
Upsert Metadata Result
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Created |
Boolean |
|||
Errors |
Array of Error |
|||
Full Name |
String |
|||
Id |
String |
|||
Success |
Boolean |
Fixed Frequency
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
The frequency at which the Scheduler initiates the flow, based on the time unit specified in the Time Unit field. The default frequency is 1000ms (1s). |
1000ms |
* |
Start delay |
Number |
The amount of time that the Scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the frequency value |
MILLISECONDS |
* |