Session runs
What is a session?
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. Each session of a workflow has its own page, which 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.
Viewing the sessions for a workflow
Access the sessions for a workflow via the Sessions button in the canvas toolbar on the draft canvas:
This button can also be found in the production canvas:
This will open the sessions page for that workflow, which will show all sessions run in that workflow so far:
Searching for a session
You can perform a search across all sessions for information or data by typing in a search term and then clicking Search:
This will return all sessions that contain your search term in the session data, including inside of components and any session data:
Opening the progress view of a session
Clicking on a session will open the progress view for that session on the right. You can then track the progress of the workflow component by component:
Clicking on a component inside of the progress view will open another panel on the right which will display the data specific to that component such as its inputs and outputs and any links if it is a form or task:
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:
Type in the email that will receive the notification emails. Select send a notification when a session fails and then click Save:
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:
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
Component status
Each component will be in a certain status, indicating its current state in the workflow.
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.
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.
In Progress
If a workflow is executing a component which may take some time to complete (e.g. generating a document) then it will be marked as "In Progress" until the execution is complete.
Terminated
When a workflow is in waiting, it can be terminated by clicking the "Terminate" button.
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.
Find form sessions that have not been submitted
Until a form session is submitted, it will not appear in the session logs. However, you can find a list of all form sessions that have been saved but not submitted by clicking the Unsubmitted Forms button in the sessions logs"
You will then find all saved but unsubmitted form sessions listed out. Clicking on them will open that form session.
When a form session is submitted (and therefore creates a workflow session), it will move from this page to the session logs page.