Specifying Data Sets

Data retrieved from Audit Trail Data, external data sources and also computed columns, as specified on the Data Sources tab described above, can be used to create two different kinds of data sets:

Series Groups being used to display charts or tables
Record Sets being used to display discrete data in report layouts (e.g. tables)

The Data Set tab updates based on the selection.

Defining Series Groups
Defining Record Sets
Filtering Data Sets and Record Sets
Defining Report Parameters
Grouping Data Sets

Defining Series Groups

Series groups can be displayed in charts and/or tables.

Figure: Series Groups

Facts

Facts are the quantities you intend to investigate, typically Duration or Count of Process Instances or Activity Instances as selected in the Retrieve Data about drop list on the Data Source tab.

For example, for a report about Process Instances you would select Process Instance Duration to investigate the average Process Instance duration over an interval or Count to investigate the number of Process Instances completed over an interval.

Facts can be viewed as the "y-axis" of an XY chart.

Supported facts for process instances selected as data source are the following:

Standard Quantities
- Count
- Process Instance Duration
- Root Process Instance Duration
- Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the process instance
- Root Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the root process instance
Numeric Descriptors - note that descriptors of type Date, Date Time, String, Boolean and other non-numeric descriptors are not supported

In case duration or processing time is selected, the unit can also be specified as displayed in the following screenshot.

Figure: Specify Unit

Supported facts for activity instances selected as data source are the following:

Standard Quantities
- Count
- Activity Instance Duration
- Activity Instance Processing Time - the total amount of time spent in the application state (applies only to interactive activities)
- Process Instance Duration
- Root Process Instance Duration
- Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the process instance
- Root Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the root process instance
Numeric Descriptors - note that descriptors of type Date, Date Time, String, Boolean and other non-numeric descriptors are not supported

In case duration or processing time is selected, the unit can also be specified as described above.

Dimensions

Dimensions are quantities over which the facts will vary. An (average) process duration for example may vary over time, the process priority, or some process data, e.g. the postal code of the customer. Dimensions can be viewed as the "x-axis" of an XY chart.

The dimensions available are based on the Data Sources.

Supported Data Types are:

String
Date
Date Time
Boolean

The Dimension drop-down list includes all descriptors and computed columns that are of the above data types.

In case duration or processing time is selected, the unit can also be specified as described for facts.

Cumulation

Cumulation intervals can also be set for date and numeric fields.

Figure: Select Cumulation Interval

In case a date dimension is selected, the unit can also be specified along with the cumulation.

Figure: Select Date Unit

Properties available for Process Instances

The following dimensions are provided per default for Process Instances data sources:

Process Instance Properties:
- Priority
- Process Instance Duration
- Process Instance OID
- Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the process instance
- Process Name
- Process Start Timestamp
- Process State
- Root Process Instance Duration
- Root Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the root process instance
- Root Process Start Timestamp
- Starting User Name
- Termination Timestamp
Descriptors:
- Case Description
- Case Name
- Descriptors

Figure: Select Dimension for Process Instances

Properties available for Activity Instances

The following dimensions are provided per default for Activity Instances data sources:

Activity Instance Properties:
- Activity Instance Duration
- Activity Instance OID
- Activity Instance Processing Time - the total amount of time spent in the application state (applies only to interactive activities)
- Activity Name
- Activity Start Timestamp
- Activity State
- Activity Type
- Criticality
- Last Modification Timestamp
- Process Instance Duration
- Process Instance OID
- Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the process instance
- Process Name
- Process Start Timestamp
- Role/Organization Performer Name
- Root Process Instance Duration
- Root Process Instance Processing Time - sum of the Activity Instance Processing Times for the constituent activities in the root process instance
- Root Process Start Timestamp
- User Performer Name
Descriptors:
- Case Description
- Case Name
- Descriptors

Figure: Select Dimension for Activity Instances

Dimension Examples

In the following example we set a Descriptor as Dimension.

Dimension Example
Figure: Setting a Descriptor as Dimension

The Report Preview with this Dimension based on the Descriptor values will look similar to the following (here a Bar char layout is used):

