Runtime Views

This chapter describes the following runtime views:

Currently, the views in the following sections are available for runtime data access.

Opening a Runtime View

To open a runtime view for runtime data:

  1. Open the Edit Data Set dialog by clicking on the data set and selecting Edit.

  2. Switch to View Selection.
  3. In the drop-down list provided for Process Database View select the runtime view you like to view or edit.

Process Instance View

The following topics describe how to work with process instance views:

Predefined Columns

Column SQL Type Content
ID String the unique (non-technical) identifier of the process instance
Name String the name of the process instance
Description String the description of the process instance
OID Long the unique technical identifier of the process instance
State Integer the state of the process instance (created: -1, active: 0, aborted: 1, completed: 2, interrupted: 3)
StartingUser Integer the OID of the starting user
StartingActivityInstance Integer the OID of the starting Activity Instance
RootProcessInstance Integer If the process instance is a subprocess, then this column shows the OID of its super-process / root process
StartTimestamp Date the start date and time of the process instance
EndTimestamp Date the end date and time of the process instance
ProcessDuration Integer the current or final (depending on the state) duration of the process instance in seconds
ProcessWorktime Integer the ProcessDuration modified according to the selected worktime calculation business logic
TotalActiveTime Integer the total duration of the process instance in seconds
SubTotalActiveTime Integer the total duration of the filtered subprocesses of the process instance in seconds
SubProcessWorktime Integer the ProcessWorktime of all filtered subprocesses.

Parameters

Name SQL Type Filters Result Set by Default Value
ProcessID String the unique (non-technical) identifier of the process definition '%'
ProcessName String '%'
ProcessInstanceOID String the unique (non-technical) identifier of the process definition '%'
ProcessInstanceState String the state of the process instance '2' (completed)
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)
ProcessDuration Integer the current or final (depending on the state) duration of the process instance in seconds '%'
ProcessWorktime Integer the ProcessDuration modified according to the selected worktime calculation business logic '%'
UseIntervalEnds String determines the interpretation of the IntervalPiStateFilter 'true'
UseOuterJoins String If you are adding user defined columns (process data) in the view then
  • false: only the process instances which have the process data with not null values are included in the view.
  • true: all the process instances regardless of data types and values of data are included in the view.
'false'
IntervalPiStateFilter String started: process instance was started in this interval
active: all processes with status "active", checked at the start or end of the interval, depending on the UseIntervalEnds parameter.
complete: all processes with status "complete", checked at the start or end of the interval, depending on the UseIntervalEnds parameter.
completed: process instance was completed in this interval
'started'
SubProcessID String the unique (non-technical) identifier of the subprocess definition '%'

Depending on user-specified process data columns, activity metrics and external data table columns, additional output columns and parameters will be created.

Process Instance State Values

Possible process instance state values are:

Value Name Description
-1 created The process instance has just been created.
0 active The process instance is running..
1 aborted The process instance has been aborted.
2 completed The process instance has been completed.
3 interrupted The process instance is interrupted - one of it's activity instances is interrupted.
4 aborting The process instance is in aborting state - an intermediate state if the process does not get aborted successfully or the time span is large before abort.

User Defined Columns

The following column types are provided to be added as user defined columns in the Process Instances view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Cumulated Process Instance View

Process instance views can be cumulated with different interval lengths. To enable cumulation check the check-box cumulated with interval length as show below. Then select the interval length (Minute, Hour, Day, Week, Month, Quarter, Year or Total).

The following topics describe how to work with cumulated process instance views:

Predefined Columns

Column SQL Type Content
ID String the unique (non-technical) identifier of the process instance
Name String the name of the process instance
Description String the description of the process instance
IntervalTimestamp Date the start date and time of the particular interval
Volume Integer the process instance volume in the particular interval
ProcessDuration_Minimum Integer the minimum duration of process instances started within the particular interval in seconds
ProcessDuration_Maximum Integer the maximum duration of process instances started within the particular interval in seconds
ProcessDuration_Average Integer the average duration of process instances started within the particular interval in seconds
ProcessDuration_Deviation Integer the standard deviation of the average duration of process instances started within the particular interval in seconds
ProcessWorktime_Minimum Integer the minimum process worktime of process instances started within the particular interval
ProcessWorktime_Maximum Integer the maximum process worktime of process instances started within the particular interval
ProcessWorktime_Average Integer the average process worktime of process instances started within the particular interval
ProcessWorktime_Deviation Integer the standard deviation of the average process worktime of process instances started within the particular interval

