| java.lang.Object | |
| ↳ | org.mule.modules.salesforce.SalesforceModule |
Known Direct Subclasses
|
Known Indirect Subclasses
|
The Salesforce Connector will allow to connect to the Salesforce application. Almost every operation that can be done via the Salesforce's API can be done thru this connector. This connector will also work if your Salesforce objects are customized with additional fields or even you are working with custom objects.
Integrating with Salesforce consists of web service calls utilizing XML request/response setup over an HTTPS connection. The technical details of this connection such as request headers, error handling, HTTPS connection, etc. are all abstracted from the user to make implementation quick and easy. {@sample.config INCLUDE_ERROR}| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| LOGGER | |||||||||||
| bc | Bayeux client | ||||||||||
| bulkConnection | REST connection to the bulk API | ||||||||||
| connection | Partner connection | ||||||||||
| loginResult | Login result | ||||||||||
| objectStore | A ObjectStore instance to use in this#getUpdatedObjects | ||||||||||
| objectStoreHelper | |||||||||||
| objectStoreManager | Object store manager to obtain a store to support this#getUpdatedObjects | ||||||||||
| proxyHost | Proxy host | ||||||||||
| proxyPassword | Proxy password | ||||||||||
| proxyPort | Proxy port | ||||||||||
| proxyUsername | Proxy username | ||||||||||
| registry | |||||||||||
| url | SalesForce SOAP endpoint | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Access
BatchResult of a submitted BatchInfo. | |||||||||||
Closes an open Job given its ID.
| |||||||||||
Creates a new Salesforce session
| |||||||||||
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
| |||||||||||
Adds one or more new records to your organization's data.
| |||||||||||
Creates a Batch using the given objects within the specified Job.
| |||||||||||
Creates a Batch using the given query.
| |||||||||||
Adds one or more new records to your organization's data.
| |||||||||||
Creates a Job in order to perform one or more batches through Bulk API Operations.
| |||||||||||
Adds one new records to your organization's data.
| |||||||||||
Deletes one or more records from your organization's data.
| |||||||||||
Retrieves a list of available objects for your organization's data.
| |||||||||||
Describes metadata (field list and object properties) for the specified object.
| |||||||||||
End the current session
| |||||||||||
The recycle bin lets you view and restore recently deleted records for 30 days before they are
permanently deleted.
| |||||||||||
Retrieves the list of individual records that have been deleted between the range of now to the duration before now.
| |||||||||||
Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
| |||||||||||
Retrieve host of proxy
| |||||||||||
Retrieve proxy password
| |||||||||||
Retrieve proxy port
| |||||||||||
Retrieve proxy username
| |||||||||||
Returns the session id for the current connection
| |||||||||||
Retrieves the list of individual records that have been updated between the range of now to the duration before now.
| |||||||||||
Retrieves the list of records that have been updated between the last time this method was called and now.
| |||||||||||
Retrieves the list of individual records that have been created/updated within the given timespan for the specified object.
| |||||||||||
Retrieves personal information for the user associated with the current session.
| |||||||||||
Deletes one or more records from your organization's data.
| |||||||||||
Creates a topic which represents a query that is the basis for notifying
listeners of changes to records in an organization.
| |||||||||||
Executes a query against the specified object and returns data that matches the specified criteria.
| |||||||||||
Retrieves data from specified objects, whether or not they have been deleted.
| |||||||||||
Returns an InputStream with the query results of a submitted
BatchInfo
| |||||||||||
Executes a query against the specified object and returns the first record that matches the specified criteria.
| |||||||||||
Resets the timestamp of the last updated object.
| |||||||||||
Retrieves one or more records based on the specified IDs.
| |||||||||||
Set proxy host
| |||||||||||
Set proxy password
| |||||||||||
Set proxy port
| |||||||||||
Set proxy username
| |||||||||||
Set Salesforce endpoint.
| |||||||||||
Subscribe to a topic.
| |||||||||||
Updates one or more existing records in your organization's data.
| |||||||||||
Updates one or more existing records in your organization's data.
| |||||||||||
Updates one or more existing records in your organization's data.
| |||||||||||
Upserts
an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.
| |||||||||||
Upserts
an homogeneous list of objects: creates new records and updates existing records, using a custom field to determine the presence of existing records.
| |||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Create connector config
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
A ObjectStore instance to use in this#getUpdatedObjects
Object store manager to obtain a store to support this#getUpdatedObjects
Proxy host
Proxy password
Proxy port
Proxy username
SalesForce SOAP endpoint
Access BatchResult of a submitted BatchInfo.
| batchInfo | The BatchInfo being monitored |
|---|
BatchResult representing result of the batch job result.| Exception | |
| Exception |
Closes an open Job given its ID.
| jobId | The Job ID identifying the Job to be closed. |
|---|
JobInfo that identifies the closed Job. | Exception | |
| Exception |
Creates a new Salesforce session
| username | Username used to initialize the session |
|---|---|
| password | Password used to authenticate the user |
| securityToken | User's security token |
| ConnectionException | if a problem occurred while trying to create the session |
|---|---|
| ConnectionException |
Converts a Lead into an Account, Contact, or (optionally) an Opportunity.
| leadId | ID of the Lead to convert. Required. For information on IDs, see ID Field Type. |
|---|---|
| contactId | ID of the Contact into which the lead will be merged (this contact must be associated with the specified accountId, and an accountId must be specified). Required only when updating an existing contact.IMPORTANT if you are converting a lead into a person account, do not specify the contactId or an error will result. Specify only the accountId of the person account. If no contactID is specified, then the API creates a new contact that is implicitly associated with the Account. To create a new contact, the client application must be logged in with sufficient access rights. To merge a lead into an existing contact, the client application must be logged in with read/write access to the specified contact. The contact name and other existing data are not overwritten (unless overwriteLeadSource is set to true, in which case only the LeadSource field is overwritten). For information on IDs, see ID Field Type. |
| accountId | ID of the Account into which the lead will be merged. Required only when updating an existing account, including person accounts. If no accountID is specified, then the API creates a new account. To create a new account, the client application must be logged in with sufficient access rights. To merge a lead into an existing account, the client application must be logged in with read/write access to the specified account. The account name and other existing data are not overwritten. For information on IDs, see ID Field Type. |
| overWriteLeadSource | Specifies whether to overwrite the LeadSource field on the target Contact object with the contents of the LeadSource field in the source Lead object (true), or not (false, the default). To set this field to true, the client application must specify a contactId for the target contact. |
| doNotCreateOpportunity | Specifies whether to create an Opportunity during lead conversion (false, the default) or not (true). Set this flag to true only if you do not want to create an opportunity from the lead. An opportunity is created by default. |
| opportunityName | Name of the opportunity to create. If no name is specified, then this value defaults to the company name of the lead. The maximum length of this field is 80 characters. If doNotCreateOpportunity argument is true, then no Opportunity is created and this field must be left blank; otherwise, an error is returned. |
| convertedStatus | Valid LeadStatus value for a converted lead. Required. To obtain the list of possible values, the client application queries the LeadStatus object, as in: Select Id, MasterLabel from LeadStatus where IsConverted=true |
| sendEmailToOwner | Specifies whether to send a notification email to the owner specified in the ownerId (true) or not (false, the default). |
LeadConvertResult| Exception | |
| Exception |
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 | Type of object to create |
|---|---|
| objects | An array of one or more sObjects objects. |
SaveResult if async is false| Exception | |
| Exception |
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.| jobInfo | The JobInfo in which the batch will be created. |
|---|---|
| objects | A list of one or more sObjects objects. This parameter defaults to payload content. |
BatchInfo that identifies the batch job. | Exception | |
| Exception |
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 | Type of object to create |
|---|---|
| objects | An array of one or more sObjects objects. |
BatchInfo that identifies the batch job. | Exception | |
| Exception |
Creates a Job in order to perform one or more batches through Bulk API Operations.
| operation | The OperationEnum that will be executed by the job. |
|---|---|
| type | The type of Salesforce object that the job will process. |
| 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 (only required for Upsert Operations). |
| contentType | 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. |
JobInfo that identifies the created Job. | Exception | |
| Exception |
Adds one new records to your organization's data.
INCLUDE_ERROR
| type | Type of object to create |
|---|---|
| object | SObject to create |
SaveResult| Exception | |
| Exception |
Deletes one or more records from your organization's data.
| ids | Array of one or more IDs associated with the objects to delete. |
|---|
DeleteResult| Exception | |
| Exception |
Retrieves a list of available objects for your organization's data.
| Exception | |
| Exception |
Describes metadata (field list and object properties) for the specified object.
| type | Object. The specified value must be a valid object for your organization. For a complete list of objects, see Standard Objects |
|---|
| Exception | |
| Exception |
End the current session
| Exception |
|---|
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.
| ids | Array of one or more IDs associated with the records to delete from the recycle bin. Maximum number of records is 200. |
|---|
EmptyRecycleBinResult| Exception |
|---|
Retrieves the list of individual records that have been deleted between the range of now to the duration before now.
| type | Object type. The specified value must be a valid object for your organization. |
|---|---|
| duration | The amount of time in minutes before now for which to return records from. |
| Exception | |
| Exception |
Retrieves the list of individual records that have been deleted within the given timespan for the specified object.
INCLUDE_ERROR
| type | Object type. The specified value must be a valid object for your organization. |
|---|---|
| startTime | Starting date/time (Coordinated Universal Time (UTC)not local timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value ' (for example, 12:30:15 is interpreted as 12:30:00 UTC). |
| endTime | 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. |
| Exception | |
| Exception |
Retrieve host of proxy
Retrieve proxy password
Retrieve proxy port
Retrieve proxy username
Returns the session id for the current connection
Retrieves the list of individual records that have been updated between the range of now to the duration before now.
| type | Object type. The specified value must be a valid object for your organization. |
|---|---|
| duration | The amount of time in minutes before now for which to return records from. |
| Exception | |
| Exception |
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
| type | Object type. The specified value must be a valid object for your organization. |
|---|---|
| initialTimeWindow | Time window (in minutes) to use the first time this method is called |
| fields | The fields to retrieve for the updated objects |
| Exception | |
| Exception |
Retrieves the list of individual records that have been created/updated within the given timespan for the specified object.
| type | Object type. The specified value must be a valid object for your organization. |
|---|---|
| startTime | Starting date/time (Coordinated Universal Time (UTC)not local timezone) of the timespan for which to retrieve the data. The API ignores the seconds portion of the specified dateTime value ' (for example, 12:30:15 is interpreted as 12:30:00 UTC). |
| endTime | 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. |
| Exception | |
| Exception |
Retrieves personal information for the user associated with the current session.
| Exception | |
| Exception |
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.| type | Type of object to update |
|---|---|
| objects | An array of one or more sObjects objects. |
BatchInfo that identifies the batch job. | Exception | |
| Exception |
Creates a topic which represents a query that is the basis for notifying listeners of changes to records in an organization.
| topicName | Descriptive name of the push topic, such as MyNewCases or TeamUpdatedContacts. The maximum length is 25 characters. This value identifies the channel. |
|---|---|
| query | The SOQL query statement that determines which records' changes trigger events to be sent to the channel. Maximum length: 1200 characters |
| description | Description of what kinds of records are returned by the query. Limit: 400 characters |
| Exception | |
| Exception |
Executes a query against the specified object and returns data that matches the specified criteria.
| 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). |
|---|
SObjects| Exception | |
| Exception |
Retrieves data from specified objects, whether or not they have been deleted.
| 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). |
|---|
SObjects| Exception | |
| Exception |
Executes a query against the specified object and returns the first record that matches the specified criteria.
| 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). |
|---|
SObject| Exception | |
| Exception |
| ConnectionException |
|---|
Resets the timestamp of the last updated object. After resetting this, a call to this#getUpdatedObjects will use the initialTimeWindow to get the updated objects. If no objectStore has been explicitly specified and this#getUpdatedObjects has not been called then calling this method has no effect.
| type | The object type for which the timestamp should be resetted. |
|---|
| ObjectStoreException |
|---|
Retrieves one or more records based on the specified IDs.
| type | Object type. The sp ecified value must be a valid object for your organization. |
|---|---|
| ids | The ids of the objects to retrieve |
| fields | The fields to return for the matching objects |
SObjects| Exception |
|---|
| objectStore |
|---|
| objectStoreManager |
|---|
Set proxy host
| proxyHost | Proxy host to set |
|---|
Set proxy password
| proxyPassword | Proxy password to set |
|---|
Set proxy port
| proxyPort | Proxy port to set |
|---|
Set proxy username
| proxyUsername | Proxy username to set |
|---|
| registry |
|---|
Set Salesforce endpoint.
| url | Web service endpoint |
|---|
Subscribe to a topic.
| topic | The name of the topic to subscribe to |
|---|---|
| callback | The callback to be called when a message is received |
Updates one or more existing records in your organization's data.
| type | Type of object to update |
|---|---|
| objects | An array of one or more sObjects objects. |
SaveResult| Exception | |
| Exception |
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.| type | Type of object to update |
|---|---|
| objects | An array of one or more sObjects objects. |
BatchInfo that identifies the batch job. | Exception | |
| Exception |
Updates one or more existing records in your organization's data.
| type | Type of object to update |
|---|---|
| object | The object to be updated. |
| Exception | |
| Exception |
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.
| externalIdFieldName | Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects. |
|---|---|
| type | The type of the given objects. The list of objects to upsert must be homogeneous |
| objects | The objects to upsert |
UpsertResult, one for each passed object| Exception | if a connection error occurs |
|---|
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.
| type | The type of the given objects. The list of objects to upsert must be homogeneous |
|---|---|
| externalIdFieldName | Contains the name of the field on this object with the external ID field attribute for custom objects or the idLookup field property for standard objects. |
| objects | The objects to upsert |
BatchInfo that identifies the batch job. | Exception | |
| Exception |
Create connector config
| endpoint | Salesforce endpoint |
|---|---|
| username | Username to use for authentication |
| password | Password to use for authentication |
| proxyHost | |
| proxyPort | |
| proxyUsername | |
| proxyPassword |
| objectStoreHelper |
|---|
| type | |
|---|---|
| objects |