Bulk Get Data(Query) (deprecated)
Operation Name
Bulk Get Data(Query)
Function Overview
This operation performs a Query operation with Bulk API and creates CSV file.
Job Creation, batch creation, batch result obtainment, and job closing will be done subsequently as one operation.
For details about the API specification used in this operation, refer to the API documentation of the selected version in the connection resource from the following link destination page.
-
"Salesforce Developer Documentation"-(https://developer.salesforce.com/docs)
-
Bulk API Developer's Guide
-
Properties
For details on use of variables, refer to Variables.
Basic Settings
Item name |
Required/Optional |
Use of Variables |
Description |
Remarks |
---|---|---|---|---|
Name |
Required |
Not Available |
Enter a name that is used on the script canvas. |
|
Required Settings
Item name |
Required/Optional |
Use of Variables |
Description |
Remarks |
---|---|---|---|---|
Destination |
Required |
Not Available |
Select a connection resource.
|
|
SOQL |
Required |
Available |
Enter SOQL. |
|
File |
Required |
Available |
Input the file path of the CSV format. The Browse button launches a file chooser that allows you to select a file. |
Note
|
Encoding |
Required |
Available |
Select or enter an encoding for the file to write. When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8. = Remarks =
For details, refer to "Supported Encodings" (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html). |
|
New line code |
Required |
Not available |
Select a newline code.
|
|
Property actions
Item name |
Description |
Remarks |
---|---|---|
Preview |
The previewer is started, and the contents of the file specified in File is displayed. |
|
Option Settings
Item name |
Required/Optional |
Use of Variables |
Description |
Remarks |
---|---|---|---|---|
Concurrency mode |
Required |
Not Available |
Select the job's concurrency mode.
|
Note
If parallel processing is performed, database conflicts can occur. If there is a severe database conflict, reads may fail. If the sequential processing mode is used, the batches will be reliably processed one after another. However, with this option, the reading processing time may increase greatly. |
Waiting Time before the monitoring (sec) starts |
Optional |
Available |
Input the waiting time, until the beginning of the batch state monitoring, in seconds. |
|
Batch monitoring intervals (sec) |
Optional |
Available |
Input the intervals, which determine whether or not the batch results have been obtained and the process has completed, in seconds. |
|
Max. monitoring time(sec) |
Required |
Not Available |
Input the maximum monitoring time for the batch state in seconds. |
|
Comment
Item name |
Required/Optional |
Use of Variables |
Description |
Remarks |
---|---|---|---|---|
Comment |
Optional |
Not Available |
You can write a short description of this connector. |
|
Mass data processing
Mass data processing isn't supported.
Transaction
Transaction is supported.
Transaction is enabled only when Enable transaction in Transaction is checked.
Parallel Stream Processing
PSP isn't supported.
Available Component variables
Component Variable Name |
Description |
Remarks |
---|---|---|
job_id |
The IDs of the jobs created are stored. |
|
batch_id |
The IDs of the batches created are stored. |
|
number_records_processed |
The number of records that have completed the process, in the batch, is stored. |
|
number_records_failed |
Stores the number of records that were not successfully processed by the batch. |
|
created_date |
Start time of the batch is stored. |
|
state |
The batch state is stored. |
|
state_message |
The batch state message is stored. |
|
apex_processing_time |
Stores the processing time (ms) of triggers and other processes related to the batch. |
|
api_active_processing_time |
Stores the processing time (ms) of the batch. Does not include time waiting for a queue or for serialization / parallelization. |
|
total_processing_time |
Stores the total processing time (ms) of the batch. Does not include time waiting for a queue. |
|
system_modstamp |
The system time of the batch is stored. |
|
queryResultCount |
Number of files created on the server is stored. |
|
server_url |
The end point URL after Login is stored. |
|
session_id |
The session Id is stored. |
|
message_category |
When an error occurs, the category of the message code corresponding to the error is stored. |
|
message_code |
When an error occurs, the code of the message code corresponding to the error is stored. |
|
message_level |
When an error occurs, the severity of the message code corresponding to the error is stored. |
|
operation_api_exception_code |
The ExceptionCode of the occured error, in a case of API error, is stored. |
|
operation_error_message |
When an error occurs, the error message is stored. |
|
operation_error_trace |
When an error occurs, the trace information for the error is stored. |
|
Message codes, exception messages, and limitations
Connector |
Message code |
Error message |
Limitations |
---|---|---|---|
Messages and limitations of the Salesforce(deprecated) connector |