About WorkZone PDF Engine configuration settings

A WorkZone PDF Engine configuration setting can be defined multiple places in the WorkZone program, for example you can define default values upon installation of the WorkZone PDF Engine and then specify different configuration parameters through the WorkZone Configurator or in the WorkZone PDF Engine web.config file as well as specifying parameters in the JSON file when generating PDF reports in the WorkZone Client.

Missing parameters

Parameters that are not implemented in the WorkZone Configurator module can be manually added to the WZPDF_CONFIGURATION table by using an SQL productivity tool such as Oracle’s SQL Developer or ScanSql, both of which are included in a standard WorkZone installation and available on the WorkZone server.

Parameter priorities

The following list illustrates the priority ranking of each WorkZone PDF Engine parameter, with the highest ranked parameter placed first.

The priority is for each individual parameter and not the entire WorkZone PDF Engine parameter stack.

  1. Body: Parameters specified in the body of the report JSON file.
  2. HTTPS Header: Parameters specified in the header of the API call.
  3. Database settings: WorkZone PDF Engine settings specified by using the WorkZone Configurator or by using the ScanSQL program directly into the database in the WZPDF_CONFIGURATION table.
  4. Web.Config settings: Settings specified in the Web.Config file.
  5. Installation default values; The settings specified when the WorkZone PDF Engine was initially installed.

Example:

Parameter location HTTP Header Header Style, Font Header Style, color
API Body Overview Font: Arial -
Configuration Database* - Font: Comic Sans -
Web.Config file Central Reports - -
Installation default Reports Font: Verdana Blue

* In the WZPDF_CONFIGURATION table.

In the example above

  • The header "Overview" will be displayed in the Arial font when a PDF report is generated using the specific API call that contains the Header parameter in the body. If another PDF report is generated that does not use the API call, the header will be "Central Reports", displayed in the Comic Sans font.
  • If the Web.Config file is deleted or of the Header and Header Style, Font parameters in the Web.config file are deleted, the PDF report will contain the header: "Reports" and the Header font: Comic Sans if the report is generated without using the API call.
  • If the Web.Config file is deleted or of the Header and Header Style, Font parameters in the Web.config file are deleted, the PDF report will contain the header: "Overview" and the Header font: Arial if the report is generated using the API call.
  • The header color will be Blue for all PDF reports as there are no parameters defined header color in the API Body, configuration database or the Web.config file.

Tip: If your installation of WorkZone PDF Engine contains many parameter settings in the web.config file and you want to keep the settings, make sure the values for the specific parameter settings are empty or undefined in the Configuration database.