Navigation Menu: Difference between revisions

Latest revision as of 10:34, 20 September 2024

The navigation menu can be opened by clicking the dashboard or view name in the header. In the beginning of the menu, for a quick access there is a list of all dashboards in the project, where the selected model is located. Also the following functionalities are available in the navigation menu:

Home

The Home view is opened by default when login in QPR ProcessAnalyzer, and it has quick access buttons to the most common functionalities.

Process Discovery

The Process Discovery is a starting point for an analysis to discover and visualize processes. The Chart on the right side allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected. The flowchart on the left shows the process drawn as a conventional process flowchart.

Conformance Checking

Conformance Analysis incorporates the Conformance Checking capability of QPR ProcessAnalyzer. There are two dashboards that belong to the conformance analysis: the nonconformance reasons and the possible root causes for the nonconformance.

Clustering Analysis

Clustering Analysis analyzes through the process mining data, and divides cases into similar groups based on case attributes and occurred types of events. Use it to get a deep understanding of the analyzed process mining data and also to validate the data.

Enhanced BPMN

The Enhanced BPMN dashboard is for designing BPMN diagrams and visualizing process mining KPI's in BPMN diagrams. Also filtering based on conformance and process flow in the BPMN diagram can be created.

Workspace

Project workspace is for managing projects, dashboards, datatables and scripts.

Manage Users

Manage Users dialog is for administrators to manage users, groups, roles and permissions in the system. It's also possible to view the effective permissions for audit purposes.

System Reports

System reports dialog is available for administrators, showing system information, such as recent tasks, running tasks, task statistics, dashboard usage, and listings of different kind of objects in the system. The reports can be modified by changing settings, but the settings cannot be saved.

Benchmark Performance

Benchmark Performance dialog tests how long it takes to run each preset (i.e. get the preset opened), and based on that creates a report of the performance of the system. The performance benchmark is done for the currently open model and filter, so before opening the Benchmark Performance dialog, change a suitable model and filter (usually benchmarking is done for All cases). The benchmark run is started by clicking the Start Run button. When the benchmark run starts, a table appears showing presets as rows and benchmarking measures as columns. You can monitor the progress of the run, because results are filled to the table as soon as they are available.

You can choose which presets to run (by default all) and how many times each preset is run (by default three times). For example, you can choose not to run certain presets to make the benchmarking complete quicker, or if for some reason, certain presets give error, they can be excluded. Running each preset more times give more predictable result, but on the other hand, the run takes longer.

When the benchmark run is completed, you can click the Export Results button to download a report (provided as a text file). The report contains the run results and also basic information about the system and the used model. The results show for each preset the average, median, minimum (fastest), maximum (slowest), standard deviation of the results, and a list of each individual run duration. In addition the footer shows sum of the measures for all run presets. You can stop the benchmarking run while in progress by clicking the Stop Run button and still export a report of already run presets. Note also that the table can be exported to Excel by right clicking it to open a context menu.

Notes:

Load to the system by other users may affect the benchmark results, so to get the most accurate results, check from the Task log that there are currently no other users in the system.
Presets are run in a random order to reduce random variation in the results.

Query Designer

Query Designer is for testing QPR ProcessAnalyzer KPI language queries that contain

root expression to select objects to be analysed
dimension expressions to slice the analyzed object into slices
measure expressions to calculate KPI's and other measures from each of the slices
data can also be sorted and number of rows limited

The expressions are written in the left side using a JSON format. When the Run Query button is clicked, the defined query is run and results appear to a table in the right side. Details of the JSON format can be found in QPR ProcessAnalyzer Expression Analysis.

Expression Designer

Expression Designer is used to run expressions in a generic context. Write the expressions in the upper box and the results appear in the lower box. When clicking the Run All button, all expressions in the upper box are run. It's also possible to select parts of the expression and click the Run Selection button to only run the selected parts. If there are errors in the run, cursor is automatically moved to the point where the error occurred.

User Settings

Sign out

The user session can be signed out, which also clears all cached information in the browser side. When using a personal computer, signing out is normally not needed from the security point of view, but if there are other users in the same computer, it's important to sign out after using the system.

When using QPR ProcessAnalyzer as Snowflake Native App, also the Snowflake session is logged out when pressing the Sign out.