Parameters

Name SQL Type Filters Result Set by Default Value
ProcessID String the unique (non-technical) identifier of the process definition '%'
ProcessInstanceOID String the unique (non-technical) identifier of the process definition '%'
ProcessInstanceState String the state of the process instance '2' (completed)
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)
UseIntervalEnds
String If true, the field IntervalTimestamp displays the end of the interval (otherwise start of interval is displayed) 'true'

Depending on user-specified process data columns, activity metrics and external data table columns, additional output columns and parameters will be created.

Grouping Cumulated Process Instance Views

Before cumulation, cumulated process instance views can be grouped multiple times. Grouping can occur by values in process data columns or foreign data table columns.

Create a cumulated process instance view as described above. Enabling the checkbox cumulated with interval length, also enables the Edit "Group by"-Columns button. In order to define groupings you have to add the user defined columns Process Data or Foreign Data first. Please refer to the chapter User Defined Columns in Runtime Views for detailed information on how to add these table columns. In the example below two process data columns Category and Product have been added to a process instance view that is cumulated by day. After adding data columns select the Edit "Group by"-Columns button.

The "Group by"-Columns dialog opens:

The left window shows the output columns by whose values the result can be grouped. The right window show the selected output columns by whose values the result set will be grouped.

Groupings on top of others will happen first. In the example shown below, grouping by Category and Product will occur. As Category is positioned higher than Product, the grouping by Category will happen first. It will be the outer grouping.

Before previewing the results, check the Parameters panel. Special attention should be paid to the StartDate, EndDate and the additional process data value filter parameters. In our example these are CategoryValueFilter and ProductValueFilter. They can be used to filter the original data before cumulation and grouping takes place.

Switch to the Preview Results panel to preview the result. Like the example shown below (some columns have been narrowed), your result set may contain rows, which do not contain values in the process data columns (Category, Product) and the ID column. If necessary, these rows can be filtered.

The filtered result set is shown below. Each time interval has been grouped by Category (first) and Product (second). (some columns have been narrowed)

Now the data set can be used inside a report. Choose the Layout tab in your Report Editor. Define groupings on your table to avoid displaying group headers multiple times. Please refer to the topic Laying out a Report of the BIRT Help to get information on how to lay out your report.

In the example shown above, the columns IntervalTimestamp, Volume and the process data columns Category and Product have been displayed in a table. Then a grouping on IntervalTimestamp has been added and the [IntervalTimestamp] data element has been move to the group header row. The output shown below follows from such a table design.

As you can see IntervalTimestamps are displayed only once, while Category values are still displayed multiple times per interval timestamp.

Now a second grouping by Category has been added to the table and the [Category] data has been moved to the group header row. This table design produces the following output.

Process Instance State View

The following topics describe how to work with process instance state views:

Cumulation Interval

Process Instance State Views are always cumulated. The cumulation interval can be set in the View Selection panel. The available options are: Minute, Hour, Day, Week, Month, Quarter, Year or Total. To cumulate all process instances in the period of consideration choose total.

Predefined Columns

Column SQL Type Content
ID String the unique (non-technical) identifier of the process instance
Name String the name of the process instance
Description String the description of the process instance
IntervalTimestamp Date the start date and time of the cumulation interval
CompletedProcesses Integer the total number of process instances completed before the interval timestamp
ProcessesCompletedInInterval Integer the number of process instances completed in the particular interval
ActiveProcesses Integer the total number of active process instances before the interval timestamp
ProcessesStartedInInterval Integer the number of process instances started in the particular interval

Parameters

Name SQL Type Filters Result Set by Default Value
ProcessID String the unique (non-technical) identifier of the process definition '%'
ProcessName String '%'
ProcessInstanceOID String '%'
ProcessInstanceState String the state of the process instance '2' (completed)
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)
ProcessDuration String '%'
ProcessWorktime String '%'
UseIntervalEnds String determines the interpretation of the ProcessesCompletedInInterval and the ProcessesStartedInInterval fields. 'true'
UseOuterjoins String If you are adding user defined columns (process data) in the view then
  • false: only the process instances which have the process data with not null values are included in the view.
  • true: all the process instances regardless of data types and values of data are included in the view.
