Official |[Dynamics 365 for Customer Engagement] Read Entity

Operation name

Read Entity

Function overview

Reads an entity.

Data model

The data model of this component is 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.
Authentication	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.	For details about how to configure connection resources for Dynamics 365 for Customer Engagement Connector, refer to Limitations of DYNAMICSCRM category.
Resource path	Required	Available	Select or enter the resource path.	For details about how to configure resource paths for Dynamics 365 for Customer Engagement Connector, refer to Limitations of DYNAMICSCRM category.
Get field display name	Optional	Not available	Select whether or not to get field display names when updating Field definition. Selected Get the field display names. Not selected (Default) Don't get the field display names.	When getting field display names, Update field definition may take longer time.
Field definition	Required	-	Displays the field definition of the entity specified in Resource path.
Field definition/Read target	Required	Not available	Select whether or not to include each field of the entity specified in Resource path in the target to read. Selected Include in the target to read. Not selected (Default) Don't include in the target to read.
Field definition/Field name	Required	Not available	Displays the field name of the entity specified in Resource path.
Field definition/Field display name	Optional	Not available	Displays the field display name of the entity specified in Resource path.
Field definition/Type	Required	Not available	Displays the type of Field name.

Property actions

Item name	Description	Remarks
Update entity set name list	Get the entity set names from the specified Destination and set them in Resource path.	Enabled when Destination and Authentication are selected.
Update field definition	Get the field definition from the specified Destination and Resource path, and set it in Field definition.	Enabled when Destination and Authentication are selected and Resource path is specified.

Query settings

Item name	Required/Optional	Use of variables	Description	Remarks
Filter	Optional	Available	Set the filter.	For details about how to configure filters for Dynamics 365 for Customer Engagement Connector, refer to Limitations of DYNAMICSCRM category.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	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

Required

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

For more details on schema used by this connector, refer to Schemas.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Transaction

Transaction 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.
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 Dynamics 365 for Customer Engagement connector