Data source: Workflow Sessions (App)

The Workflow Sessions data source is a collection of tables you can use to build workflow session reports in App.

In this article

Overview

The Workflow Sessions data source is one of several data sources available for creating reports in App. To learn more about data sources in general, please see: Overview: Data sources for reports (App).

With the Workflow Sessions data source, you can create reports that show you information about active workflow sessions.

A workflow session is a period of time where the processes through workflow items, what are also referred to as ‘workflow modules’, in a workflow.

There are two things that can trigger a workflow session to start running:

• An event (like a customer calling a phone number)

• A schedule (like every minute, hour, day, etc.)

Once a workflow is triggered, a workflow session is created. While the workflow session is running, it's an active workflow session. During an active workflow session, the system processes through each of the workflow items in the workflow.

The Workflow Sessions data source shows the workflow item that’s currently being processed in the workflow.

Note: If you want to see which workflow items have already been processed on a workflow session, use the Workflow Session History data source.

You can use this data source to retrieve information like: 

• The current workflow item in progress on the workflow

• When the workflow session began

• When the workflow session ended

• How long the workflow session has been active

This means that when you create a report with this data source, each row of the report is an active workflow session. 

So, you can filter the report to see a specific active workflow session or filter to a group of them. Either way, the report set up depends on whether you want to dive deeper into understanding one individual active workflow session or a few of them to be able to see how they relate to each other.

This article provides common use cases for the data source and a list of its tables.

Use cases

The most common use case for the Workflow Sessions data source is creating a workflow sessions report.

A workflow sessions report shows you all of the active workflow sessions on your organization’s account, including the workflow module that’s currently being processed. 

This type of report is particularly useful when you want to see this information in a single view: which of your workflows are currently running and the progress of each of those active workflow sessions.

Tables

The Workflow Sessions data source only consists of database tables that relate to this data source.. 

Below are the tables available when creating a report with this data source. Click any of the links below to view column documentation for each table.