Introduction

This topic covers the details you need to upgrade PrizmDoc to v14.x. We will discuss the benefits of upgrading, the recommended upgrade path based on your current version, steps to upgrade, and troubleshooting tips.

Benefits of Upgrading to v14.4

No database requirement to start the product
Improved Office, HTML, and email rendering
Security improvements
Performance improvements
watsonx AI features available via the AI Hub Docker image
Detect MS Office documents protected with MS Purview
Fast PDF viewing in the Hybrid Viewer
Modular licensing

Breaking Changes Between v13.x and v14.x

The default value for viewing.sessionConstraints.documentSource.allowedValues has been changed to the more secure setting of [api].
The default value for security.htmlRendering.blockExternalContent has been changed to the more secure setting of true.
The default value for security.externalContent.requireHttps has been changed to the more secure setting of true. Setting this option to true will be allowed when using the MSO rendering engine, but you will still need to handle blocking non-HTTPS requests outside of PrizmDoc.
The default value for fileTypes.excel.formulas.autocalculate.enabled has been changed to the more secure setting of false.

Rendering Fidelity Changes Between v13.x and v14.x

Since PrizmDoc continuously improves the rendering of documents, upgrading to a new PrizmDoc version causes some documents to display differently to how they displayed prior to the upgrade. In particular, some text may shift to another line or even another page.

If you have previously created markup (annotations or redactions) and saved for future use, instead of immediately burning it to your documents, such an update may cause the markup to misalign with the rendered document.

In order to keep your saved markup intact with rendered documents, use PrizmDoc PDF-only Viewing Packages. See Keeping Markup Intact With Your Documents for more details.

How To Upgrade

If you are upgrading from version 13.27 or older, we recommend you to upgrade to the latest build of PrizmDoc v13.28 first, because of the usability improvements in PDF Viewing Packages that help you to prepare for the upgrade to v14.x. If you prefer to upgrade directly from an older version to v14.x, make sure to read Upgrade PrizmDoc to v13.28 which explains how to upgrade from older versions.

Windows

Although PrizmDoc retains configuration settings when upgrading from a previous version, we recommend you to make a backup of your current configuration files, for possible future troubleshooting:
PrizmDoc Server Configuration:
- C:\Prizm\prizm-services-config.yml
- C:\Prizm\PCCIS\ServiceHost\pcc.config
PrizmDoc Application Services Configuration:
- C:\Prizm\pas\pcc.win.yml
Download the latest version of PrizmDoc Server and PrizmDoc client packages for your operating system from PrizmDoc: 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.
Restart the PrizmDoc Server and PrizmDoc Application Services to ensure the newly configured file changes take effect.

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

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

Kubernetes

PrizmDoc Viewer supports rolling updates, when pods running an older vresion of PrizmDoc are gradually replaced with ones running the new version.