Technical FAQs for "PrizmDoc"


What’s the difference between a Viewing Session and a Viewing Package?


Viewing sessions require source information for the document that you want to view. There are 3 types of sources to choose from: File, URL, and viewing package.

A viewing package is a file you want to view that is stored in its already “converted state”, which we call “pre-conversion”. This is different than a file or URL because these sources are converted and set in a temporary cache folder for use until the cache is cleared out.

Viewing package information can be set to never expire which is useful if you have documents that will be viewed over and over again by many clients. This allows the server not to have to convert the file every time and increases performance.


In PrizmDoc Viewer, when viewing Excel documents that have pictures on certain spreadsheets within that document, the pictures are not displayed.

This appears to happen only if PrizmDoc has the Microsoft Office Conversion (MSO) feature enabled. This issue does not occur if PrizmDoc is using LibreOffice.

Why is this happening?


The issue is related to an Excel “Page Setup” option called “Black and white”. The option is located in Excel under File, Print, Page Setup and is only respected when PrizmDoc has the MSO feature enabled.

When using LibreOffice, this setting does not exist and is ignored, which is why you can see the pictures.

By default, this option is disabled in Excel, so that specific option would have to be manually set by the creator of the document.

As a workaround, ensure that the “Page Setup” option for “Black and white” is not checked on any spreadsheets in an Excel document that has pictures.


Does viewing HTML in PrizmDoc Viewer allow JavaScript execution or local file access? Can PrizmDoc Viewer block externally-referenced content from being rendered?


When viewing HTML in PrizmDoc, JavaScript and local file access are disabled.

Additionally, you may configure the security.htmlRendering.blockExternalContent setting found in PrizmDoc’s Central Configuration file. When rendering any source document which uses HTML content, this setting controls whether or not externally-referenced content, such as images and iframes, will be blocked. This option affects any source document file type which uses HTML, including HTML, EML, and MSG.


When running and entering the information for a node-locked license, such as configuration file, solution name, and solution key, the following error occurs:

The licensing configuration file you provided is invalid. Please retry
your request or break the licensing process:

What would cause this issue?


This issue may be caused by a trailing space on the configuration file copied to the Linux server.

To remove the space, run the following command, making sure to replace
configurationfilename with the name of your configuration file.

truncate -s -1 **configurationfilename**

For example:

truncate -s -1 /usr/share/prizm/licenseconfiguration.txt

Can I run PrizmDoc Viewer in a Windows Docker container?


No, you cannot run PrizmDoc Viewer in a Windows Docker container. This is because Windows Docker containers do not provide the full environment that a Virtual Machine or regular Windows system install provides.

However, this is not the same thing as using a Windows system as a Docker Host, which actually can run PrizmDoc Viewer in a Linux Docker container.


How can I change the PrizmDoc Viewer so that the TextSelection tool is selected by default instead of the Pan tool?


In order to select the TextSelection tool by default in PrizmDoc Viewer there are a few things you need to take into account. First, you have to click the button inside the embedViewer() function found in the index page of the sample. Second, the button for the text selection tool is actually disabled initially, so in order to be able to click it, the button has to be enabled first by removing the pcc-disabled class.

Use the following code to do this:

function embedViewer(options) {
    var viewer = $('#viewer1').pccViewer(options);
    viewer.viewerControl.on(PCCViewer.EventType.ViewerReady, function(viewer) {

I am a PrizmDoc Cloud customer and need to do content conversion with PrizmDoc. Do I have to do anything special to make it work?


Yes, in order to do content conversion as a PrizmDoc Cloud customer, there are a few things you need to do:

  1. Most of the information regarding how to use our content conversion service can be found here, including the requests that can be made to it.
  2. The URL the requests need to go to is, so you will need to make sure the requests for content conversion are going there.
  3. You also need to add a header to the requests as follows: acs-api-key: yourapikey.

Doing these three things will allow you to use content conversion as a PrizmDoc Cloud customer.


When viewing an Excel document with hidden content in the viewer, the content remains visible when otherwise expected to remain hidden. Is this intended behavior?


Short answer: Yes.

Currently, both PrizmDoc Cloud and PrizmDoc Viewer (Self-Hosted) are configured to render hidden content by default, so this is expected behavior.

For PrizmDoc Viewer (Self-Hosted) users, this rendering behavior is configurable using the central configuration file.

The file paths for the central configuration file are:

  • Linux: /usr/share/prizm/prizm-services-config.yml
  • Windows: C:\Prizm\prizm-services-config.yml

Simply add/modify the following parameter:

fileTypes.excel.renderHiddenContent: false

Setting the render option to false will hide content as expected, whereas true will render it.


We are currently using the latest version of PrizmDoc and noticed it is using JDK 8. Do we need to license the Java version that comes with PrizmDoc with Oracle? Also are you switching to Open JDK in the future?


We are in the process of planning the update to Open JDK.

Regarding the current version we are using, the main restriction from Oracle regarding JRE is that we cannot use new versions of Java SE8 without commercial license starting from January 2019. Our build process for Java service still uses Oracle JDK8  from versions older than January 2019.


When selecting download and including annotations, the resulting PDF does not include the comments. How can we obtain the file as a PDF with the annotation comments included?


By design, when using the download button, the comments to the annotations are not included in the download.


  1. Under the View tab, select Print.
  2. From the Print dialog, select the More options drop-down.
  3. Under the Comments section, select either After Each Page or At End of Document.
  4. When selecting a printer, use the Print to PDF option and it will create a PDF with the comments included.

With PrizmDoc Viewer (Self-Hosted), you need to purchase specific licenses to include certain functionality such as OCR, MSO, etc. With this in mind, are all features of PrizmDoc Cloud included with transaction and subscription purchases?


All features that PrizmDoc Cloud has to offer are available with either transaction or subscription purchases.


Is it possible to make a call to an external API when annotation saving is complete?


In the Viewer, you can bind functions to the MarkupSaved event mentioned on the following documentation page in order to execute code when annotations are saved to the server:

A full list of events exposed by the Viewer can be found here: