Introduction

Traditional Linux Install Packages and Windows:

<install_dir>/cache

e.g.:

/usr/share/prizm/cache

C:\Prizm\cache

Docker:

/data/cache

Any valid path to a directory with read and write permissions.

NOTE: When using PrizmDoc Docker containers, we recommend that you keep this property unchanged.

Connection string to the central database. MySQL is the only database currently supported.

MySQL example: "mysql://prizm-user:password@prizm-server.database.host:3306/prizmdoc_server_db"

For source documents which contain images, ensures that the images in the SVG delivered to the browser do not exceed a particular pixel width and/or height. For example, a value of 8000 would ensure that any images in a PDF whose width or height were greater than 8000 pixels would be down-sampled before the image was added to the final SVG. A typical value is 8000.

The default value for this property is configurable. The out-of-box configuration uses a default value of 8000.

Use 0 to disable the optimization.

For CAD documents, controls how much path simplification is allowed. The path simplification algorithm will merge points which are "close together" to create an optimized SVG. You can think of this value as defining what "close together" means. A typical value is 0.3. Higher values introduce more simplification, but also more distortion. The value cannot be greater than 10.0.

The default value for this property is configurable. The out-of-box configuration uses a default value of 0.3.

Use 0 to disable the optimization.

Specifies the renderer to use with Microsoft Office documents.

When set to "auto", PrizmDoc decides which renderer to use based on the MSO feature license state. If the MSO feature is present, then the Microsoft Office renderer will be used. Otherwise, Libreoffice will be used.

When set to "libreoffice", PrizmDoc will be using the Libreoffice renderer. If you are intending to use the Libreoffice renderer permanently on a server that does not have Microsoft Office installed, contact info@accusoft.com to obtain the license key with the MSO feature disabled.

When set to "msoffice", PrizmDoc will be using the Microsoft Office renderer, if the MSO feature is enabled in the license key, otherwise the licensing error will be reported.

The parameter affects only Microsoft Office documents, RTF and CSV files. Other documents will continue to be rendered with LibreOffice.

For a complete list of supported file types see Supported File Formats.

This value is used to enable Microsoft Office Conversion connectivity for PrizmDoc servers running on Linux.

Set this value on a PrizmDoc server running on Linux to the hostname (or the IP of a single PrizmDoc server, or a load balancer of a cluster running on Windows) to utilize the Microsoft Office Conversion service running on Windows to have native rendering of Microsoft documents in PrizmDoc.

This value is used to enable Microsoft Office Conversion connectivity for PrizmDoc servers running on Linux.

Set this value on a PrizmDoc server running on Linux to the public port of a single PrizmDoc server (or a load balancer of a cluster running on Windows) to utilize the Microsoft Office Conversion service running on Windows to have native rendering of Microsoft documents in PrizmDoc.

To connect to a single server specify network.publicPort parameter of the remote server.

To connect to a load balancer specify network.clustering.clusterPort parameter of the cluster.

Controls how the page margins should be handled in Excel documents.

"preserve" - Preserve (do not remove) document pages margins. Requires that fileTypes.excel.pagination.dimensions.mode be set to "preserve" and the Office documents renderer to be set to Microsoft Office (see fidelity.msOfficeDocumentsRenderer for more details).

"remove" - Remove all margins from the document pages. Requires that fileTypes.excel.pagination.dimensions.mode be set to "override".

NOTE: Changing this setting can affect rendered layout and page count.

Controls whether the external hyperlinks are enabled or disabled when viewing or converting Microsoft Office documents to PDF.

false - All external hyperlinks are enabled.

true - All external hyperlinks are disabled.

Controls whether or not pagination is enabled for Excel documents.

true (paginated mode) - Each Excel sheet is divided into a number of pages, such that each page fits into a specific size.

false (non-paginated mode) - Each Excel sheet, irrespective of its size, is rendered onto a single page. If the number of columns and/or rows is large, then this might result in very small and unreadable output.

NOTE: Changing this setting can affect rendered layout and page count.

Controls which pagination mode to use if pagination is enabled for Excel documents (fileTypes.excel.pagination.enabled is set to "true").

"preserve" - Use the page dimensions specified in the Excel file. Requires that fileTypes.excel.margins.mode be set to "preserve" and the Office documents renderer to be set to Microsoft Office (see fidelity.msOfficeDocumentsRenderer for more details).

"override" - Ignore the page dimensions of the Excel file and instead always use the following settings in this config file:

Requires that fileTypes.excel.margins.mode be set to "remove".

Specifies how the gridlines of Excel worksheets should be rendered:

• render- (Default) Force rendering of the gridlines in the document. Gridlines would be rendered forcefully, regardless of their presence in the document settings.
• preserve- Preserve gridlines in the document as is. Gridlines would be rendered, if they are defined in the document settings, and will not be rendered if they are not defined in the document settings.
• hide- Disable rendering of the gridlines in the document. Gridlines would not be rendered, regardless of their presence in the document settings.

