Skip to main content

Best Practices for performing an upgrade of Kofax Capture

Article # 3031524 - Page views: 1236


These are the Best Practices to take into consideration when performing an upgrade.


Below is a list of recommendations to take into consideration when performing an upgrade:

  1. Make a backup of the Kofax Capture data (see the Kofax Capture Data Backup and Restore Instructions Application Note for instructions on backing up the Capture data).
  2.  If your Kofax Capture database is Oracle, be sure that your tablespace configuration complies with best practices for Oracle. See the Oracle website for more information.
  3. Make a backup or snapshot of the entire machine with the current Kofax Capture version installed as there is no rollback capability when performing a Kofax Capture major upgrade to another major Kofax Capture version .
  4. Make sure you have plenty of disk space available as an upgrade will back up certain files and uses a certain amount of temporary space during the upgrade. (the suggestion is a minimum of 5 GB or more of free disk space.)
  5. If User Tracking is enabled, export any necessary data, and then purge the User Tracking data. Perform a Repair and Compact with Dbutil.exe after the purge.
Important-Icon.png WARNING: If User Tracking data is not deleted from the database, the migration of data to the new database will take considerably longer.
  1. Make a backup of all Batch Classes by exporting them to a location outside of the Kofax Capture installation.
    1. Back up any additional data related to KTM as needed.
    2. If there are any Custom Modules or other customizations, be sure to have copies of any custom scripts or installation media.
  2. Check if there are any stuck Batches. If there are, delete them before upgrading to Kofax Capture. Using BRU tool. * It is recommended to not have any Batches in the system. If there are Batches in the system, you can use the Batch Removal Utility to remove them, creating an XML file that you can then re-import once the system has been upgraded and verified it is working correctly.
  3. It is recommended to shut down any 3rd party monitoring, antivirus utilities (Windows Defender) or exempt any Capture directories from being scanned.
  4. Make sure to perform the Kofax Capture upgrade using an account that is a member of the Local Administrator group.
  5. It is recommended to perform the upgrade directly in front of the terminal and not through a remote session. If a remote session is used, ensure that the session ID is 0 throughout the upgrade process.
  6. Make sure that the MSSQL$KOFAXCAP2014 service is running.
  7. If this is an KCNS installation, you should disable the KCN/ACI service prior to an upgrade. To do so, run “aciscfg.exe /d” from a Command Prompt.
  8. Ensure that there are no active connections to the Kofax Capture database that may interfere with the upgrade.

    • For SQL, execute the following query: sp_who2
    • For Oracle, execute the following query: select * from v$session [where username is not null]
  9. Disable any SQL Maintenance Plans that might commence while the upgrade is occurring.
  10. Make sure to have Capture installation media handy for the version you are currently running.
  11. Test the Capture modules by launching them before applying any service packs.
Note-Icon.png NOTE: If you are upgrading an KCNS/ACIS environment and plan to upgrade the Remote Sites at a later time, any changes to Batch Classes WILL NOT be downloaded to Remote Sites that are not the same version as the Central Site.


Level of Complexity 



Applies to  

Product Version Build Environment Hardware
Kofax Capture 11.x N/A N/A N/A




Article # 3031524