User Guide > Process Steps and Components > Invoker Step > Salesforce Changed Data Query Invoker
Was this helpful?
Salesforce Changed Data Query Invoker
Salesforce Changed Data Query Invoker calls query methods and outputs results into an XML file. The query methods, GetDeleted and GetUpdated, return a list of salesforce.com IDs that have been deleted or updated within a specified time period. The GetDeleted method also returns dates, such as when a particular ID was deleted.
You should be familiar with the salesforce.com web services before using this invoker.
Note:  The Salesforce Changed Data Query invoker is SHA-256 compliant and it supports Salesforce API version 54.0.
Supported Actions
Action
Description
Execute
Executes the supported parameters and properties.
 
Supported Action Parameters
Action
Parameter
Description
Execute
SourceMessage
Name of the Source message for the invoker
TargetMessage
Name of the Target message for the invoker
Supported Action Properties
Action
Name
Description
Execute
User Name
Username to access salesforce.com. The connection is limited to the access rights of the username that you use. For most purposes, enter a username with an Administrator profile.
Execute
Password
The password to authenticate the above username.
Execute
Endpoint Address
URL for salesforce.com endpoint. The default is https://www.salesforce.com/services/Soap/u/54.0.
If you do not set this option, the invoker uses the default. The default setting is based on the WSDL version. You can change the number in the URL to any supported version, including versions 21.0 through 54.0.
When you call this option, use EndpointAddress as shown in this example:
sourceMsg.properties("EndpointAddress") = "https://www.salesforce.com/services/use/u/54.0"
To connect to a sandbox, use EndpointAddress as shown in this example:
sourceMsg.properties("EndpointAddress") = "https://test.salesforce.com/services/Soap/u/54.0"
Execute
Method
Methods supported by the invoker:
• GetUpdated - Retrieves a list of IDs that have been added or changed within a given time period for the specified object type.
• GetDeleted - Retrieves a list of IDs that have been deleted within a given time period for the specified object type.
The time period for the method is specified as the Start Date and End Date.
Execute
Object Type
Name of the Salesforce entity to query.
Execute
Start Date
Start date for the GetUpdated or GetDeleted methods in the following format:
yyyy-MM-ddTHH:mm:ss.SSSZ
Example: 2006-12-20T12:09:15.000Z
This option is required; null values cause an error to be returned.
Note:  The Start Date value cannot be more than 30 days in the past.
Execute
End Date
End date for the GetUpdated or GetDeleted methods in the following format:
yyyy-MM-ddTHH:mm:ss.SSSZ
Example: 2006-12-25T06:00:45.000Z
Caution!  This option is required; null values cause an error to be returned.
All invoker property values can be specified as properties in the Source Message, and those properties override any invoker property values.
For example, you may have a Script step before the invoker that does the following:
sourceMsg.properties("StartDate") = "2006-12-20T16:40:00.000Z"
The sourceMsg in the Script Step is used as the Source Message for the invoker, so no matter what is specified in the Start Date invoker property, the sourceMsg property value is used as the Start Date.
Errors
You may encounter errors when you run your process. See the following table for error codes and their descriptions.
Code
Name
Description
Possible Reason
5
NOMEM
The allocated Java heap space memory has been exhausted.
You need to increase the Java heap space memory allocation, or select dates that are closer together so that fewer records are returned.
19
OPENERR
Salesforce.com returned an EXCEEDED_ID_LIMIT or OPERATION_TOO_LARGE exception.
The start and end dates may return too many records. Select dates that are closer together so that fewer records are returned.
33
BADOPTIONVALUE
The component detected an invalid or missing property value.
You specified a value using an incorrect format or did not supply a value.
34
INVALID
The invoker could not log in to Salesforce.com.
Username or password may be incorrect.
46
LICENSING
A valid product license is not found.
You must have a valid license for this component in order to use it.
50
UNSPECIFIED
An error occurred while loading the component.
See the process log for more information.
Last modified date: 02/09/2024