Upgrading to Synergis™ Card Synchronization plugin 4.0.0 - 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 upgrade the Card Synchronization plugin from any earlier version directly to version 4.0.0.

Before you begin

What you should know

  • It is not required to uninstall the plugin before upgrading to the new version.
  • The plugin must be upgraded on all Security Center client and server computers.
  • The upgrade keeps your current data sources, imported entities, and all event notifications.
  • Starting in version 3.2, the data schemas were redesigned and the Data source configuration wizard was improved. As a result, it is easier to add data sources and map fields. However, only data sources created in version 3.2 or later of the plugin have access to the updated schema and wizard. The wizard is unavailable to data sources created in versions 3.0 and 3.1 of the plugin.
  • To use the updated schema and the new wizard, delete your data sources, and re-add them.
IMPORTANT: For Security Center 5.8.1.0 and later, the names used to reference native Security Center card formats changed. As a result, if you are using native card format names in your data source, you must change them in your data source to either follow the bit length naming or a card format alias. You can replace existing names using the transform tool in the new Data source configuration wizard. For details, see Card format aliases for use with Synergis™ Card Synchronization plugin.

Procedure

  1. Deactivate the plugin role.
  2. Open Server Admin, and back up the Directory database.
  3. Install the new version of the plugin.
  4. If the plugin role did not automatically restart after installation, activate it.
    The plugin is ready for use.
  5. If you are running Security Center 5.8.1.0 or later, make sure that the credentials referencing native card formats in the data sources are using one of the following format names:
    • bit length, such as 26 bit Wiegand.
    • alias, such as Standard.
    IMPORTANT: If your data source contains native credential format names, replace them either directly in the data source or using the transform tool available in the latest Data source configuration wizard.
  6. If you want to use the latest Data source configuration wizard, delete all your data sources, and then add them again and re-import the entities using a unique global key.
  7. If you are using an Entra ID data source, review and update the Entra ID application registration privileges. For more information, see Registering an Entra ID app.
    IMPORTANT: You must update the application registration privileges in your Entra ID tenant because as of Card Synchronization 3.4.0, the Azure Active Directory Graph API has been migrated to Microsoft Graph. For more information, see the Microsoft documentation.