Official |[Salesforce] Read Records (SOQL)

Operation name

Read Records (SOQL)

Function overview

Reads records from an object.

This component uses "query" for REST API.

To check technical details, go to salesforce.com and check the page for SOQL queries and other related pages in the REST API Developer Guide.

Data model

The data model of this component is table model 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 to use on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Authentication settings	Required	Not available	Select a connection resource (OAuth) to use for authentication. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Connection settings	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.
SOQL	Required	Available	Enter SOQL.
Field list	Required	-	Specify fields. Each field 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 field. Delete Deletes the selected field.
Field list/Target	-	Not available	Select whether or not to include each field in target to read. Selected Include in the target to read. Not selected (Default) Don't include in the target to read.
Field list/Label	-	Not available	Enter the label for the field.
Field list/Name	-	Not available	Enter the field name (system name).
Field list/Type	-	Not available	Enter the name of the type in Salesforce.	For details on the types you can enter, refer to the following: Primitive data types (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/primitive_data_types.htm) Data types (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/field_types.htm) Refer to the table below and make sure the values of Type and Inner type match. Data type mapping table If you use aggregate functions, the type remains blank.
Field list/Inner type	-	Not available	Select the inner type for HULFT Square.	Select a value for Inner type that is compatible with the setting of Type.

Property actions

Item name	Description	Remarks
Refresh field list	SOQL is executed to retrieve the field list and refresh it.	If there is no execution result for the SOQL, retrieval of the field list fails. Either add records to the object to be read or set the fields manually. If aggregate functions are set for SOQL, the type remains blank. Enter the type manually as necessary.

Option

Item name	Required/Optional	Use of variables	Description	Remarks
Batch size	Optional	Available	Specify the number of records to read at the same time.
Base64 processing method	Required	-	Base64 string Base64 data is retrieved in Base64 format. File output Base64 data is retrieved by outputting it to a file.
Output directory	Required	Available	Specify the output directory for Base64 data.	This field is displayed when Base64 processing method is File output.
Read deleted records	Optional	-	Specify whether or not to read the data that has been deleted from Salesforce. If you enable this setting, logically deleted data is read using QueryAll. Note Records are returned by this operation according to the specifications of the Salesforce QueryAll API.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Optional	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Optional

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

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

It's table model type.

= Remarks =

For schema structure, refer to Table model type .

Element name	Column name	Description	Remarks
row	-	Repeats as many times as the number of data items.
column	The field value set for Field list	The field value set for Field List is output.

Element name

Column name

Description

Remarks

row

-

Repeats as many times as the number of data items.

column

The field value set for Field list

The field value set for Field List is output.

Loading schema in Mapper

The schema is loaded automatically.

Specify the schema of the data to be loaded.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP is supported.

= Remarks =

For details on PSP, refer to Parallel Stream Processing.

Available component variables

Component variable name	Description	Remarks
count	The number of records that were read successfully is stored.	The default value is null. Note When you use PSP, the component variable count isn't supported.
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.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as shown below. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
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	Exception message	Limitations
Messages and limitations of the Salesforce connector