This section lists and describes all servlet tags for web.xml. The web.xml file is located in the VirtualVieweHTML5\WEB-INF directory.

Note: If you are upgrading to a newer version of PrizmDoc® for Java, we recommend that you make a list of any customized parameters and files. You will need to apply your customizations to the same files in your newer version. Please make a backup copy of the web.xml file before you edit it.

AJAX servlet web.xml parameters

Name Default Description

annotationOutputFormat

snowbound

Enables the ability to edit and delete existing FileNet or PrizmDoc® for Java annotations. When set to FileNet, annotations are saved in FileNet XML format. When set to Snowbound, annotations are saved in PrizmDoc® for Java XML format.

ResponseServer web.xml parameters

Name Default Description

filePath

.\sample-documents

The file path the sample content handler uses for retrieval and storage. Not needed when using a custom content handler.

RequiredServlet web.xml parameters

Name Default Description

tmpDir

N/A

Specifies a temporary directory for files created during the processing of page manipulation routines on the server.

RetrievalServlet web.xml parameters

Name Default Description

For AFP bit depth, please use modcaBitDepth.

N/A

To set the bit depth for AFP, please use modcaBitDepth. Please note that increasing the bit depth may negatively affect the performance.

For AFP DPI, please use modcaDPI.

N/A

To set the DPI for AFP, please use modcaDPI.

For AFP format, please use modcaFormat.

N/A

To set the format for AFP, please please use modcaFormat.

Access-Control-Allow-Credentials

true

Set as the header in the response.

Access-Control-Allow-Headers

N/A

Set as the header in the response.

Access-Control-Allow-Origin

N/A

Sets a comma separated whitelist of origin URLs. If the client’s origin matches one of the URLs on this whitelist, the Access-Control-Allow-Origin header will be added to the response.

baseURL

N/A

An optional parameter that can be set when the contentHandlerClass is set to com.snowbound.snapserv.servlet. FileAndURLRetriever. The assigned value will be prepended to documentIds to create the full URL path for documents.

For example, if baseURL is set to “http://www.snowbound.com/” and the documentId is “myFile.tif”, the content handler will retrieve the document from http://www.snowbound.com/myFile.tif.

bitDepth

1

The default bits per pixel for decompression of formats not specified with individual parameters. Please note that increasing the bit depth is a trade-off with performance.

contentHandlerClass

N/A

Name of the content handler class to use.

defaultByteSize

40000

Initial size of the byte array when saving to any format not TIFF or JPEG to send to PrizmDoc® for Java.

docBitDepth

1

The bit depth to use for Word documents. Valid values are 1 or 24. Must be set to 24 to display color output. Please also see wordBitDepth. Note that increasing bit depth is a trade-off with performance.

docDPI

300

The DPI to use for Word documents. Must be set to 200 or more to display color output. Please also see wordDPI.

docxBitDepth

1

The bit depth to use for Word 2007 documents. Valid values are 1 or 24. Must be set to 24 to display color output. Note that increasing bit depth is a trade-off with performance.

docxDPI

300

The DPI to use for Word 2007 documents. Must be set to 200 or more to display color output.

docxFormat

PNG

The format to convert Word 2007 documents to. Valid values are TIFF_G4, JPEG, TIFF_LZW, PNG.

extractJpeg

true

If true, allows JPEG images to be sent directly to the client without conversion.

extractPDFPages

true

If false, the iText library will be disabled for PDF saving, resulting in raster PDFs.

extractTIFFJpeg

true

If true, allows TIFF_JPEG images to be sent directly to the client without conversion.

fontMappingPath

N/A

For AFP font mapping, specifies the directory on the server of an optional snbd_map.fnt file.

htmlHeight

11

Specified document height (in inches). Must be used with the htmlWidth parameter.

htmlWidth

11

Specified document width (in inches). Must be used with the htmlHeight parameter.

iocaBitDepth

1

The bit depth to use when decompressing IOCA pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

iocaDPI

200

The DPI to use when decompressing IOCA pages.

iocaFormat

TIFF_G4_FAX

The format to convert IOCA pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG.

jpegByteSize

600000

Initial size of the byte array when saving to JPEG to send to PrizmDoc® for Java.

jpegQuality

50

Level of quality when a page is converted to JPEG and sent to PrizmDoc® for Java.

loadVirtualDocumentAnnotations

false

Enables the loading of vir- tual document annotations.

logLevel

Finest

Detail of logging. Valid values: Severe, Warning, Info, Config, Fine, Finer, Finest, All, and OFF.

modcaBitDepth

1

The bit depth to use when decompressing MO:DCA pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

modcaDPI

200

The DPI to use when decompressing MO:DCA pages.

modcaFormat

TIFF_G4_FAX

The format to convert MO:DCA pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG.

overlayPath

N/A

For AFP and MO:DCA files, specifies the path of overlays.

pclBitDepth

1

The bit depth to use when decompressing PCL pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

pclDPI

200

The DPI to use when decompressing PCL pages.

pclFormat

TIFF_G4_FAX

The format to convert PCL pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG.

pdfBitDepth

24

The bit depth to use when decompressing PDF pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

pdfDPI

200

The DPI to use when decompressing PDF pages.

pdfFormat

JPEG

The format to convert PDF pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG.

pixelLimit

N/A

Configures server-side scaling of large raster images in order to reduce the memory footprint of the image sent to the client. If the product of an image’s dimensions are greater than this number (or the product of the numbers), it is scaled to just below that. This can be expressed as a single value (i.e “1000000”) or as 2 dimensions (“1000x1000”).

