Summary: Configuration | Message Processors | Message Sources

org.mule.modules

mule-module-sfdc

Namespace	http://www.mulesoft.org/schema/mule/sfdc
Schema Location	http://www.mulesoft.org/schema/mule/sfdc/current/mule-sfdc.xsd (View Schema)
Schema Version	4.0
Minimum Mule Version	3.3

Module Overview

The Salesforce Connector will allow to connect to the Salesforce application. 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.

{@sample.config INCLUDE_ERROR}

Summary

Configuration
<sfdc:config> Configure an instance of this module

Message Processors
<sfdc:batch-info> Access latest `BatchInfo` of a submitted `BatchInfo`.
<sfdc:batch-result> Access `BatchResult` of a submitted `BatchInfo`.
<sfdc:close-job> Closes an open Job given its ID.
<sfdc:convert-lead> Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
<sfdc:create> Adds one or more new records to your organization's data.
<sfdc:create-batch> Creates a Batch using the given objects within the specified Job.
<sfdc:create-batch-for-query> Creates a Batch using the given query.
<sfdc:create-bulk> Adds one or more new records to your organization's data.
<sfdc:create-job> Creates a Job in order to perform one or more batches through Bulk API Operations.
<sfdc:create-single> Adds one new records to your organization's data.
<sfdc:delete> Deletes one or more records from your organization's data.
<sfdc:describe-global> Retrieves a list of available objects for your organization's data.
<sfdc:describe-sobject> Describes metadata (field list and object properties) for the specified object.
<sfdc:empty-recycle-bin> The recycle bin lets you view and restore recently deleted records for 30 days before they are permanently deleted.
<sfdc:get-deleted> Retrieves the list of individual records that have been deleted between the range of now to the duration before now.
<sfdc:get-deleted-range> Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
<sfdc:get-session-id> Returns the session id for the current connection
<sfdc:get-updated> Retrieves the list of individual records that have been updated between the range of now to the duration before now.
<sfdc:get-updated-objects> Retrieves the list of records that have been updated between the last time this method was called and now.
<sfdc:get-updated-range> Retrieves the list of individual records that have been created/updated within the given timespan for the specified object.
<sfdc:get-user-info> Retrieves personal information for the user associated with the current session.
<sfdc:hard-delete-bulk> Deletes one or more records from your organization's data.
<sfdc:publish-topic> Creates a topic which represents a query that is the basis for notifying listeners of changes to records in an organization.
<sfdc:query> Executes a query against the specified object and returns data that matches the specified criteria.
<sfdc:query-all> Retrieves data from specified objects, whether or not they have been deleted.
<sfdc:query-result-stream> Returns an InputStream with the query results of a submitted `BatchInfo`
<sfdc:query-single> Executes a query against the specified object and returns the first record that matches the specified criteria.
<sfdc:reset-updated-objects-timestamp> Resets the timestamp of the last updated object.
<sfdc:retrieve> Retrieves one or more records based on the specified IDs.
<sfdc:update> Updates one or more existing records in your organization's data.
<sfdc:update-bulk> Updates one or more existing records in your organization's data.
<sfdc:update-single> Updates one or more existing records in your organization's data.
<sfdc:upsert> Upserts an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.
<sfdc:upsert-bulk> Upserts an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.

Message Sources
<sfdc:subscribe-topic> Subscribe to a topic.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:sfdc="http://www.mulesoft.org/schema/mule/sfdc"
      xsi:schemaLocation="
               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">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
	objectStore		Optional. A ObjectStore instance to use in this#getUpdatedObjects
xs:string	proxyHost		Optional. Proxy host
xs:string	proxyPassword		Optional. Proxy password
xs:int	proxyPort	80	Optional. Proxy port
xs:string	proxyUsername		Optional. Proxy username
xs:anyUri	url	https://login.salesforce.com/services/Soap/u/23.0	Optional. SalesForce SOAP endpoint

Configuration Sample

