Best practices for importing 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

You can configure your data sources and Security Center to ensure your entities and their configurations are retained if you must recreate the plugin role.

Entity configuration

CAUTION:
Modifying a schema can cause large-scale changes. Always make a Directory database backup first and turn off automatic synchronization prior to making changes.
Create a custom field for each unique ID in your data sources and Security Center before importing entities.

If you delete the plugin, all imported entities remain in Security Center. If you create the plugin again, and then add the same data sources to the new plugin, all the imported entities are duplicated.

To avoid duplicate imported entities, add a Security Center data source that uses the unique ID global key for each entity type. You can then link data source entries with existing entries in the Directory database.

IMPORTANT: It is against best practice to use the Synergis™ Card Synchronization plugin to merge or synchronize multiple Security Center directories. Instead, use the Global Cardholder Synchronizer or Federation™ roles.

Data source configuration

Before adding data sources to the Card Synchronization plugin, include an additional custom field for each entity type in your data sources.

In a database, the custom fields view should include one row for every entity you import from that database.
  • Use a descriptive name as the CustomFieldName.
    Example: <ExternalSystemName>UniqueID.
  • The values of EntityUniqueId and of CustomFieldValue are the unique ID of the cardholder, cardholder group, or credential.
In cardholder, cardholder group, and credential files, include an additional column to enter the unique ID of each entity.
NOTE: If you want to manually add cardholders to imported groups, create a parent group and add the cardholders and groups as children of the parent group. Otherwise, the manually added cardholders are removed from the group during synchronization.

Security Center configuration

Create a custom field that uses the text data type for each of the following entity types:
  • Cardholders
  • Cardholder groups
  • Credentials
Use the same name that you used in the data source.
Example: <ExternalSystemName>UniqueID.
Browse