Perform database configuration

You only need to perform the database configuration once for every WorkZone database you are using.

  1. Double-click the KMD WorkZone PDF.exe file. On the Welcome to the KMD WorkZone PDF Installation Wizard page, click Next.
  2. On the WorkZone PDF Products page, click Database Configuration.
  3. On the License Agreement page, you must read and accept the license agreement terms before you can continue the installation. Select the I accept the terms of this license agreement check box and then click Next.
  4. On the Database Configuration page, select the WorkZone database and enter login credentials to access the data (Username and Password). Click Next to continue.
  5. On the Database Configuration page, specify the location of the OData service, Crawler OAuth2 Client Id, and Crawler OAuth2 Client Secret, as the WorkZone PDF Crawler application uses the OData module to connect to WorkZone. Click Next to continue.
    The Crawler OAuth2 Client Id and Crawler OAuth2 Client Secret parameters can be defined as any strings allowed in the WorkZone OAuth2.
  6. On the Ready to perform Database Configuration page, click Configure.

You can edit WorkZone PDF parameters in WorkZone Configurator, the WZPDF_CONFIGURATION table, or the Web.config file. See Custom parameters below.

Custom parameters

WorkZone PDF Engine parameters

Parameter Description
Watermark

Specify the text to be used as the document watermark.

WatermarkStyle

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.

The default setting is an empty string.

ActionsOnDocumentBeforeConversion

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.
  • 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.

FailIfOutOfBounds

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.

Note: 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.

BypassBoundaryCheckForFiles

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.

OutputPdfCompression

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.

OutputPdfWebOptimization

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.

OutputPdfArchiving

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.

Header

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.
HeaderStyle

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.

Footer

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.

FooterStyle

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.

ConvertWithAttachments

Defines whether a document is converted with or without attachments.

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

IncludeDocumentCoverPage

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.

Target

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.

FailIfMissingFonts

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.

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.

FallbackFont

Defines a font that substitutes a missing font when a document is converted to PDF or PDF/A format.

TimeZoneId

Defines the time zone for the dates and times that are shown in process history documents. You can configure the time zone to local time or UTC time. The default time zone is the local time, which is the time of the local server.

When the history documents are generated, the dates in UTC format are converted to the configured time zone. Both the local time and the time zone offset to UTC will be shown in the history documents, for example, 17-11-2022 12:15:00 +01:00. Date only fields are displayed in the configured time format but only the date is shown.

If you do not configure this parameter or the configured time zone cannot be applied, the default time zone is the local time zone.

Please refer to the Microsoft article Default Time Zones for supported time zone standards and to List of tz database time zones in Wikipedia for IANA (Internet Assigned Numbers Authority) time zone names.