Entity Settings

Last published at: 2024-09-03 09:38:50 UTC
Delete

In the <Entity> Settings you can configure Duplicate Check settings that can differ per entity, such as the Result Fields, or the Entity Relationships to Ignore upon Merge.

To set up the Entity Settings for a certain entity:

  1. In the Duplicate Check app, at left, go to Manage Entities
  2. At the entity you want to configure settings for, click Manage  at right.
  3. Go to the <Entity> Settings tab.

General Settings

Result Fields - Duplicate Check Job Results

Delete

After a Duplicate Check job is finished, its results are shown on the Duplicate Check Job Results page. The Result Fields are the entity fields that are shown in the job results.

To change which entity fields are shown in DC Job results: 

  1. At "Result Fields - Duplicate Check Job Results", click Edit.
  2. Move the entity fields you want to display to the Selected Fields column.
  3. Click Save.

This job result shows result fields Account Name, Address 1: City, Address Phone, and Website

The result fields that are shown on tab "Duplicates Found" for single record duplicates, can be set in the Duplicate Prevention‍ settings.

Delete Entity Configuration

This option will delete the entity and all of its configuration, so including scenarios and feature configuration, from the Duplicate Check Setup. This cannot be undone! Of course you can always add the entity again at a later point, but it will need to be fully reconfigured again, including all scenarios and feature settings.

To delete an entity's full configuration from the Duplicate Check Setup, click Delete at "Delete Entity Configuration".

Merge Settings

Ignore Entity Relationship during Merge

Delete

When merging records with Duplicate Check, related records are reparented to the Master record whenever possible. However, sometimes reassigment of dependent entities is not possible, resulting in a merge error. To avoid such errors, specify which entity relationships should be skipped when merging and reparenting records.

When you encounter a merge error related to records that cannot be reparented, the error message will specify which relationship it concerns. Add the relationship to the list of relationships to ignore during merge.
If a relationship is not available to add to the list of relationships to ignore, this means it cannot be ignored. These types of relationships should be removed from the records before merging.

Delete

Ignoring an entity relationship means that the link between those entities is lost upon merge, and the related record might end up orphaned or deleted, if it was not linked to the Master record or a third record.

To find the relationship that causes merge problems:

  1. When you encounter a merge error during merge, click Copy Error To Clipboard .
  2. Paste the error in a text editor.
  3. Find the line stating "and is collected by Relationship with name: ..." or "This error likely happened due to the ... relationship defined on this table."
    In this line, "..." is the relationship name. 
  4. Add this relationship to the setting list.

To add an entity relationship to the list of relationships to ignore during merge:

  1. At "Ignore Entity Relationship during Merge", click Select an option...
    Or click on the list of relationships if you already have ignored some relationships.
  2. Select the relationship you want to ignore in merge.
    Make sure to only add relationships that you found in an error; do not add other relationships.
  3. Save and Publish.

Delete

If the relationship is not available to add to the list of relationships to ignore, this means it cannot be ignored, e.g. because it's a restricted relationship. Remove the relationship from the records before merging.

To remove an entity relationship from the list of relationships to ignore during merge:

  • At "Ignore Entity Relationship during Merge", click on the list of relationships.
  • Find the relationship you want to remove and un-select it.
  • Save and Publish.
Delete

Make sure to only add relationships that you found in an error; do not add other relationships to the setting.

Delete or Deactivate

Decide whether the losing record should be deleted or deactivated after merging. In the picklist, select "Deactivate" or "Delete".

  • When set to "Deactivate", the losing records will be deactivated upon merge.
  • When set to "Delete", the losing records will be deleted upon merge, and only the master record is kept.
    Note that merging with deleting the loser records can be performed by users that do not have delete permissions for those records! 
Delete

User permissions for merging

To merge with either deleting or deactivating the non-master records, a user needs Read, Share, Write, Append, and Append To access to the records, as well as the Merge privilege.

Set Merge Master Reference Field

When you set the losing records to be deactivated upon merge, the ID of the master record will be stored on the losing records. Select the entity field to store this ID in; create a new field if needed.

Set Status Reason

When you set the losing records to be deactivated upon merge, a status reason will be stored on the losing records. Select which status reason this should be.

Advanced Settings

Start Entity Setup Process for Entity

When the DC setup for an entity is published for the first time, customizations are applied to forms and ribbons. Because of this, the first publish of an entity setup is of the type "Publish All".

When you make any changes to your forms or ribbons, or add a form to use in an app, the DC setup needs to be re-published for all entities where you want to use Duplicate Check. This way the necessary customizations are added to the new or edited form or ribbon.

Click Start Entity Setup to start a publish of the entity's setup of the type "Publish All". This will add Duplicate Check customizations to all forms of the entity.
Just clicking "Publish" after making changes within the DC Setup is not sufficient, as it will only add the DC setup changes you made to forms.

Start Entity Teardown Process for Entity

Where the above setting "Delete Entity Configuration" removes an entity and its configuration from the Duplicate Check setup, Entity Teardown removes all Duplicate Check features from an entity. 

Click Start Entity Teardown to fully remove Duplicate Check from an entity. In the process of deleting the Duplicate Check app from your environment, first apply Entity Teardown to each entity configured in Duplicate Check. Then delete the solution. Read more about deleting the DC app in Uninstall Duplicate Check for Dynamics 365‍.

Abort Ongoing Setup/Teardown Process for Entity

The first time DC Setup is published for an entity, this should take about 5 minutes. An Entity Teardown process should also take up comparable time. If it takes significantly longer, the process might be stuck somewhere. To fix this, you can try to stop the setup publish or teardown for the entity, then try again.

Click Abort Entity Setup/Teardown   to try and stop an ongoing system Entity Setup or Teardown process for an entity.