NOTE: The following legacy configuration properties have been deprecated and will be removed in a future release. Please use central configuration properties instead.

Overview

PrizmDoc Server relies on Work Files for the temporary storage of files so they can be shared by the various services which operate on them. All work files are stored with an associated file extension. The file extension is an important value that determines how a file is processed by PrizmDoc Server.

Format Detection is enabled by default for all Work Files created directly through the Work File API or indirectly through the Viewing Session API. Format Detection can automatically identify a large number of file types including MS Office documents, imaging formats, CAD formats, and many others (see supported file formats for the complete list). The use of Format Detection makes the file extension input to the Work File and Viewing Session APIs optional in most cases.

When a document is identified by Format Detection, the detected format and file extension will be associated with the Work File and any file extension provided as input to the API will be ignored.

When a document cannot be identified by Format Detection, and a file extension was provided, then that extension will be associated with the Work File. If the document cannot be identified and no file extension was provided, an error code will be returned. See the Work File or Viewing Session API for more details.

Disabling Format Detection Behavior

In rare cases, users may wish to disable Format Detection for more control over how documents are processed by PrizmDoc Server. When Format Detection is disabled, a file extension must always be provided when adding a document through the Work File or Viewing Session APIs.

Format Detection may be disabled by editing the Watchdog configuration file located in the following default directories:

• Windows: C:\Prizm\PCCIS\Watchdog\watchdog.config
• Linux: /usr/share/prizm/pccis/Watchdog/watchdog.config

The Work File Service configuration provides a Boolean parameter to enable or disable Format Detection:

Example

"workfileService": {
      ...
      "formatDetection": {
         "enabled": true
      },
      ...
},

enabled - A value of true indicates that Format Detection will be performed for each file added to the WorkFile Service. A false value will disable Format Detection.