Navigation Menu: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(44 intermediate revisions by the same user not shown)
Line 1: Line 1:
QPR ProcessAnalyzer Deployment Package is an essential part of QPR ProcessAnalyzer that brings the latest user interface for QPR ProcessAnalyzer.
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:
 
== Installation ==
<div class="downloadButton" style="width:250px;float:right;margin:15px 20px 0px 30px;">[[QPR_Product_Downloads#QPR_ProcessAnalyzer_Deployment_Package|Download<br />Deployment Package]]</div>
 
NOTE: Starting from QPR ProcessAnalyzer 2020.4 the deployment package is not needed, and thus these instructions are not valid.
 
# Download the QPR ProcessAnalyzer Deployment Package using the link on the right and extract the package contents. Note that the deployment package version need to be same as your QPR ProcessAnalyzer version.
# Delete the possible previous versions of the deployment package views.
# Go to the [[QPR_UI_Folders|Workspace]] and create a folder '''QPR ProcessAnalyzer UI''' (if doesn't already exist).
# If creating the folder at this time, give the '''Viewer''' role to this folder for all users in QPR ProcessAnalyzer Excel Client [[Manage_Users_and_Groups_in_QPR_ProcessAnalyzer|user management]]. This is preferably done by creating a new user group for which to give the Viewer role, and then assign all users to that group.
# Open the created folder and import the views to the folder one by one by clicking '''New''' > '''Import''' and browsing the .qprpa file.
 
== QPR ProcessAnalyzer UI Views ==
This chapter introduces all the views that are in QPR ProcessAnalyzer UI.


=== Home ===
=== Home ===
The Home page contains buttons to open all views in QPR ProcessAnalyzer UI. Note that the view name of the Home page is ''QPR ProcessAnalyzer''.
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 ===
=== Process Discovery ===
This [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)|QPR ProcessAnalyzer]] view is for analysts to discover and analyze processes. The [[ChartView]] on the left side allows the creation of customized charts to answer specific business needs, with measures and dimensions the user has selected.
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.


=== Conformance Analysis ===
=== Conformance Checking ===
[[Conformance Analysis]] incorporates the [[Conformance Checking in QPR ProcessAnalyzer]] capability of QPR ProcessAnalyzer. There are two views in the conformance analysis: the other shows the nonconformance reasons, and the other shows possible root causes for the nonconformance.
[[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.
 
=== Case Level Prediction ===
[[Case Level Prediction]] makes a prediction whether a selected phenomenon will occur in cases. The phenomenon might be for example occurrence of a certain type of event, case duration longer than selected or specific case attribute value. To use the analysis, you first need to select cases for which the prediction is made. Then you need to select the predicted phenomenon. When these have been defined, the prediction is made and cases where the selected phenomenon are predicted to occur, are listed in the right side.  


=== Clustering Analysis ===
=== Clustering Analysis ===
[[Clustering Analysis]] analyzes though 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.
[[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 ===
=== Enhanced BPMN ===
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.


=== Data Import ===
=== Workspace ===
Use this view to import models and datatables into QPR ProcessAnalyzer from files. Models can be imported from .csv, .pacm and .xes files and datatables from .csv files. For details, see [[Importing Data to QPR ProcessAnalyzer]].
[[QPR_ProcessAnalyzer_Project_Workspace|Project workspace]] is for managing projects, dashboards, datatables and scripts.


=== Model Manager ===
=== Manage Users ===
Model Manager is intended for administrators to see a list of all models in the system and manage their memory loading status. When selecting one or several models (while Ctrl key pressed) and clicking the right mouse button, a popup menu appears containing functions to load models into memory and drop them from the memory. It's also possible to export models in the .pacm format.
[[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.


More columns can be added to the table by clicking the '''Columns''' button in the top right and clicking checkboxes for the additional columns. Note that the new columns appear to the right and they can be seen by scrolling the table to the right.
=== 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.  


The models list can be sorted by any column by clicking the column header. Visible models can also be filtered by clicking the filter icon next to the column header.
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.


Functionalities available in the context menu:
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.
* '''Refresh View''': The view contents is reloaded from the server to get the latest status of the models.
* '''View Model''': The model is opened in the Process Discovery view. Note that if the model loading takes much time, it might be better to use the ''Load Model'' function first, because that loads the model in background.
* '''Load Model''': The selected model(s) are loaded into the memory.
* '''Drop Model''': The selected model(s) are dropped from the memory to free memory resources.
* '''Reload Model''': The selected model(s) are dropped from the memory and loaded again into the memory. Use the reloading to get the latest model data, e.g. when new data is loaded into the model.
* '''Export as .pacm''': Export the model as a .pacm file. The .pacm file can be imported into another QPR ProcessAnalyzer environment.


=== Dashboards ===
Notes:
In Dashboards, you can find all your custom made dashboards, which are organized into [[QPR_UI_Folders|folders]]. When you want to edit a dashboard, click the menu on top right and select '''Show Dashboard Designer''' to open a header containing editing functions. Start editing by clicking '''Edit''' and when ready, click '''Save'''. You can go back to the folders by reselecting '''Dashboards''' from the top left menu.
* 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.
* Presets are run in a random order to reduce random variation in the results.
 
=== System Reports ===
System reports dialog is available for administrators, showing essential system level information, such as recent tasks, running tasks, task statistics and listings of different kind of objects in the system. The reports can also be modified using the other available tabs in the settings (note that the settings cannot be saved).


=== Query Designer ===
=== Query Designer ===
KPI  Query tester can be open by clicking the settings menu on top right. KPI Query Tester is for testing QPR ProcessAnalyzer KPI language queries that contain
Query Designer is for testing QPR ProcessAnalyzer KPI language queries that contain
* root expression to select objects to be analysed
* root expression to select objects to be analysed
* dimension expressions to slice the analyzed object into slices
* dimension expressions to slice the analyzed object into slices
* measure expressions to calculate KPI's and other measures from each of the 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
* 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 KPI Expression''' 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|QPR ProcessAnalyzer Expression Analysis]].
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]].


=== Expression Designer ===
=== Expression Designer ===
Expression tester can be open by clicking the settings menu on top right. Expression tester is used to run individual expressions in a generic context.
Expression Designer is used to run individual expressions in a generic context. Write the expressions in the upper box and the results appear in the lower box. The expressions can be run by clicking the '''Run All''' button which run all expressions in the upper box. It's also possible to select parts of the expressions 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 ===
The User Settings dialog is used to:
* change language, date format, first day of week, and use of 12-hour clock ([[Languages_and_Localization#Date_Format_Settings|more information]])
* change password
* view system and session related information
 
When changing password, you need to provide your current password and also confirm the new password. Note that when authenticated using an external SAML 2.0 identity provided, the password changing is not available.
 
=== 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.


__NOTOC__
__NOTOC__


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]

Revision as of 19:33, 11 December 2021

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.

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.

System Reports

System reports dialog is available for administrators, showing essential system level information, such as recent tasks, running tasks, task statistics and listings of different kind of objects in the system. The reports can also be modified using the other available tabs in the settings (note that the settings cannot be saved).

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 individual expressions in a generic context. Write the expressions in the upper box and the results appear in the lower box. The expressions can be run by clicking the Run All button which run all expressions in the upper box. It's also possible to select parts of the expressions 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

The User Settings dialog is used to:

  • change language, date format, first day of week, and use of 12-hour clock (more information)
  • change password
  • view system and session related information

When changing password, you need to provide your current password and also confirm the new password. Note that when authenticated using an external SAML 2.0 identity provided, the password changing is not available.

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.