Preview custom reports by using the POST request

Usually, you must re-install the PDF Engine in order to update the Report table, transfer the report templates, and update the Report/Print menu in WorkZone Client.

If you want to view the custom report during development, you can use a POST request to the Reports API with the Report JSON URI parameter to display your custom report instead. Using POST requests will not deploy your custom report and make it available to WorkZone client users but it will display your report as it is, enabling you to review the report and make any required changes.

To view the custom report, you must provide:

  • The relevant report parameters inside the POST request body, e.g. “{Parameters: {"FileKeys":["681"]}}” for the FileKey (Case) 681 same way the final report POST request is defined.
  • A URI to the Report JSON file in the ReportJSON parameter of the POST request.

Note: In order to use the POST request to display the report, the report templates must be placed in the same location as the Report JSON.

Tip: You can see more information about creating POST requests for retrieving a report in the Report API documentation.

The KMD WorkZone PDF.exe program

The KMD WorkZone PDF.exe is used to install new versions of WorkZone as well as update existing versions. The program contains standard report templates which also are deployed during the installation process.

Note: Custom report templates in the Reports folder will overwrite any standard report templates contained in the KMD WorkZone PDF.exe program if their names are identical. This way, you can create your own version of the standard reports in WorkZone and be able to keep your changes during program updates.