Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Workflow Logs

Overview

Every time a workflow is triggered, either through an item change or at a scheduled time, a workflow run log is created. The log will hold a summary of what occurred during the workflow run and if each action completed or failed.

Viewing workflow logs

To view the logs for a workflow, simply navigate to the Logs tab on the workflow. Here you will find a list of all the workflow runs with the most recent run at the top of the list:

alt text

You can select the run you want to know more about to open the Run Log item with the run summary information displayed on the General Tab by default.

alt text

Navigate to the Run log tab to view the output of the run together with the items that were created, updated or deleted with each action.

alt text

Retention periods

By default, all workflow run logs are stored indefinitely (this may change in future).

However, you may prefer to set a rolling rentention period for workflows that trigger often, where run logs are deleted automatically after a number of days. For example, if set to 30, the workflow’s run logs will always be deleted 30 days after generation. This can be useful for saving storage space in your system.

Setting the retention period on the web

Coming soon.

Setting the retention period via the API

To change the retention period for a workflow via the API, you can set the optional property on the workflow logsRetentionDays with the number of days. For example, to set the retention period to 90 days:

{
   "name": "My Workflow",
   "enabled": true,
   "trigger": {
      ...
   },
   "logsRetentionDays": 90,
   ...
}

Alloy is a Yotta Product
Yotta is a Connected Asset Management Software and Services company.
Our aspiration is to transform the management of the built world to create safer, cleaner and more sustainable places for everyone. Find out more about us here.