Skip to content

Accusoft/prizmdoc-upgrade-script

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PrizmDoc Upgrade Script

Introduction

PrizmDoc Viewer continuously improves the rendering of documents, which sometimes causes document content to be shifted. This affects documents with floating layout, such as text, Docx, Xlsx, Html, Eml, etc, and does not affect documents where layout is fixed, such as PDF or raster formats. If markup was created for affected documents in a previous version of PrizmDoc, it may not match displayed documents in a new version of PrizmDoc.

In order to keep your saved markup intact with rendered documents, use PrizmDoc PDF Viewing Packages.

The use of PDF Viewing Packages for the Upgrade Process

A PDF Viewing Package is a cached/stored PDF version of a document that the Viewer will use when viewing a document.

You can use the create_viewing_packages.py script as a starting point for preparing viewing packages from your documents.

Pre-requisites

Python v3.13 or higher.

Installation

pip install .

Usage

usage: python create_viewing_packages.py [-h] -d DOCUMENTS_FOLDER -u PAS_BASE_URL -s PAS_SECRET_KEY

options:
  -h, --help            show this help message and exit
  -d DOCUMENTS_FOLDER   Path to the documents folder
  -u PAS_BASE_URL       PAS base url, e.g. 'http://localhost:3000'
  -s PAS_SECRET_KEY     PAS secret key. See https://help.accusoft.com/PrizmDoc/v13.28/HTML/pas-configuration.html

If you run the script successfully and then try re-running it, it will report that viewing packages already exist and skip their re-creation. If necessary, you can delete viewing packages from PAS storage, using Viewing Packages API.

The documents folder includes a small set of example documents that you can use for your testing.

Customization

This script assumes that source documents are available on the local drive. You will need to replace collectFilesystemDocuments, basicFilesystemIdGenerator and basicFilesystemDisplayNameGenerator with functions specific to your kind of document storage.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages