Workflow Detail
Workflow Detail
Overview
When you click to edit an existing workflow you will be taken to the Workflow Detail page. This page displays useful information about the workflow including metadata and logs of past executions.
To continue to the workflow diagram click the ‘Edit Workflow’ button in the top left of the page or at the bottom right of the page.
Metadata
Title
This is an important field that is used to identify your workflows. This field is shown in tables of available workflows and in logs and audits.
When naming a workflow is is best to give it a concise title. Naming a workflow ‘finworkflow123’ may lead to confusion about what the workflow does especially if another Paygate user is using the system. Choosing a title such as ‘Monthly Payroll’ is unlikely to be misinterpreted or misunderstood.
Description
You should use the optional description field to give more information about what the workflow does and how it is used in the organisation. Over time you might build up a large collection of workflows and you will want to be able to quickly determine their function and role in your organisation.
Author
The name or names of the author of the workflow.
Workflow Type
The is the type of workflow such as BACS, Faster Payments, Bureau, etc.
Editing Metadata
You can edit the workflow metadata from the Workflow Diagram. Open the mapping in the designer and click ‘Workflow’ in the diagram menu and select ‘Workflow Metadata’.
Workflow Runs
The workflow runs section provides a heatmap showing how often the workflow ran on a particular day of the year.
You can use the heatmap in a few different ways:
- To show you get a workflow run and when it did not run.
- To drill down into a particular day’s logs. The squares in the heatmap are clickable. Clicking on a particular day will filter the logging table to show just that selected day’s logs.
Workflow Log
The Workflow Logs panel provides a way to view the logs from individual instances of the workflow executing.
Each time a workflow runs, Paygate will create a separate set of log messages that can be retrieved and viewed. This is a very similar view as the main ‘Workflow Logs’ page but this page only shows logs for a specific workflow.
Drill down into the logs by clicking on one of the log entries. If the table is empty it probably means the workflow has not yet been executed.
Workflow Report
With Workflow Report enabled (ticked), Paygate will send the included email recipients a report whenever a workflow is run. The report includes the logs created by the execution process as well as whether the workflow was successful or failed, when it completed, etc.
To enable workflow reporting for this workflow, tick the ‘Create a Workflow Report’ checkbox and enter one or more email addresses (in comma separated format).
This isn’t a global setting. You need to enable workflow reports for each workflow.
Don’t forget to ‘Save Details’ to store changes to the report configuration.
Triggers using this Workflow
This panel shows which triggers are using this workflow. In other words, the triggers that this workflow is bound to.
You can see at a glance how many triggers are using the workflow and whether the workflow is enabled or not.
Workflow metrics
As workflows are run, Paygate tracks various metrics about how long a workflow was queued, how long it took to run, etc. The workflow metrics panel provides these metrics for information use.
Some metrics won’t appear straight away as the system requires multiple runs to start building up the data.
Save Details
This button saves the configuration changes to the page. At the moment this is just the Workflow Report settings.
Edit Workflow
Click this button to edit the workflow in the Workflow Designer.
Clone Workflow
The clone workflow features creates an near exact copy of the current workflow. This is useful if you have a set of similar workflows to build.
Cloned workflows must have a different name to the original workflow.
Workflow metrics are not cloned with the workflow.
The cloned workflow will not have any triggers attached to it and so you will need to manually add the cloned workflow to a trigger. This is to prevent a newly cloned workflow inadvertently being executed.
Delete Workflow
Deleting a workflow will permanently delete the workflow from the Paygate system.
Take care when deleting workflows from Paygate. They cannot be recovered once deleted!