org.mule.modules

mule-module-sfdc

config

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	5.0
Minimum Mule Version	3.4

Module Overview

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.

Summary

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

Utility Calls API calls that your client applications can invoke to obtain the system timestamp, user information, and change user passwords.
<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-user-info> Retrieves personal information for the user associated with the current session.
<sfdc:reset-updated-objects-timestamp> Resets the timestamp of the last updated object.
<sfdc:set-password> Change the password of a User or SelfServiceUser to a value that you specify.

Streaming API Create topics, to which applications can subscribe, receiving asynchronous notifications of changes to data in Salesforce, via the Bayeux protocol.
<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:subscribe-topic> Subscribe to a topic.

Describe Calls A set of calls to describe record structure in Salesforce.
<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.

Core Calls A set of calls that compromise the core of the API.
<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-single> Adds one new records to your organization's data.
<sfdc:delete> Deletes one or more records from your organization's data.
<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-updated> Retrieves the list of individual records that have been updated between the range of now to the duration before 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:paginated-query> Executes a paginated query against the specified object and returns data that matches the specified criteria.
<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-single> Executes a query against the specified object and returns the first record that matches the specified criteria.
<sfdc:retrieve> Retrieves one or more records based on the specified IDs.
<sfdc:search> Search for objects using Salesforce Object Search Language
<sfdc:update> 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.

Bulk API The Bulk API provides programmatic access to allow you to quickly load your organization\'s data into Salesforce.
<sfdc:abort-job> Aborts an open Job given its ID.
<sfdc:batch-info> Access latest BatchInfo of a submitted BatchInfo.
<sfdc:batch-result> Access `BatchResult` of a submitted BatchInfo.
<sfdc:batch-result-stream> Access `BatchResult` of a submitted BatchInfo.
<sfdc:close-job> Closes an open Job given its ID.
<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-batch-stream> Creates a Batch using the given stream within the specified Job.
<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:hard-delete-bulk> Deletes one or more records from your organization's data.
<sfdc:query-result-stream> Returns an InputStream with the query results of a submitted BatchInfo
<sfdc:update-bulk> Updates one or more existing records in your organization's data.
<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.

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>

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" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

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	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		Username used to initialize the session	String	/	UTF-8
password		Password used to authenticate the user	String	/	UTF-8
securityToken		User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <sfdc:config>
         <reconnect count="5" frequency="1000"/>
    </sfdc:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.	String	/	UTF-8
initialTimeWindow		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	int	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:fields>	#[payload]	Optional. The fields to retrieve for the updated objects	List<String>

Returns

Return Type	Description
List<Map<String, Object>>	List with the updated objects in the calculated time range

API Information

This operation extends getUpdated()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:get-user-info>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
GetUserInfoResult	`GetUserInfoResult`

API Information

getUserInfo()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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 timeObjectStore has been explicitly specified and this#getUpdatedObjects has not been called then calling this method has no effect.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		The object type for which the timestamp should be reset.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Exception Payloads

Payload Class	Description
ObjectStoreException	`ConnectionException` when there is an error

<sfdc:set-password>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userId		The user to set the password for.	String	/	UTF-8
newPassword		The new password for the user.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
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.	String	/	UTF-8
query		The SOQL query statement that determines which records' changes trigger events to be sent to the channel. Maximum length: 1200 characters	String	/	UTF-8
description		Optional. Description of what kinds of records are returned by the query. Limit: 400 characters	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

API Information

Push Topic

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:describe-global>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
DescribeGlobalResult	A `DescribeGlobalResult`

API Information

describeGlobal()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:describe-sobject>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
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	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
DescribeSObjectResult	`DescribeSObjectResult`

API Information

describeSObject()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:convert-lead>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
leadId		ID of the Lead to convert. Required. For information on IDs, see ID Field Type.	String	/	UTF-8
contactId		Optional. 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.	String	/	UTF-8
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.	String	/	UTF-8
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.	Boolean	/
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.	Boolean	/
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.	String	/	UTF-8
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	String	/	UTF-8
sendEmailToOwner	false	Optional. Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default).	Boolean	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
LeadConvertResult	A `LeadConvertResult` object

