Introduction

This topic covers the details you need to upgrade PrizmDoc Viewer.

Windows

PrizmDoc Server Upgrade

Starting with version 13.14, PrizmDoc Server provides the ability to retain configuration settings when upgrading from a previous version.

PrizmDoc Server Upgrading Version 13.3 and Higher

Starting with version 13.14, when the installed version to upgrade is 13.3 or higher, the PrizmDoc Server preserves the server-side prizm-services-config.yml and pcc.config files.

PrizmDoc Server Upgrading a Version Prior to 13.3

IMPORTANT: Before starting, make a backup of the following configuration files so you can use them as a reference when re-configuring the new version after installation. This should be done before you run the PrizmDoc Viewer installer, as all configuration files will be replaced with new ones (resetting them to their default configuration):

PrizmDoc Server Configuration:
- C:\Prizm\prizm-services-config.yml
- C:\Prizm\PCCIS\ServiceHost\pcc.config

PrizmDoc Application Services Upgrade

Starting with version 13.14, the PrizmDoc Application Services provide the ability to retain configuration settings when upgrading from a previous version.

PrizmDoc Application Services Upgrading Version 13.8 and Higher

Starting with version 13.14, when the installed version to upgrade is 13.8 or higher PrizmDoc Application Services are preserving pcc.nix.yml and pcc.win.yml files.

PrizmDoc Application Services Upgrading a Version Prior to 13.8

IMPORTANT: Before starting, make a backup of the following configuration file so you can use them as a reference when re-configuring the new version after installation. This should be done before you run the PrizmDoc Application Services installer, as configuration file will be replaced with new one (resetting them to their default configuration):

PrizmDoc Application Services Configuration:
- C:\Prizm\pas\pcc.win.yml

How To Upgrade

Download the latest version of PrizmDoc Server and PrizmDoc Viewer client packages for your operating system from PrizmDoc Viewer: Current Builds.
Install PrizmDoc Server first, and then the PrizmDoc Application Services. This will perform an in-place upgrade of the PrizmDoc Server and the PrizmDoc Application Services to the new version.
At the end of the server installation, the install may request a reboot.
Make a backup of your new configuration files as listed above.
Modify each of the new configuration files and make the same changes that you had in the older configuration files.

NOTE: Do not just replace the new configuration files with the older version of the configuration files, as new configurations may have been introduced in the new version and they would be lost.

Restart the PrizmDoc Server and PrizmDoc Application Services to ensure the newly configured file changes take effect.

NOTE: If either service fails to start with an error after modifying the configuration files, replace the configuration files with the original copy of the configuration files and try making the changes again.

If you are upgrading PrizmDoc Application Services from version 12.x and you are using viewing packages and have an existing database then you need to update your existing database by executing an additional script called addTenantId.sql to add a new field to one of the existing tables. The script is in the following location:
- C:\Prizm\pas\db\mssql-scripts\addTenantId.sql (for MS SQL database)
- C:\Prizm\pas\db\mysql-scripts\addTenantId.sql (for MySQL database)

Follow your database management system's documentation to run the script. (For example, use the 'mysql' command line client for MySQL database and 'sqlcmd' for MS SQL.) If you need database connection parameters, refer to the database parameters in the PrizmDoc Application Services configuration file:

C:\Prizm\pas\pcc.win.yml

Docker

NOTE: Traditional Linux installations are no longer supported. Please see Migrating to Docker for guidance on how to migrate from traditional Linux installations to Docker containers.

These instructions assume:

The container name for PrizmDoc Server is prizmdoc-server and the container name for PrizmDoc Application Services is pas. If this is not the case, substitute the names of your containers accordingly.
Your PrizmDoc Server and PrizmDoc Application Services containers are already using valid configuration files, created according to PrizmDoc Server / Installing / Using Docker and PrizmDoc Application Services / Installing / Using Docker.

How to Upgrade

Stop and remove the old PrizmDoc Server and PAS Docker containers:

 docker stop prizmdoc-server pas
 docker rm prizmdoc-server pas

Pull the desired version of the PrizmDoc Server and PAS Docker images:

 docker pull accusoft/prizmdoc-server
 docker pull accusoft/prizmdoc-application-services

Start the PrizmDoc Server and PAS containers: You can use the same commands that you used to start PrizmDoc Server and PAS containers before the upgrade. Default commands are provided below:

Windows (PowerShell)

 docker run --rm --env ACCEPT_EULA=YES --publish 18681:18681 --volume $pwd/config:/config --volume $pwd/logs:/logs --name prizmdoc-server accusoft/prizmdoc-server
 docker run --rm --env ACCEPT_EULA=YES --publish 3000:3000 --volume $pwd/config:/config --volume $pwd/logs:/logs --volume $pwd/data:/data --name pas accusoft/prizmdoc-application-services

Linux (bash)

Start a prizmdoc-server container:

 docker run --rm --env ACCEPT_EULA=YES --publish 18681:18681 --volume $(pwd)/config:/config --volume $(pwd)/logs:/logs --volume $(pwd)/data:/data --name prizmdoc-server accusoft/prizmdoc-server
 docker run --rm --env ACCEPT_EULA=YES --publish 3000:3000 --volume $(pwd)/config:/config --volume $(pwd)/logs:/logs --volume $(pwd)/data:/data --name pas accusoft/prizmdoc-application-services

Check the health and connection endpoints for the containers. A 200 OK response indicates that the containers are healthy and able to talk to one another:

 curl -i http://localhost:18681/PCCIS/V1/Service/Current/Health
 curl -i http://localhost:3000/health
 curl -i http://localhost:3000/servicesConnection