Creating a Report of Process Folder Flow States
- Updated on 09 May 2013
- 3 minutes to read
Process folders allow process states, files and other flow data to be stored persistently in a way that is easy to manage through the portal. Processes that are expected to run for an extended period of time can be monitored and measured with process state reports.
A process state report can be created in the Report Designer by selecting the Folder Data Source and Flow Tracking Folder Data components as report sources, then selecting columns to be included in the report.
Folder Data Source can be found in the Toolbox panel, under the category Data Sources > Common Data Sources > Folder Data Source . Flow Tracking Folder Data can be found in theToolbox panel, under the category Data Sources > Add extensions data . The list of reportable columns is dependent on the selected report sources and can be found in the Toolbox panel, under the category Columns .
Our example report will list our system processes, grouped by process state, including each process's name and process type name. It will also include a pie chart describing what percentage of our flows are in each state (eg, completed , done , approved ,denied , etc. )
Begin building our report in the portal by navigating to a Designer Folder, and selecting Create Report/Page > Create Report .
In the resulting pop-up, name the new report Processes By State , and click OK to open the Report Designer .
To build the report, it is necessary to define its data sources, columns to report, and any special display features, such as charts.
First, define the report's data sources. Because the details and data of our processes are stored in folders, Add the Folder Data Source component from theToolbox panel to the Sources list. It is under the category Add > Common .
In addition to the information inside of our process folders we also want to track information about our process folders, such as which flow they belong to. To do this, add theFlow Tracking Folder Data component from the Toolbox panel to the Sources list. It is under the category Add > Extensions Data .
*Note that if you want the results to respect the permissions of the current user running the report, add the Respect Permissions filter to the Filters panel.
Now that we've defined the data sources for our report, we can define the columns of data to include in our report. To choose a column, simply click Add within the Data Fields, field.
The first column we'll select is Entity Name .
Because we want to measure the various states of our processes, also Add in State . To group the processes in the Results tab according to their present states, over the new State column heading, click the icon of pages (see below).
Now, the entities in our process report are grouped according to their present states.
We can also report which flow (or process type) is at the heart of each process by dragging the Process Type Name column into our report. As you can see, the same flow can be instantiated multiple times, creating multiple processes. Depending on the data, timing and other circumstances, these processes can result in very different states.
To fulfill the last requirement of our example - a pie chart illustrating the percentage of processes that are in each available state - click the Add button in the Views field and select Pies.
In the resulting pop-up, give our chart the name "by state", and define its fields as a count of all items, organized by "state." Click OK to add it to our report.
A new tab - Processes By State - is added to our report. In it, we'll find a pie chart describing the percentage of processes that fall into each category of state. In other examples, we'll show how charts like this one can be labeled and annotated to make the data more understandable.
Here is a sample of what it could resemble:
This completes our report on the state of our processes. We can now save it for later review, or for placement on a portal page or dashboard.