Kofax PSIsafe Synchronizer Administrator Guide: Configuration

version Kofax 11.4.x   Download Pending



This article includes advanced Administrator areas for PSIsafe Management.


This article is meant for PSIsafe Administrators with SQL database access and any third-party application credentials with read/write permissions to synchronized databases.




PSIsafe Synchronizer is a PSIsafe family application designed to synchronize a wide variety of database options with your PSIsafe installation. Database entries are correlated to folder index values, and the Synchronizer application allows an Administrator to map these connections in detail. Explore the article below to learn how best to configure your Synchronizer installation to meet your business needs.


For a first-time setup walkthrough of Kofax PSIsafe Synchronizer see:

PSIsafe Synchronizer Administrator Guide: Initial Configuration Step-by-Step Walkthrough


Login and Configure

By default Synchronizer is installed in C:\Program Files (x86)\CNG\Synchronizer\Synchronizer.exe. Simply double click this executable, or the shortcut placed on your desktop, to run Synchronizer’s visual configuration GUI.




It’s important to note that this GUI is mostly for the configuration process and not for regularly scheduled use. The scheduled Sync will be performed by the Synchronizer Console that we will configure in the next steps.



A standard PSIsafe Login screen will be displayed. Make sure the login you use has at least “CREATE” folder rights for the cabinet you will be updating with Synchronizer. These rights can be configured in the management console, as in the screenshot below:



Synchronizer connects a database to a PSIsafe Cabinet. Select the appropriate Repository & Cabinet to connect the database to, as well as the default folder security classes for the folders that Synchronizer creates.



Choose a Database Connection Type based on Environment

Setting up a database connection is the most difficult step in the process of using Synchronizer. The details of each database connection will vary largely on the type and purpose. However, some universal elements, including the directory of the database (where it is stored on the local PC or network), Drivers, and Connection Credentials are constant. Select the database using one of these two methods:


Data Source Name (DSN)

1. DSN – check the “use DSN” box and then select the appropriate DSN from the list provided.


Need to create an ODBC DSN? Open ODBC Data Sources (32-bit) and complete the following setup steps:




Object Linking and Embedding Database (OLEDB)

2. OLEDB connection string – check the “use OLEDB” box. Then click the Setup DB button. You will go through a series of screens that allow you to pick your database driver, your database server and/or file and the username/password (if any) to use in logging into the database.




Here are some helpful links to learn more about ODBC Databases, DSNs, and how they can link to your existing configuration:

OLEDB Connections and Syntax
SQL Server and ODBC Management
Microsoft Access and ODBC Databases



Choose a Database Table or SQL Statement

Data in a database is stored in tables and is accessible in several different ways.Synchronizer can use a standard database table, a query from a database, or a query can be built that can use data from several tables. If the database is relatively simple, it is likely that a single table selection will work. When the database is selected in the “Connecting to a database” section, Synchronizer reads a list of tables and queries from the database and lists them in the Select Table list.

Selecting from a table requires you to select the “Use Data Table” checkbox and then select the table from the list box.


Building SQL Statements

Alternatively, a query can be constructed that spans several tables. This is generally used when all of the pertinent information for a Cabinet is stored in different tables. To start the process of building an SQL string, click the Build SQL button.



The SQL query is built by using the screen shown to the left. The process for building a query is very similar to Microsoft Access’ query builder. Tables and/or queries are selected from the right side of the screen and placed in the Main Tab. Then links between the tables are selected. Linked fields are displayed in the SQL string at the bottom of the screen. In this manner an SQL string can be produced with a minimum of effort.




Map and Link Index Fields

After the previous 3 steps, the process for mapping the database fields to the cabinet folder indexes is performed. Fields are selected from the database with the pull down list labeled “DB Field List”. PSIsafe folder indexes are selected from the pull down list labeled “PSIsafe Indexes”. When the “Add Link” button is clicked, a connection is made between the database field and the cabinet index. This is displayed in the table below the pull down lists.

At least one of the database fields must be unique.

When it is linked to a cabinet index, the Primary Key checkbox above the Add Link button must be checked. This will be the field used to search for folders and either update or create them.