'false'

Depending on user-specified process data columns and external data table columns, additional output columns and parameters will be created.

User Defined Columns

The following column types are provided to be added as user defined columns in the Process Instance State view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Grouping the View

The Process Instance State View can be grouped by ID, Name, Description and process data or foreign data joined to the view. Grouping is done in analogy to the proceeding described for the Cumulated Process Instance View

Activity Instance View

The following topics describe how to work with activity instance views:

Predefined Columns

Column SQL Type Content
ID String the unique (non-technical) identifier of the activity
Name String the name of the activity
Description String the description of the activity
ProcessID String the unique (non-technical) identifier of the process instance the particular activity is part of
ProcessName String the names of the process instance the particular activity is part of
ProcessDescription String the description of the process instance the particular activity is part of
OID Integer the technical identifier of the activity
State Integer the state of the activity instance
ProcessInstanceOID Integer the technical identifier of the process instance the particular activity is part of
WorklistPerformerOID Date the OID of the worklist performer of the activity instance
UserPerformerOID Date the OID of the user performer of the activity instance
PerformedByOID Date the OID of the current performer of the activity instance
StartTimestamp Date the start timestamp of the activity
EndTimestamp Date the end timestamp of the activity
ActivityDuration Integer the current or final (depending on the state) duration of the activity in seconds.
ActivityWorkTime Integer the activity worktime of the activity

Parameters

Name SQL Type Filters Result Set by Default Value
ProcessDefinitionID String the unique (non-technical) identifier of the process definition '%'
ProcessInstanceOID String the unique technical identifier of the process instance '%'
ProcessInstanceState String the state of the process instance '2' (completed)
ActivityID String the unique (non-technical) identifier of the activity '%'
ActivityInstanceOID String the unique technical identifier of the activity instance '%'
ActivityInstanceState String the state of the activity instance '2' (completed)
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)

Activity Instance State Values

Possible activity instance state values are:

Value Name Description
0 created The activity instance has just been created.
1 application The activity instance is currently performed either interactively or automatically.
2 completed The activity instance has been completed.
4 interrupted Completion of the activity instance has caused exceptions.
5 suspended The (interactive) activity instance has been suspended to the worklist of a user, a role or an organization.
6 aborted The activity instance has been aborted directly by a user or by explicitly aborting the process instance.
7 hibernated The activity instance has an asynchronous receiving part and is hibernated to wait for an awakening event.
8 aborting The activity instance in aborting state - an intermediate state if the process does not get aborted successfully or the time span is large before abort.

User Defined Columns

The following column type is provided to be added as user defined column in the Activity Instances view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Organizational Worklist View

Predefined Columns

Column SQL Type Content
OID Integer the technical identifier of the organization
Type String the organization type
ID String the (non-technical) identifier of the organization
Name String the name of the organization
Department ID String the unique identifier of the department
Department OID String the OID of the department
Description String the description of the organization
TotalAssignedItemCount Integer the total number of items assigned to the organization
TotalPerformedItemCount Integer the total number of items performer by the organization
WorkingTimeOnUnfinishedActivities Integer the total time the organization worked on uncompleted activities in seconds
WorkingTimeOnCompletedActivities Integer the total time the organization worked on completed activities in seconds
TotalWorkingTime Integer the total time the organization worked in seconds
FullTimeEquivalent Integer the organization's full time equivalent in seconds
PercentageWorkload Decimal the organization's workload in percent.

Parameters

Name SQL Type Filters Result Set by Default Value
ParticipantIDs String the unique (non-technical) identifier of the participants '%'
ActivityIDs String the unique (non-technical) identifier of the activities '%'
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)

User Defined Columns

The following column type is provided to be added as user defined column in the Organizational Worklist view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

User Worklist View

Predefined Columns

Column SQL Type Content
OID Integer the technical identifier of the user
ID String the (non-technical) identifier of the user
FirstName String the first name of the user
LastName String the last name of the user
Email String the email address of the user
Description String the description of the user
ValidFrom Date the date and time the user account is valid from
ValidTo Date the date and time the user account is valid to
TotalAssignedItemCount Integer the total number of items assigned to the user
TotalPerformedItemCount Integer the total number of items performer by the user
WorkingTimeOnUnfinishedActivities Integer the total time the user worked on unfinshed activities in seconds
WorkingTimeOnCompletedActivities Integer the total time the user worked on completed activities in seconds
TotalWorkingTime Integer the total time the user worked in seconds
FullTimeEquivalent Integer the user's full time equivalent in seconds
PercentageWorkload Decimal the user's workload in percent.

