Reporting in Workflows

Event Logging Settings Configured on the Workflow Level

Each workflow has an array of event logging options that can be configured by Administrator and Manager.

When a workflow runs on a site, the event logging options configured for the workflow can in some cases take precedence over the site or site group automated reporting options (see section Create Recurring Email Reports for Sites and Site Groups).

For example, if a workflow is configured to bypass email distribution of the event log, the automated distribution options of the corresponding site / site group are ignored.

For full details on workflow event logging, see section Workflow Reference > Event Logging for Workflows > Workflow Event Logging Overview. Some of the global presets used in workflow event logging settings can be configured by Administrator only.

Workflow Steps Targeted at Reporting

The following workflow steps are specifically targeted at creating reports:

• person Manual Actions > edit Write a report

  The step prompts the operator to manually type a report while processing the workflow.

  info

  The edit Write a Report step is available in Manual Workflows only.

• more_horizOther Steps > content_paste PDF Entry

  This is an automated reporting step that produces a dynamically generated report. For details on which information can be included in the report, see section Dynamic Text Messages Generation in Workflows.

  The step is available in Manual and Automated Workflows.

To set up a workflow that uses one of these steps:

1. Create a workflow as described in Workflow Reference > Operations with a Workflow

   a. Create a workflow – see section Add a Workflow > Start Creating a Workflow in Workflow Reference > Operations with a Workflow

   b. Set incoming conditions for the workflow – see section Work with Workflows > Workflow Incoming Conditions and Workflow Comment > Set Incoming Conditions for a Workflow

2. Add and configure the corresponding step:

   For general information on how to add a step, see section Work with Workflow Steps > Add a Step.

   The setup of particular steps is described in Workflow Reference > Workflow Step Reference

   • person Manual Actions > edit Write a Report – in section Manual Steps > Manual Actions > Write a Report
   • more_horizOther Steps > content_paste PDF Entry– in section Other Steps > PDF Entry

Custom Report Templates

Besides using specialized reporting steps, you can configure a custom report template for any step of the workflow for which this capability is supported.

Custom report templates are custom step outputs that are included in the PDF event log reports and can be configured to contain dynamically generated text messages with some workflow execution or alarm details included in them. For details on which details can be included, see section Dynamic Text Messages Generation in Workflows.

Custom report templates can be configured for multiple steps in one workflow.

For details on configuring a custom report template for a step, see section Operations with a Workflow > Work with Workflow Steps > Custom Report Template of a Step in Workflow Reference.