The Salesforce Connector will allow to connect to the Salesforce application using regular username and password via the SOAP API. Almost every operation that can be done via the Salesforce's API can be done thru this connector. This connector will also work if your Salesforce objects are customized with additional fields or even you are working with custom objects.

Integrating with Salesforce consists of web service calls utilizing XML request/response setup over an HTTPS connection. The technical details of this connection such as request headers, error handling, HTTPS connection, etc. are all abstracted from the user to make implementation quick and easy.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.5.0 or higher

Configs


Basic Authentication

<sfdc:config>

Connection Management

Salesforce connector configuration that uses basic authentication for establishing connection with Salesforce system.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

Username used to initialize the session

x 

password

String

Password used to authenticate the user

x 

securityToken

String

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

 

url

String

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

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

 

sessionId

String

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

 

serviceEndpoint

String

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

 

disableSessionInvalidation

boolean

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

false

 

clientId

String

Client ID for partners

 

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

 

useDefaultRule

Boolean

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

false

 

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

 

fetchAllApexSoapMetadata

boolean

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

false

 

fetchAllApexRestMetadata

boolean

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

false

 

apexClassNames

List<String>

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

 

clearNullFields

boolean

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

false

 

readTimeout

Integer

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

0

 

connectionTimeout

Integer

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

0

 

proxyHost

String

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

 

proxyPort

String

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

 

proxyUsername

String

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

 

proxyPassword

String

Password used to authenticate against the proxy.

 

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

 

batchSobjectMaxDepth

Integer

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

5

 


OAuth 2.0 JWT Bearer

<sfdc:config-oauth-jwt-bearer>

Connection Management

Salesforce configuration object that uses OAuth 2.0 JWT bearer in order to establish a connection with the Salesforce system.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

consumerKey

String

Consumer key for Salesforce-connected app

x 

keyStore

String

Path to key store used to sign data during authentication

x 

storePassword

String

Password of key store

x 

principal

String

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

x 

tokenEndpoint

String

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

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

 

disableSessionInvalidation

boolean

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

false

 

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

40.0

 

clientId

String

Client ID for partners

 

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

 

useDefaultRule

Boolean

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

false

 

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

 

fetchAllApexSoapMetadata

boolean

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

false

 

fetchAllApexRestMetadata

boolean

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

false

 

apexClassNames

List<String>

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

 

clearNullFields

boolean

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

false

 

readTimeout

Integer

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

0

 

connectionTimeout

Integer

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

0

 

proxyHost

String

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

 

proxyPort

String

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

 

proxyUsername

String

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

 

proxyPassword

String

Password used to authenticate against the proxy.

 

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

 

batchSobjectMaxDepth

Integer

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

5

 


OAuth 2.0 SAML Bearer

<sfdc:config-oauth-saml-bearer>

Connection Management

Salesforce configuration object that uses OAuth 2.0 SAML bearer in order to establish connection with Salesforce system.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

consumerKey

String

Consumer key for Salesforce connected app

x 

keyStore

String

Path to key store used to sign data during authentication

x 

storePassword

String

Password of key store

x 

principal

String

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

x 

tokenEndpoint

String

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

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

 

disableSessionInvalidation

boolean

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

false

 

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

40.0

 

clientId

String

Client ID for partners

 

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

 

useDefaultRule

Boolean

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

false

 

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

 

fetchAllApexSoapMetadata

boolean

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

false

 

fetchAllApexRestMetadata

boolean

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

false

 

apexClassNames

List<String>

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

 

clearNullFields

boolean

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

false

 

readTimeout

Integer

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

0

 

connectionTimeout

Integer

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

0

 

proxyHost

String

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

 

proxyPort

String

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

 

proxyUsername

String

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

 

proxyPassword

String

Password used to authenticate against the proxy.

 

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

 

batchSobjectMaxDepth

Integer

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

5

 


OAuth 2.0 Username-Password

<sfdc:config-oauth-user-pass>

Connection Management

Salesforce configuration object that uses OAuth 2.0 JWT bearer in order to establish a connection with the Salesforce system.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

consumerKey

String

Consumer key for Salesforce-connected app

x 

consumerSecret

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 

securityToken

String

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

 

tokenEndpoint

String

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

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

 

disableSessionInvalidation

boolean

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

false

 

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

40.0

 

clientId

String

Client ID for partners

 

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

 

useDefaultRule

Boolean

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

false

 

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

 

fetchAllApexSoapMetadata

boolean

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

false

 

fetchAllApexRestMetadata

boolean

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

false

 

apexClassNames

List<String>

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

 

clearNullFields

boolean

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

false

 

readTimeout

Integer

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

0

 

connectionTimeout

Integer

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

0

 

proxyHost

String

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

 

proxyPort

String

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

 

proxyUsername

String

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

 

proxyPassword

String

Password used to authenticate against the proxy.

 

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

 

batchSobjectMaxDepth

Integer

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

5

 


OAuth v2.0

<sfdc:config-with-oauth>

OAuth2 Using OAuth2 as authentication method will add the authorize and unauthorize operations. You must authorize before using any operation with OAuth2.

