Skip to main content

Workflow Monitoring

Workflow Monitoring is the page to check when you want to know whether any of your workflows have failed. Open it daily to catch runs that failed overnight. It shows how many errors are still unhandled, which workflows they come from, and lets you retry them, fix the input and resend, or mark them as verified.

Go to Administration → Workflow Management → Workflow Monitoring, or select the Workflow Monitoring button on the Workflows list.

Typical routine​

  1. Open Workflow Monitoring. The cards at the top show how many errors are unhandled.
  2. Narrow the Time range, or pick one Workflow.
  3. Open a failed run to see the error details.
  4. Choose what to do: Retry, Edit payload and resend, or Mark as verified.

Access and permissions​

  • To open the page you need read permission on workflows. The page lists only runs of workflows you are allowed to read.
  • Retry and Edit payload and resend need permission to run that specific workflow. Without it, the actions are disabled for that run.

Retry, resend or verify?​

caution

Retrying runs the whole workflow again and can repeat its effects. For example, a workflow that posts an order to M3 may post the same order twice. If the problem was already fixed by hand, use Mark as verified instead.

  • Retry runs the workflow again with the same input.
  • Edit payload and resend lets you correct the input first. The payload is the data the run started with, such as the values a user entered or the file contents that triggered it.
  • Mark as verified records that the error is handled, without running anything.

Filters​

  • Search matches the workflow name, execution ID, custom status message and execution key values. An execution key is a business value (such as an order number) that a workflow saves with each run so you can find the run later. A custom status is a result (SUCCESS or FAILED) that a workflow sets itself. See the Error Handling Deep Dive for how to set both.
  • Workflow narrows the page to one workflow and shows the error count for each. Clear the selection to show all workflows again.
  • Time range covers the last 3, 7, 14 or 21 days (default 3 days).
  • Show retried and Show verified include runs that are already handled. By default only unhandled errors are listed, meaning those that have been neither retried nor verified.

Overview cards and chart​

The cards show Unhandled errors, Affected workflows, Hours since last error and Avg Errors/Day for the selected time range.

The Unhandled errors by workflow chart shows the five workflows with the most unhandled errors, with all others grouped as Other. Select a workflow in the chart to filter the list to its failed runs.

Error executions​

The Error executions list shows each failed run with its workflow, time, status and execution key values. A run counts as failed if it failed or its custom status is FAILED.

Each row has a menu with Retry, Mark as verified, Edit payload and resend, Open full page and Open workflow logs (the workflow's Execution Logs).

To handle several runs at once, select rows and choose Mark as verified or Retry. Retry asks for confirmation and warns if some selected runs did not fail. Runs of workflows you can't run are skipped.

Open a run to see its Execution details: the execution ID, error notification, execution keys, error details and the Trigger payload.

Edit payload and resend​

Use this when a plain retry would fail again, for example because of a wrong value.

  1. Open the failed run and choose Edit payload and resend.
  2. Edit the Trigger payload (JSON). JSON is a plain-text format for data, for example {"orderNumber": "100234", "quantity": 5}. It must be a valid JSON object or array. Select Reset to original to discard your changes.
  3. Select Resend.

The workflow runs again with the edited payload and the original run is marked as retried. If the original run was started with a file, the edited payload is sent instead of that file.

Limits​

  • Details and actions are not available for runs older than 3 months.
  • If there are too many errors to list, a message tells you how many of the most recent runs are shown. Choose a shorter time range to see all of them.
  • You can select up to 50 runs at a time for bulk actions.

Further reading​

Last updated on