Read Entity

Operation Name

Read Entity

Function Overview

Reads entity.

Data Model

XML type.

Properties

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 the name on the script canvas.  
Required settings
Item name Required/Optional Use of variables Description Remarks
Destination Required Not available Select a global resource.
  • [Add]:
    Adds a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
Authentication Required Not available Select a global resource.
  • [Add]:
    Adds a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
Resource path Required Available Select or enter the resource path.
Get field display name Optional Not available Select whether or not to get field display name when updating Field definition.
  • [Checked]:
    Gets the field display names.
  • [Not checked]: (default)
    Does not 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/Target Required Not available Select whether or not to include each field of the entity specified in [Resource path] in target.
  • [Checked]:
    Includes in target.
  • [Not Checked]: (default)
    Does not includes in target.
  
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, if [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, if [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.
Data processing method
Item name Required/Optional Use of variables Description Remarks
Data processing method Required Not available Select the data processing method.
  • [Apply script settings]:(default)
    Applies the mass data processing settings of the script property to the adapter.
  • [Do not perform mass data processing]:
    Does not perform mass data processing.
  • [Perform mass data processing]:
    Performs mass data processing.
  
Comment
Item name Required/Optional Use of variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.		  

Schema

Input schema

None.

Output schema

For more details on the schema this adapter uses, refer to “Schema”.

Loading schema in Mapper

Schema is loaded automatically.
For more details, refer to “Edit Schema”.

Mass Data Processing

Mass Data Processing is supported.

Transaction

Transaction is not supported.

PSP usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
count The number of read data will be stored.
  • Default value is null.
message_category When an error occurs, the category of the message code corresponding to the occurred error will be stored.
  • Default value is null.
message_code When an error occurs, the message code corresponding to the occurred error will be stored.
  • Default value is null.
message_level When an error occurs, the severity of the message code corresponding to the occurred error will be stored.
  • Default value is null.
error_type When an error occurs, the type of the occurred error will be stored.
  • Default value is null.
  • The error type will be in the below format.
    Example: “java.io.FileNotFoundException”
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the message of the occurred error will be stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, the corresponding error trace information will be stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions or the client applications to be executed.

Specification Limits

For details about the specific restrictions of Dynamics 365 for Customer Engagement Adapter, refer to “Dynamics 365 for Customer Engagement Adapter Restrictions”.

Main Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] or [Authentication] is not specified. Specify [Destination] or [Authentication].
ResourceNotFoundException
Resource definition is not found. Name: [<Global resource name>]		 The resource definition selected in [Destination] or [Authentication] is not found. Check the global resource specified in [Destination] or [Authentication].
InvalidPropertyConfigurationException
<Property name> is not specified.		 [<Property name>] is not specified. Specify [<Property name>].
InvalidResourcePathException
Invalid resource path: <Resource path>		 The format of the resource path is invalid. Check [Resource path].
For details about the main exceptions of Dynamics 365 for Customer Engagement Adapter, refer to “Dynamics 365 for Customer Engagement Adapter Restrictions”.

Notes

For details about the specific precautions of Dynamics 365 for Customer Engagement Adapter, refer to “Dynamics 365 for Customer Engagement Adapter Restrictions”.