Salesforce Connector Documentation Reference

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.

<salesforcen:abort-job>

Aborts an open Job given its ID. The Job ID identifying the Job to be aborted.

<salesforcen:batch-info>

Access latest { BatchInfo} of a submitted { BatchInfo}. Allows tracking of the execution status. The com.sforce.async.BatchInfo being monitored

<salesforcen:batch-info-list>

Get information about all batches in a job. - id of the job that you want to reatrieve batch information for - in case that batchInfoList can not be run - in case that a problem with connection to server occurs

<salesforcen:batch-result>

Access { com.sforce.async.BatchResult} of a submitted { BatchInfo}. The com.sforce.async.BatchInfo being monitored

<salesforcen:batch-result-stream>

Access { com.sforce.async.BatchResult} of a submitted { BatchInfo}. The com.sforce.async.BatchInfo being monitored

<salesforcen:close-job>

Closes an open Job given its ID. The Job ID identifying the Job to be closed.

<salesforcen:convert-lead>

Converts a Lead into an Account, Contact, or (optionally) an Opportunity. 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. 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 Salesforce Headers More Info 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. ID of the Lead to convert. Required. For information on IDs, see ID Field Type. 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. 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. 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. Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default).

<salesforcen: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")].

Type of object to create Salesforce Headers More Info An array of one or more sObject objects.

<salesforcen:create-batch>

Creates a Batch using the given objects within the specified Job. The Job can be of XML or CSV type. This call uses the Bulk API. The operation will be done in asynchronous fashion. The com.sforce.async.JobInfo in which the batch will be created. The Job can be of XML, JSON or CSV type. A list of one or more sObject objects. This parameter defaults to payload content.

<salesforcen: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. The query to be executed. The com.sforce.async.JobInfo in which the batch will be created.

<salesforcen:create-batch-stream>

Creates a Batch using the given stream within the specified Job. The stream can have a CSV,XML, ZIP_CSV or ZIP_XML format. This call uses the Bulk API. The operation will be done in asynchronous fashion. The com.sforce.async.JobInfo in which the batch will be created. This parameter defaults to payload content. A stream containing the data. The stream can have a CSV,XML, ZIP_CSV or ZIP_XML format.

<salesforcen: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. Type of object to create An array of one or more sObject objects.

<salesforcen:create-job>

Creates a Job in order to perform one or more batches through Bulk API Operations. The concurrency mode of the job, either Parallel or Serial. The type of Salesforce object that the job will process. 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. The com.sforce.async.OperationEnum that will be executed by the job. 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).

<salesforcen:create-metadata>

Create metadata: Adds one or more new metadata components to your organization The Metadata Type to be created a List of Map<String, Object> representing the metadatas to be created

<salesforcen:create-single>

Adds one new record to your organization's data. Type of object to create Salesforce Headers More Info SObject to create

<salesforcen:delete>

Deletes one or more records from your organization's data. Salesforce Headers More Info Array of one or more IDs associated with the objects to delete.

<salesforcen:delete-metadata>

Deletes one or more metadata components from your organization, given the object(s) API Name(s) The metadata type of the components to delete Full names of the components to delete

<salesforcen:deploy-metadata>

Deploy. File-based call to deploy XML components. Use this call to take file representations of components and deploy them into an organization by creating, updating, or deleting the components they represent. Indicates whether any failure causes a complete rollback (true) or not (false). A stream containing the data. This parameter defaults to payload content. Indicates whether a warning should allow a deployment to complete successfully (true) or not (false). If true, the deleted components in the destructiveChanges.xml manifest file aren't stored in the Recycle Bin. This option only works in Developer Edition or sandbox organizations; it doesn't work in production organizations.

<salesforcen:describe-global>

Retrieves a list of available objects for your organization's data. Salesforce Headers More Info

<salesforcen:describe-metadata>

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

<salesforcen:describe-sobject>

Describes metadata (field list and object properties) for the specified object. Salesforce Headers More Info Object. The specified value must be a valid object for your organization. For a complete list of objects, {see Standard Objects}