Controls whether or not the High Efficiency Image File Format (HEIF, HEIC) support is enabled for viewing, redaction, and conversion to JPG/JPEG, PDF, PNG, SVG and TIFF formats.

ATTENTION: If this feature is enabled, you or your organization will be responsible for obtaining the required third-party patent licenses for distribution of PrizmDoc Viewer with the enabled HEIF/HEIC feature. Accusoft is unable to obtain a transferable license to give to customers. Customers must obtain it directly.

Controls whether email headers containing the meeting information (When, Who) should be rendered in email documents.

NOTE: This feature is a work-in-progress that is not officially supported by Accusoft. Its behavior may change at any time in a future release of the product. We are collecting and reviewing any feedback you can provide about this feature at https://ideas.accusoft.com/ideas/PDV-I-745

NOTE: If you change the __experimental.fileTypes.email.renderMeetingInfo setting, you must clear your cache in order for the new settings to take effect on the files that were previously converted with the old rendering mode.

NOTE: This setting affects the rendering layout of email documents. Markup generated for documents rendered with this setting turned off cannot not be used for documents rendered with this setting turned on and vice versa.

One of the following strings:

• "none"
• "database"

Viewing Packages metadata storage type. Must be one of the following values:

• "none" - Do not store viewing package metadata (the "v3" viewing package REST APIs will be disabled).

• "database" - Store viewing package metadata in the central database.

  When used, database.connectionString parameter must be defined and viewingPackagesArtifacts.storage must be set to "s3".

One of the following strings:

• "none"
• "s3"

Viewing Packages artifact storage type. Must be one of the following values:

• "none" - Do not store viewing package artifacts (the v3 viewing packages REST APIs will be disabled).

• "s3" - Store viewing package artifacts in S3.

  When used, viewingPackagesArtifacts.s3BucketName and viewingPackagesArtifacts.path parameters must be defined and viewingPackagesMetadata.storage must be set to "database".

Java Virtual Machine settings to use when starting Email Processing Service.

Examples:

"-Xms2G -Xmx5G" - Set initial JVM heap size to 2G and max heap size to 5G.

"-XX:MaxRAMPercentage=50.0 -XX:+UseG1GC" - Set dynamic JVM heap size and use G1GC garbage collector.

Java Virtual Machine settings to use when starting PDF Processing Service.

Examples:

"-Xms2G -Xmx5G" - Set initial JVM heap size to 2G and max heap size to 5G.

"-XX:MaxRAMPercentage=50.0 -XX:+UseG1GC" - Set dynamic JVM heap size and use G1GC garbage collector.

Traditional Linux Install Packages and Windows:

<install_dir>/logs

e.g.:

/usr/share/prizm/logs

C:\Prizm\logs

Docker:

/logs

Any valid path to a directory with write permissions.

NOTE: When using PrizmDoc Docker containers, we recommend that you keep this property unchanged.

The number of rotated logs to keep in addition to the active log file. Logs are rotated each day at midnight (UTC).

NOTE: This value does not currently apply to all services. Some services will always keep 7 rotated logs.

Logs with 7 day archives:

• AutoRedactionService.log
• FormatDetectionService.log
• HTMLConversionService.log
• OfficeConversionService.log
• PDFConversionService.log
• RasterConversionService.log
• VectorConversionService.log

Any open HTTP port on the server

NOTE: When using PrizmDoc Docker containers, make sure this port is exposed by the container.

The server list can be set once via config, or repeatedly at runtime via a REST API call. Setting the list of servers here is useful if you have a static set of machines that will not change.

NOTE: When using PrizmDoc Docker containers in Kubernetes, we recommend that you use the PrizmDoc Cluster Manager to take care of the server list at runtime.

The length of time that a redaction creator, markup burner, content converter, form extractor, search context, search task or plain text redactor process remains usable. This must be an integer, followed by "s", "m", "h", or "d". The suffixes stand for second, minute, hour, or day, respectively. There should not be any space characters between the number and suffix. For example, "20m" indicates viewing sessions will timeout after 20 minutes.

Please see the topic Implement Caching Strategies for more details.

The number of LibreOffice conversion service instances to run concurrently, or "auto" to let the product choose an appropriate value.

We recommend using the default value of "auto". If you do provide a specific value, it should not be set higher than the number of physical cores available on your server.

The number of threads each instance should create to handle document processing requests, or "auto" to let the product choose an appropriate value.

We recommend using the default value of "auto". If you do provide a specific value, it should not be higher than 2 x ocs.instances.

The number of ports which can be used internally for communication with the LibreOffice conversion instances, or "auto" to let the product choose an appropriate value.

We recommend using the default value of "auto". If you do provide a specific value, it should be no higher than 4 x ocs.instances.

The AES encryption key used to create external viewing session IDs. The external viewing session ID is a AES encrypted, Base64 encoded value of a string in the format of:

<internal ID>/<server’s host name>/<Auth-Token header value>

