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.

= Remarks =

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

= Remarks =

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. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.	Connection resources for API 26.0 or later versions can be specified.
SOQL	Required	Available	Enter SOQL.	For syntax details, please refer to the Salesforce API documents.
Schema definition	Required	-	Sets the schema from the results of the SOQL. Each row can be operated with the following buttons: Up Moves the selected row upward by one row. Down Moves the selected row downward by one row. Add Adds a row. Remove Deletes the row.	The order of the SOQL does not need to match that of the Schema definition. You can automatically reflect the results from response of executed SOQL.
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 An empty result will be included if a schema name is input that is not included in the response. Differentiates between uppercase and lowercase. When a parent-child relationship is included, the data model becomes XML. In this case you cannot use variables. In addition you cannot use the below characters. If no alias is set for the aggregate function schema, the result will automatically be called "expr0". The ending character will start with 0 and increase by one for each aggregate function used. When a schema that includes a parent-child relationship is specified the [Relationship Name.Schema Name]. When a schema that includes a parent-child relationship is used, the relationship name is specified by Schema definition/child relationship name.
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. For data type details, please refer to the Salesforce API documents.

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.	Cannot be performed in the following instances: If the SOQL has not been specified. If a variable has been used for the SOQL.
Execute SOQL to set schema	Automatically reflect the results from response of executed SOQL.	Cannot be performed in the following instances: If the SOQL has not been specified. If a variable has been used for the SOQL. Note When the extracted results include an ID, the ID will be set to the beginning of the schema. The schema is not set correctly if not even a single record is returned. When using a relation query, the relationship record must also be included in the filter results. If no record exists, please set the schema manually. In the following case the type is not set. Please manually set the type: Includes GROUP BY clauses and functions. Fields with more than one reference.

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.) Selected Reads the data deleted in Salesforce. Not selected (Default) Does not read the data deleted in Salesforce.	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.	The default value is "2000." API specification will not allow value less than 200. If the value is set, the behavior will depend on the specification of the API. A number of 200 or greater, up to 2000, can be set. An error occurs if any number outside of this range is set. Depending on the operating environment, increasing the batch size generally helps improve the performance of the read data operation. 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.

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.)

Selected

Reads the data deleted in Salesforce.

Not selected

(Default)

Does not read the data deleted in Salesforce.

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.

The default value is "2000."
API specification will not allow value less than 200. If the value is set, the behavior will depend on the specification of the API.
A number of 200 or greater, up to 2000, can be set. An error occurs if any number outside of this range is set.
Depending on the operating environment, increasing the batch size generally helps improve the performance of the read data operation.

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.

Schemas

Input Schema

None.

Output Schema

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.

= Remarks =

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.	The default value is null.
object_name	The object name is stored.	The default value is null. Note When using aggregate functions or a GROUP BY clause, "AggregateResult" will be stored instead of the object name. The value will not be stored when the number of read records is 0.
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	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity 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.
operation_error_message	When an error occurs, the error message is stored.	The default value is null.
operation_error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Error message	Limitations
Messages and limitations of the Salesforce(deprecated) connector