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

version Kofax 11.4.x

Download Pending

 Audience

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

 

Overview

 

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. This article is designed to be a step-by-step walkthrough of the Synchronizer configuration process.

 

For more general configuration information on Kofax PSIsafe Synchronizer see:

Kofax PSIsafe Synchronizer Administrator Guide: Configuration

 

Step 1 – Run Kofax PSIsafe Synchronizer

By default Kofax Synchronizer is installed in C:\Program Files\CNG\Synchronizer. The executable name is Synchronizer.exe. Simply double click this executable to run Synchronizer. A shortcut is also installed on the All Programs toolbar when you click on the Windows Start button. A standard CNG-Login screen will be displayed. Make sure the login you use has “CREATE” folder rights for the cabinet you will be updating with the PSIsafe Synchronizer.

 

 

Figure 1- Synchronizer Login Screen

This will bring you to the following display.

 

 

Figure 2 - Synchronizer Setup Screen

Step 2 – Enter a new setup name or pick from the list.

The Synchronizer can be used to connect to many different databases and cabinets. A
setup name is required for each database connection. The setup name is entered in the text box
on the left under the caption “Enter new Setup”. If you are modifying a setup, simply select one
from the box on the right

 

 

Figure 3 – Selecting/Entering a setup name

Step 3 – Select the PSIsafe Setup Information

The Synchronizer connects a database to a PSIsafe. This step is used to select
which Repository/Cabinet to connect the database to, as well as picking the default folder
security classes.

 

 

Figure 4 - Select Cabinet Repository and Cabinet

Step 4 – Setup the database connection Notes

Database novices, should spend a little time at this website to learn the basics of databases.
http://www.databaseprimer.com.
Setting up a Data Source Name (DSN) is used to attach to some databases. A primer is available
at this website.
http://support.microsoft.com/default.aspx?scid=kb;en-us;305599
Set up an OLEDB connection - http://www.datamystic.com/datapipe/ole_db_setup.html.

Connecting to a database

Setting up a database connection is the most difficult step in the process of using the
Synchronizer. This is dependent on the database and going through all the detail is beyond the
scope of this document. Select the database using one of these two methods:

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

 

 

Figure 5 - Select a DSN

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.

 

 

Figure 6 - Build a DB Connection string

Selecting/Creating the data table

Data in a database is stored in tables and is accessible in several different ways. The
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, the Synchronizer reads a list of tables and queries from the database and lists
them in the Select Table list. A table or query is easily selected from the list as shown in Figure 4.

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

 

 

Figure 7 - Select a table

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

 

 

Figure 8 - Build a SQL String

The SQL query is built by using the screen shown in Figure 9 - Build an SQL String. 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.

 

 

Figure 9 - Build an SQL String

Step 5 - Provide the mapping information

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. Only one primary key index is allowed per setup.

 

 

Step 6 – Optional Synching Parameters

 

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 the 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”. The linked Folder Security allows Synchronizer to set the folder security level. The database value must match the folder security description defined in PSIsafe to operate.

 

 

Step 7 – Operating Kofax PSIsafe Synchronizer

Saving a Setup
In order to synchronize with the same database and not have to go through all of the setups, make sure you’ve saved the setup by clicking on the Save Setup button. The setup will be saved with the setup name entered in Step 1.

Make sure there is a setup name in the “Enter New Setup” text box at the top of the screen.

Deleting a Setup

A Synchronizer Setup can be deleted by simply clicking on the Delete Setup Button as
displayed in Error! Reference source not found. the same database and not have to go through
ll of the setups, make sure you’ve saved the setup by clicking on the Save Setup button The
setup will be saved with the setup name entered in Step 1. Make sure there is a setup name in
the “Enter New Setup” text box at the top of the screen.

Synchronize the folders

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. See the section below "Regularly Scheduled Synchronizations" or the full help article information in PSIsafe Synchronizer Administrator Guide: Configuring Synchronizer.

Other Features

Using the Query Builder

 

To learn more about the Query Builder visit:
http://www.activequerybuilder.com/hs15.html

This guide helps explain the query builder used in “Figure 9 - Build an SQL String” in considerable detail.

Regularly Scheduled Synchronizations

Obviously the synchronizer is a powerful tool and should be carefully used. There is a command line mode that works with the synchronizer to enable an IT person to setup regularly scheduled synchronizations. This is accomplished by running the SynchronizerConsole from a Windows command screen. This task will run every minute and look at each of the Synchronizer setups that are in the database. If it is time for that particular synchronization to run again then a synch will be performed. Otherwise the console just goes back to sleep.

“<path to executable>\SynchronizerConsole.exe” [-savelogin|-uselogin] –nosync
-savelogin runs the normal login screen and saves the parameters
-uselogin uses the last login setup with the Synchronizer
-nosync runs the console without syncing anything.