Manage Rules

Owned by Pamela Totas (Deactivated)
Last updated: May 25, 2023
3 min read

Migration Rules are defined to handle duplicates during migration import process. The attributes which are used to define duplicate checks are:

  • How to define a duplicate (name, definition or identifier) for a component.

  • The action that needs to be done to handle duplicates.

 Duplicate handling varies with each component type based on its functionality.

Migration Wizard allows you to customize the configuration of migration rules for each component. You must select migration rules for each component to inform the Migration Wizard how to handle duplicate checks for each component during the import process. 

Create Migration Rules

In the Setup workspace, you can create custom migration rule for each and every migratable component for the migration process.

To create a migration rule:

  1. In Migration Wizard, from the left navigation, select Setup > Manage Rules. 
    By default, you see the Manage Rules workspace with the existing rules, if any.

  2. On the Home tab, in the Manage group, click Create New.
    You see the New Migration Rules dialog box. 

  3. In the Name box, enter a name for the migration rule.

  4. In the Description box, enter a description about the migration rule. 
    The Component Group section lists the migratable metadata components across Eagle products.
    You see under each Component Group, all the migratable items pertaining to the group are listed.

  5. Select the migration items for which you want to define the migration rule.

  6. Under Define a Duplicate drop-down, select the duplicate rule for the component.
    Duplicate Rule dictates the matching formula that the Migration Wizard uses to determine if an incoming component is in fact a match with an existing component. By default, only Name is enabled. Migration Wizard matches the name of the incoming component with name of an existing component.

  7. Under the Duplicate Handling drop-down, select a migration rule to handle duplicates for the component. Available options:
    - Use the existing item in the destination: If the incoming component matches the existing component, the existing component will be used.
    - Overwrite the existing item in the destination: If the incoming component matches the existing component, the existing component’s definition is overwritten by the incoming component’s definition.
    - Let the user rename the item before migration: If the incoming component matches the existing component, the incoming component will be renamed.
    - Let the user decide before migration: The user can decide to rename the component or to override the component at this point.
    - Select at import in the destination: The user can select this component during the “import” process of the migration. Note: This rule is ONLY enabled for Performance Model, Classifications and Entities.
    - Do not migrate in the destination: The user can choose not to migrate this component. Note: This rule is ONLY enabled for Code Values.
    - Reconcile with existing item in the destination: If the incoming component matches the existing component, the existing component’s definition is updated with the incoming component’s definition.
    - Use the existing item with Active flag enabled: If the incoming component does not match with an existing component, the incoming component will be used with Active flag enabled. This rule is ONLY enabled for Automated Event Wrapper.
    - Use the existing item with Active flag disabled: If the incoming component does not match with an existing component, the incoming component will be used with Active flag disabled. This rule is ONLY enabled for Automated Event Wrapper.
    - Overwrite the existing item with Active flag enabled: If the incoming component matches with an existing component, the existing component’s definition is overwritten by the incoming component’s definition with Active flag enabled. This rule is only enabled for Automated Event Wrapper.
    - Overwrite the existing item with Active flag disabled: If the incoming component matches with an existing component, the existing component’s definition is overwritten by the incoming component’s definition with Active flag disabled. This rule is only enabled for Automated Event Wrapper.
    Based on the migrated items, the duplicate handling rules vary. Duplicate handling varies with each component type based on its functionality.

  8. Follow the same procedure for other migration items you require.

  9. Click Save to save the migration rule.
    You see the saved migrated rule gets listed in the Manage Rules workspace.

    The created Migration Rule is listed in the Select Migration Rule drop-down of the Migration Wizard's Export workspace.

Modify the Migration Rule

In the Setup workspace, you can modify the custom migration rule.

To create a migration rule:

  1. In Migration Wizard, from the left navigation, select Setup > Manage Rules. 
    By default, you see the Manage Rules workspace with the existing rules, if any.

  2. Select the rule you want to modify.

  3. On the Home tab, in the Manage group, click Edit.
    You see the Migration Rule dialog box.

  4. Modify the rules, if needed.

  5. Click Save to save your changes.