Internal ID: This value is a unique GUID that is internally created by PCCIS for each new viewing session.

Server’s Host Name: Aptly named, this value is the hostname of the server on which PCCIS is running.

Auth-Token Header Value: If the "Auth-Token" HTTP header exists in the initial POST request to create a viewing session, its value will be used here. Otherwise, "accusoft" is used. This value is useful if you have the need to store an authorization token for each viewing session which a proxy might need.

See PrizmDoc Cluster Management for more details.

When rendering any source document which uses HTML content, 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.

NOTE: Changing this setting can affect rendered layout and page count.

NOTE: If you change the security.htmlRendering.blockExternalContent setting, you must clear your cache in order for the new settings to take effect on files previously converted with the old rendering mode.

false - When rendering HTML, issue network requests for externally-referenced content in images, iframes, etc., and include that content in the final output. Any URL accessible from this machine may be loaded and included in the final output. See the Security Guidance page for more details.

true - When rendering HTML, block externally-referenced content in images, iframes, etc. No network requests will be issued when rendering HTML and the final output will only include the content that is directly-present in the source HTML.

Traditional Linux Install Packages and Windows:

<install_dir>/cache/UserDocuments

e.g.:

/usr/share/prizm/cache

C:\Prizm\cache\UserDocuments

Docker:

/data/cache/UserDocuments

Any valid path to a directory with read permissions.

NOTE: When using PrizmDoc Docker containers, we recommend that you keep this property unchanged.

The length of time that a viewing session remains usable. This must be an integer, followed by "s", "m", "h", or "d". The suffixes stand for second, minute, hour, or day, respectively. There should not be any space characters between the number and suffix. For example, "20m" indicates viewing sessions will timeout after 20 minutes.

Please see the topic Implement Caching Strategies for more details.

The length of time that a document is cached and can be potentially reused by other new viewing sessions. This must be an integer, followed by "s", "m", "h", or "d". Those suffixes stand for second, minute, hour, or day, respectively. There should not be any space characters between the number and suffix. For example, "1d" indicates that data will be cached for up to one day.

Please see the topic Implement Caching Strategies for more details.

NOTE: If the amount of time specified by viewing.cacheLifetime is shorter than the amount of time specified by viewing.sessionConstraints.minSecondsAvailable.max, the viewing.cacheLifetime will be changed at runtime to match the amount of time specified by viewing.sessionConstraints.minSecondsAvailable.max. If you change this value to decrease the cache lifetime, make sure that you also adjust the viewing.sessionConstraints.minSecondsAvailable.max value to represent the same or shorter amount of time.

Creates a value filter that will be applied to the "documentSource" JSON property when creating a new viewing session to ensure appropriate values are being set. If the actual property value fails to match the filter, an error will be returned and the viewing session will not be created.

Allowing a combination of document sources here enables you to create viewing sessions with different sources on the fly without needed to modify this config file.

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Minimum allowed value for the "countOfInitialPages" JSON property when creating a new viewing session.

Together with viewing.sessionConstraints.countOfInitialPages.max create a range filter that will be applied to ensure appropriate values are being set. If the actual property value fails to match the filter, an error will be returned and the viewing session will not be created.

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Maximum allowed value for the "countOfInitialPages" JSON property when creating a new viewing session.

Together with viewing.sessionConstraints.countOfInitialPages.min create a range filter that will be applied to ensure appropriate values are being set. If the actual property value fails to match the filter, an error will be returned and the viewing session will not be created.

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Valid regular expression using the .NET Regular Expression Language

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Valid regular expression using the .NET Regular Expression Language

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Creates a value filter that will be applied to the "pageContentEncryption" JSON property when creating a new viewing session to ensure appropriate values are being set. If the actual property value fails to match the filter, an error will be returned and the viewing session will not be created.

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Creates a value filter that will be applied to the "serverCaching" JSON property when creating a new viewing session to ensure appropriate values are being set. If the actual property value fails to match the filter, an error will be returned and the viewing session will not be created.

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Please see the topic Implement Caching Strategies for more details.

Creates a value filter that will be applied to the "render.html5.alwaysUseRaster" JSON property when creating a new viewing session to ensure appropriate values are being set. If the actual property value fails to match the filter, an error will be returned and the viewing session will not be created.

This property is one of several that can be used to limit unwanted values from being used within the JSON properties of the initial POST request to create a viewing session. These filter values are useful to prevent mistaken or malicious values from being sent that could affect server behavior.

Any valid path to a directory with read and write permissions.

NOTE: When using PrizmDoc Docker containers, we recommend that you keep this property unchanged.

The length of time that a workfile remains usable. This must be an integer, followed by "s", "m", "h", or "d". The suffixes stand for second, minute, hour, or day, respectively. There should not be any space characters between the number and suffix. For example, "20m" indicates viewing sessions will timeout after 20 minutes.

Please see the topic Implement Caching Strategies for more details.