Salesforce connector configuration that uses the OAuth2 dance for establishing a connection with the Salesforce system.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

consumerKey

String

Your application's client identifier (consumer key in Remote Access Detail).

x 

consumerSecret

String

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

x 

apiVersion

Double

Salesforce API version. The default value is the latest version supported by the connector.

40.0

 

clientId

String

Client ID for partners

 

assignmentRuleId

String

The ID of a specific assignment rule to run for the Case or Lead. The assignment rule is either set to active or inactive. The ID can be retrieved by querying the AssignmentRule object. If specified, do not specify useDefaultRule. This element is ignored for accounts, because all territory assignment rules are applied.

If the value is not in correct ID format (15-character or 18-character Salesforce ID), the call fails and a MALFORMED_ID exception is returned. Default value is false.

 

useDefaultRule

Boolean

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

false

 

allowFieldTruncationSupport

Boolean

If true, truncates field values that are too long, which is the behavior in API versions 14.0 and earlier.

Default is false: no change in behavior. If a string or text area value is too large, the operation fails and the fault code STRING_TOO_LONG is returned.

false

 

fetchAllApexSoapMetadata

boolean

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

false

 

fetchAllApexRestMetadata

boolean

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

false

 

apexClassNames

List<String>

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

 

clearNullFields

boolean

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

false

 

readTimeout

Integer

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

0

 

connectionTimeout

Integer

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

0

 

proxyHost

String

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

 

proxyPort

String

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

 

proxyUsername

String

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

 

proxyPassword

String

Password used to authenticate against the proxy.

 

timeObjectStore

ObjectStore

An ObjectStore instance to use in SalesforceConnector#getUpdatedObjects

 

batchSobjectMaxDepth

Integer

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

5

 

Processors


Create

<sfdc:create>

  DataSense enabled

Adds one or more new records to your organization's data.

IMPORTANT: When you map your objects to the input of this message processor keep in mind that they need to match the expected type of the object at Salesforce.

Take the CloseDate of an Opportunity as an example, if you set that field to a string of value "2011-12-13" it will be sent to Salesforce as a string and operation will be rejected on the basis that CloseDate is not of the expected type.

The proper way to actually map it is to generate a Java Date object, you can do so using Groovy expression evaluator as #[groovy:Date.parse("yyyy-MM-dd", "2011-12-13")].

XML Sample

<sfdc:create config-ref="Salesforce3" type="Account">
    <sfdc:objects>
        <sfdc:object>
             <sfdc:inner-object key="BillingStreet">30 Maiden Lane</sfdc:inner-object>
             <sfdc:inner-object key="BillingCity">San Francisco</sfdc:inner-object>
             <sfdc:inner-object key="BillingCountry">US</sfdc:inner-object>
             <sfdc:inner-object key="BillingState">CA</sfdc:inner-object>
             <sfdc:inner-object key="Name">MuleSoft</sfdc:inner-object>
             <sfdc:inner-object key="BillingPostalCode">94108</sfdc:inner-object>
        </sfdc:object>
    </sfdc:objects>
</sfdc:create>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to create

x 

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

An array of SaveResult if async is false


Create job

<sfdc:create-job>

  DataSense enabled

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

operation

OperationEnum

The com.sforce.async.OperationEnum that will be executed by the job.

x 

type

String

The type of Salesforce object that the job will process.

x 

externalIdFieldName

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 (only required for Upsert Operations).

 

contentType

ContentType

The Content Type for this Job results. When specifying a content type different from XML for a query type use queryResultStream(BatchInfo) method to retrieve results.

 

concurrencyMode

ConcurrencyMode

The concurrency mode of the job, either Parallel or Serial.

 

headers

Map<String,String>

These headers are sent as HTTP headers with the request to Bulk API

 

Returns

Return Java Type Description

JobInfo

A JobInfo that identifies the created Job.


Close job

<sfdc:close-job>

Closes an open Job given its ID.

XML Sample

<sfdc:close-job config-ref="mySalesforceConfig" jobId="ID" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

The Job ID identifying the Job to be closed.

x 

Returns

Return Java Type Description

JobInfo

A JobInfo that identifies the closed Job.


Abort job

<sfdc:abort-job>

Aborts an open Job given its ID.

XML Sample

<sfdc:abort-job config-ref="mySalesforceConfig" jobId="ID" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

The Job ID identifying the Job to be aborted.

x 

Returns

Return Java Type Description

JobInfo

A that identifies the aborted Job.


Job info

<sfdc:job-info>

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

XML Sample

<sfdc:job-info config-ref="mySalesforceConfig" jobId="ID" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

the Job ID of the Job being monitored

x 

Returns

Return Java Type Description

JobInfo

Latest JobInfo representing the status of the job result.


Create batch

<sfdc: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 will be done in asynchronous fashion.

XML Sample

<sfdc:create-batch config-ref="mySalesforceConfig">
    <sfdc:job-info id="#[flowVars['jobInfo']"/>
    <sfdc:objects>
        <sfdc:object ref="#[payload]" />
    </sfdc:objects>
</sfdc:create-batch>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobInfo

JobInfo

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