Figure: Example Report with Dimension based on Descriptor values

Defining Record Sets

Record Sets should be defined when the report data is displayed in tables.

Record Set Columns

A column selector is provided to allow you to select the columns for the report.

The columns available for selection are based on the defined Data Sources and include all descriptors and computed columns. Please see sections Properties available for Process Instances and Properties available for Activity Instances, respectively, for available properties.

Available columns also include Process Instance Duration, Root Process Instance Duration and Activity Instance Duration.

Refer to section Retrieving Audit Trail Data in chapter Specifying Data Sources for an overview on the data that can be retrieved for process instance and activity instance data sources accordingly.

Figure: Record Set Columns for Process Instances

Figure: Record Set Columns for Activity Instances

The order of the Selected Columns determines the order in which they will appear in the Report. They can be re-arranged using the Move Up and Move Down arrow buttons accordingly. By default, the table is sorted on the first column.

Ordering Selected Columns

The order of the selected columns determines the order in which they will appear in the Report table. They can be re-arranged using using the Move Up and Move Down arrow buttons accordingly. By default the table will be sorted on the first column.

Ordering Selected Columns
Figure: Changing the Order of Selected Columns

Filtering Data Sets and Record Sets

You can define report parameters for your data set, which are saved with your report and can be edited in the report viewer. The data set can be filtered by all Data Sources including all descriptors and computed columns. It is possible to create multiple filters.

Filters can optionally be parameterized. Refer to section Defining Report Parameters for details.

Figure: Filtering Data Sets

The Filter list options are grouped as follows:

Process Instance Properties or Activity Instance Properties
Descriptors
Computed Columns

Filter Operator

Filter operators are provided according to the selected filter.

Figure: Filter Operators

Process Instance Properties

The following table lists available operators for specific field types for process instance properties:

Field/Type	Operator	UI Control	Contents
Priority	Equal Less or Equal Greater or Equal Not Equal	Drop List	Selection of priority values:
Process Instance OID	Equal Less or Equal Greater or Equal Not Equal In Not In	Numeric box	Accepts any numeric value. Commas can be used to separate values when In or Not In operator is specified.
Process Name	Equal In List (implicit)	Multi-select box Includes option to show/hide `Auxiliary Processes`	Process Definitions in all active models.
Process Start Timestamp	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars
Process State	Equal In List (implicit)	Multi-select box	The following states can be selected:
Termination Timestamp	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars

Activity Instance Properties

The following table lists available operators for specific field types for activity instance properties:

Field/Type	Operator	UI Control	Contents
Activity Instance OID	Equal Less or Equal Greater or Equal Not Equal In Not In	Numeric box	Accepts any numeric value. Commas can be used to separate values when In or Not In operator is specified.
Activity Name	Equals In List (implicit)	Multi-select boxes with options to show/hide: Auxiliary Processes Non-Interactive Activities Interactive Activities Auxiliary Activities An option to select to show all processes is provided.	All Processes /All Activities
Activity Start Timestamp	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars
Activity State	Equals In List (implicit)	Multi-select box
Criticality	Equal Less or Equal Greater or Equal Not Equal	Drop List	Criticality labels
Last Modification Timestamp	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars
Process Instance OID	Equal Less or Equal Greater or Equal Not Equal In Not In	Numeric box	Accepts any numeric value. Commas can be used to separate values when In, Not In operator is specified.
Process Start Timestamp	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars

Descriptors

The following table lists available operators for specific field types for descriptors:

Field/Type	Operator	UI Control	Contents
Boolean	Equal (implicit)	Checkbox	selected/unselected
Numeric	Equal Less or Equal Greater or Equal Not Equal In Not In	Numeric box	Accepts any numeric value. Commas can be used to separate values when In, Not In operator is specified. Simple Types long, number 32-bit, number 16-bit, number 8-bit, Scientific High, Scientific Regular, Money XSD Types byte, date, double, float, int, integer, long, negativeInteger, nonNegativeInteger, nonPostiveInteger, postiveInteger, short, time, unsignedbyte, unsignedInt, unsignedLong, unsignedShort
String	Equal Not Equal In Not In Like	Text Entry box	Accepts any value. Commas can be used to separate values when In, Not In operator is specified.
Date / Date Time	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars
Enumerations	Equals In List (implicit)	Multi-Select

