Using global keys to avoid duplicate entities - Card Synchronization 4.0.0

Synergis™ Card Synchronization Plugin Guide 4.0.0

Product
Card Synchronization
Content type
Guides > Plugin and extension guides
Version
4.0
Release
4.0.0
Language
English
Last updated
2024-02-28

When importing entities that have corresponding entries in another data source or in Security Center, you can configure the Synergis™ Card Synchronization plugin to associate the entries and treat them as a single entity. To associated these entries, you need to identify a unique field as a global key.

Before you begin

Learn about global keys to see how you can avoid duplication when importing data.

What you should know

  • You can choose from the global key fields already listed in the configuration window, such as unique ID, email, full name, or you can add a new global key field by creating custom fields in Security Center.
    NOTE: All custom fields are listed as global key fields in the configuration window.
  • The values from the external source always take precedence over existing values in Security Center unless the value is NULL.

Procedure

  1. From the Config Tool homepage, open the Plugins task.
  2. In the Plugins task, select the Card Synchronization plugin role from the entity browser, and click the Properties tab.
  3. In the Synchronization section, turn off Automatic synchronization.
  4. In the Data sources section, select a data source and click Edit data source ().
  5. On the What to sync page, do the following:
    1. Choose the types of entities to import:
      Cardholders
      Imports the cardholders from the external data source into Security Center.
      Cardholder groups
      Imports the cardholder groups from the external data source into Security Center.
      IMPORTANT: This does not put cardholders into their respective cardholder groups.
      Cardholder group memberships
      Synchronizes the relationship of cardholders and cardholder groups from the external data source.
      IMPORTANT: This option assigns imported cardholders to cardholder groups. If this option is not selected, imported cardholders are not linked to cardholder groups.
      Credentials
      Imports the credentials from the data source into Security Center.
    2. Select Resolve data source relationships using global keys, and then click Next.
  6. In the Is global key column, select the fields that contain unique data for each entity.
    Fields identified as a global key are used to link imported entities with existing Security Center entities. For example: if every cardholder in your database has a unique employee ID, then map the employee ID to the Unique ID and make it a global key.
    Selecting global keys.
  7. Click Next, and repeat step 6 for the other entity types.
  8. Click Finish.
  9. On the Properties page, under Synchronization, turn on Automatic synchronization.
  10. Click Apply.
  11. If a synchronization does not automatically occur, click Synchronize now.

Results

The plugin compares the contents of global key fields for each entity. Entities that share the same data in a global key field are considered to be the same entity and are merged.