Perform database configuration

Specify the text to be used as the document watermark.

Defines the default style of the watermark. This parameter must be in JSON format.

You can specify color, transparency, and font as follows: 

• Color: Any valid html string format such as standard color name, hex value, and RGB colors.
  Example: Standard color name: Red
  Hex value: #FF0000
  RGB: 255,0,0
• Transparency: Transparency ranges from 0 to 100 where 100 represents full opacity.
• Font: The name of the font to be used for the watermark. You do not need to specify font size, the watermark will be sized to fit the page automatically.

All the parameter arguments listed above are optional.

Watermark example

Define a watermark style using a red Verdana font with medium transparency.

{ Color: "Red", Transparency: "55", Font: "Verdana"}

The default setting is an empty string.

When a document is being converting to PDF, review information such as comments, tracked revisions (changes), notes, and annotations can be hidden or not on the final PDF document.

You can define the setting for each specific document type and for each specific review information. To do this, edit and use the following JSON:

{

Pdf: { Annotations: 'Show'/'Hide'/'Flatten', Forms: 'Show'/'Flatten'},

Word: { Comments: 'Show'/'Hide', Revisions: 'Accept'/'Show'/'Reject' },

Excel: { Comments: 'Show'/'Hide', Revisions: 'Accept'/'Show'/'Reject' },

PowerPoint: { Comments: 'Show'/'Hide', Notes: 'Show'/'Hide' }

}

where:

• Show – The relating review information will be shown (included) to the final document.
• Hide – The relating review information will be hidden (excluded) from the final document.
• Accept – The tracked revisions (changes) will be applied and hidden on the final document.
• Reject – The tracked revisions (changes) will be declined and hidden on the final document.
• Flatten – The relating controls (text boxes, check boxes, annotations, etc.) will be included as regular content (text and images) to the final document.

Important: If you upgrade WorkZone PDF from 2019.2 version or earlier, be aware that the following backward compatibility will be applied automatically:

Old values	New values
true	{ Pdf: { Annotations: 'Hide' }, Word: { Comments: 'Hide', Revisions: 'Accept'}, Excel: { Comments: 'Hide', Revisions: 'Accept' }, PowerPoint: { Comments: 'Hide', Notes: 'Hide' } }
false	{ Pdf: { Annotations: 'Show' }, Word: { Comments: 'Show', Revisions: 'Show' }, Excel: { Comments: 'Show', Revisions: 'Show' }, PowerPoint: { Comments: 'Show', Notes: 'Show' } }

You can change the settings manually if it is relevant.

If set to False, the document is converted even if the content exceeds the bounds of a document. If set to True, the content fails to convert. The default setting is False.

Documents with the states UL (Locked ), ARK (Archived), and AFS (Closed) will not be checked for content which is out of bounds even if the parameter is set to True. Documents with these states are locked in their final state regardless of content that exceeds the page bounds.

Specifies which file types are to be bypassed when boundaries of objects in the files are checked during PDF conversion.

The syntax is a string of comma-separated file extensions, for example: pdf, xps, docx.

The default file extension is pdf, meaning the check for out-of-bounds objects in pdf documents will be bypassed.

Compresses the PDF output to reduce its size.

This parameter is particularly important as large documents may take a long time to download from a server.

The default setting is True.

Optimizes the PDF output for the web. This parameter is particularly important as regards large documents that may take a long time to download from a server.

The default setting is True.

Defines the output PDF format.

Select False to convert to a PDF format for generic usage (PDF 1.7).

Select True to convert to a PDF format that is used for long-term storage (PDF/A-3b).

The default setting is False.

Defines the content of the header.

You can specify the header content as normal text, field values from the database, document metadata or by using the following Microsoft field codes:

• {Title}: The document title.
• {Date}: The current date aligned with the country date standard.
• {Page}: The current page number in the document.
• {NumPages}: The total amount of pages in the document.

Custom header text example

<setting name="Header" serializeAs="String">

<value> 'My Custom Header'</value>

</setting>

Field code header example

<setting name="Header" serializeAs="String">

<value> {page}</value>

</setting>

Defines the default style of the header that will be used if the style is not specified in the request.

This parameter must be in JSON format.

You can specify the formatting of the header, for example, bold or italic, and which font to use.

All parameters are optional.

The default setting is an empty string.

Header style example

Print the header in bold using Arial as font.

{ "Bold": true, "Font": "Arial"}

Defines the content of the footer.

You can specify the footer content as normal text, field values from the database, document metadata, or the following Microsoft field codes can be used:

• {Title}: The document title.
• {Date}: The current date based on defined culture settings.
• {Page}: The current page number in the document.
• {NumPages}: The total amount of pages in the document.

Custom footer text example

<setting name="Footer" serializeAs="String">

<value> 'My Custom Footer'</value>

</setting>

Field code footer example

<setting name="Footer" serializeAs="String">

<value> " Page {page} of {NumPages}"</value>

</setting>

Defines the default style of the footer that will be used if the style is not specified in the request.

This parameter must be in JSON format.

You can specify the formatting of the header, for example, bold or italic, and which font to use.

All parameters are optional.

The default setting is an empty string.

Footer style example

Print the footer in bold using Arial as font.

{ "Bold": true, "Font": "Arial"}

Defines whether a document is converted with or without attachments.

The default setting is True, which means that all document attachments are converted.

Specifies whether or not to create a separate cover page for each document in a multi-document report.

The default setting is False, which means individual documents in a multi-document.

Specify which WorkZone PDF Engine instance you want to apply custom parameters for. You are effectively naming the PDF Engine instance in order to uniquely identify it. Once an instance has been named, any Engine parameters specified in the database (WZPDF_CONFIGURATION table) for that specific instance will be applied to the instance.

The Target parameter is a case-sensitive string with the default value PDFENGINE. The default value may be changed to any string value that corresponds to the value in the Target field in the WZPDF_CONFIGURATION table.

If you specify a Target parameter which does not exist in the WZPDF_CONFIGURATION table, the request will fail with a 404 Not Found error and the error message: The configuration for target"..." is not found.

You must uniquely name each PDF Engine instance (for example, RenderForProcess, RenderForMobile, etc.) you expect to use in the Target field of the WZPDF_CONFIGURATION table.

Tip: Create the required targets in the WZPDF_CONFIGURATION table before specifying Target parameters in order to have a list of valid PDF Engine instance names.

Defines whether WorkZone must check availability of missing fonts in a document before its conversion to PDF. By default, the parameter is disabled, that is, the missing fonts are not checked. Note that WorkZone checks missing fonts on the IIS server only for particular file types. See the list of file types in the Font check column in the Supported file types table in the Administrator's Guide for WorkZone PDF.

Important: During document conversion to PDF/A, missing fonts are always checked, regardless the value of FailIfMissingFonts. This behavior is aligned with the PDF/A specification.