Viewing Activity and Process Instances categorized by Priorities

To get an overview over the number and status of activity instances and process instances, open the Process Manager in the Control Center Perspective.

Process Manager View
Figure: Process Manager View

Priority Overview

The Priority Overview displays the numbers of instances per process definition categorized by priorities. All processes are taken in account, which the logged-in user has the declarative security permission Read Process Instance Data for. This permission is defined for the process definition in the modeler. Please refer to section Authorization of chapter Working with Process Definitions in the Business Process Modeling Handbook for detailed information on the Read Process Instance Data permission.

The list contains the following entries:

The list of activity and process instances according to priorities is subdivided in Total Count, listing all instances, and Critical Count, listing the critical instances. The section Criticality describes how criticality is defined for activity and process instances.

Expand the process definition entries to open new table rows representing the activities instances.

Tooltips for Descriptions

Tooltips for model descriptions

If the Description is added in the Properties page for the model in modeler, then it is displayed as tooltip text in the portal when you hover the mouse over the model name.

Model Tooltip Text
Figure: Tooltip Text of a Model

Tooltips for process descriptions

If the Description is added in the Properties page for the process in modeler, then it is displayed as tooltip text in the portal when you hover the mouse over the process name.

Process Tooltip Text
Figure: Tooltip Text of a Process

Tooltips for activity descriptions

If the Description is added in the Properties page for the activity in modeler, then it is displayed as tooltip text in the portal when you hover the mouse over the activity name.

Activity Tooltip Text
Figure: Tooltip Text of an Activity

Status

The status shows the criticality in terms of traffic light colors, whereby the colors have the following meaning:

The target processing time is the Target Processing Time property set during the modeling process for the activity or process instance. This property can be set as controlling parameter for the process definition. For details on this property refer to chapter Working with Process Definitions of the Infinity Process Platform Documentation - Developer Modeling Guide. Working with Process Definitions in the Developer Modeling Guide.

Controlling the displayed Priority state

To control the displayed priority state, assign a valid class name (including the package name) that implements the org.eclipse.stardust.ui.web.bcc.jsf.IThresholdProvider interface to the property Carnot.Threshold.Provider. Set this property in your carnot.properties file, residing in the ipp-resources folder of your dynamic Web project or the WEB-INF/classes folder in the Control Center WAR file accordingly, e.g.:

Carnot.Threshold.Provider = org.eclipse.stardust.example.MyThresholdProvider

The org.eclipse.stardust.ui.web.bcc.jsf.IThresholdProvider interface to be implemented provides the following code:

package org.eclipse.stardust.ui.web.bcc.jsf;

public interface IThresholdProvider
{
   /** State for hidden traffic light 
   **/
   final static int UNDEFINED_THRESHOLD_STATE = -1;
   /** State for red traffic light 
   **/
   final static int CRITICAL_THRESHOLD_STATE = 1;
   /** State for yellow traffic light 
   **/
   final static int WARNING_THRESHOLD_STATE = 2;
   /** State for green traffic light 
   **/
   final static int NO_THRESHOLD_STATE = 3;
   
   /** Gets the threshold state of a given process definition.
    *  This method is called in the priority overview table.
    *  @param pdwp Process definition with all priorities
    *  @return one of the state
    *  @see UNDEFINED_THRESHOLD_STATE, CRITICAL_THRESHOLD_STATE, 
    *        WARNING_THRESHOLD_STATE, NO_THRESHOLD_STATE
   **/
   int getProcessThreshold(ProcessDefinitionWithPrio pdwp);
   
   /** Gets the threshold state of a given activity.
    *  This method is called in the priority overview table.
    *  @param adwp Activity with all priorities
    *  @return one of the state
    *  @see UNDEFINED_THRESHOLD_STATE, CRITICAL_THRESHOLD_STATE, 
    *        WARNING_THRESHOLD_STATE, NO_THRESHOLD_STATE
   **/
   int getActivityThreshold(ActivityDefinitionWithPrio adwp);
}

The default implementation is the following:

package org.eclipse.stardust.ui.web.bcc.jsf;

import org.eclipse.stardust.ui.web.bcc.jsf.PriorityOverviewEntry.Priorities;


public class ThresholdProvider implements IThresholdProvider
{

