Salesforce Close Ingest Job Activity
The Salesforce Close Ingest Job activity is used to change the state of open jobs to a completed state. For example, UploadComplete, Closed, Aborted.
General
On the General tab, establish a connection with the Salesforce.com server.
The following table lists the configurations on the General tab of the Salesforce Close Ingest Job 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 browse and select a connection.
Description
On the Description tab, enter a short description for the Salesforce Close Ingest Job activity.
Input
On the Input tab, specify the input values for the Salesforce Close Ingest Job activity.
The following table lists the input elements on the Input tab of the Salesforce Close Ingest Job activity:
| Input Items | Data Type | Description |
|---|---|---|
| CloseJobConnection (All fields in this section are optional.) | ||
| ServerUrl | String | Enter the web address of the endpoint that is used by this operation. |
| SessionId | String | Enter the unique ID associated with this session. |
| ExternalSessionIdUsed | Boolean | Specify whether an external session ID is used (true) or not (false).
If the value is set to true, an external session ID is automatically filled in the sessionId field. Note: If the ExternalSessionIdUsed is set to true, the session cannot be refreshed and any attempt to do so results in an exception.
|
| CloseJob | ||
| jobId | String | Enter the ID of the bulk job that is going to be UploadComplete, closed, or aborted. |
| state | String | Enter the state to update the job to.
Valid values:UploadComplete, Closed, or Aborted referring to either closing a job or aborting it. |
| CloseJobOptional | ||
| timeout | Long | Specify the number of milliseconds an internal API call waits before returning the data.
Default value: 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 Close Job activity:
| Output Item | Data Type | Description | |
|---|---|---|---|
| SalesforceCloseJobOutput | |||
| 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 finishes. | |
Fault
On the Fault tab, you can find the error code and error message of the Salesforce Close Ingest Job 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 occurs 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. |