Configuring the data source for File synchronization
2023-07-10Last 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
file (CSV) Synchronization.
Prepare a CSV file containing the identities attributes that you want to import and
synchronize.
Check your license information: Part number
CD-IDSYNC-SERVICE-1Y is required for One Identity Synchronization Tool import.
Important: Make sure that your CSV files are not being edited and are closed,
because the synchronization tool locks the files during the synchronization process.
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
File (CSV import).
The data source order is important because the first data source always overrides common
fields.
One data source can include multiple CSV files containing identities.
There is no limit to the number of data sources. However, the larger the data source
(not only CSV files), the memory requirements increase.
Best Practice: To avoid user permission issues when using CSV files with the
ClearID One Identity Synchronization Tool, save
them to a C: or C:\temp folder location. Do not
save CSV files in a user-controlled file or folder locations (C:\Users
folders or desktop folder location) or you might encounter File
path is not valid user permissions issues.
Procedure
In the One Identity Synchronization Tool Data
sources section, click Add data source ().
In the Source section of the Data source
configuration dialog, select File and click
Next.
Note: If you selected File in the Source
section, the Configuration section of the Data source
configuration dialog is skipped because it is not required.
In the What to sync section of the Data source
configuration dialog, select Identities to synchronize
from the external system data source.
If you selected Identities as a
data source, in the What to sync section, configure the identity
attributes settings.
Note: The fields that are displayed vary depending on the data source selected in the
Source section (step 2) earlier.
The following image shows the options that are
displayed after selecting a File (CSV) data source.
If you selected File as your data source, configure the file
settings.
File
Click More () to
select the CSV file containing your attributes.
Note: The file path must exist on
the server where the One Identity Configuration Tool is installed.
Delimiter
Enter a Delimiter value.
For example, for a CSV file
it is a comma-separated value (CSV).
Start at line
Select a Start at line.
For example, the data in a
table with no headings might start at line 0, whereas the data in a table with
headings might start at line 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 system attributes in the External field columns that you
want to map from the external system to the ClearID identity attributes shown in the
One Identity field
column.
If your CSV file contains column titles, the names are displayed.
If your CSV file does not contain column titles, the column number is
displayed.
(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.
A script icon () is shown in the Sample value column when the field text
is being replaced with a regular expression.
The transform expressions are processed in the order specified in the
Add transform expressions for field dialog.
Tip: If required, you can select the row of any expressions that you
no longer require, and click delete
.
(Optional) Click Refresh () to update the external
fields data from your data 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.
Click Next.
In the Summary section, review the data
that will be synchronized.
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.
If the data synchronization details look correct, click
Finish.