@@ Line 1: / Line 1: @@
-== Setup Instructions ==
+The navigation menu can be opened by clicking the dashboard or view name in the header. In the beginning of the menu, for a quick access there is a list of all dashboards in the project, where the selected model is located. Also the following functionalities are available in the navigation menu:
-# The QPR ProcessAnalyzer Deployment Package supports QPR UI versions starting from 2018.4, so check that you are running a new enough QPR UI version.
-# As most of the views in the deployment package need the In-Memory processing, [[Installing_QPR_ProcessAnalyzer_Server#Configure_Web_Service_to_use_In-Memory_or_In-Database_processing|make sure In-Memory processing is enabled]] in the QPR ProcessAnalyzer service you are using.
-# [https://files.qpr.com/releases/PADeploymentPackage/QPRPADeploymentPackageV001.zip Download the QPR ProcessAnalyzer Deployment Package from here], and extract the contents in the package to a temporary folder.
-# Copy the '''PASolution''' folder from the temporary folder to the '''wwwroot''' folder of your IIS. Alternatively, if you didn't route QPR UI traffic through IIS, copy the folder to the <QPR UI Installation folder>\Glassfish\glassfish\domains\domain1\docroot (e.g. "C:\Program Files\QPR Software Plc\QPR UI\Glassfish\glassfish\domains\domain1\docroot").
-# Log in to QPR UI.
-# Switch to '''My Workspace''' and import the views from the temporary folder into your QPR UI.
-# Lock all views.
-# Publish at least the "QPR ProcessAnalyzer Frontpage" view.
-== QPR ProcessAnalyzer - Frontpage ==
+=== Home ===
-This view contains links to all the other QPR ProcessAnalyzer Deployment Package views. It's advisable to publish this view, so all users have access to it.
+The Home view is opened by default when login in QPR ProcessAnalyzer, and it has quick access buttons to the most common functionalities.
-=== Images Used in the View ===
+=== Process Discovery ===
-* The '''view background''' image is "FrontPageBackground.png" that is found in the "PASolution" folder. To change the image, either replace the "FrontPageBackground.png" image with your desired image, or place your own image to the "PASolution" folder, go to the View Properties' Presentation tab, and change the image link to point to the name of your own image.
+The Process Discovery is a starting point for an analysis to discover and visualize processes. The [[QPR ProcessAnalyzer Chart|Chart]] on the right side allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected. The [[Process Flowchart|flowchart]] on the left shows the process drawn as a conventional process flowchart.
-* The '''QPR Logo''' image is "QPR_logo_slogan_color_300dpi.jpg" that is found in the "PASolution" folder. To change the image, either replace the "QPR_logo_slogan_color_300dpi.jpg" image with your desired image, or place your own image to the "PASolution" folder, go to the "Content panel" > "QPR Logo" HTML presentation object Properties' Presentation tab, and change the image link to point to the name of your own image.
+=== Conformance Checking ===
+[[Conformance Analysis]] incorporates the [[Conformance Checking|Conformance Checking]] capability of QPR ProcessAnalyzer. There are two dashboards that belong to the conformance analysis: the nonconformance reasons and the possible root causes for the nonconformance.
-=== Menu Buttons ===
+=== Clustering Analysis ===
-The menu buttons act as links to the different analysis views in the QPR ProcessAnalyzer Deployment Package by setting the needed value for the "sys:dashboardIdentifier" context variable. The menu buttons are placed in the "Content panel" > "Menu Buttons" HTML presentation object. Each individual button is in its own div, so you can edit or remove them easily.
+[[Clustering Analysis]] analyzes through the process mining data, and divides cases into similar groups based on case attributes and occurred types of events. Use it to get a deep understanding of the analyzed process mining data and also to validate the data.
-== QPR ProcessAnalyzer ==
+=== Enhanced BPMN ===
-This is a plain [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)|QPR ProcessAnalyzer]] view for process discovery.
+The [[QPR_ProcessAnalyzer_BPMN_Editor|Enhanced BPMN]] dashboard is for designing BPMN diagrams and visualizing process mining KPI's in BPMN diagrams. Also filtering based on conformance and process flow in the BPMN diagram can be created.
-== QPR ProcessAnalyzer - Conformance View ==
+=== Workspace ===
-This view incorporates the [[Conformance Checking in QPR ProcessAnalyzer]] capability of QPR ProcessAnalyzer.
+[[QPR_ProcessAnalyzer_Project_Workspace|Project workspace]] is for managing projects, dashboards, datatables and scripts.
-== QPR ProcessAnalyzer - ChartView ==
+=== Manage Users ===
-The ChartView allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected. If you edit this view, make sure that the ChartView panel is placed on top of the QPR ProcessAnalyzer panel (you can do this by having the ChartView panel the last panel that you have moved), so that the BPMN editor is shown correctly.
+[[Manage_Users_and_Groups|Manage Users dialog]] is for administrators to manage users, groups, roles and permissions in the system. It's also possible to view the effective permissions for audit purposes.
-== QPR ProcessAnalyzer - KPI Analysis Tester ==
+=== System Reports ===
-This view is an example of the [[HTML_Presentation_Object:_QPR_ProcessAnalyzer_KPI_Analysis_Tester|KPI Analysis Tester]].
+System reports dialog is available for administrators, showing system information, such as recent tasks, running tasks, task statistics, dashboard usage, and listings of different kind of objects in the system. The reports can be modified by changing settings, but the settings cannot be saved.
-== QPR ProcessAnalyzer - Change Password ==
+=== Benchmark Performance ===
-This view allows the currently logged in user to change his password.
+Benchmark Performance dialog tests how long it takes to run each preset (i.e. get the preset opened), and based on that creates a report of the performance of the system. The performance benchmark is done for the currently open model and filter, so before opening the Benchmark Performance dialog, change a suitable model and filter (usually benchmarking is done for ''All cases''). The benchmark run is started by clicking the '''Start Run''' button. When the benchmark run starts, a table appears showing presets as rows and benchmarking measures as columns. You can monitor the progress of the run, because results are filled to the table as soon as they are available.
-== QPR ProcessAnalyzer - Data Import ==
+You can choose which presets to run (by default all) and how many times each preset is run (by default three times). For example, you can choose not to run certain presets to make the benchmarking complete quicker, or if for some reason, certain presets give error, they can be excluded. Running each preset more times give more predictable result, but on the other hand, the run takes longer.
-This view is used to import data into the QPR ProcessAnalyzer service (direct database import is not supported). Note that you need to have sufficient rights to import data to the QPR ProcessAnalyzer service in order to use this view.
-=== Import File ===
+When the benchmark run is completed, you can click the '''Export Results''' button to download a report (provided as a text file). The report contains the run results and also basic information about the system and the used model. The results show for each preset the average, median, minimum (fastest), maximum (slowest), standard deviation of the results, and a list of each individual run duration. In addition the footer shows sum of the measures for all run presets. You can stop the benchmarking run while in progress by clicking the '''Stop Run''' button and still export a report of already run presets. Note also that the table can be exported to Excel by right clicking it to open a context menu.
-You can choose whether to import:
-* '''cases''' or '''case attributes'''
-* '''events''' or '''event attributes'''
-* '''.xes''' or '''.pacm''' file.
-With cases or case attributes and events or event attributes, the data import supports .csv files. A .xes or a .pacm file will contain both case and event data.<br>
-=== File Format ===
+Notes:
-Here you should define in what format the data is in the import file:
+* Load to the system by other users may affect the benchmark results, so to get the most accurate results, check from the [[QPR_ProcessAnalyzer_Logs#Task_Log|Task log]] that there are currently no other users in the system.
-* '''Column delimiter''': semicolon, tab or specified in the "other" field
+* Presets are run in a random order to reduce random variation in the results.
-* '''Date format''' (only used for the start time field): Specified in the "Date Format" field. Default format is: "yyyy-MM-dd HH:mm:ss,fff", where dd = zero-padded day of the month, from 01 through 31; MM = zero-padded month, from 01 through 12; yyyy = year as a four-digit number; HH = zero padded hour, using a 24-hour clock from 00 to 23; mm = zero-padded minute, from 00 through 59; ss = second, from 00 through 59; fff = millisecond.
-* '''Text qualifier''': Specified in the "Text qualifier" field
-* '''Header row number''': the row in the file that is to be used as the header row for the data.
-=== Import Destination ===
+=== Query Designer ===
-Three types of destinations are supported:
+Query Designer is for testing QPR ProcessAnalyzer KPI language queries that contain
-* '''New model to an existing project''': you can select the project to which the new model is to be created. You can also define the name of the new model.
+* root expression to select objects to be analysed
-* '''New model to a new project''': you can define the name of the new project and new model. Note that currently you can't define different names for the new project and the new model.
+* dimension expressions to slice the analyzed object into slices
-* '''Existing model''': you can select the project and model to which the data is to be created. You can click the '''Open''' button to check the model that is currently selected.
+* measure expressions to calculate KPI's and other measures from each of the slices
+* data can also be sorted and number of rows limited
-== QPR ProcessAnalyzer - ModelManager ==
+The expressions are written in the left side using a JSON format. When the '''Run Query''' button is clicked, the defined query is run and results appear to a table in the right side. Details of the JSON format can be found in [[Web_API:_Expression/query|QPR ProcessAnalyzer Expression Analysis]].
-This view is intended for use by an administrator. Using this view requires that the QPR UI installation and the QPR ProcessAnalyzer service it uses reside in the same domain. The view enables the administrator to control which QPR ProcessAnalyzer models are loaded in memory for in-memory processing at the service. It is advisable not to publish this view.
+=== Expression Designer ===
+Expression Designer is used to run expressions in a generic context. Write the expressions in the upper box and the results appear in the lower box. When clicking the '''Run All''' button, all expressions in the upper box are run. It's also possible to select parts of the expression and click the '''Run Selection''' button to only run the selected parts. If there are errors in the run, cursor is automatically moved to the point where the error occurred.
-[[Category: QPR UI Solutions]]
+=== [[User_Settings|User Settings]] ===
+=== Sign out ===
+The user session can be signed out, which also clears all cached information in the browser side. When using a personal computer, signing out is normally not needed from the security point of view, but if there are other users in the same computer, it's important to sign out after using the system.
+When using QPR ProcessAnalyzer as Snowflake Native App, also the Snowflake session is logged out when pressing the ''Sign out''.
+__NOTOC__
+[[Category: QPR ProcessAnalyzer]]