Configuring the data source for Database synchronization

2026-02-03Last updated

Before you can synchronize an external system with Genetec ClearID™, you must first configure the Genetec ClearID™ One Identity Synchronization Tool data sources for database synchronization.

Before you begin

What you should know

  • This procedure is for IT or security personnel responsible for external system attributes administration.
  • This procedure describes how to configure the data source for a Database (Microsoft SQL Server, Oracle Database, ODBC).
  • The data source order is important because the first data source always overrides common fields.
  • There is no limit to the number of data sources. However, larger sources require more memory.

Procedure

  1. In the One Identity Synchronization Tool Data sources section, click Add data source ().
    Genetec ClearID™ One Identity Synchronization Tool with Add data source highlighted.
  2. In the Source section, select Database and click Next.
    Data source configuration dialog in the ClearID One Identity Synchronization Tool showing Source settings page with Database selected.
  3. In the Configuration section, configure the database settings.
    1. Select an SQL server type:
      • Microsoft SQL Server
      • Oracle Database (only views are currently supported)
      • ODBC
    2. If you selected Microsoft SQL Server, configure the following:
      Data source configuration dialog in the ClearID One Identity Synchronization Tool showing Configuration settings page with Microsoft SQL server currently selected.
      • Use custom connection string: Select this option to enter your own database connection string. When selected, the Server and Database fields are removed.
      • Connection string
      • Server
      • Database
    3. If you selected Oracle Database or ODBC, configure the following:
      Data source configuration dialog in the ClearID One Identity Synchronization Tool showing Configuration settings page with Oracle Database selected.
      • Connection string
  4. In the What to sync section, select Identities to synchronize from the external system data source.
    Data source configuration dialog in the ClearID One Identity Synchronization Tool showing What to sync page with the data synchronization checkbox selected.
  5. If you selected Identities, configure the identity attributes settings.
    Note:
    The fields that are displayed vary depending on the data source you selected in the Source section.
    The following image shows the options that are displayed after selecting a Database data source.
    Data source configuration dialog in the ClearID One Identity Synchronization Tool showing the Identities page including One Identity fields. external fields, sample values, and global key settings.
    1. Configure your External field attribute mappings.
      One Identity field
      Displays the ClearID identity attributes. Mandatory fields are highlighted using an asterisk (*).
      Important:
      The Unique ID is used internally by One Identity as the primary key to identify what it is. For example, an employee number or email address could be used, as long as it is unique.
      External Field
      Select the corresponding attributes from your external system that you want to map to each ClearID field.
      Sample value
      If available, an example of the external field’s data is shown next to each selected mapping.
      Tip:
      Use the sample value column to check the format of the attributes data you are about to import from your external system fields into ClearID.
    2. (Optional) Click Script () to add a transform expression to find and replace external field text using regular expressions.
      For example, you can look for variations of a country name to replace with the correct country code.
      Add transform expressions for field dialog in the ClearID One Identity Synchronization Tool showing example find and replace expressions that replace the country names with country codes.
      • A script icon () appears in the Sample value column when a transform expression is applied.
      • The transform expressions are processed in the order specified in the Add transform expressions for field dialog.
      Tip:
      To remove an expression, select its row and click .
    3. (Optional) Click Refresh () to update the external fields data from your data source. This refresh option is used if data has changed in the external system, or if new data rows or attribute columns were added.
    4. Click Next.
  6. In the Summary section, review the data that will be synchronized.
    Data source configuration dialog in the ClearID One Identity Synchronization Tool showing the Roles page including One Identity fields. external fields, sample values, and global key settings.
    Note:
    If multiple data sources are selected, only the first data source file is displayed in the Summary section Data source name field. If you want each of the data files listed in the Data sources section, you must add them individually.
    1. If the data synchronization details look correct, click Finish.

After you finish

Configure your synchronization settings.