<salesforcen: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. Salesforce Headers More Info Array of one or more IDs associated with the records to delete from the recycle bin. Maximum number of records is 200.

<salesforcen:find-duplicates>

Performs rule-based searches for duplicate records. The input is an array of sObject, each of which specifies the values to search for and the type of object that supplies the duplicate rules. The output identifies the detected duplicates for each object that supplies the duplicate rules. findDuplicates() applies the rules to the values to do the search. The output identifies the detected duplicates for each sObject. - type of sobjects to find duplicates for - list of SObject used as a criterion when searching for duplicates Salesforce Headers More Info - in case that findDuplicate can not be run - in case that a problem with connection to server occurs

<salesforcen:get-deleted>

Retrieves the list of individual records that have been deleted since a time in the past specified in minutes before now. Salesforce Headers More Info Object type. The specified value must be a valid object for your organization. The amount of time, counted from now to some point in the past, for which to return records.

<salesforcen:get-deleted-range>

Retrieves the list of individual records that have been deleted within the given time frame for the specified object. Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame to retrieve the data from. The API ignores the value for seconds in the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC). Salesforce Headers More Info Object type. The specified value must be a valid object for your organization. Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame to retrieve the data from. The API ignores the value for seconds in the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If the time is not specified, the current server time will be used.

<salesforcen:get-server-timestamp>

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

<salesforcen:get-server-url>

Retrieves the Partner Server Url of the Salesforce instance.

<salesforcen:get-session-id>

Retrieves the Session Id of the current session. The session will be validated; if the session is invalid, reconnection will be triggered (if the strategy is enabled), and the new session id will be returned

<salesforcen:get-updated>

Retrieves the list of individual records that have been updated within a time range, specified in minutes, counting from the current time to some point in the past. Salesforce Headers More Info Object type. The specified value must be a valid object for your organization. The amount of time in minutes, counted from now to some point in the past, to specify the range you want updated records from.

<salesforcen: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 GetUpdatedResult#latestDateCovered. IMPORTANT: In order to use this method in a reliable way user must ensure that right after this method returns the result is stored in a persistent way since the timestamp of the latest . In order to reset the latest update time use resetUpdatedObjectsTimestamp(String) 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 Salesforce Headers More Info The fields to retrieve for the updated objects Object type. The specified value must be a valid object for your organization.

<salesforcen:get-updated-range>

Retrieves the list of individual records that have been created/updated within the given time frame for the specified object. Ending date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:35:15 is interpreted as 12:35:00 UTC). If it is not provided, the current server time will be used. Salesforce Headers More Info Starting date/time (Coordinated Universal Time (UTC) not local timezone) of the time frame for which to retrieve the data. The API ignores the value for seconds in the specified dateTime value (for example, 12:30:15 is interpreted as 12:30:00 UTC). Object type. The specified value must be a valid object for your organization.

<salesforcen:get-user-info>

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

<salesforcen: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. An array of one or more sObject objects. Type of object to update

<salesforcen:invoke-apex-rest-method>

Invokes any operation from an Apex class that is exposed as REST web service The query parameters that will be added to the request URL A Map containing the URLParameters if necessary and the request body information (if the http method allows input) The reference to an ApexRequestHeaders object containing request headers and cookies The Apex class method name that will be invoked using REST

<salesforcen:invoke-apex-soap-method>

Invokes any operation from an Apex class that is exposed as SOAP web service the Apex class method name that will be invoked using SOAP XML containing information about the method to be invoked and its parameters. The XML must adhere to the WSDL standards.

<salesforcen:job-info>

Access latest { JobInfo} of a submitted { JobInfo}. Allows to track execution status. the Job ID of the Job being monitored

<salesforcen:list-metadata>

Retrieves property information about metadata components in your organization The metadata type used as criteria when querying for information

<salesforcen:merge>

Merge up to three records into one. A list of ids of the objects to be merged Salesforce Headers More Info Type of object to merge The Master object used for the merge

<salesforcen:non-paginated-query>

