QPR ProcessAnalyzer Presentation Object (PAPO)

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search

QPR ProcessAnalyzer Presentation Object (or PAPO) is a generic presentation object designed for process mining analysts, as it contains most analysis functionality in QPR ProcessAnalyzer in one place. It's possible to change between analyses using PAPO's context menu.

Basics: Control Window and Analysis Window

The ProcessAnalyzer presentation object is divided into two parts: the Control Window on the left and the Analysis Window on the right:

PAPO.png

The two windows are separated by a vertical splitter, which can be dragged to give more space to either window. Clicking the splitter will collapse it to the right, from where it can be expanded by clicking it again.

Control Window presents information using the currently active filter. When clicking analysis items in the Control Window, you are making selections which are reflected in the Analysis Window. Thus, the Analysis Window shows information based on the currently active filter and the selections made in the Control window. In both windows, you can add new filter rules as follows: select the items to be added to the filter and in the popup menu select Include Only Cases, Exclude Cases, Include Only Event Types or Exclude Event Types. The event types filters are available only when selecting event types (possible in the Flowchart Analysis and Event Types Analysis). When new filter rules are added, a new filter is created (containing rules from the previous filter and the new filter rules).

By default, Control Window shows the Flowchart Analysis and Analysis Window shows the Profiling Case Analysis. To change the type of analysis used in the Control Window and in the Analysis Window, right-click in the window background and in the opening popup menu, select Change Analysis and then the desired analysis. The Control Window has the following analyses: Duration Analysis, Flowchart Analysis, Profiling Case Analysis, Profiling Event Analysis and Variation Analysis. The Analysis Window contains all available analyses except the Flowchart Analysis.

Selections in the Control Window either filter the analysis in the Analysis Window (all analyses except the Influence Analyses) or then the selection works as a bases for the comparison in the Influence Analysis (Influence Analysis for Case Attributes and Influence Analysis for Flowchart).

QPR ProcessAnalyzer Analyses in PAPO

PAPO includes the following analyses:

Adding PAPO to View

  1. Add a new PAPO to a panel by clicking the QPR ProcessAnalyzer Presentation Object button on the side toolbar.
  2. By default, PAPO shows the Flowchart Analysis based on the default filter for the user. To change this, the FilterId context variable needs to be defined. We'll define the FilterId in the View context, so that it will be available when the view is opened. First, click Close to close the panel.
  3. The View context is accessible in the View properties. Click the Properties button and then switch to the Context tab.
  4. Type in "FilterId" to the Variable name text box and then click the check mark.
  5. Tap the Value section on the FilterId row and input the desired FilterId value there, and then tap the check mark. The Behavior can be left as "Default", so that if the FilterId value is changed in the session context, the flowchart will update accordingly.
    You can also define some additional context variable values that are used by the QPR ProcessAnalyzer Presentation Object. After you are done, tap Close to apply the changes.
  6. Click the Save button on the toolbar on top to save the view. Saving a view will also save any unsaved changes to the panels in the view.
    PAPOTutorial.png

Configuration Tab

On PAPO's Configuration tab, you can define the PAPO's variables to be used. The context variable definitions here are used to override the default settings in the PAPO. The definition is done as JSON.

As an example, to have the PAPO function as a KPI Analysis, and to disable the control window, changing analysis, and creating new filters functionalities, use the following JSON:

{
  "AnalysisWindowType": "11",
  "DisabledFunctionalities": [
    "controlwindow",
    "changeanalysis",
    "createnewfilters"
  ],
  "ContextVariableOverrideMode": "UnspecifiedOnly"
}

Variables used by PAPO

The below listed context variables are used by PAPO. PAPO sets these context variables automatically to the session context when the settings are changed in PAPO. PAPO also uses the effective values of these context variables and presents PAPO according to them.

