PSIsafe Upgrade Paths and Processes

version 12.2.x   Download Unavailable



This article is intended for On-Premises installations only. This article is not applicable to PSIsafe Cloud customers. Cloud upgrades are performed by Cloud IT Administrators or Kofax IT Administrators.


This article is available publicly and information within should be used with caution.



It's important to note that before beginning any kind of upgrade process, backups of the existing data must be performed to ensure a smooth rollback if necessary. Similar to how the PSIcapture data is backed up in \Programdata\PSIGEN, we will do the same with the Repositories and the CNG_Main and CNG_Forms SQL databases. Before any upgrade is done, ensure any IT staff complete these backup tasks, and verify the files are located in an accessible place on the network, or locally. Support team members can assist with the backup of Databases and Repositories. Repository files should remain unchanged during an upgrade process, whereas SQL DBs will be altered by the upgrade process itself, with SQL Transact scripts run by the upgrade packages. For more information on backup and migration processes, see:

PSIsafe Administrator Guide: Backup and Restore SQL Databases and Repositories

PSIsafe Server Administrator Guide: Moving or Migrating a PSIsafe Server to another Machine


The following is a brief summary of the Backup process described in the article above:

Backing up the SQL Databases

  1. Find the Server installation. This can be done by checking client connection settings.
  2. You will see CNG-Server under Services.msc
  3. Stop the Service and ensure all users are not using the client.
  4. Open SSMS and have the DBA login as SA account.
  5. Open the Databases tab.
  6. Right click on the CNG_Main and CNGForms databases sequentially.
  7. Click on Tasks
  8. Click on Back Up.
  9. Choose a location to store the backup file.
  10. Click ok, ensure the process completes to 100% in the bottom-left corner, and you have made a backup of the CNG_Main database.

Backing up Repositories

  1. Open PSIsafe Management
  2. Default Username and Password
    • User: Administrator
    • Password: (default or customized)
  3. Click on Filing Structure > Repositories
  4. You will see where all the physical repositories are. Ensure each one is copied and moved to a secure location.
  5. Ensure each additional aspect of the installation is backed up as necessary.
It is the responsibility of the PSIsafe customer to ensure they regularly backup their data.
With the Backup Process complete, the Upgrade Process can begin:
  1. You have already located the server installation by knowing where the CNG-Server service is located in Services.msc.
  2. Download and install the Server Update package on the server machine only.
  3. Once complete, open the PSIsafe Desktop Client on the server and ensure it prompts for the "Auto Update" process, and updates properly to the version you wish to upgrade the On-Premise installation to.
    1. In some cases, if the PSIsafe Desktop Client does not perform the upgrade properly, you can manually uninstall the client and reinstall via the Full Client Installation Package.
    2. The automatic update routine was removed in version 12.2. Manual upgrades must be performed for clients going forward from this version.
  4. Check for Client Auto Update processes in the same fashion on any Workstation machines, or update manually as necessary.
  5. If users are still logged in to the old PSIsafe Desktop Client, you will need to log out and attempt to log back in. The machine should then prompt to Auto Update upon successful login.
  6. You have now successfully completed the upgrade.


SQL Upgrade Scripts

As of version 11.3, some installations of PSIsafe Server will require a SQL Database Upgrade script to be run via SSMS on the PSIsafe Database to update various aspects of the database to function properly with the newer versions of the product.

If performing an upgrade from version 11.3 > 12.1, SQL DB Upgrade scripts will almost certainly be mandatory alongside the upgrade installer. While the upgrade installer may in some cases perform these upgrades automatically, it's important to be prepared to run the scripts in the event that the scripts are not automatically applied.

If performing an upgrade from version 12.1 > 12.2, SQL DB Upgrade scripts are bundled with the installation package on the partner portal, and must be run to update the database with the latest schema changes.


PSIsafe Server Upgrade Paths

The following is a reference guide for each version of PSIsafe, and the Upgrade Paths that should be incorporated for this process:


Version Notes Additional Notes

(baseline version)

Current GA version.

(On-Premise GA)

(Cloud GA)


Cannot rollback. Seamless upgrade from baseline v. to baseline v. 12.2.x

Upgrade Scripts may need to be run manually. Upgrading from 10.4 or 10.3 to any version beyond 12.1 will require running upgrade scripts in most cases.

(baseline version)

(Common GA)

(Final PSIGEN Official Product)

Must upgrade to this baseline version before proceeding to version 12.2.x.


Cannot rollback. Seamless upgrade from v. to baseline v.

(baseline version)

Can be directly upgraded to 12.1

Cannot rollback. (baseline version) Can be directly upgraded to 12.1 Cannot rollback.  

Can be directly upgraded to 12.1

(Common GA)

Rollback possible (to v. but not recommended (leaves visible color and line variations in UI). Seamless upgrade from baseline v. to

Can be directly upgraded to 11.1 using Server update

(First Official PSIGEN Product)

Seamless upgrade from v. 10.4 to v. 11.0 (Not a recommended build). or

(baseline version)

Patch to .4500. Then can be directly upgraded to 11.1 using the Upgrade Installer.

Upgrade to 12.1.x using Upgrade Installer (Contains all DB Script upgrades)
(Common GA)
(Final CNG Official Product)

Seamless upgrade from v. 6.2 to baseline v. 10.4.

NOTE: If migrating a 10.4.x DB to a new machine with a 10.4+ Full Installation, Upgrade Scripts must be run manually. Upgrading from 10.4 or 10.3 to any later version will require running upgrade scripts in most cases.

10.3   Upgrade to, then patch to .4500  
10.2   Upgrade to, then patch to .4500  
10.0   Upgrade to, then patch to .4500  
9.0   Upgrade to, then patch to .4500  
8.5   Upgrade to, then patch to .4500  
8.0   Upgrade to, then patch to .4500  
7.0   Upgrade to, then patch to .4500  
6.2(baseline version)   Upgrade to, then patch to .4500  
6.0(baseline version)   Upgrade to 6.2  
5.8(baseline version)   Upgrade to 6.0 Clarion Backend until 5.8. Database script available to be run, if 6.0 update doesn't create necessary tables in database.
5.4   Upgrade to 5.8  
5.0(baseline version)   Upgrade to 5.8  
4.5   Upgrade to 5.0  
4.2(baseline version)   Upgrade to 5.0  
4.0   Upgrade to 4.2  
3.5   Upgrade to 4.2  


Keywords: How to Upgrade PSIsafe, PSIsafe Upgrade, On Premises, PSIsafe Backup

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



Article is closed for comments.