Importing entities from a database - Card Synchronization 3.2

Card Synchronization Plugin Guide 3.2

Card Synchronization
Content type
Guides > Plugin and extension guides
Last updated

You can import entities from an external system using a Microsoft SQL, Oracle, or ODBC-compliant database that conforms to the Card Synchronization schema. After the import, changes made in that data source can be synchronized in Security Center.

Before you begin

  • In the external database, create a user for the plugin that only has read access to the required tables.
  • If the database is not on the Security Center server, make sure that the database is reachable using the connection type (TCP, OLE DB, or other) that is specified in the connection string.
  • Copy the connection string from your external data source.

    The connection string specifies information about a data source and the means of connecting to it. It may include attributes such as the name of the driver, server and database, and security information such as username and password.

  • Complete the steps outlined in Preparing to import entities.

What you should know

Including pictures in the data source increases import time.
NOTE: If you are upgrading from version 3.0 or 3.1 of the Card Synchronization plugin, the data source configuration appears as they were in the previous version. For instructions on how to import these entities, refer to the plugin guide that came with the previous version of the plugin. To see the Data source configuration wizard shown in this topic, you must delete your data sources from the plugin, and then recreate them.


  1. From the Config Tool home page, 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 Data sources section, click Add data source ().
    The Data source configuration window opens.
  4. From the Source list, select Database, and then click Next.
    Selecting Database.
  5. In the Configuration window, select a data source by doing the following:
    For this type of connection: Do this:
    Microsoft SQL Server with a connection string
    1. In the SQL server type list, select Microsoft SQL Server.
    2. Select the Use custom connection stream check box.
    3. Enter the connection string for your database.

      Example: Data Source=myServer\myDatabase;Database=myDatabaseInstance; User Id=myUsername;Password=myPassword;

    Microsoft SQL Server without a connection string
    1. In the SQL server type list, select Microsoft SQL Server.
    2. Clear the Use custom connection stream check box.
    3. In the Server list, select or type the name of the database server and database.

      Example: ServerName\SQLEXPRESS

    4. In the Database list, select or type the name of the database instance.
    Oracle database
    1. In the SQL server type list, select Oracle Database.
    2. Enter the connection string for your database.

      Example: Data Source=MyOracleDB;User Id=myUsername;Password=myPassword;Integrated Security=no;

    ODBC connection to a database
    1. In the SQL server type list, select ODBC.
    2. Enter the connection string for your database.

      Example: DSN=myDSN;User Id=myUsername;Password=myPassword;

  6. If you upgraded from Card Synchronization 3.0, in the External custom fields table name, select the name of the table in your database that contain the custom fields. If you don't have custom fields, leave this field blank.
  7. If your data is formatted using a Card Synchronization 3.0 schema and you want to use the features found in Card Synchronization 3.2, select the table that contains the custom fields.
  8. For data in the external database is configured according to the Card Synchronization 3.0 schema, in the External custom fields table name list, select the name of the table that contains your data.
    Omit this step for a new installation of Card Synchronization.
  9. Select the entity types to import and synchronize with Security Center, and then click Next.
    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.
    Imports the credentials from the data source into Security Center.
    Choosing what to import and synchronize
  10. From the Table name list, select the table you want to configure.
  11. Map each external field to a Security Center field by selecting the column name from the corresponding drop-down list.
    For an explanation of the external fields, refer to the following topics:
    Mapping cardholder fields
  12. (Optional) Choose one or more fields to be global keys.
  13. (Optional) If the external data contains terms that you want to replace, do the following:
    1. Click Find and replace text using regular expressions ().
    2. Enter the text to find and replace.
      For example, you could look for variations of a country name and replace them with a country code, or replace a native card format name by a supported card format alias.
    3. If necessary, change the order using the up and down arrows.
      The transform expressions are processed in the order specified in the Add transform expressions for field dialog.
    1. Click Save.
    Tip: If required, you can select the row of any expressions that you no longer require, and click delete .
    A script icon () is shown in the Sample value column when the field text is being replaced by a regular expression.
  14. (Optional) Click Refresh () to update the external fields data from your source. This refresh option is used in situations where the existing data has been modified, new data rows have been added, or new attribute columns have been added.
  15. If there are external field without a corresponding Security Center field, you can create new custom fields and associate them now: Click Manage custom fields, fill the form, and then click Save.
    Create new custom fields and map them to external fields.
    NOTE: To map an external field that is, turn on the Display all external fields option.
  16. Click Next.
  17. In the Data source name field, enter a name for the data source, and then click Finish.
  18. Click Apply.


When a synchronization occurs, the database data source is added to the list of data sources, and the entities are created in Security Center.