Read Data(Child-Parent Relation) (deprecated)

Operation Name

Read Data(Child-Parent Relation)

Function Overview

This operation is to read data, using the query() or queryAll() call of the SOAP API.

We will specify filter criteria with SOQL(Sforce Object Query Language) but with this component, you may set the filters without directly writing SOQL.

However, you can still directly write after the WHERE clause.

This component can make use of child-to-parent relationships and functions.

Furthermore, aggregate functions can be used in the items selected in the schema definition, and by using it in combination with aggregate conditions (GROUP BY clause, etc.), the results of the aggregate functions, based on the aggregate conditions, can be obtained.

Note

child-to-parent relationships beyond 2 levels cannot be used.

= 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 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	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 18.0 or later versions can be specified.
Table Name	Required	Not Available	Select the name of a table in Salesforce.
Item list table refinement	Required	Not Available	Select a relation object name that is referable from the Salesforce table (object) selected in Table Name.
Sort	Required	Not Available	Sorts the list of items by the selected method. Check Ascending order Check Descending order Label Ascending order Label Descending order API Ascending order (Default) API Descending order Type Ascending order Type Descending order
Item list	Required	-	Displays the item list of the table on Salesforce selected in Table Name.	Only the items that can be added are displayed.
Item list/Check	Optional	Not Available	Select the checkboxes for the columns that you want to select as Schema definition.
Item list/Label	Required	Not Available	Displays the label names of the columns for the table selected in Table Name or the columns for the parent table.
Item list/API	Required	Not Available	Displays the API names of the columns for the table selected in Table Name or the columns for the parent table.
Item list/Type	Required	Not Available	Displays the data types of the columns for the table selected in Table Name or the columns for the parent table.
Schema definition	Required	-	Displays a list of columns for the table selected as the schema definition.	Note Limiting the settings to only items needed in the subsequent processes (deleting unnecessary items from the Schema Definition) helps improve processing performance.
Schema definition/Label	Required	Not Available	Displays the label names of the columns for the table selected as the schema definition.
Schema definition/API	Required	Not Available	Displays the API names of the columns for the table or the parent table selected as the schema definition.
Schema definition/Type	Required	Not Available	Displays the data types of the columns for the table or the parent table selected as the schema definition.
Schema definition/SOQL(group statement)	Optional	Not Available	You can specify an aggregate function in the columns for the table or the parent table selected as the schema definition. SUM MAX MIN AVG COUNT COUNT_DISTINCT

Property actions

Item name	Description	Remarks
Select	Set items selected in the List item/Check column in Schema definition.

Option Settings

Item name	Required/Optional	Use of Variables	Description	Remarks
SOQL(filter statement)	Required	Available	Specify the search conditions (Where sentence) for the table selected in the Table Name.	For syntax details, please refer to the Salesforce API documents.
SOQL(group statement)	Optional	Available	Specify the aggregate conditions (GROUP BY clause, etc.) for performing an aggregation, for the table selected in the Table Name or the parent table.	For example, when specifing the GROUP BY clause, the description needs to start with "GROUP BY". For syntax details, please refer to the Salesforce API documents.
Column name type	Required	Not Available	Select the display type of the column name, for displaying the schema in mapping. Label The label name (item name) defined in Salesforce is displayed. API (Default) The API reference name defined in Salesforce is displayed.
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.) Unread (Default) Does not read the data deleted in Salesforce. Read Reads 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." A number of 200 or greater, up to 2000, can be set. An error occurs if any number outside of this range is set. API specification will not allow value less than 200. If the value is set, the behavior will depend on the specification of the API. 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.

Property actions

Item name	Description	Remarks
Extraction test	Check whether the processing can be performed with the specified search conditions and aggregate conditions.	This action cannot be performed when SOQL (filter statement) and SOQL (group statement) are not specified.

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

The number of columns varies depending on the Schema definition settings.

= Remarks =

For schema structure, refer to Table model 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.
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