Knowledge Base - Cloud Connect
Knowledge Base - Cloud Connect
Breadcrumbs

Matching

Cloud Connect leverages Microsoft Dynamics 365 F&O's matching feature by checking for matching data, such as BOMs, routes, and items, when saving a configuration. If matching data is present in Microsoft Dynamics 365 F&O, the data is reused rather than duplicated. This behavior leads to improved save performance and a smaller master data set to manage in Microsoft Dynamics 365 F&O. Users must Set Matching to Active and Initialize Default Matching Set on a processing entity to enable matching. A default set of matching fields exist for the entities listed below: 

  • BOMBillOfMaterialsVersionEntity

  • BOMBillOfMaterialsLineEntity

  • EcoResReleasedProductEntity

  • EcoResReleasedProductVariantEntity

  • RouteVersionEntity

  • RouteRouteOperationEntity

  • RouteOperationPropertiesEntity

Match Keys

A match key in Microsoft Dynamics 365 F&O represents each unique variant of an entity record or structure and is used to match existing entity data and reuse it while creating a new record. On a given entity, each unique set of match field values represents a match key. When matching is enabled and a new record is saved to Microsoft Dynamics 365 F&O, if the match fields in the incoming record match an existing record in the system, the system reuses the existing record rather than creating a new one. This minimizes the size of the master data set in Microsoft Dynamics 365 F&O. There are three types of matching:

  • Single-level Match: Used for a configurable entity that does not have a child entity associated with it. The key must match on the record for a match to occur. When a match occurs, the entire record is reused.

  • Multilevel Match: Used for a configurable entity that has a child entity associated with it. The key must match on the master and detail record(s) for a match to occur. When a match occurs, the entire master and detail record is reused. This is the default type of matching, typically used to match product variants and bill of materials.

  • Structure Match: Used for data entities entity that has a more than two-level structure which is typically a route. All match fields need to be provided via a process map. Match keys must match on the entire structure for a match to occur. When a match occurs, the entire structure is reused. This type of matching requires the Structure matching toggle to be set to Yes on the Match setup form.

Structure matching.png

Examples BOM Structure

Bill of Materials sample structure.png

  • Root entity is BOMBillOfMaterialsVersionEntity

    • Child entity is BOMBillOfMaterialsLineEntity.

Example Route Structure

ExampleRouteStructure.png

  • Root entity is RouteVersionEntity

    • Child entity is RouteRouteOperationEntity

      • Child entity of this processing entity is RouteOperationPropertiesEntity

        • Child entity of this processing entity is RouteOpertationPropertiesResourceRequirementEntity

You can view the structure of a given entity by selecting the Show structure button from the Match setup page.

ShowVersion2.png

Limitations for Match Keys

  • You cannot use a template or base together with matching.

  • Any field you try to match must be part of the process map and be part of the process document.

Recalculate Match Keys

When you change a match field on an entity, you must use the process outlined in this topic to recalculate match keys so they are available the next time a Configurator user saves a configuration to Microsoft Dynamics 365 F&O. For more information, see the Recalculate Match Keys procedure.

Procedures

Initialize Default Matching Set

  1. In Microsoft Dynamics 365 F&O, use search to navigate to the Experlogix Processing Entities page.

    ProcessingEntitiesPage.png

  2. From the list of entities, select an applicable entity.

    SelectedEntity.png

  3. Select the Match Setup button.

  4. On the Match Setup page, select the Set Defaults button.

    SetDefaultsMatch.png

The list of default match fields populates.

Default match fields.png

Set Matching to Active

  1. In Microsoft Dynamics 365 F&O, use the search to navigate to the Experlogix Processing Entities page.

    ProcessingEntitiesPage.png

  2. From the list of entities, select an applicable entity.

    SelectedEntity.png

  3. Select the Match Setup button.

  4. On the Match Setup page, select the Edit button.

    MatchActive.png

  5. Toggle Match Active to Yes.

Add a Match Field

The match key field must be added to the Match Setup page in Microsoft Dynamics 365 F&O to use it.

  1. In Microsoft Dynamics 365 F&O, in the left pane, select Modules.

    FO-ModulesPane.png

  2. From the options displayed in the left pane, select Experlogix Integrator.

    The Experlogix Integrator options display.

  3. Select Experlogix Processing entities.

    FO-ExperlogixProcessingEntities.png

  4. In the left pane, select the processing entity for which you want to enable matching.

    FO-SelectProcessingEntity.png

  5. At the top, select Actions.

  6. Select Match setup.

    The Match setup page displays.

  7. Select New to add a new match key field.

    FO-AddMatchField.png

Alternatively, you can use the Set defaults button at the top to load the default set of match fields. This is only available for a limited set of entities.

  1. In the Match field field, add the match field name.

  2. Select the required name from the displayed options.

  3. Select the Save button.

    The Match field is added to the Match setup page.

Enable a Match Key

A match key needs to be enabled before it can be used in an Entity record. If you want to use the existing data in the system, recalculate the match keys as shown in Recalculate Match Keys.

  1. Access the Experlogix Processing entity page.

  2. Select the required entity.

    FO-SelectProcessingEntity.png

  3. At the top, select Actions.

    FO-SelectMatchSetup.png

  4. Select Match setup.

    The Match setup page displays.

  5. At the top, select the Recalculate match keys button.

    FO-RecalculateMatchKeysButton.png

  6. Toggle the Recalculate match keys button to enable the match key for the entity.

    FO-RecalculateMatchKeysToggle.png

  7. Toggle the Write new matches button to enable adding new matches.

  8. Select the OK button.

    The match key is enabled for the entity.