Installation step Description
AttributeTypeId Selected attribute type id in Profiling Cases Analysis.
AnalysisWindowOpen Defines whether the Analysis Window is open. Value 1 is for open and value 0 for closed.
AnalysisWindowSize Width of the Analysis Window as percentage (number between 0 and 100). For example 0 means that the Analysis window is not visible (only Control Window is visible) and 100 means that the Analysis Window uses all space (Control Window is not visible). Note that when PAPO width is small, due to rounding, the value may not reach the extreme values (0 or 100) but a value close to that.
AnalysisWindowType

Analysis shown in the Analysis Window. Possible values:

  • 0 = Profiling Case Analysis
  • 1 = Influence Analysis for Flowchart
  • 2 = Variation Analysis
  • 3 = Duration Analysis
  • 4 = Influence Analysis for Case Attributes
  • 5 = Case Analysis
  • 6 = Event Analysis
  • 7 = Event Type Analysis
  • 10 = Profiling Event Analysis
  • 11 = KPI Analysis
CasesCaseAttributeTypeIds Id of a case attribute type of the case attribute to be added to the Case Analysis. Default value is "0", meaning no case attribute will be added to the analysis.
CasesEventAttributeTypeIds Id of an event attribute type of the event type attribute to be added to the Case Analysis. Default value is "0", meaning no event type attribute will be added to the analysis.
CasesEventTypeCounts Id of an event type for which the event type count is added to the Case Analysis. Default value is "0", meaning event type counts are not added to the analysis.
CasesMaximumCount The maximum number of rows, i.e. cases, shown in the Case Analysis. Default value is "1000".
CasesShowDurations

A value defining which duration groups to be added to the Case Analysis. Possible values corresponding to the duration groups:

  • 0 = No duration groups added (default)
  • 1 = Second
  • 2 = Minute
  • 4 = Hour
  • 8 = Day
  • 10 = Week
  • 20 = Month
  • 40 = Quarter
  • 80 = Year

To add multiple groups, sum the values. For example, a value of "38" would add the Month (20), Week (10), and Day (8) duration groups to the analysis.

CasesShowEnds

A value defining the case end groups to be added to the Case Analysis. Possible values corresponding to the case end groups:

  • 0 = No case end groups added (default)
  • 1 = Weekday
  • 2 = Month
  • 4 = Year

To add multiple groups, sum the values. For example, a value of "3" would add the Month (2) and Weekday (1) case end groups to the analysis.

CasesShowEventTypeString A boolean value defining whether to add the event type string of the variation the case belongs to in the Case Analysis. Default value is 0 (false).
CasesShowStarts

A value defining the case start groups to be added to the Case Analysis. Possible values corresponding to the case start groups:

  • 0 = No case start groups added (default)
  • 1 = Weekday
  • 2 = Month
  • 4 = Year

To add multiple groups, sum the values. For example, a value of "3" would add the Month (2) and Weekday (1) case start groups to the analysis.

CasesShowVariationIds A boolean value defining whether to add the variation id of each case in the Case Analysis. Default value is 0 (false).
ContextVariablePrefix A prefix used to distinguish the settings for different QPR ProcessAnalyzer Presentation Objects in the view. If you wish to have multiple QPR ProcessAnalyzer Presentation Objects in the same view, set a value for this context variable for the other QPR ProcessAnalyzer Presentation Object. That way, Settings defined in the other QPR ProcessAnalyzer Presentation Object are not taken into use in the QPR ProcessAnalyzer Presentation Object that has this context variable defined.
ContextVariableOverrideMode Defines if and how context variable values of the QPR ProcessAnalyzer Presentation Object can be overridden by user interface controls, such as the Popup Menu. Possible values are:
  • Allow: it's possible to change the context variable values.
  • Never: it's not possible to change any of the context variable values, not even those that are not defined in the Configuration tab.
  • UnspecifiedOnly: it's possible to change only those context variable values that are not defined in the Configuration tab.