x 

objects

List<Map<String,Object>>

A list of one or more sObject objects. This parameter defaults to payload content.

#[payload]

 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Create batch stream

<sfdc: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. The operation will be done in asynchronous fashion.

XML Sample

<sfdc:create-batch-stream config-ref="mySalesforceConfig" stream-ref="#[flowVars['stream']]">
    <sfdc:job-info id="#[flowVars['jobInfo']]"/>
</sfdc:create-batch-stream>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobInfo

JobInfo

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

#[payload]

 

stream

InputStream

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

x 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Create batch for query

<sfdc:create-batch-for-query>

Creates a Batch using the given query.

This call uses the Bulk API. The operation will be done in asynchronous fashion.

XML Sample

<sfdc:create-batch-for-query config-ref="mySalesforceConfig" query="select AccountNumber, Name from Account">
    <sfdc:job-info ref="#[payload]"/>
</sfdc:create-batch-for-query>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobInfo

JobInfo

The com.sforce.async.JobInfo in which the batch will be created.

#[payload]

 

query

String

The query to be executed.

x 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Create bulk

<sfdc:create-bulk>

  DataSense enabled

Adds one or more new records to your organization's data.

This call uses the Bulk API. The creation will be done in asynchronous fashion.

XML Sample

<sfdc:create-bulk config-ref="mySalesforceConfig" type="Account">
    <sfdc:objects>
        <sfdc:object>
            <Name>MuleSoft</Name>
            <BillingStreet>30 Maiden Lane</BillingStreet>
            <BillingCity>San Francisco</BillingCity>
            <BillingState>CA</BillingState>
            <BillingPostalCode>94108</BillingPostalCode>
            <BillingCountry>US</BillingCountry>
        </sfdc:object>
    </sfdc:objects>
</sfdc:create-bulk>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to create

x 

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Create single

<sfdc:create-single>

  DataSense enabled

Adds one new record to your organization's data.

XML Sample

<sfdc:create-single config-ref="mySalesforceConfig" type="Account">
    <sfdc:object>
        <Name>MuleSoft</Name>
        <BillingStreet>30 Maiden Lane</BillingStreet>
        <BillingCity>San Francisco</BillingCity>
        <BillingState>CA</BillingState>
        <BillingPostalCode>94108</BillingPostalCode>
        <BillingCountry>US</BillingCountry>
    </sfdc:object>
</sfdc:create-single>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to create

x 

object

Map<String,Object>

SObject to create

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

SaveResult

An array of { SaveResult}


Update

<sfdc:update>

  DataSense enabled

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

XML Sample

<sfdc:update config-ref="mySalesforceConfig" type="Account">
    <sfdc:objects>
        <sfdc:object ref="#[payload]"/>
    </sfdc:objects>
</sfdc:update>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to update

x 

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

An array of { SaveResult}


Update single

<sfdc:update-single>

  DataSense enabled

Updates one record in your organization's data.

XML Sample

<sfdc:update-single config-ref="mySalesforceConfig" type="Account">
    <sfdc:object ref="#[payload]"/>
</sfdc:update-single>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to update

x 

object

Map<String,Object>

The object to be updated.

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

SaveResult

A { SaveResult}


Update bulk

<sfdc:update-bulk>

  DataSense enabled

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

This call uses the Bulk API. The creation will be done in asynchronous fashion.

XML Sample

<sfdc:update-bulk config-ref="mySalesforceConfig" type="Account">
    <sfdc:objects>
        <sfdc:object ref="#[payload]"/>
    </sfdc:objects>
</sfdc:update-bulk>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to update

x 

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Merge

<sfdc:merge>

  DataSense enabled

Merge up to three records into one.

XML Sample

<sfdc:merge config-ref="Salesforce__Basic_Authentication" type="Account">
            <sfdc:object>
                <Name>MuleSoft</Name>
                <BillingStreet>30 Maiden Lane</BillingStreet>
                <BillingCity>San Francisco</BillingCity>
                <BillingState>CA</BillingState>
                <BillingPostalCode>94108</BillingPostalCode>
                <BillingCountry>US</BillingCountry>
                <Id>001j000000FVBSHAA5</Id>
            </sfdc:object>
            <sfdc:ids>
                <sfdc:id>001j000000ZVBGAAA5</sfdc:id>
                <sfdc:id>001j000000ZVBUbAAP</sfdc:id>
            </sfdc:ids>
        </sfdc:merge>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to merge

x 

object

Map<String,Object>

The Master object used for the merge

#[payload]

 

ids

List<String>

A list of ids of the objects to be merged

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

MergeResult

instance of {see MergeResult} containing the result of the Merge


Upsert

<sfdc:upsert>

  DataSense enabled

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

XML Sample

<sfdc:upsert config-ref="mySalesforceConfig" type="Account" externalIdFieldName="InternalAccountCode">
    <sfdc:objects>
        <sfdc:object>
            <InternalAccountCode>A01596</InternalAccountCode>
            <Name>MuleSoft</Name>
            <BillingStreet>30 Maiden Lane</BillingStreet>
            <BillingCity>San Francisco</BillingCity>
            <BillingState>CA</BillingState>
            <BillingPostalCode>94108</BillingPostalCode>
            <BillingCountry>US</BillingCountry>
        </sfdc:object>
    </sfdc:objects>
