Salesforce Get Result

The Salesforce Get Result activity is used to retrieve the job results for Bulk Operation and Bulk Query.

General

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

The following table lists the configurations on the General tab of the Salesforce Get Result 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.

Output Format Yes
Select one of the following format of the file types from the drop-down list:
  • JSON
  • XML
  • CSV
  • ROW
Note: If you select ROW format during Bulk Operation and want the Get Result to be written into a file then you should select XML file type in Get Result
Output File Yes

Specifies the absolute path for the Output file. The file format should be compatible with the format selected for Bulk Operation Activity.

Description

On the Description tab, you can enter a short description for the Salesforce Get Result activity.

Input

On the Input tab, you can specify input values for the Salesforce Get Result activity.

The following table lists the input elements on the Input tab of the Salesforce Get Result activity:

Input Items Data Type Description
GetResultConnection (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 is 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.

GetResult
jobId String Required. Specifies the job Id for which the result is to be obtained.
fileLocation String Optional. Specifies the file path of the records file. This field is not displayed when ROW format is selected on the General tab.
GetResultOptional (All fields in this section are optional.)
timeout Long The timeout value specifies the number of milliseconds an internal API call waits before the data returns.

Default value is set to infinite. If timeout is not provided it fails with TimeoutError.

Sforce-Disable-Batch-Retry String Specifies if retries are disabled for unfinished batches included in the operation. Field values are either True or False.
Sforce-Line-Ending String Specifies whether line endings are read as line feeds (LFs) or as carriage returns and line feeds (CRLFs).
Sforce-Enable-PK-Chunking String Enables automatic primary key (PK) chunking for a bulk query operation. This option is used for Bulk Query activity only.

Output

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

The following table lists the output elements on the Output tab of the Salesforce Get Result activity:

Output Item Data Type Description
SalesforceGetResultOutput
result jobId String The ID of an sObject used later to check job status and get job result.
success Boolean Indicates whether the bulk query activity has succeeded (true) or not (false).
filepath String

Indicates the file path of the results.

unprocessedBatches Integer Specifies the number of batches that are not processed.
record The fields under record refer to the actual records for that Job ID. If you perform a Get Result operation after the Bulk operation, then the records display the record that was either inserted, upserted, updated, or deleted using bulk operation. If the Job ID is of a bulk query then it displays the records that were queried for the bulk query.

Fault

On the Fault tab, you can find the error code and error message of the Salesforce Get Result activity. See Error Codes for more information about error codes and corrective actions to take.

Fault Thrown when..
SalesforceRestException There is a problem with REST request, response or any other REST API error.
SalesforceLoginException An error occurred when logging in to the Salesforce.com server.
SalesforceConnectionNotFoundException An error occurred when the external session ID was not used or the Salesforce connection was not configured correctly.