ControlWindowType
  • 3 = Duration Analysis
  • 1 = Flowchart Analysis
  • 0 = Profiling Case Analysis
  • 10 = Profiling Event Analysis
  • 2 = Variation Analysis
CostsMode How to aggregate shown costs in Flowchart Analysis. Possible values are Total (default) or Average.
DiagramZoom Zoom level for the flowchart (default is 100) in Flowchart Analysis.
DisabledFunctionalities

Disabled functions in PAPO defined as a JSON array. Possible items are:

  • controlwindow: Disables the Control Window, i.e. only the Analysis window is visible (splitter is not used).
  • analysiswindow: Disables the Analysis Window, i.e. only the Control window is visible (splitter is not used).
  • settingsbutton: Disables the Settings buttons for all analyses in both Control and Analysis Windows.
  • infobutton: Disables the Info button.
  • modelbutton: Disables the Model button.
  • changeanalysis: Prevents the users from switching between analyses using the popup menu.
  • createnewfilters: Prevents the users from creating new filter rules in PAPO popup menu and from removing filter rules.

For example, the following array will disable the Analysis Window, disable the Settings button, and prevent users from creating new filters:

["analysiswindow", "settingsbutton", "createnewfilters"]
DurationVisualizationMode Defines whether to show the Duration Analysis as a table or chart. Possible values are table and columnchart.
EnableTableExporting Enables exporting of all tables to Microsoft Excel, Microsoft Word and PDF files. Exporting buttons are available in the context menu. In addition, the Data Grid Export Service needs to be installed. Value 1 enables exporting and 0 (default) disables exporting.
EventAttributeTypeId Id of the event attribute selected in Profiling Event Analysis.
EventsEventAttributeTypeIds A comma-separated list of event attribute type ids of the event attributes shown in the Event Analysis. Default value is 0, i.e. no event attributes shown in the analysis. A value of "*" will add all event attributes to the analysis.
EventsMaximumCount The maximum amount of rows to show in the Event Analysis.
EventTypesMaximumCount The maximum amount of rows to show in Event Type Analysis. Value 0 shows all rows.
EventTypesShowRelativeStart Boolean value defining whether to show the Relative Start and Relative Start Standard Deviation columns in Event Type Analysis.
EventTypesVisibilityThreshold
ExpressionAnalysisPresentation KPI Analysis settings for visualization type and number of decimals.
ExpressionAnalysisQuery KPI Analysis settings to determine shown data (measures and dimensions).
FilterId QPR ProcessAnalyzer filter id based on which the contents in QPR ProcessAnalyzer Presentation Object are currently shown. (default=0)
FlowsDurationMode Aggregation function used for shown flow durations in Flowchart Analysis. Possible values are Average, Median (default) or AverageWeighted.
FlowsVisibilityThreshold
GraphDirection Should the flowchart be drawn horizontally from left to right (=1) or vertically from up to down (=0) (default) in Flowchart Analysis.
GraphLayoutType Layout algorithm used for flowchart graph in Flowchart Analysis. Possible values are grid, tree, forceDirected, layeredDigraph (default), circular and radial.
InfluenceAttributeTypeId
InfluenceMaximumCount The number of most and least contributing rows to show in Influence Analysis for Case Attributes (corresponds with the "Show" setting).
InfluenceMaximumCount
InfluenceShowDetails
InfluenceWeightedByCaseValue
LeftPanelPage The identifier of the page shown in the settings panel. Possible values are info (default), settings and layout.
MaximumDuration In Duration Analysis, defines the maximum number of different durations shown.
ProfilingEventMaximumCount In Profiling Event Analysis, defines the number of the most common attribute values to show +1 (for the "Others" slice). For example, if you define the value as "4", the Profiling Event Analysis will show the four most common attribute values as their own slices and the "Others" group as one additional slice.
ProfilingMaximumCount In Profiling Case Analysis, defines the number of the most common attribute values to show +1 (for the "Others" slice). For example, if you define the value as "4", the Profiling Case Analysis will show the four most common attribute values as their own slices and the "Others" group as one additional slice.
ProfilingVisualizationMode Defines whether to show the Profiling Analysis as a table or a pie chart. Possible values are "table" and "piechart".
RadialLayers Number of radial layers to show in the radial layout (default=2).
ScrollPosition The "X,Y" coordinates of the flowchart's "START" element's scrolling position, the top-left corner of the ProcessAnalyzer Presentation Object being the 0 point.
Selected<case attribute name> Case attribute value selected for given case attribute.
Selected<event attribute name> Event attribute value selected for given event attribute.
SelectedActivities Comma separated list of event type ids representing the current selection in the flowchart.
SelectedCaseAttributeValues The case attribute values selected in the Profiling Case Analysis shown on the Control window. The format is <case attribute type id>,<attribute value>.
SelectedCounts Comma separated list of ids of event type counts representing the current selection in the variation analysis.
SelectedDurationGranularity The selected time period in the Duration analysis shown by the Group By list. Value is defined as seconds. Possible values are:
  • 1 = Second
  • 60 = Minute
  • 3600 = Hour
  • 86400 = Day
  • 604800 = Week
  • 2629800 = Month
  • 7889400 = Quarter
  • 31557600 = Year
