Kofax PSIsafe Synchronizer Administrator Guide: Overview & Installation

version Kofax 11.4.x   Download Pending

 

 Note

This article includes advanced Administrator areas for PSIsafe Management.

 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 an application designed to help synchronize metadata in the form of indexes between a wide variety of third party applications and your PSIsafe Cabinets. Once configured, it can synchronize automatically in the background and update your PSIsafe Cabinet index fields as often as you update your external database.

PSIsafe Synchronizer is used to create a “map” between an external database and PSIsafe folder indexes. Once the “map” is setup, PSIsafe Synchronizer will automatically read the database selected and either update or create folders in PSIsafe with the updated/new data. The “map” is created by selecting a database field and matching it with the appropriate PSIsafe folder index. It is not necessary to use every field in the database as a folder index. Rather, select the most common searchable fields as data to be added to PSIsafe Folder Indexes.

 

Understanding Synchronizer


Synchronizer is used to synchronize folder index data in PSIsafe with data from an external database. If necessary, new folders are created and updated as records are created or modified in the external database. The objective of Synchronizer is to provide a simple and automatic method to add/update folder records so double entry is eliminated and data is kept updated in the PSIsafe folder indexes.


These folder index fields will typically contain information relevant to the storage of documents within PSIsafe, and not necessarily all the indexes available.

How it works


Synchronizer is used to create a map of links between an external database and PSIsafe folder indexes. Once the links are mapped and setup, Synchronizer will automatically read the your external database and either update or create folders in PSIsafe with the updated and new data.


The link is created by selecting a database field and matching it with the appropriate PSIsafe folder index. You don’t have use every field in the database as a folder index, but typically the most common searchable fields can be linked to your pre-configured PSIsafe Folder Indexes. You’ll set these indexes up in the Management console beforehand.


Things to Know before Configuring PSIsafe Synchronizer

 

  1. Database Information (Internal IT knowledge)
    1. Where does the database reside?
    2. What type of database is it?
      1. SQL Server
      2. Oracle
      3. Microsoft Access
      4. Other
    3. Connecting to the database
      1. Do you have an OLE DB or ODBC driver or DSN for the database?
      2. Can a Data Source Name (DSN) be built to point to the database?
    4. Accessing the data in the database
      1. What table or query will be connected to PSIsafe?
      2. Do you need to build a query spanning several tables?
      3. What is the primary key field for the database or query?
  2. Which PSIsafe Repository & Cabinet to use.
    1. Do the field definitions in the table match the folder index definitions?
      1. i.e. data table has separate fields for last name, first name, then the PSIsafe folder indexes should as well.
  3. Matching is done on a field by field basis.
    1. For each needed field in the database table/query, you need a corresponding field in the PSIsafe folder indexes.
  4. How often will the Synchronizer operate?
    1. Hourly, daily, weekly, or otherwise?
    2. Stress will occur on the server briefly during this time period, so be aware of peak usage times of PSIsafe.
  5. Synchronizer can be used to connect to different databases and cabinets. Separate Synchronizer setups are required for each database connection. Each Scheduled Synchronization runs all configured profiles at once.

Prerequisites

PSIsafe Server and Client 11.x External ODBC DSN or SQL Connection String
Windows Server 2012 or later External DB credentials

 

Download the Synchronizer installer by contacting support@psigen.com to request a link.

 

Installation

Run the installation program after unblocking the installers, as detailed in the section below. It’s best to install the PSIsafe Synchronizer installation program on the same machine as the external database which will be linked to PSIsafe. Make sure access is also available to the PSIsafe repository from this machine. Install the program with the default settings provided. Alternative settings should only be used when directed by PSIGEN technical support staff.

 

 

Unblock Installers & Run as Administrator

Ensure you unblock all installers downloaded via Properties > Unblock. Then, right click and “Run as Administrator” when completing the following installation guide. Ensure that the user running the installation has proper permissions in Active Directory or otherwise.

 

install1.png

 

It’s best to install Synchronizer on the same machine as the external database we are linking to PSIsafe. This helps improve performance of the Synchronization itself. Make sure Windows- based security permissions, whether in an Active Directory environment or otherwise, grant access to the PSIsafe Repository from this machine.

 

inst3.png

 

Install the program with the default settings provided. You may wish to create a service account specifically for Synchronizer to use, so you can establish specific permissions to your repository and add permissions to task scheduler instance.

 

Once your installation is complete, check out the Kofax PSIsafe Synchronizer Administrator Guide: Configuration.

 

Port Exceptions

 

 

PSIsafe uses the following ports:
(Add Inbound and Outbound entries)


TCP: 8993-8994 (Service Ports)
11000 (.NET Remoting)
1433 (SQL Service)


UDP: 1434 (SQL Browser Service)

 

Keywords: PSIsafe Synchronizer Installation, Install PSIsafe Synchronizer, Synchronizer Install Process

 

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

Comments

0 comments

Please sign in to leave a comment.