</sfdc:upsert>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

externalIdFieldName

String

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

x 

type

String

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

x 

objects

List<Map<String,Object>>

The objects to upsert.

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

a list of UpsertResult, one for each


Upsert bulk

<sfdc:upsert-bulk>

  DataSense enabled

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

This call uses the Bulk API. The creation will be done in asynchronous fashion.

XML Sample

<sfdc:upsert-bulk config-ref="mySalesforceConfig" type="Account" externalIdFieldName="InternalAccountCode">
    <sfdc:objects>
        <sfdc:object>
            <InternalAccountCode>A01596</InternalAccountCode>
            <Name>MuleSoft</Name>
            <BillingStreet>30 Maiden Lane</BillingStreet>
            <BillingCity>San Francisco</BillingCity>
            <BillingState>CA</BillingState>
            <BillingPostalCode>94108</BillingPostalCode>
            <BillingCountry>US</BillingCountry>
        </sfdc:object>
    </sfdc:objects>
</sfdc:upsert-bulk>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

externalIdFieldName

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 

objects

List<Map<String,Object>>

The objects to upsert

#[payload]

 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Batch info

<sfdc:batch-info>

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

XML Sample

<sfdc:batch-info config-ref="mySalesforceConfig">
    <sfdc:batch-info ref="#[payload]"/>
</sfdc:batch-info>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

 

contentType

ContentType

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

 

Returns

Return Java Type Description

BatchInfo

Latest BatchInfo representing status of the batch job result.


Batch result

<sfdc:batch-result>

Access BatchResult of a submitted BatchInfo.

XML Sample

<sfdc:batch-result config-ref="mySalesforceConfig">
    <sfdc:batch-info ref="#[payload]"/>
</sfdc:batch-result>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

 

Returns

Return Java Type Description

BatchResult

BatchResult representing result of the batch job result.


Batch result stream

<sfdc:batch-result-stream>

Access BatchResult of a submitted BatchInfo.

XML Sample

<sfdc:batch-result-stream config-ref="mySalesforceConfig">
    <sfdc:batch-info ref="#[payload]"/>
</sfdc:batch-result-stream>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

 

headers

Map<String,String>

Optional parameter specifying the headers for the operation

 

Returns

Return Java Type Description

InputStream

InputStream representing result of the batch job result.


Query result stream

<sfdc:query-result-stream>

Returns an InputStream with the query results of a submitted BatchInfo

Internally the InputStreams contained in the sequence will be requested on-demand (lazy-loading). They should be used only with query jobs.

XML Sample

<sfdc:query-result-stream config-ref="mySalesforceConfig">
    <sfdc:batch-info ref="#[payload]"/>
</sfdc:query-result-stream>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

batchInfo

BatchInfo

The com.sforce.async.BatchInfo being monitored

#[payload]

 

headers

Map<String,String>

Optional parameter specifying the headers for the operation

 

Returns

Return Java Type Description

InputStream

InputStream with the results of the Batch.


Describe global

<sfdc:describe-global>

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

XML Sample

<sfdc:describe-global config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

DescribeGlobalResult

A DescribeGlobalResult


Retrieve

<sfdc:retrieve>

  DataSense enabled

Retrieves one or more records based on the specified IDs.

XML Sample

<sfdc:retrieve config-ref="mySalesforceConfig" type="Account">
     <sfdc:ids>
         <sfdc:id>4323</sfdc:id>
         <sfdc:id>4676</sfdc:id>
     </sfdc:ids>
     <sfdc:fields>
         <sfdc:field>Id</sfdc:field>
         <sfdc:field>Name</sfdc:field>
     </sfdc:fields>
</sfdc:retrieve>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

ids

List<String>

The ids of the objects to retrieve

#[payload]

 

fields

List<String>

The fields to return for the matching objects

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List<Map<String,Object>>

An array of SObjects


Query

<sfdc:query>

  Paged Operation

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

XML Sample

<sfdc:query config-ref="mySalesforceConfig" query="SELECT Id FROM Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

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 

pagingConfiguration

PagingConfiguration

the paging configuration

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,SalesforceConnector>

An array of SObjects query()


Non paginated query

<sfdc:non-paginated-query>

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

XML Sample

<sfdc:non-paginated-query config-ref="mySalesforceConfig" query="SELECT Id FROM Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

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 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List<Map<String,Object>>

An array of SObjects


Query all

<sfdc:query-all>

  Paged Operation

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

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 

pagingConfiguration

PagingConfiguration

the paging configuration

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,SalesforceConnector>

An array of { SObject}s query()


<sfdc:search>

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

XML Sample

<sfdc:search config-ref="mySalesforceConfig" query="Find {salesforce} RETURNING Solution(id, SolutionName, SolutionNumber, Mule_Version__c, Product__c)" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

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 Search Language (SOSL).

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List<Map<String,Object>>

An array of SObjects


Query single

<sfdc:query-single>

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

XML Sample