pptBitDepth

24

The bit depth to use when decompressing PPT pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

pptDPI

200

The DPI to use when decompressing PPT pages.

pptFormat

JPEG

The format to convert PPT pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG.

preferencesPath

N/A

Specifies the location of stored client preferences on the server when using the default content handler.

rtfBitDepth

24

The bit depth to use when decompressing RTF pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

rtfDPI

150

The DPI to use when decompressing RTF pages.

rtfFormat

TIFF_LZW

The format to convert rtf pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG.

saveVirtualDocumentAnnotations

false

Enables the saving of virtual document annotations.

snowboundLicensePath

Blank

Sets the path to the slicense.json license file. Can be absolute or relative.

splitAnnotationLayersByPage

false

When set to true, annotations will be saved in files by page rather than all in one file.

supportRedactions

false

Turns on redaction support.

svgExclusions

ODT, PCL_1, PCL_5, PPTX, ASCII, EMAIL

Exclude any formats from SVG support. This is useful if a formats is misbehaving in SVG and you want to force that format to use the normal, bitmap delivery. The format is a comma-separated list of format names.

The following are the valid values for the svgExclusions parameter: AFP, ASCII, DOT, DOTX, HTML, MO:DCA, PCL_1, PCL_5, PDF, PDF_15, POWER_POINT, PPTX, ODS, ODT, RTF, XLS, XLSX, EMAIL.

Please note that the format names are case sensitive. The user can get the file type name for a given document by using the Image Info button and looking at the File Format value.

thumbByteEstimate

6000

The initial byte size of the buffer used on the server to transport thumbnails.

thumbnailDPI

60

Specifies the DPI to use when rendering thumbnails for vector formats such as PDF and MS Word.

tiffByteSize

40000

Initial size of the byte array when saving to TIFF to send to PrizmDoc® for Java.

tiffCompressionType

TIFF_G4_FAX

Sets the accepted TIFF file formats. The values are: TIFF_LZW, TIFF_JPEG, TIFF_JPEG7, TIFF_G4_ FAX. The default value is TIFF_LZW.

vectorPDF

false

If true, PDF pages are sent to the client as vector images instead of being converted to a rasterized image.

wordBitDepth

24

The bit depth to use when decompressing Word pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

wordDPI

200

The DPI to use when decompressing Word pages.

wordFormat

JPEG

The format to convert Word pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG. The bit depth to use when decom- pressing XLS pages. Valid values are 1 or 24.

xlsBitDepth

24

The bit depth to use when decompressing XLS pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

xlsDPI

200

The DPI to use when decompressing XLS pages.

xlsFormat

JPEG

The format to convert XLS pages to. Valid values are TIFF_G4_FAX, JPEG, TIFF_LZW, PNG. The bit depth to use when decom- pressing XLS pages. Valid values are 1 or 24.

xlsHeight

11

Specified document height (in inches). Must be used with the xlsWidth parameter.

xlsWidth

14

Specified document width (in inches). Must be used with the xlsHeight parameter.

xlsxHeight

11

Specified document height (in inches). Must be used with the xlsxWidth parameter.

xlsxWidth

14

Specified document width (in inches). Must be used with the xlsxHeight parameter.

xlsxUsePrintArea

true

Controls which cells to display. When true only cells inside the print area are displayed. When false all cells are displayed.

xlsxBitDepth

24

The bit depth to use when decompressing XLSX pages. Valid values are 1 or 24. Note that increasing bit depth is a trade-off with performance.

xlsxDPI

200

The DPI to use when decompressing XLSX pages.

UploadServlet web.xml parameters

Name Default Description

clearCacheOnSave

true

Clears the server document cache when a document is saved.

outputConfigPath

N/A

Specifies the path and name of the output.properties file which is used to determine the formats used when saving documents. Note that the format that you want to use may not be recognized by the default output properties. To override the default output properties and set the output format, edit the outputConfigPath parameter in your web.xml file as shown in the following example:

<init-param>
  <param-name>outputConfigPath</param-name>
  <param-value>/whatever/path/to/output.properties</param-value>
</init-param>

Then output.properties should have the following format:

TIFF_LZW.format=TIFF_LZW
PDF.format=PDF
JPEG.format=JPEG
default.format=TIFF_LZW

permanentAnnotationLinks

true

WEBTOP VERSION ONLY. If false, keeps annotations from carrying over to new versions of documents.

saveAnnotationsAsXml

true

If true, saves annotations as XML rather than binary.

sessionClass

N/A

Specifies the session class to use.

ResponseServlet web.xml parameters

Name Default Description

convertPDF

JPEG

Specifies the format PDF pages should be converted to (replaced by pdfFormat).

documentCacheCount

1

Number of documents the server will cache in memory.

jpegCompression

-1

Level of quality when a page is converted to JPEG. (replaced by jpegQuality)

maxByteMultiplier

20

Maximum number of times the byte array is doubled, if the original estimate is too small, when saving to send to PrizmDoc® for Java.

pngForPDF

false

Specifies that PDF pages should be converted to PNG. (replaced by convertPDF, and then by pdfFormat)

ResponseServer web.xml parameters

Name Default Description

concurrentBWThumbs

500

Limits the number of concurrent 1-bit thumbnail requests processed on the server.

concurrentColorThumbs

10

Limits the number of concurrent color thumbnail requests processed on the server.

concurrentImages

500

Limits the number of concurrent image page requests processed on the server.