PDF reports

Prerequisite: To configure the WorkZone PDF settings, you must be assigned the CONFIGADM access code and WorkZone PDF must be installed.

Use this page to manage both standard and custom reports. WorkZone includes several standard reports for different purposes, such as the Classification Scheme report, .A case list with parties and documents report. In addition to the standard reports, you can create custom reports that can be published and make available to users in WorkZone.

  • Standard reports: These reports are marked Yes in the Standard column. You can edit standard reports but you cannot delete them.

  • Custom reports: You can create, edit, and delete these reports.

Custom reports

Custom reports allow you to customize reports to your organization's specific needs. Reports are built using OData queries to define the data and report templates that define the layout.

You can create your own reports, modify existing ones, and control when they are available to users. When creating a custom report, you configure the data source, output format, and templates, and decide whether the report should be published for end users.

You can update custom reports at any time. If a report is no longer needed, you can delete it.

Create a custom report

  1. On the start page, click PDF > PDF report.
  2. On the PDF report tab, click Create.
  3. In the Create PDF report dialog, complete the following fields:
    • Title – Enter a name for the report. Provide a title in all activated languages (see Language settings). The title is not shown to users.
    • Description – Enter a description of the report. The description is shown to the users in WorkZone. Provide a description in all activated languages.
    • Standard – The setting is always disabled for custom reports. It is only enabled for standard reports and cannot be changed.
    • Publish report - Enable this option, if you want to make the report available to users.

      • By default, the option is disabled.

      • When disabled, only users with the CONFIGADM access code can view and use the report.

      • It is recommended to enable this option only after the report has been fully configured and tested.

      • To modify the report later, disable the option, make your changes, and enable it again.

    • Default output - Select the default output format for the report: PDF, HTML, or Power BI.
    • Report context - Select the context in which the report will be used. See Report contexts.
    • ODATA3 queries - Enter an OData query to define the data source of the report. You can:

      • Copy an OData query from a standard report, and modify it, for example by adding or removing fields.

      • Add your own OData query.

    • ODATA3 query parameters - Enter query parameters to specify the IDs of the items to include in the report.

      For example, FileKey can be used in OData3 queries to filter cases so that only use a specific case is included. Query parameters can also be used to provide a list of record keys for merging documents into a report.

      In general, query parameters provide all the input values required to generate a report.

  4. Under Templates, select a new template from your local drive or select an existing WorkZone template, and select the culture that matches the culture of the selected template.

  5. Add template files for all supported languages.

  6. Click Create to add the report. The report template including XML mapping is now added to the Templates for reports case in WorkZone.

  7. Enabled the Publish option to make the report visible to users who do not have the CONFIGADM access code.

Context name Where used Configuration

MassDispatchRecipient

 

WorkZone Client > Case detail page > Documents tab. The Mass dispatch recipient history document is saved on the dispatch case after process completion.

The report is in CSV format. The Word report templates are not used.

MassDispatchReport

WorkZone Client > Case detail page > Documents tab. The Mass dispatch history document is saved on the dispatch case after process completion.

If you want to use a custom report, you configure the report ID in WorkZone Configurator. Go to Process > Processes > MassDispatch process (or a copy of it) > RepodtId field.

ContactContacts

Not used

 

MassDispatchValidation

The process task contains the mass dispatch validation report

The report is in CSV format. The Word report templates are note used.

ProcessUserTask

Not used.

 

SmartpostData

WorkZone Client > Case detail page > Documents tab. The SmartPost process history document is saved on the case after process completion.

If you want to use a custom report, you configure the report ID in WorkZone Configurator. Go to Process > Processes > SmartPost process (or a copy of it) > RepodtId field.

Meeting

WorkZone Client > Meeting detail page > Print > Template field.

 

General

WorkZone Client > Report > General.

 

Records

WorkZone Client > Document list > Manage > Reports.

 

File

WorkZone Client > Case detail page > Print > Advanced tab > Template field.

 

Files

WorkZone Client > Case list > Report.

 

Task

Click the PDF icon in a process task to open PDF version of the task.

 

Record

WorkZone Client > Document detail page > Manage > Report.

 

PowerBI

WorkZone Client> Report > PowerBI.

 

Agenda

Not used.

 

PFile

WorkZone Client > Case in Archive detail page > Print > Advanced > Template field.

 

Process

WorkZone Client > Case detail page > Documents tab. The Process history document is saved on the case after process completion.

If you want to use a custom report, you configure the report ID in WorkZone Configurator > Process > Processes > any process with a history report (or a copy of it), except SmartPost and Mass Dispatch > RepodtId field.

FileNotes

WorkZone Configurator > Case detail page > Notes > Print notes > Advanced > Template field.

 

Update an existing report

You can make changes to existing standard and custom report in Word and Exel???. It is recommend to disable the Publish report option before changing the report.

When you have completed your changes, click Update XML mapping to update the XML mapping in the report template.

Restore template list

Click Restore templates to revert the report list to its state before you started editing.

Note: Restore only works if you have not yet saved your changes.

Delete reports

Only custom reports can be removed. To completely remove a custom report from WorkZone, you must delete both the report configuration and the report template.

Delete the report configuration

  1. On the start page, click PDF > PDF report.

  2. Point to the report that you want to delete.

  3. Click Delete.

The report configuration is removed from WorkZone Configurator. However, the template files remain on the Templates for reports case.

Delete the report template

  1. Locate the Templates for reports case in WorkZone Client or WorkZone One.

  2. Select the report that you want to delete and click Recycle.