Salesforce Bulk Query

The Salesforce Bulk Query activity supports SOQL for Bulk API.

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 Bulk Query 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.

Query Type Yes Select a query type from the drop-down list. The default type is Query. If you select Query from the drop-down list, the operation queues a job for retrieving existing records only. If you select QueryAll, the operation queues a job for retrieving all archived and deleted records.
Format Yes Select one of the following format of the file types in which you want to view the Query Results on Salesforce server from the drop-down list:
  • XML
  • JSON
  • CSV
Salesforce Query No Displays the query to be executed against the specified object. Click Query Builder to open the wizard to build your query or clear the existing query with Clear Query.

For more information about the query builder, see Salesforce Query Builder.

Prepared Statement No If you use a prepared parameter '?' in the query, then define the parameter name and its data type in the statement. You can add multiple prepared parameters using the add button. The data type Byte is not supported for the parameters in the query.
Serial Processing No Select this option if you prefer to process batches serially. By default, Salesforce processes batches in parallel.

Description

On the Description tab, you can enter a short description for the Salesforce Bulk Query activity.

Input

On the Input tab, you can specify input values for the Salesforce Bulk Query activity.

The following table lists the input elements on the Input tab of the Salesforce Bulk Query 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 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.

Bulk (All fields in this section are optional.)
queryType String Specifies the query type, that is, Query or QueryAll.
format String Select one of the following format of the file types in which you want to view the Query Results on Salesforce server from the drop-down list:
  • XML
  • JSON
  • CSV
serialProcessing Boolean Specifies if serial processing is used (true) or not (false). If value is set to false then the Salesforce processes batches in parallel.
query String Specifies the query to be executed against the specified object. Query specified on the Input tab gets priority over query added on the General tab.
fields

This field is visible when you define a prepared parameter on the General tab. You can pass the prepared parameters values under the parameters.

BulkOptional (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. If no timeout value is provided, then 180000 milliseconds is considered as default.
Sforce-Disable-Batch-Retry String Specifies if retries are disabled for unfinished batches included in the operation.

Valid values: 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.

For example, you can set the chunk size as follows: chunkSize=1000

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 Bulk Query activity:

Output Item Data Type Description
SalesforceBulkQueryOutput
result jobId String The ID of the job that is queued on the Salesforce server.
success Boolean Indicates whether the job was successfully queued (true) or not (false).

Fault

On the Fault tab, you can find the error code and error message of the Salesforce Bulk Query 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.