Importing entities from a file - Card Synchronization 3.2

Card Synchronization Plugin Guide 3.2

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

You can import entities from an external system using a file that conforms to the Card Synchronization schema. After the import, changes made in that data sources can be synchronized in Security Center. After the import, changes made in the data source can be synchronized in Security Center.

Before you begin

Complete the steps outlined in Preparing to import entities.

What you should know

  • Each external data source that you add to the Data sources list uses one data source license. One file data source can contain up to one file per entity type (cardholder, cardholder group, cardholder group member, and credential). If you add a separate file data source for each entity type, this counts as four data sources.
  • To include international characters, special characters, and accents the file must use Unicode character set.
  • Including pictures from 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 File, and then click Next.
    Selecting File.
  5. 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
  6. Configure the following settings:
    Browse to the file you want to import.
    Enter the delimiter used in the file.
    NOTE: If the delimiter is present in one of the values to import, edit the file so that the value is between quotation marks.
    Start at line
    If your file contains headers, enter the number of the first line after the header. When set to 0 (zero), all lines in the file are treated as data records.
    Tip: To facilitate mapping the sample values to the destination, configure this after scanning the file.
  7. 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:
  8. (Optional) Choose one or more fields to be global keys.
  9. (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.
  10. (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.
  11. 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.
  12. Click Next.
  13. In the Data source name field, enter a name for the data source, and then click Finish.
  14. Click Apply.


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