Salesforce Bulk Ingest Query Activity

The Salesforce Bulk Ingest Query supports SOQL to query large data for Bulk API 2.0

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 Ingest 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. The available format is CSV.
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.
Line Ending Yes Specifies whether line endings are read as line feeds (LFs) or as carriage returns and line feeds (CRLFs).
CSV Separator Yes Specifies the CSV separator that is used in the file. You can select any one of these separators: Comma, Backquote, Caret, Pipe, Semicolon, and Tab.

Description

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

Input

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

The following table lists the input elements on the Input tab of the Salesforce Bulk Ingest 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 The format of the file type in which you want to view the Query Results on Salesforce server. The file format supported is CSV.
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.
BulkOptional
timeout Long The timeout value specifies the number of milliseconds an activity waits before it times out.

Default value: 18000 milliseconds

If timeout value is not specified: The system sets the value to infinite (that is, activity times out only after all records are processed)

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

Output Item Data Type Description
SalesforceBulkQueryOutput
jobInfo apiVersion String The salesforce API version in which the job was created.
columnDelimiter String Column Delimiter (symbol used to separate fields in the CSV records) used in the CSV job data. Values include COMMA, CARET, PIPE, BACKQUOTE, SEMICOLON, and TAB.
concurrencyMode String For future use. Currently only parallel mode is supported in Bulk API 2.0.
contentType String The format of the data being processed. Currently only CSV is supported for Bulk API 2.0.
contentUrl String The URL to use for Upload Job requests for this job. Only provided if the job is in Open state.
createdById String The ID of the user who created the job. The batch is created by using the same user.
createdDate DateTime The date and time in the UTC time zone when the job was created.
externalIdFieldname String Optional. This field contains the name of the field defined as the key indexing field in the Salesforce object.

It is used with the upsert operation.

id String Unique ID of the job. The same can be mapped to further activities such as CheckStatus, GetResult, and CloseJob.
jobType String The job’s type. Values include:
  • BigObjectIngest: BigObjects job
  • Classic: Bulk API 1.0 job
  • V2Ingest: Bulk API 2.0 job
lineEnding String The line ending used for CSV job data. This output field can be mapped to the GetResult activity.
object String The Salesforce object type for the data being processed.
operation String The processing operation specified. This can be mapped to further activities such as CheckStatus and GetResult.
state String The current state of processing for the job. The BulkOperation and BulkQuery activities always update the job's state to UploadComplete. Other states are Open, Aborted, JobComplete, and Failed.
systemModstamp String Date and time in the UTC time zone when the job finished.

Fault

On the Fault tab, you can find the error code and error message of the Salesforce Bulk Ingest 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.
SalesforceBulkException An error occurred when validating input parameters, requests, and parsing data before sending a request to Salesforce.