<sfdc:query-single config-ref="mySalesforceConfig" query="SELECT Id FROM Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

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 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

Map<String,Object>

A single SObject


Convert lead

<sfdc:convert-lead>

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

XML Sample

<sfdc:convert-lead config-ref="mySalesforceConfig"
                   leadId="001..." contactId="#[variable:contactId]" overWriteLeadSource="false" doNotCreateOpportunity="true"
                   convertedStatus="Qualified" sendEmailToOwner="true"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

leadId

String

ID of the Lead to convert. Required. For information on IDs, see ID Field Type.

x 

contactId

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.

 

accountId

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.

 

opportunityId

String

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

 

overWriteLeadSource

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

 

doNotCreateOpportunity

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

 

opportunityName

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.

 

convertedStatus

String

Valid LeadStatus value for a converted lead. Required. To obtain the list of possible values, the client application queries the LeadStatus object, as in: Select Id, MasterLabel from LeadStatus where IsConverted=true

x 

sendEmailToOwner

Boolean

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

false

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

LeadConvertResult

A LeadConvertResult object


Empty recycle bin

<sfdc:empty-recycle-bin>

The recycle bin lets you view and restore recently deleted records for 30 days before they are permanently deleted. Your organization can have up to 5000 records per license in the Recycle Bin at any one time. For example, if your organization has five user licenses, 25,000 records can be stored in the Recycle Bin. If your organization reaches its Recycle Bin limit, Salesforce.com automatically removes the oldest records, as long as they have been in the recycle bin for at least two hours.

XML Sample

<sfdc:empty-recycle-bin config-ref="mySalesforceConfig">
    <sfdc:ids>
        <sfdc:id>001...</sfdc:id>
    </sfdc:ids>
</sfdc:empty-recycle-bin>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

ids

List<String>

Array of one or more IDs associated with the records to delete from the recycle bin. Maximum number of records is 200.

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

A list of { com.sforce.soap.partner.EmptyRecycleBinResult}


Get server timestamp

<sfdc:get-server-timestamp>

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

XML Sample

<sfdc:get-server-timestamp config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

Calendar

Calendar with the current timestamp


Delete

<sfdc:delete>

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

XML Sample

<sfdc:delete config-ref="mySalesforceConfig">
    <sfdc:ids>
        <sfdc:id>001...</sfdc:id>
    </sfdc:ids>
</sfdc:delete>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

ids

List<String>

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

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

An array of DeleteResult


Hard delete bulk

<sfdc:hard-delete-bulk>

  DataSense enabled

Deletes one or more records from your organization's data. The deleted records are not stored in the Recycle Bin. Instead, they become immediately eligible for deletion.

This call uses the Bulk API. The creation will be done in asynchronous fashion.

XML Sample

<!-- Hard Delete Accounts -->
<sfdc:hard-delete-bulk config-ref="mySalesforceConfig" type="Account">
    <sfdc:objects>
        <sfdc:object ref="#[payload]"/>
    </sfdc:objects>
</sfdc:hard-delete-bulk>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

Type of object to update

x 

objects

List<Map<String,Object>>

An array of one or more sObject objects.

#[payload]

 

Returns

Return Java Type Description

BatchInfo

A BatchInfo that identifies the batch job.


Get updated range

<sfdc:get-updated-range>

  DataSense enabled

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

XML Sample

<sfdc:get-updated-range config-ref="mySalesforceConfig" type="Account" startTime="#[variable:startTime]" endTime="#[variable:endTime]"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

startTime

Calendar

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

x 

endTime

Calendar

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

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

GetUpdatedResult

GetUpdatedResult


Get deleted range

<sfdc:get-deleted-range>

  DataSense enabled

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

XML Sample

<sfdc:get-deleted-range config-ref="mySalesforceConfig" type="Account" startTime="#[variable:startTime]" endTime="#[variable:endTime]"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

startTime

Calendar

Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame to retrieve the data from. 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 

endTime

Calendar

Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame to retrieve the data from. 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 the time is not specified, the current server time will be used.

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

GetDeletedResult

A GetDeletedResult


Describe sObject

<sfdc:describe-sobject>

  DataSense enabled

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

XML Sample

<sfdc:describe-sobject config-ref="mySalesforceConfig" type="Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

DescribeSObjectResult

DescribeSObjectResult


Get deleted

<sfdc:get-deleted>

  DataSense enabled

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

XML Sample

<sfdc:get-deleted config-ref="mySalesforceConfig" type="#[map-payload:type]" duration="#[map-payload:duration]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

duration

int

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

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

GetDeletedResult

A GetDeletedResult


Get updated

<sfdc:get-updated>

  DataSense enabled

Retrieves the list of individual records that have been updated within a time range, specified in minutes, counting from the current time to some point in the past.

XML Sample

<sfdc:get-updated config-ref="mySalesforceConfig" type="#[map-payload:type]" duration="#[map-payload:duration]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

duration

int

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

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

GetUpdatedResult

GetUpdatedResult object containing an


Get updated objects

<sfdc:get-updated-objects>

  DataSense enabled

