Read Records

Operation name

Read Records

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 that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description
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.
Object name	Required	Available	Enter an object name.
Field list	Required	-	Specify fields.
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	The field label is displayed.
Field list/Name	-	Not available	The field name (system name) is displayed.
Field list/Type	-	Not available	The name of the type in Salesforce is displayed.
Field list/Inner type	-	Not available	The inner type for HULFT Square is displayed.
Search criteria (WHERE clause)	Optional	Available	Enter the WHERE clause of SOQL.

Property actions

Item name	Description	Remarks
Refresh object name list	Object name is retrieved and the list is updated.
Refresh field list	The field list of the object that is set is retrieved and updated.

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.

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

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>Value of the target field</column>
  </row>
  <row>
    : 
  </row>
</table>

Element name	Column name	Description	Remarks
row	-	Repeats for the number of the entities.
column	Value of the target field	The value of the target field that is selected in Target of Field list is output.

Element name

Column name

Description

Remarks

row

Repeats for the number of the entities.

column

Value of the target field

The value of the target field that is selected in Target of 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 follows. 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			None