Parameters

Name SQL Type Filters Result Set by Default Value
UserFirstNames String the user's first names '%'
UserLastNames String the user's last names '%'
ActivityIDs String the unique (non-technical) identifier of the activities '%'
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)

User Defined Columns

The following column type is provided to be added as user defined column in the User Worklist view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Log Entry View

Predefined Columns

Column SQL Type Content
OID Integer the technical identifier of the log entry
Type String the type of the log entry
Code String the technical code of the log entry
Subject String the subject of the log entry
Timestamp Date the date and time the log entry was created
UserAccount String the user account the log entry was generated for
UserFirstName String the first name of the user the log entry was generated for
UserLastName String the last name of the user the log entry was generated for

Parameters

Name SQL Type Filters Result Set by Default Value
Code String contains the kind of logging (e.g. Security, Engine, Recovery, Daemon) '%'

Data Value View

Predefined Columns

Column SQL Type Content
ID String the identifier of the process data
Name String the name of the process data
Description String the description of the process data
Type Integer the type of the data value
Value String the value of the process data
OID String the OID of process instance the process data belongs to

Parameters

Name SQL Type Filters Result Set by Default Value
DataID String the unique (non-technical) identifier of the process data '%'
ProcessID String the unique (non-technical) identifier of the process definition '%'
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)

User Defined Columns

The following column type is provided to be added as user defined column in the Data Value view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Quality Assurance Codes View

Predefined Columns

Column SQL Type Content
ActivityInstanceOid String the technical identifier of the activity instance
QualityAssuranceCodeKey String key of the quality assurance code
QualityAssuranceCodeValue String string value of the quality assurance code
AssignDate Date date of assignment

Parameters

Name SQL Type Filters Result Set by Default Value
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
ProcessId String the unique (non-technical) identifier of the process definition %
ActivityId String the unique (non-technical) identifier of the activity %
ModelOID String the technical identifier of the model %

User Defined Columns

The following column type is provided to be added as user defined column in the Transition view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for a quality assurance codes view:

Preview Result Table for Quality Assurance Codes View
Figure: Preview Result Table for Quality Assurance Codes View

Quality Assurance View

Predefined Columns

Column SQL Type Content
ProcessDefinitionName String the name of the process definition
ProcessDefinitionOid String the technical identifier of the process definition
ProcessInstanceOid String the technical identifier of the process instance
ActivityName String the name of the activity
ActivityOid String the technical identifier of the activity
ActivityInstanceOid String the technical identifier of the activity instance
QualityAssuranceState String state of the quality assurance
QualityAssuranceResult String the quality assurance result

Parameters

Name SQL Type Filters Result Set by Default Value
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
ProcessId String the unique (non-technical) identifier of the process definition %
ActivityId String the unique (non-technical) identifier of the activity %
ModelOID String the technical identifier of the model %

User Defined Columns

The following column type is provided to be added as user defined column in the Transition view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for a quality assurance view:

Preview Result Table for Quality Assurance View
Figure: Preview Result Table for Quality Assurance View

Transition View

Please note that the Transitions View does not display transitions of a certain model. It looks for transitions of all deployed models starting with the active model. A transition is only displayed once, so it is not shown if a transition with the same Id is already displayed.

Predefined Columns

Column SQL Type Content
ProcessID String the (non-technical) identifier of the process definition the transition is part of
TransitionID String the (non-technical) identifier of the transition
IntervalTimestamp Date the start date and time of the cumulation interval
FromActivityID String the transition's starting activity
ToActivityID String the activity the transition leads to
Percentage Decimal the number of instances of this process definition passing this transition in relation to the total number of instances of this process definition
Volume Integer the total number of times the particular transitions has been passed
AverageVolumePerProcessInstance Decimal the average number of times this transition has been passed per process instance
DeviationVolumePerProcessInstance Decimal the deviation of the average number of times this transition has been passed per process instance

Parameters