Retrieves the list of records that have been updated between the last time this method was called and now. This method will save the timestamp of the latest date covered by Salesforce represented by GetUpdatedResult#latestDateCovered. IMPORTANT: In order to use this method in a reliable way user must ensure that right after this method returns the result is stored in a persistent way since the timestamp of the latest . In order to reset the latest update time use resetUpdatedObjectsTimestamp(String)

XML Sample

<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns:spring="http://www.springframework.org/schema/beans"
            xmlns:sfdc="http://www.mulesoft.org/schema/mule/sfdc"
            xmlns:vm="http://www.mulesoft.org/schema/mule/vm"
            xsi:schemaLocation="
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
            http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
            http://www.mulesoft.org/schema/mule/vm http://www.mulesoft.org/schema/mule/vm/current/mule-vm.xsd
            http://www.mulesoft.org/schema/mule/sfdc http://www.mulesoft.org/schema/mule/sfdc/current/mule-sfdc.xsd">

    <flow name="getSalesforceUpdatedAccountObjects">
        <poll frequency="600000" >
            <sfdc:get-updated-objects config-ref="mySalesforceConfig" type="Account" initialTimeWindow="120">
                <sfdc:fields>
                    <sfdc:field>Id</sfdc:field>
                    <sfdc:field>Name</sfdc:field>
                </sfdc:fields>
            </sfdc:get-updated-objects>
        </poll>
        <vm:outbound-endpoint path="persistentQueue" exchange-pattern="one-way" connector-ref="persistentVmConnector" />
    </flow>
</mule>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

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

x 

initialTimeWindow

int

Time window (in minutes) used to calculate the start time (in time range) the first time this operation is called. E.g: if initialTimeWindow equals 2, the start time will be the current time (now) minus 2 minutes, then the range to retrieve the updated object will be (now - 2 minutes; now). After first call the start time will be calculated from the object store getting the last time this operation was exec

x 

fields

List<String>

The fields to retrieve for the updated objects

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List<Map<String,Object>>

List with the updated objects in the calculated time range


Reset updated objects timestamp

<sfdc:reset-updated-objects-timestamp>

  DataSense enabled

Resets the timestamp of the last updated object. After resetting this, a call to getUpdatedObjects will use the initialTimeWindow to get the updated objects. If no timeObjectStore has been explicitly specified and getUpdatedObjects has not been called then calling this method has no effect.

XML Sample

<sfdc:reset-updated-objects-timestamp config-ref="mySalesforceConfig" type="Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The object type for which the timestamp should be reset.

x 


Set password

<sfdc:set-password>

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

XML Sample

<sfdc:set-password userId="#[payload['Id']]" config-ref="pepe" newPassword="#[newPassword]"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userId

String

The user to set the password for.

x 

newPassword

String

The new password for the user.

x 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 


Publish topic

<sfdc:publish-topic>

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

XML Sample

<sfdc:publish-topic config-ref="mySalesforceConfig" topicName="AccountTopic" query="SELECT Id FROM Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topicName

String

Descriptive name of the push topic, such as MyNewCases or TeamUpdatedContacts. The maximum length is 25 characters. This value identifies the channel.

x 

query

String

The SOQL query statement that determines which records' changes trigger events to be sent to the channel. Maximum length: 1200 characters

x 

description

String

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

 


Publish streaming channel

<sfdc:publish-streaming-channel>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

channelName

String

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

x 

ownerId

String

Identifier fir the channel owner.

 

description

String

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

 

Returns

Return Java Type Description

List

A POJO list containing data about the outcome of the request.


Get user info

<sfdc:get-user-info>

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

XML Sample

<sfdc:get-user-info config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

GetUserInfoResult

A GetUserInfoResult


Create metadata

<sfdc:create-metadata>

  DataSense enabled

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

XML Sample

<sfdc:create-metadata config-ref="mySalesforceConfig" type="Account">
            <sfdc:objects>
                <sfdc:object ref="#[payload]" />
            </sfdc:objects>
    </sfdc:create-metadata>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The Metadata Type to be created

x 

objects

List<Map<String,Object>>

a List of Map<String, Object> representing the metadatas to be created

#[payload]

 

Returns

Return Java Type Description

List

An array of SaveResult: contains


Update metadata

<sfdc:update-metadata>

  DataSense enabled

Updates one or more metadata components in your organization.

XML Sample

<sfdc:update-metadata config-ref="mySalesforceConfig" type="Account">
            <sfdc:objects>
                <sfdc:object ref="#[payload]" />
            </sfdc:objects>
    </sfdc:update-metadata>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The metadata type of the components updated

x 

objects

List<Map<String,Object>>

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

#[payload]

 

Returns

Return Java Type Description

List

An array of SaveResult: containing


Upsert metadata

<sfdc:upsert-metadata>

  DataSense enabled

Creates or updates one or more metadata components in your organization

XML Sample

<sfdc:upsert-metadata config-ref="mySalesforceConfig" type="Account">
            <sfdc:objects>
                <sfdc:object ref="#[payload]" />
            </sfdc:objects>
    </sfdc:upsert-metadata>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The metadata type of the components to create/update

x 

objects