View Match Keys

  1. Access the Experlogix processing entity page.

  2. Select the required entity.

    FO-SelectProcessingEntity.png

  3. At the top, select Actions.

    FO-SelectMatchKeys.png

  4. Select Match keys.

    The Match keys page displays the available match keys for the entity.

FO-MatchKeysList.png

Ignore a Match Key

  1. Access the Match keys page.

  2. Select the match key record to ignore it for further matching.

    FO-IgnoreMatchKey.png

  3. Select the Ignore button at the top.

    The match key is set to ignore.

FO-MatchKeyIgnored.png

View a Match String

There are two ways a Microsoft Dynamics 365 F&O user can view a match string once a match occurs.

  • If a log trace is active when saving the configuration with a match, a Match string record appears in the log on the Experlogix logging page. The match string is visible under the Display header on the record.

MatchStringLog.png

  • On the Match Keys page, selecting the Match string button will display the match string for the selected record.

MatchKeysmatchString.png

Export Matching Setup

If you looking to reuse your matching setup in another Microsoft Dynamics 365 F&O environment, you can export and import your matching data rather than recreate it manually.

  1. In Microsoft Dynamics 365 F&O, using the search tool, navigate to the Data management page.

    Data Management.png

  2. Select the Export button.

  3. On the Export page, do the following:

    MatchExport.png

    1. In the Group name field, enter a group name.

    2. Select the Add entity button.

    3. In the Entity name field, select Match field.

    4. Select the Add button.

    5. Select the Close button.

  4. Select the Export button.

  5. Select Export now or Export in batch as applicable and follow the on-screen prompts.

    ExportNow.png

  6. Once the request processes, select the Download file button.

    DownloadExportFile.png

Your match key file downloads.

Import Matching Setup

If you looking to reuse your matching setup in another Microsoft Dynamics 365 F&O environment, you can export and import your matching data rather than recreate it manually. This process describe how to import match keys into an environment.

  1. In Microsoft Dynamics 365 F&O, using the search tool, navigate to the Data management page.

    Data Management2.png

  2. Select the Import button.

  3. On the Import page, do the following:

    ImportMatchAddFile.png

    1. In the Group name field, enter a group name.

    2. Select the Add file button.

    3. In the Entity name field, select Match field.

    4. Select Upload and add.

    5. Locate and select the XLSX file containing your match data.

      The selected file is added to the Selected entities pane.

  4. Select the Import button.

  5. Select Import now, Import in batch, or Re-import as applicable and follow the on-screen prompts.

    Import Options.png

Recalculate Match Keys

Recalculate Match Keys for Child Entities in a Shared Structure

When an entity is a part of partially shared structure, you cannot recalculate match keys on it directly and must do it from the structure's root entity. When you make changes to one or more match fields on a child entity, a message displays in Microsoft Dynamics 365 F&O informing the user of on which specific root entities they must recalculate match keys.

  1. Access the Experlogix processing entity page.

  2. Select the required entity.

    FO-SelectProcessingEntity.png

  3. At the top, select Actions.

    FO-SelectMatchKeys.png

  4. Select Match keys.

    The Match keys page displays the available match keys for the entity.

  5. Select all the match keys.

  6. At the top, select the Delete button.

    FO-DeleteAllMatchKeys.png

  7. Select the back arrow to access the Experlogix processing entity page.

  8. At the top, select Actions.

    FO-MatchSetupCalculateKeys2.png

  9. Select Match setup.

    The Match setup page displays.

  10. At the top, select the Recalculate match keys button.

    FO-RecalculateMatchKeysButton.png

  11. Toggle the Recalculate match keys button to enable the match key for the entity.

    FO-RecalculateMatchKeysToggle2.png

  12. Toggle the Write new matches button to enable adding new matches.

  13. Select the OK button.

  14. Access the Match keys page to view the new match keys. The match keys are recalculated for the entity and newly added match keys display on the Match keys page.

Recalculate Match Keys in Batch Process

The match keys can be recalculated in a batch using the Batch Process in Microsoft Dynamics 365 F&O. The match keys typically need to be recalculated when either the data is changed or the match fields are changed.

The match key batch process allows processing multiple recalculate match key requests at once. For more information on match keys, see . For more information on batch processing in Microsoft Dynamics 365 F&O, please see Batch processing and batch servers.

  1. In Microsoft Dynamics 365 F&O, in the left pane, select Modules> Experlogix Integrator>ExperlogixProcessing entities.

    FO-ExperlogixProcessingEntities.png

  2. In the left pane, select the Processing Entity you want to enable matching.

    FO-SelectProcessingEntity.png

  3. At the top, select Actions.

    FO-SelectMatchSetup.png

  4. Select Match setup.

    The Match setup page displays.

  5. Toggle the Recalculate match keys button to Yes, to enable the match key for the entity.

    FO-ToggleRecalculateMatchKeys.png

  6. Toggle the Batch process button to Yes to enable the batch process.

  7. From the Batch group dropdown menu, select Experlogix.

  8. Select OK. The batch job is added to the batch queue, and a 'The Recalculate match keys job is added to the batch queue.' message displays.

  9. From the left pane, select System administration.

    FO-BatchJob.png

  10. From the Inquiries section, select Batch jobs.

    The Batch job page displays.

  11. Filter the job description by Recalculate match keys to view the added batch job.

    FO-RecalculateKeyJob.png

The match keys are recalculated when the batch job is executed as per the schedule.