API Information

convertLead()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to create	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. An array of one or more sObjects objects.	List<Map<String, Object>>

Returns

Return Type	Description
List<SaveResult>	An array of `SaveResult` if async is false

API Information

create()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:create-single>

Adds one new records to your organization's data.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to create	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:object>	#[payload]	Optional. SObject to create	Map<String, Object>

Returns

Return Type	Description
SaveResult	An array of `SaveResult`

API Information

create()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:delete>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:ids>	#[payload]	Optional. Array of one or more IDs associated with the objects to delete.	List<String>

Returns

Return Type	Description
List<DeleteResult>	An array of `DeleteResult`

API Information

delete()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:ids>		Array of one or more IDs associated with the records to delete from the recycle bin. Maximum number of records is 200.	List<String>

Returns

Return Type	Description
List<EmptyRecycleBinResult>	A list of `EmptyRecycleBinResult`

API Information

emptyRecycleBin()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.	String	/	UTF-8
duration		The amount of time in minutes before now for which to return records from.	int	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
GetDeletedResult	`GetDeletedResult`

API Information

getDeleted()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.	String	/	UTF-8
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).	Calendar	/
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.	Calendar	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
GetDeletedResult	`GetDeletedResult`

API Information

getDeletedRange()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.	String	/	UTF-8
duration		The amount of time in minutes before now for which to return records from.	int	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
GetUpdatedResult	`GetUpdatedResult` object containing an array of GetUpdatedResult objects containing the ID of each created or updated object and the date/time (Coordinated Universal Time (UTC) time zone) on which it was created or updated, respectively

API Information

getUpdated()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Object type. The specified value must be a valid object for your organization.	String	/	UTF-8
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).	Calendar	/
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.	Calendar	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
GetUpdatedResult	`GetUpdatedResult`

API Information

getUpdatedRange()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:paginated-query>

Executes a paginated query against the specified object and returns data that matches the specified criteria. The returned class QueryResultObject provides the methods getData() to retrieve the results in a List and hasMore() to check if there are more pages to retrieve from the server. The query result object contains up to 500 rows of data by default and can be increased up to 2,000 rows.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
query		Optional. 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).	String	/	UTF-8
queryResultObject		Optional. QueryResultObject returned by a previous call to this operation. If this is set the other parameter will be ignored.	QueryResultObject	/
withDeletedRecords	false	Optional. Flag that specifies whether or not to retrieve records that have been deleted.	Boolean	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
QueryResultObject	`QueryResultObject` with the results of the query or null.

API Information

query()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
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).	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
List<Map<String, Object>>	An array of SObjects

API Information

query()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:query-all>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
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).	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
List<Map<String, Object>>	An array of SObjects

API Information

query()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
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).	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
Map<String, Object>	A single SObject

API Information

query()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:retrieve>

Retrieves one or more records based on the specified IDs.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Object type. The sp ecified value must be a valid object for your organization.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:ids>		The ids of the objects to retrieve	List<String>
<sfdc:fields>		The fields to return for the matching objects	List<String>

Returns

Return Type	Description
List<Map<String, Object>>	An array of SObjects

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:search>

Search for objects using Salesforce Object Search Language

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
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 Search Language (SOSL).	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
List<Map<String, Object>>	An array of SObjects

API Information

search()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:update>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to update	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. An array of one or more sObjects objects.	List<Map<String, Object>>

Returns

Return Type	Description
List<SaveResult>	An array of `SaveResult`

API Information

update()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:update-single>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to update	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:object>	#[payload]	Optional. The object to be updated.	Map<String, Object>

Returns

Return Type	Description
SaveResult	A `SaveResult`

API Information

update()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
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.	String	/	UTF-8
type		The type of the given objects. The list of objects to upsert must be homogeneous	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. The objects to upsert	List<Map<String, Object>>

Returns

Return Type	Description
List<UpsertResult>	a list of `UpsertResult`, one for each passed object

API Information

upsert()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error if a connection error occurs

<sfdc:abort-job>

Aborts an open Job given its ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobId		The Job ID identifying the Job to be aborted.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
JobInfo	A JobInfo that identifies the aborted Job.