List<Map<String,Object>>

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

#[payload]

 

Returns

Return Java Type Description

List

An array of UpsertResult: Each returned


Delete metadata

<sfdc:delete-metadata>

  DataSense enabled

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

XML Sample

<sfdc:delete-metadata config-ref="mySalesforceConfig" type="Account">
            <sfdc:full-names>
                <sfdc:full-name>Full Name</sfdc:full-name>
            </sfdc:full-names>
    </sfdc:delete-metadata>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The metadata type of the components to delete

x 

fullNames

List<String>

Full names of the components to delete

#[payload]

 

Returns

Return Java Type Description

List

An array of DeleteResult: Each DeleteResult contains


Rename metadata

<sfdc:rename-metadata>

  DataSense enabled

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

XML Sample

<sfdc:rename-metadata config-ref="mySalesforceConfig" type="Account" oldFullName="oldAccount" newFullName="newAccount"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The metadata type of the components to rename

x 

oldFullName

String

The current component full name

#[payload]

 

newFullName

String

The new component full name

x 

Returns

Return Java Type Description

SaveResult

SaveResult: A SaveResult object is returned


Read metadata

<sfdc:read-metadata>

  DataSense enabled

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

XML Sample

<sfdc:read-metadata config-ref="mySalesforceConfig" type="Account">
            <sfdc:full-names>
                <sfdc:full-name>Full Name</sfdc:full-name>
            </sfdc:full-names>
    </sfdc:read-metadata>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The metadata type of the components to read

x 

fullNames

List<String>

List of full names of the components to read

#[payload]

 

Returns

Return Java Type Description

List<Map<String,Object>>

ReadResult containing an array of metadata components is


List metadata

<sfdc:list-metadata>

  DataSense enabled

Retrieves property information about metadata components in your organization

XML Sample

<sfdc:list-metadata config-ref="mySalesforceConfig" type="Account"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The metadata type used as criteria when querying for information

x 

Returns

Return Java Type Description

List

An array of FileProperties


Describe metadata

<sfdc:describe-metadata>

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

XML Sample

<sfdc:describe-metadata config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

DescribeMetadataResult

DescribeMetadataResult Contains information about


Deploy metadata

<sfdc:deploy-metadata>

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

XML Sample

<sfdc:deploy-metadata config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

stream

InputStream

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

#[payload]

 

ignoreWarnings

boolean

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

false

 

purgeOnDelete

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

 

rollbackOnError

boolean

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

true

 


Retrieve metadata

<sfdc:retrieve-metadata>

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

XML Sample

<sfdc:retrieve-metadata config-ref="Salesforce__Basic_Authentication" doc:name="Salesforce">
            <sfdc:package-names ref="#[['packageName1','packageName2']]"/>
    </sfdc:retrieve-metadata>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

packageNames

List<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.

 

specificFiles

List<String>

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

 

unpackaged

InputStream

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

 

Returns

Return Java Type Description

InputStream

InputStream representing result of the retrieve job.


Get session id

<sfdc:get-session-id>

Retrieves the Session Id of the current session.

XML Sample

<sfdc:get-session-id config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

validateSession

boolean

The session will be validated; if the session is invalid, reconnection will be triggered (if the strategy is enabled), and the new session id will be returned

false

 

Returns

Return Java Type Description

String

the Salesforce current session Id


Get server url

<sfdc:get-server-url>

Retrieves the Partner Server Url of the Salesforce instance.

XML Sample

<sfdc:get-server-url config-ref="mySalesforceConfig"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

String

the Salesforce Server Url


Invoke apex soap method

<sfdc:invoke-apex-soap-method>

  DataSense enabled

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

XML Sample

<sfdc:invoke-apex-soap-method config-ref="mySalesforceConfig" input-ref="input.xml" soapMethodName="methodName"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

soapMethodName

String

the Apex class method name that will be invoked using SOAP

x 

input

XMLStreamReader

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

#[payload]

 

Returns

Return Java Type Description

XMLStreamReader

XML containing the result of invoking the Apex method


Invoke apex rest method

<sfdc:invoke-apex-rest-method>

  DataSense enabled

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

XML Sample

<sfdc:invoke-apex-rest-method config-ref="mySalesforceConfig" restMethodName="ApexRestClassName-methodName" requestHeaders-ref="#[message.requestHeaders]">
    <sfdc:query-parameters>
        <sfdc:query-parameter key="queryParam1">queryParam1Value</sfdc:query-parameter>
        <sfdc:query-parameter key="queryParam2">queryParam2Value</sfdc:query-parameter>
    </sfdc:query-parameters>
</sfdc:invoke-apex-rest-method>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

restMethodName

String

The Apex class method name that will be invoked using REST

x 

input

Object

A Map containing the URLParameters if necessary and the request body information (if the http method allows input)

#[payload]

 

requestHeaders

ApexRequestHeaders

The reference to an ApexRequestHeaders object containing request headers and cookies

 

queryParameters

Map<String,String>

The query parameters that will be added to the request URL

 

Returns

Return Java Type Description

Map<String,Object>

A Map containing the result returned by the method invoked


Push generic event