Computed Columns

The following table lists available operators for specific field types for computed columns:

Field/Type	Operator	UI Control
String	Equal Not Equal In Not In Like	Text Entry box
Integer	Equal Less or Equal Greater or Equal Not Equal In Not In	Numeric Box
Decimal	Equal Less or Equal Greater or Equal Not Equal In Not In	Numeric Box
Count	Equal Less or Equal Greater or Equal Not Equal	Numeric Box
Timestamp	Greater or Equal Less or Equal Between Equal (implicit)	From / To Date Time Calendars

Filtering via From / To Date Time Calendars

For filtering via From / To Date Time calendars the operator is implicit and derived as follows:

Greater or Equal = Entry in From field only
Less or Equal = Entry in To field only
Between = Entries in both fields. To must be more recent than From.
Equals = Same entry in both fields

You can use the calendar that pops up when clicking the entry field to enter start or end date respectively.

Figure: Date/Time Calendar

You can switch to start date and duration time and date settings, by clicking the Switch to Start Date and Duration option below the entry fields.

Figure: Switch to Start Date and Duration

To switch to start date and end date settings, click the Switch to Start Date and End Date option below the entry fields accordingly.

Figure: Switch to Start Date and End Date

Defining Report Parameters

Report Definitions can be parameterized e.g. to run a report for a time frame starting from a varying date or by filtering the report by varying data. Report Parameters are specifically important for the re-use of Report Definitions as Report Templates.

Wherever an input in the Stardust Reporting is succeeded by the

Clicking the Set Parameter icon next to a Filter (or Dimension for Series Groups) sets that data as a Report Parameter. In turn the Remove Parameter icon removes the data from the parameter list.

Is Parameter =
Not Parameter =

All defined parameters appear in the top part section of the Preview tab, where they can be edited and re-run. In the following example, we set a parameter defining the Process Name with name Confirm Order Process.

Figure: Setting a Parameter for a specific Process Name

This parameter appears in the top section of the Preview tab, where it can be modified and submitted as described in chapter Previewing Reports.

Figure: Parameter appearing in the Preview Tab

You can define multiple parameters for a Report Definition. All dimensions and filters can be parameters, including computed columns. Note that all date and date/time parameters appear in the Map Report Execution Time to field on Scheduling tab.

All Parameters must have a default value. For composite reports, only the parameters defined in the parent report will be displayed in the report at runtime, and these parameters can be passed to child reports.

Grouping Data Sets

Data sets can be grouped by any Data Source including Descriptors and Computed Columns.

The Group By list groups options under the following headers:

Process Instance Properties or Activity Instance Properties
Descriptors
Computed Columns

Figure: Grouping Data Sets for Process Instances

Figure: Grouping Data Sets for Activity Instances

Grouping Record Sets

Note that selecting a Group by data for a record set affects the columns available for selection. If the data set is grouped, only the Group By data and other numeric descriptors are available in the Selected Columns. All other data are filtered out of the column selector control.

Figure: Record Set Columns for Grouped Process Instances

The aggregate operations average (Average), minimum (Min), maximum (Max), and standard deviation (Std Dev) are available for durations, e.g. Activity Instance Duration, Process Instance Duration and Root Process Instance Duration, and each numeric descriptor.

Grouping Examples

In the following example we group a Report by a Descriptor CustomerName.

Grouping Example
Figure: Select a Descriptor to group by

In the Report Preview the report will look similar to the following, using a different color for each customer name (here a XY Plot layout is used):

Figure: Example Report with Grouped Data Sets by Descriptor value

In the next example we group a Report by Activity Type.

Grouping Example
Figure: Select a Descriptor to group by

In the Report Preview the report will look similar to the following, using a different color for each Activity Type (here a Bar chart with Stack Series layout is used):

Figure: Example Report with Grouped Data Sets by Activity Type