Name SQL Type Filters Result Set by Default Value
FromActivityID String the unique (non-technical) identifier of the activity the transition starts from '%'
ToActivityID String the unique (non-technical) identifier of the activity the transition leads to '%'
ProcessID String the unique (non-technical) identifier of the process definition '%'
StartDate String the start date and time of the period under consideration '<currentYear>-01-01 00:00:00.0'
EndDate String the end date and time of the period under consideration '<currentDate> <currentHour>:<currentMinute+1>:00.0'
(creation date and time of data set)

User Defined Columns

The following column type is provided to be added as user defined column in the Transition view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Path View

Predefined Columns

Column SQL Type Content
ProcessID String the (non-technical) identifier of the path's process instance
ActivityIDs String the (non-technical) identifiers of the activities belonging to the process path
Duration Integer the duration of the process path

Parameters

Name SQL Type Filters Result Set by Default Value
ProcessID String the unique (non-technical) identifier of the process definition '%'

Active Models View

Predefined Columns

Column SQL Type Content
ID String the unique identifier of the process model
Name String the name of the process model
Active Version String active version of the model
OID String model OID
Description String model description

Parameters

Name SQL Type Filters Result Set by Default Value
ModelID String the unique (non-technical) identifier of the process model '%'

User Defined Columns

The following column type is provided to be added as user defined column in the Active Models view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for an Active Model view:

Preview Result Table for Active Models View
Figure: Preview Result Table for Active Models View

Consumed Process Interfaces View

Predefined Columns

Column SQL Type Content
Name String Name of the process interface
ID String the unique (non-technical) identifier of the process interface
OID String the unique technical identifier of the process interface

Parameters

Name SQL Type Filters Result Set by Default Value
ModelOID String the unique technical identifier of the process model '%'

User Defined Columns

The following column type is provided to be added as user defined column in the Consumed Process Interfaces view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Model Consumer View

Predefined Columns

Column SQL Type Content
Name String Name of the consumer model
ID String the unique (non-technical) identifier of the consumer model
OID String the unique technical identifier of the consumer model

Parameters

Name SQL Type Filters Result Set by Default Value
ModelOID String the unique technical identifier of the process model '%'

User Defined Columns

The following column type is provided to be added as user defined column in the Model Consumer view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for a model consumer view:

Preview Result Table for Model Consumer View
Figure: Preview Result Table for Model Consumer View

Model Details View

Predefined Columns

Column SQL Type Content
Name String name of the process model
ID String the unique (non-technical) identifier of the process model
OID String the unique technical identifier of the process model
Version String version number
Active String flag to determine if model is active
Disabled String flag if model is disabled or enabled
Valid From String date the model is valid since
Description String model description

Parameters

Name SQL Type Filters Result Set by Default Value
ModelID String the unique (non-technical) identifier of the process model '%'

User Defined Columns

The following column type is provided to be added as user defined column in the Model Details view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for a Model Details view:

Preview Result Table for Model Details View
Figure: Preview Result Table for Model Details View

Model Provider View

Predefined Columns

Column SQL Type Content
Name String Name of the provider model
ID String the unique (non-technical) identifier of the provider model
OID String the unique technical identifier of the provider model

Parameters

Name SQL Type Filters Result Set by Default Value
ModelOID String the unique technical identifier of the process model '%'

User Defined Columns

The following column type is provided to be added as user defined column in the Transition view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for a model provider view:

Preview Result Table for Model Provider View
Figure: Preview Result Table for Model Provider View

Provided Process Interfaces View

Predefined Columns

Column SQL Type Content
ModelID String the unique (non-technical) identifier of the process model
ModelName String the unique (non-technical) identifier of the process model
ProcessID String the unique (non-technical) identifier of the process definition
ProcessName String the name of the process definition

Parameters

Name SQL Type Filters Result Set by Default Value
ModelOID String the unique technical identifier of the process model '%'

User Defined Columns

The following column type is provided to be added as user defined column in the Provided Process Interfaces view:

For detailed information on the according column types and how to add, edit and remove user defined columns, refer to the chapter User Defined Columns in Runtime Views.

Example Result Preview

The following screenshot shows an example preview result for a provided process interfaces view:

Preview Result Table for Provided Process Interfaces View
Figure: Preview Result Table for Provided Process Interfaces View