<sfdc:push-generic-event>

Pushes generic streaming custom events to the specified streaming channel.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

events

List<GenericStreamingEvent>

The event list

#[payload]

 

channelId

String

The streaming channel name

x 

Returns

Return Java Type Description

List<PushEventResult>

A list containing information about each messages push result


Reset password

<sfdc:reset-password>

Resets the password of the user linked to the connector's configuration.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

ResetPasswordResult

instance of ResetPasswordResult containing generated password


Change own password

<sfdc:change-own-password>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

oldPassword

String

Old password of the account

x 

newPassword

String

New password of the account

x 

Returns

Return Java Type Description

ChangeOwnPasswordResult

instance of ChangeOwnPasswordResult containing the result of the operation


Find duplicates by ids

<sfdc:find-duplicates-by-ids>

  DataSense enabled

Performs id-based searches for duplicate records. The input is an array of ids to be used to detect the duplicates. The output identifies the detected duplicates for each id.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

- type of sobjects to find duplicates for

x 

ids

List<String>

- list of object ids used when searching for duplicates

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

list of found duplicate results containing information about the objects found as duplicates, one for each id specified


Find duplicates

<sfdc:find-duplicates>

  DataSense enabled

Performs rule-based searches for duplicate records. The input is an array of sObject, 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.

XML Sample

<sfdc:find-duplicates config-ref="Salesforce3" type="Account">
    <sfdc:objects>
        <sfdc:object>
             <sfdc:inner-object key="BillingStreet">30 Maiden Lane</sfdc:inner-object>
             <sfdc:inner-object key="BillingCity">San Francisco</sfdc:inner-object>
             <sfdc:inner-object key="BillingCountry">US</sfdc:inner-object>
             <sfdc:inner-object key="BillingState">CA</sfdc:inner-object>
             <sfdc:inner-object key="Name">MuleSoft</sfdc:inner-object>
             <sfdc:inner-object key="BillingPostalCode">94108</sfdc:inner-object>
        </sfdc:object>
    </sfdc:objects>
</sfdc:find-duplicates>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

- type of sobjects to find duplicates for

x 

criterion

List<Map<String,Object>>

- list of SObject used as a criterion when searching for duplicates

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

list of found duplicate results containing information about the objects found as duplicates, one for each SObject in criterion list


Batch info list

<sfdc:batch-info-list>

Get information about all batches in a job.

XML Sample

<sfdc:batch-info-list config-ref="Salesforce3" config-ref="mySalesforceConfig" jobId="ID"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

- id of the job that you want to reatrieve batch information for

x 

contentType

ContentType

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

 

Returns

Return Java Type Description

BatchInfoList

BatchInfoList associated to given job


Publish platform event message

<sfdc:publish-platform-event-message>

  DataSense enabled

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

platformEventName

String

name of platform event to create

x 

platformEventMessage

Map<String,Object>

PlatformEventMessage to create

#[payload]

 

headers

Map<SalesforceHeader,Object>

Salesforce Headers More Info

 

Returns

Return Java Type Description

List

An array of { SaveResult}

Sources


Subscribe topic

<sfdc:subscribe-topic>

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

XML Sample

<?xml version="1.0" encoding="UTF-8"?>
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns:spring="http://www.springframework.org/schema/beans"
            xmlns:sfdc="http://www.mulesoft.org/schema/mule/sfdc"
            xsi:schemaLocation="
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
            http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
            http://www.mulesoft.org/schema/mule/sfdc http://www.mulesoft.org/schema/mule/sfdc/current/mule-sfdc.xsd">

    <flow name="sendSmsNotifications">
        <sfdc:subscribe-topic config-ref="mySalesforceConfig"
                              topic="/NewsFeedStream"/>
        <logger level="INFO" message="Message received!"/>
    </flow>
</mule>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topic

String

The name of the topic to subscribe to

x 

callback

SourceCallback

The callback to call when a message is received

x 

Returns

Return Java Type Description

StopSourceCallback

org.mule.api.callback.StopSourceCallback


Subscribe streaming channel

<sfdc:subscribe-streaming-channel>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

streamingChannel

String

The name of the streaming channel to subscribe to

x 

callback

SourceCallback

The callback to call when a message is received

x 

Returns

Return Java Type Description

StopSourceCallback

org.mule.api.callback.StopSourceCallback


Replay topic

<sfdc:replay-topic>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

topic

String

The name of the topic to subscribe to

x 

replayOption

ReplayOption

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

x 

replayId

String

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

x 

autoReplay

boolean

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

false

 

callback

SourceCallback

The callback to call when a message is received

x 

Returns

Return Java Type Description

StopSourceCallback

org.mule.api.callback.StopSourceCallback


Replay streaming channel

<sfdc:replay-streaming-channel>

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:

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

streamingChannel

String

The name of the streaming channel to subscribe to

x 

replayOption

ReplayOption

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

x 

replayId

String

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

-2

 

autoReplay

boolean

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

false

 

callback

SourceCallback

The callback to call when a message is received

x 

Returns

Return Java Type Description

StopSourceCallback

org.mule.api.callback.StopSourceCallback