SelectedDurations The selected durations in the Duration analysis, separated by commas.
SelectedEventAttributeValues The event attribute values selected in the Profiling Event Analysis shown on the Control window. The format is <event attribute type id>,<attribute value>.
SelectedTransitions Comma separated list of flow ids representing the current selection in the flowchart.
SelectedVariations Comma separated ids of variation ids representing the current selection in the variation analysis.
ShowEventTypesAmount Should the number of occurrences together with the occurrence percentages within all the cases be displayed for every event type in the flowchart (0 or 1, default=1).
ShowEventTypesCost Should the accumulated event type cost values be displayed for every event type in the flowchart (0 or 1, default=0).
ShowFlowsAmount Should the number of occurrences together with the occurrence percentages within all the cases be displayed for every flow in the flowchart (0 or 1, default=1).
ShowFlowsCost Should the accumulated event type cost values be displayed for every flow in the flowchart (0 or 1, default=0).
ShowFlowsDuration Should the average or median duration be displayed for every flow in the flowchart (0 or 1, default=0).
ShowLeftPanel Should the settings panel be locked open (=1) or not (=0/default).
ShowRightPanel Should the filter panel be locked open (=1) or not (=0/default).
UniqueOnly Setting whether the information shown in flowchart is shown in unique only (=1) (default) or all occurrences (=0) mode.
VariationsGroupBy Defines how to group the variations in Variation Analysis. Supported values are 0 (default) meaning that each separate variation is shown per row and 1 meaning that one row for the amount of events in an event type in the variations.
VariationsMaximumCount Defines the limit to the number of shown variations in Variation Analysis.
VariationsShowOthers Boolean value (0 or 1) defining whether to group other variations into a single one when the limit set in VariationsMaximumCount is reached in Variation Analysis.

PAPO Usage Examples

Defining Model

To change the model and filter:

  1. Click the Model button:
    PAPOModelButton.png
  2. Select the model and filter from the two drop-down menus shown:
    PAPOModelAndFilter.png
    The names of the models are shown as <project name> - <model name>.

Defining Default Filter for the Analysis

By default, QPR ProcessAnalyzer Presentation Object will show analyses based on the default filter for the user. To change this, the FilterId variable needs to be set as follows:

  1. In the View editor, click the Properties button to open the View properties.
  2. Type in FilterId to the Variable name text box and click the check mark or press Enter:
    ContextVariableName.png
  3. Click the Pen icon on the Value column, type in the filter id you want and click the check mark or press Enter:
    ContextVariableValue.png
  4. You should now have the FilterId variable defined:
    ContextVariableDefined.png