Other Synchronizer Parameters & Manual Operation

If the database being used to link to PSIsafe has a large number of records, it is best to only update the cabinet folder indexes that have changed since the last time Synchronizer was run. The database must support this by providing a date modified field. This field is changed to reflect the last time the database record was modified. The timer interval field is used to set the number of minutes between synchronizations when Synchronizer is running on “Automatic Sync”.  

Setting Folder Security with Synchronizer
The linked Folder Security option allows Synchronizer to set the folder security level. The database value must match the folder security description defined in PSIsafe to operate. Both new and existing folders will be updated when Synchronizer runs.

NOTE: The database must contain a field that can be used for Folder Security. Database contents must match the text contained in the Folder Classes defined in Management. If no match is found, the folder will be assigned a default security of non-sensitive.

NOTE: If a synchronized cabinet index structure is changed in any way - the data field map must be redone.




Save Configuration & Prepare Console

Saving, Deleting, and Recreating Setups

In order to synchronize with the multiple setups in the same database, and not have to repeat all the configuration steps, make sure you’ve saved the setup by clicking on the Save Setup button. You can then easily start a new setup and rename it when finished. The setup will be saved with the setup name entered in the field.

Make sure there is a setup name in the “Enter New Setup” text box at the top of the screen or you will see an error displayed onscreen.

Saved Configurations are stored in the following tables within your main SQL Database for PSIsafe.

  1. dbo.SynchonrizerLinkTempSettings
  2. dbo.SynchronizerMaster

You can reference your saved configurations by viewing these tables.



A Synchronizer Setup can be deleted by simply clicking on the Delete Setup Button.



Running Synchronizer

Folders can be synchronized in three different ways:

1. Manually, by clicking on the “Manual Sync” button.
2. Automatically every 1-60 seconds by entering a time and clicking on the “Automatic Sync” button. Syncing will continue until the button is clicked again.
3. Use the windows scheduler to schedule a sync time on a regular basis via the Synchronizer Console.

Configuring the Synchronizer Console’s Login - Command Prompt

  1. Run Command prompt (Click Start> Type “cmd” and click enter).
  2. Type “cd/” and press enter.
  3. Type “cd Program Files (x86)\CNG\Synchronizer” and press enter.
  4. Type “SynchronizerConsole.exe –sl –ns” and press enter.
  5. In the Login Window that pops up, Enter the Synchronizer account’s username & password, and click Login. This account will be used for Synchronizer at regularly scheduled intervals, so make sure it is assigned an appropriate license type that will not be in use by another user and that the account has the proper rights as previously mentioned.
  6. Close Command prompt.

Additional commands and parameters:

“-ns” No Sync
“-sl” Save login info
“-ul” use saved login info
“-rs” for Run Continuous
“-h” help

Preparing the Synchronizer Console for Windows Task Scheduler

Browse in Windows explorer to “C:\Program Files (x86)\CNG\Synchronizer\”
Create a text File with the following exactly:

“C:\Program Files\CNG\Synchronizer\SynchronizerConsole.exe” –ul

Save the file as a batch file with .bat as the extension. To run the Command Prompt Window minimized on the scheduled Synchronization time, create a shortcut to the batch file and modify the properties to run in a minimized state. We will point to this shortcut in the Windows Task Scheduler configuration.

Setup the Windows Task Scheduler Instance


As indicated in the above screenshots, creating a Windows Task scheduler instance is a matter of setting the General options, Triggers, Actions, and additional Settings. The conditions will likely remain default. Adjust the values to suit your Synchronization needs.



Migrating PSIsafe Synchronizer

ODBC instances can be migrated by exporting the Registry Entries. Otherwise, the database configuration itself will need to be recreated on the new server. When migrating a PSIsafe Synchronizer installation, data field maps are always redone. Since Synchronizer stores no other data other than the logs, generated login information files, and batch files pointing to the executable, this process is usually repeated in its entirety during a migration.

Was this article helpful?
0 out of 1 found this helpful



Article is closed for comments.