Session Logs

What are the session logs?#

When a workflow is started and run, it starts a workflow session. A session is a specific instance of the workflow being started, tracking its progress through all of its tasks until completion. The logs are basically a logbook of workflow sessions - it records and tracks every time a workflow is run. The logs contains information about when the workflow was started, what version of the workflow was started, the status of components such as whether they have been completed, are in waiting or encountered an error, and so on. If an error is encountered, the logs will tell you where that error was encountered in the workflow and display an error message.

img

Access the logs for a workflow via the Logs button in the canvas toolbar:

img

Notification Emails#

You can turn on email notifications from the session logs, which will then send you an email when a workflow session has run and encountered an error.

To turn on notification emails, enter the session logs page and then click Notifications:

img

Type in the email that will receive the notification emails. Select send a notification when a session fails and then click Save:

img

An email will now be sent to the specified email address every time a workflow session fails to run due to an error. The email will look something like this:

img

note

Additional notification options will be added soon e.g. send notification email if workflow session is terminated, send notification email if workflow session is successful

Statuses#

Success#

If a workflow session has been run successfully, you will see a green tick next to it and next to all components inside of it.

img

Waiting#

If a workflow has reached a component which pauses the workflow, such as the sequential form, you will see that it is marked as in waiting. All the components inside of that workflow that have already been run will have a green tick next to them, and the component where the workflow is currently paused will have an "waiting" status displayed.

img

Terminated#

When a workflow is in waiting, it can be terminated by clicking the "Terminate" button.

img

This ends the workflow and makes it no longer accessible or possible to complete.

img

Error#

If an error is encountered when a workflow is run, you will see and error state in the logs. You will also find a description of the error that was encountered as well.

img