Read Data(execute SOQL) (deprecated)
Operation Name
Read Data (execute SOQL)
Function Overview
This operation is to read data, using the query() or queryAll() call of the SOAP API.
You an directly input SOQL(Sforce Object Query Language).
Therefore you must understand SOQL syntax.
For details about the API specification used in this component, 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)
-
SOAP API Developer's Guide
-
Salesforce Object Query Language (SOQL)
-
Data Model
The data model of this component is the Table Model type or XML type.
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. |
|
Schema definition |
Required |
- |
Sets the schema from the results of the SOQL. Each row can be operated with the following buttons:
|
|
Schema definition/Label |
Required |
Available |
Input the schema name that is to be obtained from the SOQL response. Usually this will be a field name specified in the SELECT clause. |
Note
|
Schema definition/API |
Optional |
Available |
Enter the API name for the schema. |
|
Schema definition/Type |
Required |
Not Available |
Select a data type. |
Note
An exception will be thrown if the conversion to the selected data type fails.
|
Property actions
Item name |
Description |
Remarks |
---|---|---|
Extraction test |
A query is performed, based on the specified schema and search conditions. The number of retrieved records will be displayed as a result. |
|
Automatically reflect the results from response of executed SOQL. |
Note
|
Option Settings
Item name |
Required/Optional |
Use of Variables |
Description |
Remarks |
---|---|---|---|---|
Read records that have been deleted(queryAll) |
Required |
- |
Specify whether or not to read the data that has been deleted from Salesforce. (If it is to be read, a reading, using the queryAll service, will take place.)
|
Note
Please be aware that, in the deleted record reading process by the data reading (query), data which has been deleted from the recycle bin can still be read for about 24 hours after deletion. |
Batch size |
Required |
Available |
Enter the batch size for obtaining the data reading results from Salesforce. |
Note
According to the Salesforce connector specifications, if you set a batch size to 2000 when reading 10,000 records, the result data set will be obtained in 5 parts. |
Comment
Item name |
Required/Optional |
Use of Variables |
Description |
Remarks |
---|---|---|---|---|
Comment |
Optional |
Not Available |
You can write a short description of this connector. |
|
None.
Data model type depends on the Schema definition.
-
When the schema does not use a parent-child relationship
It's table model type.
= Remarks =For schema structure, refer to Table model type .
-
When the schema uses a parent-child relationship
It's XML type.
Loading schema in Mapper
The schema is loaded automatically.
For details, refer to Edit Schema.
Mass data processing
Mass data processing isn't supported.
Parallel Stream Processing
PSP isn't supported.
Available Component variables
Component variable name |
Description |
Remarks |
---|---|---|
count |
The number of read data records is stored. |
|
object_name |
The object name is stored. |
Note
|
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 |