Executes a query against the specified object and returns data that matches the specified criteria. 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). Salesforce Headers More Info { com.sforce.ws.ConnectionException} when there is an error related to connection { org.mule.modules.salesforce.exception.SalesforceException} when there is an error query()

<salesforcen:publish-streaming-channel>

Creates a streaming channel on which generic, custom messages can be pushed. Descriptive name of the StreamingChannel. Limit: 80 characters, must start with "/u/". This value identifies the channel and must be unique. Identifier fir the channel owner. Description of what kinds of records are returned by the query. Limit: 255 characters When there is a connection error Streaming Channel

<salesforcen:publish-topic>

Creates a topic representing a query, which is used to notify listeners when changes are made to records in an organization. Descriptive name of the push topic, such as MyNewCases or TeamUpdatedContacts. The maximum length is 25 characters. This value identifies the channel. The SOQL query statement that determines which records' changes trigger events to be sent to the channel. Maximum length: 1200 characters Description of what kinds of records are returned by the query. Limit: 400 characters

<salesforcen:push-generic-event>

<salesforcen:query>

Executes a query against the specified object and returns data that matches the specified criteria. The returned fields are String and, if necessary, you can convert them to the apropiate type using for example Weave and Transform Message 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). Salesforce Headers More Info

<salesforcen:query-all>

Retrieves data from specified objects, whether or not they have been deleted. 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). Salesforce Headers More Info

<salesforcen:query-result-stream>

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

<salesforcen:query-single>

Executes a query against the specified object and returns the first record that matches the specified criteria. 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). Salesforce Headers More Info { com.sforce.ws.ConnectionException} when there is an error related to connection { org.mule.modules.salesforce.exception.SalesforceException} when there is an error query()

<salesforcen:read-metadata>

Returns one or more metadata components from your organization, given the object(s) API Name(s) The metadata type of the components to read List of full names of the components to read

<salesforcen:rename-metadata>

Renames a Metadata component in your organization, given its old API Name and the new name The new component full name The metadata type of the components to rename The current component full name

<salesforcen:reset-password>

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

<salesforcen:reset-updated-objects-timestamp>

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

<salesforcen:retrieve>

Retrieves one or more records based on the specified IDs. Salesforce Headers More Info Object type. The specified value must be a valid object for your organization. The fields to return for the matching objects The ids of the objects to retrieve

<salesforcen:retrieve-metadata>

Retrieve. This call retrieves XML file representations of components in an organization. A list of file names to be retrieved. If a value is specified for this property, packageNames must be set to null. A list of package names to be retrieved. If you are retrieving only unpackaged components, do not specify a name. You can retrieve packaged and unpackaged components in the same retrieval operation. A stream containing a list of components to retrieve that are not in a package.

<salesforcen:search>

Search for objects using Salesforce Object Search Language. Mimics using the search box inside the Salesforce UI. 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). Salesforce Headers More Info

<salesforcen:set-password>

Change the password of a User or SelfServiceUser to a value that you specify. The new password for the user. Salesforce Headers More Info The user to set the password for.

<salesforcen:update>

Updates one or more existing records in your organization's data. Salesforce Headers More Info An array of one or more sObject objects. Type of object to update

<salesforcen: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. An array of one or more sObject objects. Type of object to update

<salesforcen:update-metadata>

Updates one or more metadata components in your organization. a List of Map<String, Object> representing the metadata to be updated The metadata type of the components updated

<salesforcen:update-single>

Updates one record in your organization's data. Salesforce Headers More Info The object to be updated. Type of object to update

<salesforcen:upsert>

Upserts a homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records. In most cases, prefer { #upsert(String, String, List, Map)} over { #create(String, List, Map)}, to avoid creating unwanted duplicate records. 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. The type of the given objects. The list of objects to upsert must be homogeneous. Salesforce Headers More Info The objects to upsert.

<salesforcen:upsert-bulk>

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

<salesforcen:upsert-metadata>

Creates or updates one or more metadata components in your organization The metadata type of the components to create/update A List of Map<String, Object> representing the metadatas to be upserted

<salesforcen:subscribe-topic-source>