   private int getThreshold(Priorities priorities)
   {
      int thresholdState = priorities.getLowPriority() + 
         priorities.getNormalPriority() > 0 ? 
            WARNING_THRESHOLD_STATE : NO_THRESHOLD_STATE;
      return priorities.getHighPriority() > 0 ?
         CRITICAL_THRESHOLD_STATE : thresholdState;
   }
   
   public int getActivityThreshold(ActivityDefinitionWithPrio adwp)
   {
      return getThreshold(adwp.getCriticalPriorities());
   }

   public int getProcessThreshold(ProcessDefinitionWithPrio pdwp)
   {
      return getThreshold(pdwp.getCriticalPriorities());
   }

}

Interrupted Instances

The count of interrupted processes is displayed to access and restart according activity instances. You can view the specific interrupted process and activity instances by clicking on the count that is greater than zero.

Interrupted State
Figure: Interrupted Instances displayed in the table

Criticality

Whether a process or an activity instance becomes critical will be decided based on global percentage thresholds (p1, p2, p3) of the target execution time. This is obtained via an algorithm specified based on the process duration and the priority:

Whereby the global percentage threshold is determined via the property Carnot.Critical.Duration.Threshold in your carnot.properties file, residing in in the ipp-resources folder of your dynamic Web project or the WEB-INF/classes folder in the Control Center WAR file accordingly. You can granulate this property according to the priority by using Carnot.Critical.Duration.Threshold.x for priority value x. For example:

Carnot.Critical.Duration.Threshold.1 = 1.25
Carnot.Critical.Duration.Threshold.0 = 1.5
Carnot.Critical.Duration.Threshold.-1 = 2.0

The target execution time is the Target Execution Time property set during the modeling process for the process instance. This property can be set as controlling parameter for the process definition. For details on this property refer to chapter Working with Process Definitions of the Infinity Process Platform Documentation - Developer Modeling Guide. Working with Process Definitions in the Developer Modeling Guide.

Order of Displayed Activities

Per default, the activities are displayed in the order the transition graph is created in the model. This means, for a process with a linear activity-transition graph, the activities are displayed in the sequence of activities. For a graph with parallel threads, the order is one thread after the other.

In case you like to change that default behavior, add the property Infinity.Engine.Process.SortActivitiesInTransitionOrder to your carnot.properties file with the value false. The activities will then be ordered by the creation order of the activities in the modeler.

Showing and Hiding Auxiliary Processes

Per default, process definitions that are not business relevant are not displayed in the Priority Overview table. These processes are marked as "Is Auxiliary Process" in the modeler. Please refer to chapter Working with Process Definitions of the Infinity Process Platform Documentation - Modeling Guide Working with Process Definitions of the Modeling Guide for details.

To switch to show or hide auxiliary processes in the table, click the Show / Hide Auxiliary Process icon / in the toolbar.

Showing and Hiding Auxiliary Activities

You can show or hide the activities that are marked as "Is Auxiliary Activity" in the modeler. Please refer to chapter Specifying Activities of the Infinity Process Platform Documentation - Modeling Guide Specifying Activities of the Modeling Guide for details.

To view auxiliary activities in the table, click the Show Auxiliary Activities icon in the toolbar.

Viewing Selected Processes

To represent a process instance result set, click on a the process drill-down link. The corresponding processes table is displayed in the lower part of the screen:

Selected Process Instances
Figure: Selected Processes

This section lists details about the process instance and case process instance.

For a detailed description on the columns and functionality of the process table in general, refer to chapter Working with Process Tables.

Note that the Selected Processes pane displays case process instances, if you click on the count of one of the case process. For detail information on case process instance, please refer to the Case Details View.

Viewing Selected Activity Instances

To represent an activity instance result set, click on a the activity drill-down link. The corresponding activity instance table will be displayed in the lower part of the screen.

Selected Activity Instances
Figure: Selected Activity Instances

Please note that only activities are displayed, which the logged-in user has the declarative security permission Read Process Instance Data and Read Activity Instance Data for. These permissions are defined in the modeler for the process definition and the activity accordingly. Please refer to section Authorization of chapter Specifying Activity Properties and section Authorization of chapter Working with Process Definitions in the Business Process Modeling Handbook for detailed information on the Read Activity Instance Data and Read Process Instance Data permissions accordingly.

For detailed information on an activity instance, click on the name to open the appropriate Viewing Process Details view.

For a detailed description on the columns and functionality of the activity table, refer to chapter Activity Tables.