Skip to main content

How to configure a DirSync using a CSV file

Article # 3036198 - Page views: 11


This article contains the description on how to configure a TOM file, so that it is going to make a DirSync using the according CSV file.

Requirements for making a Dirsync via CSV file are a DirSync License, DirSync template user (TCfW), LINK- FI (TOM Format) and the CSV file containing the user list which needs to be synchronized in the address book.


DirSync template user (TCfW) 

First create a TCfW user profile which will contain the variables for the different fields which are filled out by the data from the CSV synchronization file.

The DirSync template user may look like this:

dirsync template.png

It is very important that the “Dirsync allowed” flag is checked.

The Values between the $-signs have to be the names of the CSV-columns.

This template user, by default doesn’t have an address or any rights. So if there is no address inserted in the CSV file the user will remain without address.

Regarding the rights of the template user, it isn't possible to set the rights via the CSV file. Therefore, if template users should be created with different sets of rights, it is suggested to have more DirSync Template users with the needed rights.


The same applies to every other form of individual user rights. That means, create a Template user with a unique User ID, define the needed rights for this user and put the Template User ID in the "template column" of the CSV File for the users which should have the rights defined in the Template User.

So we can create groupings of Template Users which have individual rights in order to fit most of the synchronized users.

DirSync CSV-Transaction File 

DirSync within the transaction files uses the general syntax “ParameterName=Value”. The DirSync via CSV files uses the attached CSV-file for directory synchronization.

The first row of the CSV-file consists of the parameter-names, the rest of the rows are filled with values. Parameters/columns that have always the same value don't necessarily need their own column.

Example of a DirSync CSV-Transaction File:

Screen Shot 2018-07-31 at 12.07.26 PM.png

In the parameter-section 'CSVINFO' the following parameters allow for configuring the column-names and values of the CSV-file:


Actually, the CSVINFO is used to merge the data from the CSV-Transaction file and from the CSV- Synchronisation file.

The 4th line is also very important. It is the line that describes where the CSV-Synchronization File is located. (In this case it is located in the TCLFI folder)

The CSV-Transaction File grabs the CSV-Synchronization File and after that it inserts the data into the TCOSS File structure.

Important-Icon.pngPlease make sure to have a backup of the CSV-Synchronization File,
because after it is grabbed by the CSV-Transaction File it will be erased immediately.

DirSync CSV-Synchronization File 

The first row of the CSV-Synchronization file consists of the parameter-names, the rest of the rows are filled with values.

Example of a CSV-Synchronization File:

example user sync.png


mode - would refer to a column that specifies the operation to be executed (default: either A, M, or D; or one of the values defined the same way with the ADD, MODIFY and DELETE parameters).

It is possible to change the default Values "A,M or D" in the registry:

HKLM\SOFTWARE\Topcall\TCLINKFI\Dirsync_CSV\OperationAdd Default Value = "A"
HKLM\SOFTWARE\Topcall\TCLINKFI\Dirsync_CSV\OperationDelete Default Value = "D"
HKLM\SOFTWARE\Topcall\TCLINKFI\Dirsync_CSV\OperationModify Default Value = "M"

DirectoryName – is interpreted as the User ID of the customer (CSVINFO: NAME=DirectoryName)

Template - requests the CSV-file to have a column named: 'template'. This column has to provide the User ID of users or recipients on the KCS server for mapping the rest of the attributes. TYPE=”template” would not search for a column of the name 'template' but would search for a user or recipient of the name template itself on the KCS server (CSVINFO: TYPE=template)

Resulting user:

Registration Key Type Default Description 
ColumnMode STRING MODE Default name for column Mode
ColumnName STRING NAME Default name for column Name
ColumnType STRING TYPE Default name for coulmn Type
OperationAdd STRING A Value in Mode- column for adding
OperationModify STRING M Value in Mode- column for modifying
operationDelete STRING D Value in Mode- column for deleting
LinkType STRING "xy" Default link-type the added user belongs to
Delimiter DWORD 44 (,) defines the column-delimiter in the CSV- file as ASCII-value
DirSync CSV Registry Keys 

For all parameters values are defined in the registry. These values are used if nothing is specified in the transaction-file. If no registry-values exist, the keys are created with the listed default values.

Registry Keys (…\TOPCALL\TCLINKxy\Dirsync_CSV):

Parameter Default Description
MODE MODE Name of column which values define if users/recipients shall be added or deleted 
NAME NAME Name of column in that the KCS user-ids are specified 
TYPE TYPE Name of column in that the KCS user- or recipient- templates (shadow-users) are specified, defining the mapping of the rest of the attributes to be synchronized

"xy" stands for the two letters specifying the Linktype using the TC Open Message Format. (“FI” or “MQ”)

For a detailed description of how Directory Synchronization generally works, and especially on how to use shadow user templates, see the current TC/LINK Manual. (See references)

Level of Complexity 


Applies to  

Product Version Build Environment Hardware
Kofax Communication Server All      
  • Was this article helpful?