API Information

abortJob()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:batch-info>

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

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
batchInfo		The BatchInfo being monitored	BatchInfo	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
BatchInfo	Latest BatchInfo representing status of the batch job result.

API Information

getBatchInfo()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:batch-result>

Access BatchResult of a submitted BatchInfo.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
batchInfo		The BatchInfo being monitored	BatchInfo	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
BatchResult	`BatchResult` representing result of the batch job result.

API Information

getBatchResult()BatchInfo status

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:batch-result-stream>

Access BatchResult of a submitted BatchInfo.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
batchInfo		The BatchInfo being monitored	BatchInfo	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
InputStream	java.io.InputStream representing result of the batch job result.

API Information

getBatchResult()BatchInfo status

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:close-job>

Closes an open Job given its ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobId		The Job ID identifying the Job to be closed.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
JobInfo	A JobInfo that identifies the closed Job.

API Information

closeJob()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobInfo		The JobInfo in which the batch will be created.	JobInfo	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. A list of one or more sObjects objects. This parameter defaults to payload content.	List<Map<String, Object>>

Returns

Return Type	Description
BatchInfo	A `BatchInfo` that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobInfo		The JobInfo in which the batch will be created.	JobInfo	/
query	#[payload]	Optional. The query to be executed.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
BatchInfo	A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:create-batch-stream>

Creates a Batch using the given stream 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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
jobInfo		The JobInfo in which the batch will be created.	JobInfo	/
stream	#[payload]	Optional. A stream containing the data. This parameter defaults to payload content.	InputStream	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
BatchInfo	A `BatchInfo` that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to create	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. An array of one or more sObjects objects.	List<Map<String, Object>>

Returns

Return Type	Description
BatchInfo	A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:create-job>

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

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
operation		The `OperationEnum` that will be executed by the job.	OperationEnum	/
type		The type of Salesforce object that the job will process.	String	/	UTF-8
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).	String	/	UTF-8
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.	ContentType	/
concurrencyMode		Optional. The concurrency mode of the job, either Parallel or Serial.	ConcurrencyMode	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
JobInfo	A `JobInfo` that identifies the created Job.

API Information

createJob()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to update	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. An array of one or more sObjects objects.	List<Map<String, Object>>

Returns

Return Type	Description
BatchInfo	A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<sfdc:query-result-stream>

Returns an InputStream with the query results of a submitted BatchInfo

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
batchInfo		The BatchInfo being monitored	BatchInfo	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
InputStream	InputStream with the results of the Batch.

API Information

getBatchResult()BatchInfo status

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		Type of object to update	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. An array of one or more sObjects objects.	List<Map<String, Object>>

Returns

Return Type	Description
BatchInfo	A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

<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	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
type		The type of the given objects. The list of objects to upsert must be homogeneous	String	/	UTF-8
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.	String	/	UTF-8
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sfdc:objects>	#[payload]	Optional. The objects to upsert	List<Map<String, Object>>

Returns

Return Type	Description
BatchInfo	A BatchInfo that identifies the batch job.

API Information

createBatch()

Exception Payloads

Payload Class	Description
Exception	`ConnectionException` when there is an error

Message Sources

<sfdc:subscribe-topic>

Subscribe to a topic.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
topic		The name of the topic to subscribe to	String	/	UTF-8
callback		The callback to be called when a message is received	SourceCallback	/
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	String	/	UTF-8
password		Optional. Password used to authenticate the user	String	/	UTF-8
securityToken		Optional. User's security token	String	/	UTF-8
url	https://login.salesforce.com/services/Soap/u/26.0	Optional. Salesforce endpoint URL	String	/	UTF-8
proxyHost		Optional. Hostname of the proxy	String	/	UTF-8
proxyPort	80	Optional. Port of the proxy	int	/
proxyUsername		Optional. Username used to authenticate against the proxy	String	/	UTF-8
proxyPassword		Optional. Password used to authenticate against the proxy	String	/	UTF-8

Returns

Return Type	Description
StopSourceCallback	org.mule.api.callback.StopSourceCallback

API Information

Streaming API