Navigation Menu: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
 
(80 intermediate revisions by 2 users not shown)
Line 1: Line 1:
QPR ProcessAnalyzer Deployment Package installs QPR ProcessAnalyzer UI to QPR UI.
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:


== Installing Deployment Package ==
=== Home ===
<div class="downloadButton" style="width:300px;float:right;margin:15px 20px 0px 30px;">[[QPR_Product_Downloads#QPR_ProcessAnalyzer_Deployment_Package|Download Deployment Package<br />for QPR ProcessAnalyzer]]</div>
The Home view is opened by default when login in QPR ProcessAnalyzer, and it has quick access buttons to the most common functionalities.


# Download the deployment package (link on the right) and extract its contents to a temporary folder. Note that QPR UI and deployment package versions need to be the same.
=== Process Discovery ===
# In QPR UI, delete the possible previous versions of the QPR ProcessAnalyzer Deployment Package views. If the views have been ''published'', to need to ''unpublish'' and ''unlock'' the views to be able to delete them.
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.
# Go to the '''My Workspace''' screen, import all the views (.qprmdb files) from your temporary folder.
 
# In the My Workspace screen, open the '''QPR ProcessAnalyzer''' view, click the menu on top right (three dots), click '''Show Header''', from the appearing header click '''File''', click '''Lock views and panels''', click '''File''' again, click '''Publish view'''.
=== Conformance Checking ===
# It's recommended to set the deployment package home page as the [[QPR_UI_System_Settings#Other_settings|default view]] in QPR UI (DEFAULT_VIEW_PATH setting with value "/QPRProcessAnalyzerHome").
[[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.
 
=== 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.


== Deployment Package Contents ==
=== Enhanced BPMN ===
This chapter introduces all the views that are in the deployment package. Note that the deployment packages manipulates QPR UI header by hiding the Help and Selections buttons.
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.


=== Home (QPR ProcessAnalyzer) ===
=== Workspace ===
The Home page contains buttons to open all views in the deployment package. Note that the view name of the Home page is ''QPR ProcessAnalyzer''.
[[QPR_ProcessAnalyzer_Project_Workspace|Project workspace]] is for managing projects, dashboards, datatables and scripts.


=== Process Discovery ===
=== Manage Users ===
This [[QPR_ProcessAnalyzer_Presentation_Object_(PAPO)|QPR ProcessAnalyzer]] view is for analysts to discover the process.
[[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.
 
=== 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.  


=== Conformance Analysis ===
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.
The [[QPR ProcessAnalyzer - Conformance Analysis View|Conformance Analysis View]] 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 using the Influence Analysis for Case Attributes.


=== Process Benchmarking ===
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.
Process Benchmarking can be used to compare process flows e.g. between two selected case attribute values. The view works as follows:
# Open Profiling Case Analysis using the drop down menu.
# For the compared case attribute values, create a filter in the left side view and another filter in the right side view for another attribute value.
# Go back to the flowchart view using the drop down menu. Now you can see two flowcharts to make the benchmarking.


=== ChartView ===
Notes:
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.
* 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.


=== Clustering Analysis ===
=== System Reports ===
The [[QPR_ProcessAnalyzer_-_Clustering_Analysis_View|Clustering Analysis View]] 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.
System reports dialog is available for administrators, showing system information, such as recent tasks, running tasks, task statistics and listings of different kind of objects in the system. The reports can be modified by changing settings, but the settings cannot be saved.


=== Data Import ===
=== Query Designer ===
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]].
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


=== KPI Expressions Tester ===
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 for testing QPR ProcessAnalyzer expressions, e.g. before using the expressions in the dashboards. 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]].


=== Model Manager ===
=== Expression Designer ===
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.
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.


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.
=== User Settings ===
In the User Settings dialog, you can:
* Change language, date format, first day of week, and use of 12-hour clock ([[Languages_and_Localization#Date_Format_Settings|more information]])
* Change user password
* View system and user session related information


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.
When changing password, you need to provide your current password and also confirm the new password. Note that when authenticated using the SSO (SAML 2.0 identity provided), the password changing in QPR ProcessAnalyzer is not available.


Functionalities available in the context menu:
=== Sign out ===
* '''Refresh View''': The view contents is reloaded from the server to get the latest status of the models.
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.
* '''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.


__NOTOC__
__NOTOC__


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]
[[Category: Deployment Packages]]
[[Category: QPR UI]]

Latest revision as of 23:10, 24 October 2023

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 system information, such as recent tasks, running tasks, task statistics and listings of different kind of objects in the system. The reports can be modified by changing settings, but 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 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

In the User Settings dialog, you can:

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

When changing password, you need to provide your current password and also confirm the new password. Note that when authenticated using the SSO (SAML 2.0 identity provided), the password changing in QPR ProcessAnalyzer 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.