Search Results

Salesforce Retrieve All

The Salesforce Retrieve All activity retrieves one or more individual objects based on the specified object IDs from the database of your organization.

General

In the General tab, you can establish a connection to the Salesforce.com server.

The following table lists the configurations in the General tab of the Salesforce Retrieve All activity:

Field Module Property? Description
Name No The name displayed as the label of the activity in the process.
Salesforce Connection Yes The path to the Salesforce shared resource.

Click the Choose/Create Default Resource icon to select a usable connection for the activity.

Description

In the Description tab, you can enter a short description for the Salesforce Retrieve All activity.

Input

In the Input tab, you can specify input values for the Salesforce Retrieve All activity.

The following table lists the input elements in the Input tab of the Salesforce Retrieve All activity:

Input Items Data Type Description
connectionInfo (All fields in this section are optional.)
serverUrl String The web address of the endpoint that is used by this operation.
sessionId String The unique ID associated with this session.
externalSessionIdUsed Boolean Specifies whether an external session ID is used (true) or not (false).

If the value set to true, an external session ID is filled in the sessionId field.

In this case, when the session has to be refreshed, the refreshed operation cannot be performed, and an exception is thrown.

retrieve
batchSize Integer Optional. When processing large amounts of data, the activity internally invokes several SOAP calls. This field is used to set the batch size for the number of records returned through an SOAP call.

The value must be set between 200 and 2000. The default value is 500.

If the input value equals -1, it is set to the default value. If the input value is greater than 2000, it is set to 2000. If the input value is less than 200 (except -1), it is set to 200.

retrieveMain Each retrieveMain includes the following elements:
  • fieldList (A string value): required. A list of one or more fields in the specified object, separated by commas.You must specify valid field names and must have read-level permissions to each specified field.

    The fieldList defines the ordering of fields in the result. The usage of the wildcard (*) might cause a very large result set to be returned, which can slow the client application performance, so it is best practice to use this function when necessary.

  • sObjectType (A string value): required. The specified value must be a valid object for your organization.
  • ids (A string value): required. An array of one or more IDs of the objects to retrieve. You can pass a maximum of 2000 object IDs to the activity.
retrieve_Optional
_configData Each _configData includes the following element:
  • timeout (An integer value): the timeout value specifies the number of milliseconds an internal API call waits before the data returns.

    The default value is 15000 milliseconds.

headers Each headers includes the following elements:
  • CallOptions
    • client (A string value): a string that identifies a particular client.
    • defaultNamespace (A string value): a string that identifies a developer namespace prefix. Use this field to resolve field names in managed packages without having to fully specify the fieldName everywhere.
  • MruHeader
    • updateMru (A boolean value): specifies whether to update the list of most recently used items (true) or not (false), which is on the sidebar of the Salesforce.com user interface.
  • PackageVersionHeader
    Each PackageVersion includes the following nodes:
    • majorNumber (An integer value): the major version number of a package version.

      A package version is denoted by majorNumber.minorNumber, for example 2.1.

    • minorNumber (An integer value): the minor version number of a package version.

      A package version is denoted by majorNumber.minorNumber, for example 2.1.

    • namespace (A string value): the unique namespace of the managed package.
SubsetSetting Each SubsetSetting includes the following elements:
  • ProcessInSubsets (A boolean value): optional. Specifies whether you can process smaller batches of rows instead of retrieving one large result set (true) or not (false).

    This element must be used in conjunction with a Repeat loop scope to process the result sets. See Retrieving Data in the Subset Mode for more information.

    The default value is false.

  • subsetSize (An integer value): optional. This element is only available when the ProcessInSubsets field is set to true. When that field is set to true, records are processed in batches. The returned data is passed out from the activity when completing the activity in a subsetSize sized batch.

    This element specifies the maximum number of messages that are picked up for each execution loop. Its region is from 1 to 10.

    You can process smaller batches of rows instead of retrieving one large result set by using this element. This element must be used in conjunction with a Repeat loop scope to process the result sets. See Retrieving Data in the Subset Mode for more information.

    The default value is 1.

Output

In the Output tab, you can find the output value.

The following table lists the output elements in the Output tab of the Salesforce Retrieve All activity:

Output Item Data Type Description
retrieveAllResponse
result Complex An array of sObjects representing individual objects of the specified object and containing data defined in the fieldlist specified in the ids.

Those sObjects can be converted to the specified type defined in the metadata schema, for example, the Salesforce_Metadata, retrieved from the Salesforce.com server.

lastSubset Boolean Indicates whether the current output is the last subset (true) or not (false).

Fault

In the Fault tab, you can find the error code and error message of the Salesforce Retrieve All activity. See TIBCO ActiveMatrix BusinessWorks Error Code for more information about error codes and corrective actions to take.

Fault Thrown when
SalesforceExecuteSOAPMethodException An error occurred when calling an SOAP method.

For example, wrong values are set in the Input fields or the Salesforce session has timed out.

SalesforceLoginException An error occurred when logging in to the Salesforce.com server.
SalesforceConnectionNotFoundException An error occurred when the external session ID is not used or the Salesforce connection is not configured correctly.