INCLUDE_ERROR

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <sfdc:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Description
username	Username used to initialize the session
password	Password used to authenticate the user
securityToken	User's security token

Also this connector offers automatic retry for certain operations. There are a couple of situations in which a retry may solve the problem at hand, like for example if the system is currently busy or if the session has expired. Those kind of situations are solvable by reacquiring a connection and retrying the operation.

By default, the connector will automatically attempt to retry the operation only once. You can at your choosing specify a greater ammount of retries by using the retryMax attribute on each operation.

    ... retryMax="3"/>

Message Processors

<sfdc:batch-info>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
batchInfo		The `BatchInfo` being monitored
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

Latest BatchInfo representing status of the batch job result.

API Information

getBatchInfo()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:batch-result>

Access BatchResult of a submitted BatchInfo.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
batchInfo		The `BatchInfo` being monitored
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

BatchResult representing result of the batch job result.

API Information

getBatchResult()BatchInfo status

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:close-job>

Closes an open Job given its ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
jobId		The Job ID identifying the Job to be closed.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

A JobInfo that identifies the closed Job.

API Information

closeJob()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:convert-lead>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
leadId		ID of the Lead to convert. Required. For information on IDs, see ID Field Type.
contactId		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		Optional. 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.
overWriteLeadSource	false	Optional. 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.
doNotCreateOpportunity	false	Optional. 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.
opportunityName		Optional. 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		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
sendEmailToOwner	false	Optional. Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default).
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

A list of LeadConvertResult

API Information

convertLead()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:create>

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

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to create
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> An array of one or more sObjects objects.

Return Payload

An array of SaveResult if async is false

API Information

create()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:create-batch>

Creates a Batch using the given objects within the specified Job.

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
jobInfo		The `JobInfo` in which the batch will be created.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> Optional. A list of one or more sObjects objects. This parameter defaults to payload content.

Return Payload

A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
	Exception
Exception

<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

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
jobInfo		The `JobInfo` in which the batch will be created.
query	#[payload]	Optional. The query to be executed.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:create-bulk>

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

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to create
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> An array of one or more sObjects objects.

Return Payload

A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:create-job>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
operation		The `OperationEnum` that will be executed by the job.
type		The type of Salesforce object that the job will process.
externalIdFieldName		Optional. 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		Optional. The Content Type for this Job results. When specifying a content type different from XML for a query type use `queryResultStream(com.sforce.async.BatchInfo)` batchResultStream} method to retrieve results.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

A JobInfo that identifies the created Job.

API Information

createJob()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:create-single>

Adds one new records to your organization's data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to create
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:object> SObject to create

Return Payload

An array of SaveResult

API Information

create()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:delete>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:ids> Array of one or more IDs associated with the objects to delete.

Return Payload

An array of DeleteResult

API Information

delete()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:describe-global>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

A DescribeGlobalResult

API Information

describeGlobal()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:describe-sobject>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

DescribeSObjectResult

API Information

describeSObject()

Exception Payloads

Payload Class	Description
	Exception
Exception

<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

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

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

Return Payload

A list of EmptyRecycleBinResult

API Information

emptyRecycleBin()

Exception Payloads

Payload Class	Description
Exception

<sfdc:get-deleted>

Retrieves the list of individual records that have been deleted between the range of now to the duration before now.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.
duration		The amount of time in minutes before now for which to return records from.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

GetDeletedResult

API Information

