Skip to main content
Kofax

How to upgrade multiple ShareScan 5.0, 5,1, 5.2 or 5.4 managers with a shared database

Upgrading ShareScan 5.0, 5.1 or 5.2 Managers with a shared database requires special handling.

Information:

The following steps are the best practices for upgrading an environment with multiple ShareScan managers with a shared SQL database running ShareScan version 5.0 or 5.1 to a later version of ShareScan with minimal downtime. The example scenario provided below is from version 5.0 to version 5.1, however these steps are relevant for upgrades to 5.2 as well. 

Note: These steps should also be followed when installing hotfixes which update the database.

NOTE: Please review  if upgrading to a software version with a service pack.

  1. In the ShareScan Administration Console, select the Home tab of the ribbon > Licensing. Click on the License Report to save your license keys.
  2. In the ShareScan Administration Console, select the Advanced tab of the ribbon > Database > Database Backup to export a backup copy of the SQL database. Fill in the form. Upon completion of the backup, browse to the directory where this was stored and confirm the backup exists.
  3. Set up a new ShareScan Manager (RTM + SP4 or later Service Pack) installation. The database created with this option is used as a temporary database until all Manager PCs in the fleet are upgraded. )
    • hotfixes are not required, if there were any deployed on the production PCs.
    • The SQL database must be either a new local SQL server 2008 express database as is installed by ShareScan installer OR a new named instance on the same SQL server where the currently used database exists. New database instances must be created by the database administrator.
  4. Using the database backup as created in step 2, restore the database using the db_restore.cmd script located in the \Nuance\ShareScan5\Server\Tools\Database folder.
    • NOTE: If the new database instance is installed on a SQL server with a sa password that is not known/ not provided, instead of the below steps, the eCopyShareScan-Restore.sql script can be used by the database administrator to restore the database. This script performs additional necessary operations that do not occur when restoring the database using standard SQL server tools.
    • Move the SQL database backup created in step 2 to the ShareScan manager installed in step 3.
    • Go to Start > All Programs > Accessories > Right click on Command Prompt and select "Run as administrator"
    • Change the directory to where the database script is located example: cd C:\program files\Nuance\ShareScan5\Server\Tools\Database
    • Run the script with the following command: db_restore.cmd sa eCopy  
      • example: db_restore.cmd 10.140.26.19 sa e+C0py2007_@x "c:\backup\sp4dbbackup.bak" eCopy e+C0py2007_@x
  5. At this time the newly set up ShareScan manager should be a functional copy of the production database. All connectors and services profiles should exist on this new ShareScan manager.
    • Note: The ShareScan licenses may appear with a Hardware fingerprint mismatch error message. This can be ignored during the upgrade process. The licenses will function for 30 days.
  6. For all ShareScan managers other than the last, upgrade the individual ShareScan manager PCs one by one using the below steps. Note: for the last ShareScan manager please follow the steps in item number 7 below.
    1. Go to Start > Run > type services.msc and click OK. In the Windows Services menu find the ShareScan Manager and ShareScan Agent services. Click on each service and select Stop.
    2. If using ShareScan 5.0, download the ShareScanTroubleshooter.zip and extract to the ShareScan PC. This zip file is available via the registration site. ShareScan 5.1 and 5.2 already includes the Troubleshooter tool as part of the default installation.
    3. Open the ShareScan Troubleshooter tool. From the Menu select Database > Test/Set connection.
      • Enter the Server name of the temporary SQL database from step 3 above
      • Enter the database name. default is eCopyShareScan
      • Enter the runtime Username & Password. This was specified in step 4 above. default is eCopy and e+C0py2007_@x
      • Click the test button, if the test is successful click on the Set Configuration button to change the database to the temporary SQL database.
    4. In the Windows Services menu, start the ShareScan Manager and ShareScan Agent services.
    5. Open the ShareScan Administration console and confirm no errors are received. Perform a scan on a device connected to this manager. These two tests confirm that there is not a conflict with the database or the database connection. This should be completed before proceeding.
    6. Download the ShareScan 5.1 installer to the ShareScan PC. This zip file is available via the registration site or reseller Engage accounts. Extract the contents of zip file to this computer. Right-click on the executable and select "Run as Administrator". In the installation wizard, select "Upgrade ShareScan 5.0 to ShareScan 5.1" on the welcome screen. Click through relevant options in the wizard and complete the installation.
      • The temporary database will not have issues with the multple upgrades being performed by each of the ShareScan managers being upgraded.
    7. After the upgrade is complete, start the ShareScan Administration console. Confirm no errors are received.
      • Note: for the first ShareScan Administration console that gets upgrades, a message box will appear when first opening the ShareScan Administration Console. The message box contains a Select Manager prompt listing all the IPs of ShareScan Managers attached to the SQL database. Click Yes and select the ShareScan Manager IP of the PC that was just upgrades. This step copies several settings to the database that were previously stored in the Windows Registry. This step is only performed once.
    8. Verify the functionality of the ShareScan manager by testing a scan. This Manager should now be fully functional on ShareScan 5.1.
    9. Repeat the the Step 6 sub items 1-8 for all ShareScan Managers remaining to be upgraded with the exception of the last ShareScan Manager.
  7. For the last ShareScan Manager, the primary SQL database will also need to be upgraded. Complete step 6 sub items 6-8 on this PC.
    • Note that the steps where the ShareScan manager was pointed to the temporary SQL database are not completed for this ShareScan Manager as the primary SQL database is being updated.
    • Note that the Messagebox will appear again after opening the ShareScan Administration console. Follow the same steps as previously.
  8. On all ShareScan managers other than the last (which is already set to the primary SQL databse), open the ShareScan troubleshooter tool. From the Menu select Database > Test/Set connection.
    • Enter the Server name of the primary SQL database
    • Enter the database name. default is eCopyShareScan
    • Enter the runtime Username & Password. default is eCopy and e+C0py2007_@x
    • Click the test button, if the test is successful click on the Set Configuration button to change the database to the temporary SQL database.
  9. Discard the temporary database and the temporary ShareScan server created in step 3.
  10. Open the ShareScan troubleshooter tool and use the Database > Remove unused manager data  option to ensure there is no data belonging to a ShareScan Manager that does not exist anymore. Note: Deleting data via this function is not possible to undo except by a database restore. All managers ever connected will be listed in this tool. Ensure that only IP addressed selected are no longer attached to the ShareScan SQL database.