IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Developing monitor models > Create monitor models > Generate monitor models > Generate from applications in the workspace
Default metrics and Key Performance Indicators for process applications
Generated monitor models contain numerous default metrics and Key Performance Indicators (KPI) for a process application.
The default metrics and KPIs are found in the following three parts of a monitor model:
- Monitor details model
- KPI model
- Dimensional model
These three parts and their default metrics and KPIs are discussed in the following three sections.
Monitor details model
When a monitor model is generated, it contains at least one monitoring context definition. A root monitoring context definition is generated for each business process, referenced toolkit, or BluePrint process in a process application. The root monitoring context definition includes a child monitoring context definition for the process steps. In addition, a root monitoring context definition is created for the process application as a whole.
The default metrics, triggers, and counters are generated into the default monitor models, but they are also offered for selection in the Generate Monitor Model wizard for generating custom monitor models.
Each activity in a process in the IBM Process Designer authoring environment has the following eight default tracked fields associated with it:
- Cost
- Resource Cost
- Labor Cost
- Rework
- Value Add
- Total Time (Clock)
- Wait Time (Clock)
- Execution Time (Clock)
These eight tracked fields, which are referred to as KPIs in Process Designer, should not be confused with the KPIs in IBM Business Monitor, which are aggregate values of metrics defined in a monitor model (such as min, max, and avg).
When a monitor model is generated, a metric is created in the process_name Steps monitoring context to store the value of each of these built-in tracked values. Additionally, the generated monitor model contains a monitor KPI with an aggregation type of Average for each of those eight values.
If custom KPIs are created in Process Designer for the process application, the auto-generated model will not automatically create metrics for the custom KPIs.
The monitoring contexts and their associated metrics, triggers, and counters are described in the following table:
Monitoring contexts and their associated metrics, triggers, and counters Monitoring context Metrics, triggers, and counters Description process_name (one instance for each process execution) Aux Starting Process Instance ID (key metric) An internal metric that is the key of the monitoring context. It identifies the process execution (instance) that is monitored by this context. process_name Instance ID (metric) This metric caches the ID of the process instance. process_name Termination Trigger (trigger) This internal trigger is fired when one of the following events is received:
- PROCESS_COMPLETED
- PROCESS_FAILED
- PROCESS_TERMINATED
Active Step Names (metric) A comma-separated list of active step names in the monitored process execution. Aux Active Step Instance IDs (metric) An internal metric that captures a comma-separated list of active step instance IDs in a process. This metric is not displayed in any automatically generated dashboards. Aux Last Completed Step Instance ID (metric) This is an internal metric to capture the instance ID of the last completed step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Aux Last Completed Step Name (metric) This internal metric captures the name of the last completed step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Aux Last Started Step Instance ID (metric) This is an internal metric to capture the instance ID of the last started step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Aux Last Started Step Name (metric) This is an internal metric to capture the name of the last started step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Start Time (metric) The start time of the monitored process execution. End time (metric) The end time of the monitored process execution. Total Time (Clock) (metric) The total elapsed time of a process execution. It is calculated from the Start Time and End Time metrics. Tracked Field (metric) A business process defined in the process application or toolkit can have a set of auto-tracked fields defined by the business user. A metric is generated for each auto-tracked field of type String, Decimal, Integer, Date or Boolean. The metric captures the business data of the latest process event that reported this tracked field. If the Tracked Field metric is of data type Boolean, the corresponding metric will be of type String in the monitor model. And if the tracked field is of type Integer, the generated metric type will be Decimal. Otherwise, it will match the type of the auto-tracked field. Step Completed (trigger) This trigger is fired when a step is completed in the monitored process execution. Step Started (trigger) This trigger is fired when a new step is started in the monitored process execution. Steps Active (counter) The number of active steps running in a process. It is incremented when a Start event arrives for a process step and it is decremented when an End event arrives for a process step. Steps Completed (counter) The number of completed steps in a process. The count is incremented when an End event arrives for a process step. Snapshot ID (metric) Captures the snapshot ID (version) of the monitored process. Snapshot Name (metric) Captures the snapshot name of the monitored process. State (metric) Captures the current state of the process step. process_name Steps (one instance for each step execution) This monitoring context is a child of the business process execution monitoring context.
Step Instance ID (key metric) Key of the monitoring context. It identifies the step execution that is being monitored. Called Process Instance ID (metric) Captures the instance ID of the process that is called by this step. This metric only exists if the process contains a subprocess. Number of Started Instances (metric) Captures the number of parallel instances started by a multi-instance Loop activity. Start Time (metric) The start time of the process step. End Time (metric) The end time of the process step. Cost (metric) The cost of running a process step. Captures the value of the associated default tracked field (KPI) Cost in IBM BPM. Resource Cost (metric) The resource cost of running a process step. Captures the value of the associated default tracked field (KPI) Resource Cost in IBM BPM. Labor Cost (metric) The labor cost of running a process step. Captures the value of the associated default tracked field (KPI) Labor Cost in IBM BPM. Total Time (Clock) (metric) The total time of running a process step. Captures the value of the associated default tracked field (KPI) Total Time (Clock) in IBM BPM. Execution Time (Clock) (metric) The execution time of a process step. Captures the value of the associated default tracked field (KPI) Execution Time (Clock) in IBM BPM. Wait Time (Clock) (metric) The wait time of a process step. Captures the value of the associated default tracked field (KPI) Wait Time (Clock) in IBM BPM. Rework (metric) The rework (percent true) of running a process step. Captures the value of the associated default tracked field (KPI) Rework in IBM BPM. Value Add (metric) The value add (percent true) of running a process step. Captures the value of the associated default tracked field (KPI) Value Add in IBM BPM. Step Name (metric) The name of the process step. Potential Performer ID (metric) The user ID of the performer that is assigned to this step. This metric is only populated for steps that are user tasks. Potential Performer Name (metric) A performer (user or group) that is assigned to this step. This metric is only populated for steps that are user tasks. Performer ID (metric) The user ID of the performer who actually works on this step. This metric is only populated for steps that are user tasks. Performer Name (metric) The performer who actually works on this step. This metric is only populated for steps that are user tasks. Snapshot ID (metric) The snapshot ID of the monitored process. Snapshot Name (metric) The snapshot name of the monitored process. State (metric) The current state of the process step. process_name Steps Termination (trigger) This internal trigger is fired to terminate the monitoring context instance 30 days after the last event arrived. auto_tracked_field_name ◇ (metric) Captures the data of an auto-tracked field before the process step is started. This metric is appended with the superscript diamond symbol ◇. auto_tracked_field_name (metric) Captures the data of an auto-tracked field after the process step has completed. process_application_name (one instance for each end-to-end process execution) Starting Process Instance ID (key metric) The instance identifier of a top-level (main) process execution that starts an end-to-end process chain. process_application_name Termination Trigger (trigger) This is an internal trigger that is fired to terminate the monitoring context instance 30 days after the last event arrived. You can update this trigger to change when the monitoring context is terminated. custom_tracked_field_name (metric) Each tracking group defined in the process application has a set of tracked fields defined by the business user. A metric is generated for each tracked field of type Number, Date, and String that has an assigned value. The metric value captures the last value reported for this field by any tracking event emitted during this end-to-end process execution. Aux timing_interval_name Start Point (metric) An internal metric that records the start time of a timing interval. This metric is not displayed in any automatically generated dashboards. Aux timing_interval_name End Point (metric) An internal metric that records the end time of a timing interval. This metric is not displayed in any automatically generated dashboards. timing_interval_name (metric) A metric that captures the duration of a timing interval during the end-to-end process run monitored by this context. The value is calculated when the end point of the timing interval is reached. As long as the timing interval has not completed, this metric will have no value. For timing intervals defined in a toolkit, the toolkit name is appended to the timing interval name to avoid names clashes that might otherwise occur. The timing interval is calculated from the following internal metrics:
- Aux timing_interval_name Start Point
- Aux timing_interval_name End Point
Snapshot ID (metric) The snapshot ID of the monitored process. tracking_group_name Events (one instance for each custom tracking event that is received) This monitoring context definition is a child of the process application monitoring context definition. A monitoring context definition is generated for each tracking group that is defined in the process application or in a referenced toolkit.
Time Emitted (key metric) The emission time of the custom tracking event captured by this monitoring context (used as the key). Event Name (metric) The name of the tracking event definition. tracked_field_name (metric) Each tracking group defined in a process application has a list of tracked fields defined by the business user. A metric is generated for each tracked field and captures the field value reported by the tracking event received in this monitoring context. tracking_group_name Events Termination Trigger (trigger) This trigger terminates the monitoring context as soon as a tracking event is received. (The context is created, updated, and terminated by the same event.) Snapshot ID (metric) The snapshot ID of the monitored process. Snapshot Name (metric) The snapshot name of the monitored process. subprocess_name A KPI context is created for each subprocess. The KPI context name is the fully qualified name of the subprocess. Subprocesses can be nested more than one level deep.
subprocess_name Instance ID (key metric) This key metric caches the ID of the subprocess instance. subprocess_name Termination Trigger (trigger) This internal trigger is fired when one of the following events is received:
- SUBPROCESS_COMPLETED
- SUBPROCESS_FAILED
- SUBPROCESS_TERMINATED
Active Step Names (metric) A comma-separated list of active step names in the monitored subprocess execution. Aux Active Step Instance IDs (metric) An internal metric that captures a comma-separated list of active step instance IDs in a subprocess. This metric is not displayed in any automatically generated dashboards. Aux Last Completed Step Instance ID (metric) This is an internal metric to capture the instance ID of the last completed step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Aux Last Completed Step Name (metric) This is an internal metric to capture the name of the last completed step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Aux Last Started Step Instance ID (metric) This is an internal metric to capture the instance ID of the last started step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Aux Last Started Step Name (metric) This is an internal metric to capture the name of the last started step. It has a default value of ‘ ‘ (space). This metric is not displayed in any automatically generated dashboards. Start Time (metric) The start time of the monitored subprocess execution. End time (metric) The end time of the monitored subprocess execution. Total Time (Clock) (metric) The total elapsed time of a subprocess execution. It is calculated from the Start Time and End Time metrics. Tracked Field (metric) A business process defined in the subprocess application or toolkit can have a set of auto-tracked fields defined by the business user. A metric is generated for each auto-tracked field of type String, Decimal, Integer, Date or Boolean. The metric captures the business data of the latest process event that reported this tracked field. If the Tracked Field metric is of data type Boolean, the corresponding metric will be of type String in the monitor model. And if the tracked field is of type Integer, the generated metric type will be Decimal. Otherwise, it will match the type of the auto-tracked field. Step Completed (trigger) This trigger is fired when a step is completed in the monitored subprocess execution. Step Started (trigger) This trigger is fired when a new step is started in the monitored subprocess execution. Steps Active (counter) The number of active steps running in a process. It is incremented when a Start event arrives for a process step and it is decremented when an End event arrives for a subprocess step. Steps Completed (counter) The number of completed steps in a process. The count is incremented when an End event arrives for a subprocess step. Snapshot ID (metric) Captures the snapshot ID (version) of the monitored subprocess. Snapshot Name (metric) Captures the snapshot name of the monitored subprocess. State (metric) Captures the current state of the subprocess step. subprocess_name Steps (one instance for each step execution) This monitoring context is a child of the Subprocess monitoring context.
Step Instance ID (key metric) Key of the monitoring context. It identifies the step execution that is being monitored. Called Process Instance ID (metric) Captures the instance ID of the subprocess that is called by this step. This metric only exists if the subprocess contains a subprocess. Number of Started Instances (metric) Captures the number of parallel instances started by a multi-instance loop activity. Start Time (metric) The start time of the subprocess step. End Time (metric) The end time of the subprocess step. Cost (metric) The cost of running a subprocess step. Captures the value of the associated default tracked field (KPI) Cost in IBM BPM. Resource Cost (metric) The resource cost of running a subprocess step. Captures the value of the associated default tracked field (KPI) Resource Cost in IBM BPM. Labor Cost (metric) The labor cost of running a subprocess step. Captures the value of the associated default tracked field (KPI) Labor Cost in IBM BPM. Total Time (Clock) (metric) The total time of running a subprocess step. Captures the value of the associated default tracked field (KPI) Total Time (Clock) in IBM BPM. Execution Time (Clock) (metric) The execution time of a subprocess step. Captures the value of the associated default tracked field (KPI) Execution Time (Clock) in IBM BPM. Wait Time (Clock) (metric) The wait time of a subprocess step. Captures the value of the associated default tracked field (KPI) Wait Time (Clock) in IBM BPM. Rework (metric) The rework (percent true) of running a subprocess step. Captures the value of the associated default tracked field (KPI) Rework in IBM BPM. Value Add (metric) The value add (percent true) of running a subprocess step. Captures the value of the associated default tracked field (KPI) Value Add in IBM BPM. Step Name (metric) The name of the subprocess step. Potential Performer ID (metric) The user ID of the performer that is assigned to this step. This metric is only populated for steps that are user tasks. Potential Performer Name (metric) A performer (user or group) that is assigned to this step. This metric is only populated for steps that are user tasks. Performer ID (metric) The user ID of the performer who actually works on this step. This metric is only populated for steps that are user tasks. Performer Name (metric) The performer who actually works on this step. This metric is only populated for steps that are user tasks. Snapshot ID (metric) The snapshot ID of the monitored subprocess. Snapshot Name (metric) The snapshot name of the monitored subprocess. State (metric) The current state of the subprocess step. subprocess_name Steps Termination (trigger) This internal trigger is fired to terminate the monitoring context instance 30 days after the last event arrived. auto_tracked_field_name ◇ (metric) Captures the data of an auto-tracked field before the subprocess step is started. This metric is appended with the superscript diamond symbol ◇. auto_tracked_field_name (metric) Captures the data of an auto-tracked field after the subprocess step has completed.
Key Performance Indicators model
A monitor KPI with an aggregation type of Average is generated for each default tracked field (KPI) and for every step defined in the business process (which is eight monitor KPIs for each step). Each monitor KPI includes the following information, which is based on the tracked field (KPI) definition in the process model:
- A low, medium, and high range:
- The low range is from 0 (zero) to the minimum threshold defined in the process model. (If there is no minimum threshold or if it is set to 0, the low range is not generated.)
- The medium range is from the minimum threshold to the maximum threshold.
- The high range is from the maximum threshold to the "maximum threshold plus the medium range".
- A KPI target value that is based on the expected threshold defined in the process model.
These KPIs are automatically added to generated monitor models and are available for selection in the Generate Monitor Model wizard used to generate custom monitor models.
The monitor KPIs are summarized in the following table:
Monitor KPIs Monitor KPI Description step_name Average Cost Calculates the average cost of running the referenced process step. step_name Average Resource Cost Calculates the average resource cost of running the referenced process step. step_name Average Labor Cost Calculates the average labor cost of running the referenced process step. step_name Average Total Time (Clock) Calculates the average total time of running the referenced process step. step_name Average Wait Time (Clock) Calculates the average wait time of the referenced process step. step_name Average Execution Time (Clock) Calculates the average execution time of the referenced process step. step_name Average Rework (percent true) Calculates the average rework percentage of running the referenced process step. The Show as a percentage check box is selected by default. There is no range or target associated with this KPI. step_name Average Value Add (percent true) Calculates the average value add percentage of running the referenced process step. The Show as a percentage check box is selected by default. There is no range or target associated with this KPI. step_name Count Calculate the total number of instances for a particular process step. process_name Average Total Time (Clock) Calculates the average total time of running the referenced process.
Dimensional model
The default measures and dimensions are automatically added to the generated monitor models and are available for selection in the Generate Monitor Model wizard used to generate custom monitor models.
Two dimensions and two cubes are created for each auto-tracked field name. One set of two dimensions and two cubes is created for the value of the metric before the activity starts. Another set of two dimensions and two cubes is created for the value of the metric after the activity completes. The dimensions and measures for the value of the metric before the activity starts are appended with the superscript diamond symbol ◇.
For example:
Average OrderNumber ◇
The cubes and their associated measures and dimensions are described in the following table:
Cubes and associated measures and dimensions Cubes Measures and Dimensions Description process_name This cube is generated from the process monitoring context definition.
Average Steps Active (measure) Captures the average number of active steps in process executions. Average Steps Completed (measure) Captures the average number of completed steps in process executions. Average Total Time (Clock) (measure) Captures the average total time of process executions. Average auto_tracked_field_name (measure) An average measure for each auto-tracked field of data type decimal. auto_tracked_field_name (dimension) A dimension for each auto-tracked field of data type string or dateTime. Start Time (dimension) A dimension for the start time of the monitored process. End Time (dimension) A dimension for the end time of the monitored process. State Dimension (dimension) The current state of the process step. process_name Process Steps This cube is generated from the process steps monitoring context definition.
Average Cost (measure) Captures the average cost of process steps. Average Resource Cost (measure) Captures the average resource cost of process steps. Average Labor Cost (measure) Captures the average labor cost of process steps. Average Total Time (Clock) (measure) Captures the average total time of process steps. Average Execution Time (Clock) (measure) Captures the average execution time of process steps. Average Wait Time (Clock) (measure) Captures the average wait time of process steps. Average Value Add (percent true) (measure) Captures the average value add percentage of process steps. Average Rework (percent true) (measure) Captures the average rework percentage of process steps. Average auto_tracked_field_name (measure) A measure that captures the average of each auto-tracked field of data type decimal. auto_tracked_field_name (dimension) A dimension for each auto-tracked field of data type string or dateTime. Start Time (dimension) A dimension for the start time of process steps. End Time (dimension) A dimension for the end time of process steps. Step Name (dimension) A dimension for the name of process steps. Potential Performer ID (dimension) The user ID of the performer that is assigned to this step. This metric is only populated for steps that are user tasks. Potential Performer Name (dimension) A performer (user or group) that is assigned to this step. This metric is only populated for steps that are user tasks. Performer ID (dimension) The user ID of the performer who actually works on this step. This metric is only populated for steps that are user tasks. Performer Name (dimension) The performer who actually works on this step. This metric is only populated for steps that are user tasks. State Dimension (dimension) The current state of the process step. process_application_name App This cube is generated from the monitoring context definition for a process application.
Average custom_tracked_field_name (measure) An average measure for the last value reported of each tracked field defined in a custom tracking group that has a data type of decimal. Average timing_interval_name (measure) An average measure for the referenced timing interval, which must be defined in the process application or a referenced toolkit. tracked_field_name (dimension) A dimension for the last value reported of each tracked field defined in a custom tracking group that has a data type of string or dateTime. tracking_group_name Events This cube is generated from the monitoring context definition for custom tracking events, which is a child of the monitoring context definition for the process application that defines the corresponding tracking group (as part of the process application itself or in a referenced toolkit).
Time Emitted (dimension) A dimension for the emission time of custom tracking events. custom_tracking_event_name (dimension) A dimension for the name of the received custom tracking events. Average custom_tracked_field_name (measure) An average measure for each custom tracked field of data type decimal. custom_tracked_field_name (dimension) A dimension for each custom tracked field of data type string or dateTime. subprocess_name This cube is generated from the subprocess monitoring context definition. The subprocess cube name is a fully qualified name.
For example, if you have a subprocess in root process 1, the name will be Root Process 1/Subprocess. If you have a nested subprocess, the name can be Root Process/First Subprocess/Second Subprocess.
Average Steps Active (measure) Captures the average number of active steps in subprocess executions. Average Steps Completed (measure) Captures the average number of completed steps in subprocess executions. Average Total Time (Clock) (measure) Captures the average total time of subprocess executions. Average auto_tracked_field_name (measure) An average measure for each auto-tracked field of data type decimal. auto_tracked_field_name (dimension) A dimension for each auto-tracked field of data type string or dateTime. Start Time (dimension) A dimension for the start time of the monitored subprocess. End Time (dimension) A dimension for the end time of the monitored subprocess. State Dimension (dimension) The current state of the subprocess step. subprocess_name Subprocess Steps This cube is generated from the subprocess steps monitoring context definition. The subprocess cube name is a fully qualified name.
For example, if you have a subprocess in root process 1, the name will be Root Process 1/Subprocess Steps. If you have a nested subprocess, the name can be Root Process/First Subprocess/Second Subprocess Steps.
Average Cost (measure) Captures the average cost of subprocess steps. Average Resource Cost (measure) Captures the average resource cost of subprocess steps. Average Labor Cost (measure) Captures the average labor cost of subprocess steps. Average Total Time (Clock) (measure) Captures the average total time of subprocess steps. Average Execution Time (Clock) (measure) Captures the average execution time of subprocess steps. Average Wait Time (Clock) (measure) Captures the average wait time of subprocess steps. Average Value Add (percent true) (measure) Captures the average value add percentage of subprocess steps. Average Rework (percent true) (measure) Captures the average rework percentage of subprocess steps. Average auto_tracked_field_name (measure) A measure that captures the average of each auto-tracked field of data type decimal. Start Time (dimension) A dimension for the start time of subprocess steps. End Time (dimension) A dimension for the end time of subprocess steps. Step Name (dimension) A dimension for the name of subprocess steps. Potential Performer ID (dimension) The user ID of the performer that is assigned to this step. This metric is only populated for steps that are user tasks. Potential Performer Name (dimension) A performer (user or group) that is assigned to this step. This metric is only populated for steps that are user tasks. Performer ID (dimension) The user ID of the performer who actually works on this step. This metric is only populated for steps that are user tasks. Performer Name (dimension) The performer who actually works on this step. This metric is only populated for steps that are user tasks. State Dimension (dimension) The current state of the subprocess step.
Generate monitor models from applications located in the workspace