Salesforce Check Ingest Job Status Activity
The Salesforce Check Ingest Job Status activity performs a check on the jobs and retrieves their status.
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 Check Ingest Job Status 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
|
| Wait for completion | No | Select the checkbox to wait for the completion of the job and get the job status. Recommendation for Bulk Operation with large amount of data: When a large amount of data is processed during a Bulk Operation activity (added, updated, or deleted) and Bulk Queries return a large amount of data, it might take time to process the entire request. In such a scenario, select this option and give a sufficiently large timeout value to complete the operation. |
| Timeout | Yes | The timeout value specifies the number of milliseconds an activity waits before timing out. The activity will either time out after given milliseconds or if the
Wait for completion checkbox is selected, it will wait for the job to be completed, whichever is earlier.
Default value: 50000 milliseconds. The activity adds a buffer of 5000 milliseconds to the given value to allow for processing time. For example, if the value is given as 50000 milliseconds then the activity will time out after 55000 milliseconds. But the job check status poll is done only for the first 50000 milliseconds. (This does not apply for infinite timeout.) If timeout value is not specified: The system sets the value to infinite (that is, activity times out only after all records are processed). Note: Data type for Module property of
Timeout should be integer.
|
| Interval | Yes | Specifies the time interval between each check status call. The field is editable only when you select the
Wait for completion checkbox.
Default interval value: 1000 milliseconds. Tip: It is recommended that you choose this interval as per the submitted job for optimal API usage.
Note: Data type for Module property of
Interval should be Integer.
|
to select a usable connection for the activity.
Description
On the Description tab, you can enter a short description for the Salesforce Check Ingest Job Status activity.
Input
On the Input tab, you can specify input values for the Salesforce Check Ingest Job Status activity.
The following table lists the input elements on the Input tab of the Salesforce Check Ingest Job Status activity:
| Input Items | Data Type | Description |
|---|---|---|
| CheckStatusConnection (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 generated. |
| CheckStatus | ||
| jobId | String | Required. The ID of the job that is queued on the Salesforce server. |
| timeout | Integer | Optional. The timeout value specifies the number of milliseconds an internal API call waits before the data returns. |
| waitForCompletion | Boolean | Optional. Specifies a boolean value to wait for the completion of all jobs. |
| interval | Integer | Optional. Specifies the time interval between each check status call. |
| operationType | String | Supported operation types are insert, upsert, update, delete, harddelete, query, and queryall.
It can be mapped from the output of previous Bulk Ingest, Query, or Close Job activity. |
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 Check Ingest Job Status activity:
| Output Item | Data Type | Description | |
|---|---|---|---|
| SalesforceBulkQueryCheckStatus | |||
| 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 an 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 type. Values include:
|
|
| 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 Check Ingest Job Status activity. See Error Codes for more information about error codes and corrective actions to take.
| Fault | Generated 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. |