Official |[Dynamics 365 for Customer Engagement] Write Entity

Operation name

Write Entity

Function overview

Writes input data to entity.

Data model

The data model of this component is XML type and table model type.

Properties

= Hint =

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.
Input data	Required	Not available	Select a component 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/Write target	Required	Not available	Select whether or not to include each field of the entity specified in Resource path in the target to write. Selected Include in the target to write. Not selected (Default) Don't include in the target to write.
Field definition/Primary key	Required	Not available	Displays whether Field name is the primary key. Selected Displays that it's the primary key. Not selected (Default) Displays that it's not the primary key.
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.

Key settings

Item name	Required/Optional	Use of variables	Description	Remarks
Key field of resource path	Optional	Not available	Select the key field for the entity selected in Resource path.	When Get key information is clicked, the primary key field and the field defined with alternate key will be displayed. The default value is the primary key field. When it's omitted, the primary key field will be used.
Associated key settings	Optional	-	Displays the associated key settings of the entity specified in Resource path.	When it's omitted, the primary key field will be used as the key for all entity fields.
Associated key settings/Entity field	Optional	Not available	Displays the entity field of the entity specified in Resource path.
Associated key settings/Associated entities	Optional	Not available	Displays the associated entity set name of Entity field.
Associated key settings/Associated key fields	Optional	Not available	Displays the key field for the entity associated to Entity field.	The default value is the primary key field. Update the value by the following steps: Select the update target in Entity field. Select the key field in Associated key fields. Click Update associated key settings.
Entity field	Optional	Not available	Select Associated key fields of Associated key settings and the Entity field of the same row to be changed.	The list of entities that you can specify is displayed when Get key information is clicked.
Associated key fields	Optional	Not available	Select the key field for the entity selected in Entity field.	When Entity field is selected, the primary key field and the field defined with alternate key are displayed. The default value is the primary key field.

Property actions

Item name	Description	Remarks
Get key information	Get the key information from the specified Destination and Resource path, and set it to the following properties: Key field of resource path Associated key settings Entity field Associated key fields	Enabled when Destination and Authentication are selected and Resource path is specified.
Update associated key settings	Update Associated key fields of Associated key settings with the value selected in Associated key fields. Select the target entity field in Entity field.	Enables when Entity field and Associated key fields are selected.

Item name

Description

Remarks

Get key information

Get the key information from the specified Destination and Resource path, and set it to the following properties:

Key field of resource path
Associated key settings
Entity field
Associated key fields

Enabled when Destination and Authentication are selected and Resource path is specified.

Update associated key settings

Update Associated key fields of Associated key settings with the value selected in Associated key fields.

Select the target entity field in Entity field.

Enables when Entity field and Associated key fields are selected.

Option settings

Item name	Required/Optional	Use of variables	Description	Remarks
Skip entities which the system failed to process	Optional	Not available	Select whether or not to skip entities which the system failed to process and continue processing. Selected Skip the items that failed to be written and continue the write processing. Not selected (Default) When an item failed to be written, end the write processing as an error.
Processing method when the key is specified	Required	Not available	Select the processing method when the key is specified. Create or update (Default) Creates the entity if it doesn't exist, and updates it if it exists. Create only Creates the entity if it doesn't exist, and an error occurs if it exists. Update only Updates the entity if it exists, and an error occurs if it doesn't exist.

Item name

Required/Optional

Use of variables

Description

Remarks

Skip entities which the system failed to process

Optional

Not available

Select whether or not to skip entities which the system failed to process and continue processing.

Selected

Skip the items that failed to be written and continue the write processing.

Not selected

(Default)

When an item failed to be written, end the write processing as an error.

Processing method when the key is specified

Required

Not available

Select the processing method when the key is specified.

Create or update

(Default)

Creates the entity if it doesn't exist, and updates it if it exists.

Create only

Creates the entity if it doesn't exist, and an error occurs if it exists.

Update only

Updates the entity if it exists, and an error occurs if it doesn't exist.

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

= Hint =

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

Output schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>uri</column>
    <column>action</column>
    <column>target</column>
    <column>status_code</column>
    <column>message</column>
    <column>error_type</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Column name/Label	Description	Remarks
row	-	Repeats for the number of the entities to be written.
column	uri	The URI which distinguishes operation targets uniquely.
	action	Outputs the operation method.	create Creation operation. update Update operation. delete Deletion operation. Note When the operation is to relate the entities, it will be "update" even if it's new relation.
	target	Outputs the type of operation target.	entity Operation to entities. property Operation to entity properties. relation Operation to relation of entities. Note When all of the following conditions are satisfied, the relation row won't be output. An operation to associate the specified entities to the entity field of N:1 entity relationship The operation for the entity specified in Resource path is creation or update operation
	status_code	Outputs the HTTP status code for the operation.
	message	Outputs the operation message.
	error_type	When an error occurs, stores the error type.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException

= Hint =

For schema structure, refer to Table model type .

Loading schema in Mapper

The schema is loaded automatically.

= Hint =

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. Entities of navigation property are also counted.
insert_count	The number of entities which are newly created is stored.	The default value is null. When an entity of navigation property is newly created, it's also counted.
update_count	The number of updated entities is stored.	The default value is null. When an entity of navigation property is updated, it's also counted.
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.

Update of owner

To update the owner (ownerid), input "systemuser" or "team" in the type attribute.

= Remarks =

For details, refer to Entity type (ownerid).

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Dynamics 365 for Customer Engagement connector