getDeleted()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:get-deleted-range>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.
startTime		Starting date/time (Coordinated Universal Time (UTC)not local timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value ' (for example, 12:30:15 is interpreted as 12:30:00 UTC).
endTime		Optional. Ending date/time (Coordinated Universal Time (UTC)not local timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If not specific, the current server time will be used.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

GetDeletedResult

API Information

getDeletedRange()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:get-session-id>

Returns the session id for the current connection

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

the session id for the current connection

<sfdc:get-updated>

Retrieves the list of individual records that have been updated between the range of now to the duration before now.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.
duration		The amount of time in minutes before now for which to return records from.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

GetDeletedResult

API Information

getUpdated()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:get-updated-objects>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.
initialTimeWindow		Time window (in minutes) to use the first time this method is called
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:fields> The fields to retrieve for the updated objects

Return Payload

GetDeletedResult

API Information

getUpdated()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:get-updated-range>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.
startTime		Starting date/time (Coordinated Universal Time (UTC)not local timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value ' (for example, 12:30:15 is interpreted as 12:30:00 UTC).
endTime		Optional. Ending date/time (Coordinated Universal Time (UTC)not local timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of 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.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

GetUpdatedResult

API Information

getUpdatedRange()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:get-user-info>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

GetUserInfoResult

API Information

getUserInfo()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:hard-delete-bulk>

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

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to update
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> An array of one or more sObjects objects.

Return Payload

A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:publish-topic>

Creates a topic which represents a query that is the basis for notifying listeners of changes to records in an organization.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
topicName		Descriptive name of the push topic, such as MyNewCases or TeamUpdatedContacts. The maximum length is 25 characters. This value identifies the channel.
query		The SOQL query statement that determines which records' changes trigger events to be sent to the channel. Maximum length: 1200 characters
description		Optional. Description of what kinds of records are returned by the query. Limit: 400 characters
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

API Information

Push Topic

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:query>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
query		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).
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

An array of SObjects

API Information

query()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:query-all>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
query		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).
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

An array of SObjects

API Information

query()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:query-result-stream>

Returns an InputStream with the query results of a submitted BatchInfo

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
batchInfo		The `BatchInfo` being monitored
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

InputStream with the results of the Batch.

API Information

getBatchResult()BatchInfo status

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:query-single>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
query		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).
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Return Payload

A single SObject

API Information

query()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:reset-updated-objects-timestamp>

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

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		The object type for which the timestamp should be resetted. XML Sample INCLUDE_ERROR
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

Exception Payloads

Payload Class	Description
ObjectStoreException

<sfdc:retrieve>

Retrieves one or more records based on the specified IDs.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Object type. The sp ecified value must be a valid object for your organization.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:ids> The ids of the objects to retrieve
<sfdc:fields> The fields to return for the matching objects

Return Payload

An array of SObjects

Exception Payloads

Payload Class	Description
Exception

<sfdc:update>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to update
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> An array of one or more sObjects objects.

Return Payload

An array of SaveResult

API Information

update()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:update-bulk>

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

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to update
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> An array of one or more sObjects objects.

Return Payload

A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:update-single>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		Type of object to update
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:object> Optional. The object to be updated.

Return Payload

A SaveResult

API Information

update()

Exception Payloads

Payload Class	Description
	Exception
Exception

<sfdc:upsert>

Upserts an 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) over create(String, List), to avoid creating unwanted duplicate records.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
externalIdFieldName		Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.
type		The type of the given objects. The list of objects to upsert must be homogeneous
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> The objects to upsert

Return Payload

a list of UpsertResult, one for each passed object

API Information

upsert()

Exception Payloads

Payload Class	Description
Exception	if a connection error occurs

<sfdc:upsert-bulk>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
type		The type of the given objects. The list of objects to upsert must be homogeneous
externalIdFieldName		Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token
Retry and Reconnect This message processor supports automatic retry and reconnect. If the API call fail for a known error then the API will be automatically retried. This does not happen on every type of error, only a few that has been selected and are known to be recoverable from.
retryMax	1	Optional. Specify how many times this operation can be retried automatically

Child Elements

<sfdc:objects> The objects to upsert

Return Payload

A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
	Exception
Exception

Message Sources

<sfdc:subscribe-topic>

Subscribe to a topic.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
topic		The name of the topic to subscribe to
callback		The callback to be called when a message is received
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username used to initialize the session
password		Optional. Password used to authenticate the user
securityToken		Optional. User's security token