Get Job and Batch Information

Operation Name

Function Overview

This operation issues a request for obtaining the specified job's job information (Getting Job Details) as well as the batch information list (Getting Information for All Batches in a Job).
The information of the specified job can be obtained from the component variable.
Also, the batch information list can be obtained from the output schema.

This component is a function that realizes the smallest unit Bulk API operation.
Generally, if utilizing the functions, such as [Bulk Write Data(Insert)], in order to perform job creation, batch creation, the obtainment of batch results, and job closing as bulk process, this component does not need to be used.

For the API specifications used in this operation, please refer to the version of the API document, selected in the global resource, in the below mentioned link.

"Salesforce Developer Documentation"-(https://developer.salesforce.com/docs)
- Bulk API Developer's Guide

Data Model

The data model of this component is the Table Model type.

Properties

For information about using variables, refer to "variables".

Basic Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Name	Required	Not Available	Enter the name that appears on the script canvas.

Required Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Destination	Required	Not Available	Select Global Resources. [Add...]: Add new global resource. [Edit...]: Global resource settings can be edited by [Edit Resource list].
Job ID	Required	Available	Enter the ID of the job to be specified.

Large Data Processing Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Large Data Processing	Required	Not Available	Select a Large Data Processing Settings. [Use the setting in the script]:(default) Apply Large Data Processing Settings settings of script property to adapter. [Disable Large Data Processing]: Large Data Processing is not performed. [Enable Large Data Processing]: Large Data Processing is performed.

Comment

Item name	Required/Optional	Use of Variables	Description	Supplement
Comment	Optional	Not Available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

The batch information, included in the obtained job, is output.

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>batchId</column>
    <column>numberRecordsProcessed</column>
    <column>createdDate</column>
    <column>state</column>
    <column>stateMessage</column>
    <column>systemModstamp</column>
    <column>numberRecordsFailed</column>
    <column>apexProcessingTime</column>
    <column>apiActiveProcessingTime</column>
    <column>totalProcessingTime</column>
  </row>
  <row>
    :
  </row>
</table>

Element Name	Column Name	Description	Supplement
row	-	Repeats as many times as the number of batches in the job.
column	batchId	The batch ID is output.
	numberRecordsProcessed	The record number of completed batch processes is output.
	createdDate	The starting time of the batch is output.
	state	The batch state is output. [Queued]:The process has not begun. [InProgress]:Currently processing. [Completed]:The process has completed. [Failed]:The process was not successful. Please check the [stateMessage]. [Not Processed]:The job was canceled before processing.
	stateMessage	The batch state message is output.
	systemModstamp	The batch SystemModstamp is output.
	numberRecordsFailed	Stores the number of records that were not successfully processed by the specified batch.	API 18.0 does not support this functionality so the value will not be stored when using this version.
	apexProcessingTime	Stores the processing time (ms) of triggers and other processes related to the specified batch.	API 18.0 does not support this functionality so the schema will not be displayed when using this version.
	apiActiveProcessingTime	Stores the processing time (ms) of the specified batch. Does not include time waiting for a queue or for serialization / parallelization.	API 18.0 does not support this functionality so the schema will not be displayed when using this version.
	totalProcessingTime	Stores the processing time (ms) of the specified batch. Does not include time waiting for a queue or for serialization / parallelization.	API 18.0 does not support this functionality so the schema will not be displayed when using this version.

Reading Schema by Mapper

The schema will be read automatically.

Large Data Processing

Large Data Processing is supported.

Transaction

Transaction is not supported.

Usage on PSP Script

Cannot be used on PSP Script.

Available Component variables

Component Variable Name	Description	Supplement
job_id	The ID of the specified job is stored.	The default value is null.
object	The object API of the specified job is stored.	The default value is null.
external_id_field_name	The external ID item API Name, of the specified job, is stored.	The default value is null.
concurrency_mode	The simultaneous execution mode of the specified job is stored.	The default value is null.
content_type	The contents type of the specified job is stored.	The default value is null.
state	The job state of the specified job is stored.	The default value is null.
operation	The operation type of the specified job is stored.	The default value is null.
created_by_id	The creator ID of the specified job is stored.	The default value is null.
created_date	The created time of the specified job is stored.	The default value is null.
number_batches_completed	The number of completed batches, of the specified job, is stored.	The default value is null.
number_batches_queued	The number of batches, in the queue of the specified job, is stored.	The default value is null.
number_batches_failed	The number of failed batches, in the specified job, is stored.	The default value is null.
number_batches_progress	The number of batches in process, in the specified job, is stored.	The default value is null.
number_batches_total	The total number of batches, in the specified job, is stored.	The default value is null.
number_records_processed	The number of records that have completed the process, in the specified job, is stored.	The default value is null.
number_records_failed	Stores the number of records that were not successfully processed by the specified batch.	The default value is null. API 18.0 does not support this functionality so the value will not be stored when using this version.
number_retries	The number of retries in the specified job is stored.	The default value is null.
apex_processing_time	Stores the processing time (ms) of triggers and other processes related to the specified batch.	The default value is null. API 18.0 does not support this functionality so the value will not be stored when using this version.
api_active_processing_time	Stores the processing time (ms) of the specified batch. Does not include time waiting for a queue or for serialization / parallelization.	The default value is null. API 18.0 does not support this functionality so the value will not be stored when using this version.
total_processing_time	Stores the total processing time (ms) of the specified page. Does not include time waiting for a queue.	The default value is null. API 18.0 does not support this functionality so the value will not be stored when using this version.
system_modstamp	The system time of the specified job is stored.	The default value is null.
server_url	The end point URL after Login is stored.	The default value is null.
session_id	The session Id is stored.	The default value is null.
message_category	In the case that an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	In the case that an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	In the case that an error occurs, the importance of the message code corresponding to the error is stored.	The default value is null.
operation_api_exception_code	The ExceptionCode of the occured error, in a case of API error, is stored.	The default value is null. For any error other than an API Error, the value is not stored. The content to be stored may change according to the version of DataSpider Servista.
operation_error_message	If an error occurs, the error message of the occured error is stored.	The default value is null. The content to be stored may change according to the version of DataSpider Servista.
operation_error_trace	When an error occurs, the trace information of the occured error is stored.	The default value is null. The content to be stored may change according to the version of DataSpider Servista.

Specification Limits

In order to perform data reading and writing with this adapter, API's of Salesforce organization must be published.

All permissions for reading/writing data and other operations, as well as data access control, depend upon the profile, shared rule setting and API specifications in Salesforce.

Main exceptions

Exception Name	Reason	Resolution
ResourceNotFoundException Resource Definition is Not Found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource Definition is Not Found. Name:[<Global Resource Name>]	The resource definition selected in [Destination] cannot be found.	Verify the global resource specified in [Destination]
java.net.UnknownHostException	This exception occurs when the PROXY server specified in the global resource cannot be found.	Verify the condition of the PROXY server. Or verify [Proxy Host] of the global resource specified in the [Destination].
java.net.SocketTimeoutException connect timed out	A time-out has occurred while connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Connection timeout(sec)] of the global resource specified in the [Destination].
java.net.SocketTimeoutException Read timed out	A time-out has occurred while waiting for a responce from the server after connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Timeout(sec)] of the global resource specified in the [Destination].
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException	Invalid value is set for the property of Salesforce Bulk adapter.	Check the error message, and verify the settings.
com.sforce.soap.partner.fault.LoginFault	Login to Salesforce has failed.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.
com.sforce.async.AsyncApiException	An error has occurred in the batch or job executed in the Salesforce Bulk adapter.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.