QPR ProcessAnalyzer Project Workspace

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search

In QPR ProcessAnalyzer, dashboards, models, datatables and scripts are organized into projects. Project Workspace shows all projects in a hierarchy (on the left side) and contents of the selected project (on the right side). Different types of entities are available as tabs. Currently, there are tabs for dashboards, models, datatables and scripts. Dashboards and datatables are described in this page and script are described in Managing Scripts.

The Project Workspace can be opened by clicking the QPR Software logo on top left, or in the Home screen by clicking the Workspace button.

All actions, such as open, create, modify and delete, are available as buttons in the toolbar and also in the context menu, which can be opened by right clicking the target project, dashboard, datatable or script.

Projects

Workspace.png

Creating Project

  1. On the left side projects hierarchy, select the project where you want to create a project.
  2. Click the New button and click either Project.
  3. Define a name for the projects and click Create.

Deleting Project

  1. Either select a single project on the left side hierarchy (only one can be selected), or one or several projects (and optionally other objects depending on which tab is open) on the right side list.
  2. Click the Delete button and click Delete for the confirmation message. (The deleted project goes to the recycle bin.)

Renaming Project

  1. Select the project to be renamed (either in the left side hierarchy or in the right side table).
  2. Click the Rename button.
  3. Change the project name in the opening dialog and click OK.

Moving Project

Projects can be moved by dragging them with a mouse from the right side list to the target project in the left side hierarchy. A project can be seen in the right side list by opening its parent project in the left side projects hierarchy.

Dashboards

Dashboards can be created, opened, moved, deleted, imported and exported in the Dashboards tab, which shows all dashboards in the selected project.

Opening Dashboard

  1. Select the project where the dashboard to be opened is located.
  2. Open the Dashboards tab.
  3. Double-click the dashboard in the list, or select the dashboard with a single click and click the Open button.

Creating Dashboard

  1. On the left side projects hierarchy, select the project where you want to create the dashboard.
  2. Open the Dashboards tab.
  3. Click the New button and click Dashboard. The dashboard designer opens.
  4. The dashboard can be named by opening the menu on the right and clicking Dashboard properties. The name can be defined in the General tab. The dialog can be closed by clicking the Done button.
  5. The dashboard is saved when clicking the Save button.

Deleting Dashboard

  1. Select the project where the dashboard(s) to be deleted are located.
  2. Open the Dashboards tab.
  3. Select one or several dashboards to be deleted.
  4. Click the Delete button and click Delete to the confirmation message.

Renaming Dashboard

  1. Select the project where the dashboard to be renamed is located.
  2. Open the Dashboards tab.
  3. Select the dashboard to be renamed.
  4. Click the Rename button.
  5. Change the dashboard name in the opening dialog and click OK.

Moving Dashboard

Dashboards can be moved by dragging them with a mouse from the right side list to the target project in the left side hierarchy. Alternatively, dashboards to be moved can be selected and from the context menu, select Move to and then select the target project.

Duplicating Dashboard

  1. Select the project where the dashboard to be duplicated is located.
  2. Open the Dashboards tab.
  3. Select the dashboard to be duplicated.
  4. Click the Duplicate button. A duplicate of the dashboard is created.

Importing Dashboard

  1. From the left side projects hierarchy select the project where you want to import the dashboard.
  2. Open the Dashboards tab.
  3. Click the New button, and select Import Dashboard.
  4. Select a .qprpa file to be imported.

Exporting Dashboard

  1. Navigate to the project where the dashboard to be exported is located.
  2. Open the Dashboards tab and select the dashboard.
  3. Click the Export button. The exported file can be downloaded.

Models

Models tab shows all models in the selected project, and there models can be opened, created, edited, deleted, imported and exported. Go through an end-to-end description how to create model from eventlog data from a CSV file.

Model status is essential as models need to be online to use them on dashboards and run analyses on them. Model status is visible as an icon left of the model name, denoting whether the model is in the server memory or being loaded into memory. The memory capacity of the server limits how many models there can be in the memory at the same time. Also loading a model into memory might take a while depending the model size. Model is one of the following statuses:

  • Online: Model is currently in the memory and available to dashboards and analyses.
  • Offline: Model is currently not the memory (and thus it's not consuming any memory resources).
  • Loading: Model is currently being loaded into the memory. The loading needs to complete until the model can be used.

Note that in QPR ProcessAnalyzer, all processing is performed in the server/cloud side, so the model does not need to be loaded into user workstation, and thus it doesn't consume resources in the workstation side.

Opening Model

  1. Select the project where the model to be opened is located.
  2. Open the Models tab.
  3. Double-click the model in the list, or select the model with a single click and click the Open button. Model is opened in the Process Discovery view.

Editing Model Settings

Model level settings are organized into following dialogs: Properties (general settings), Attributes, Notifications and Business calender. Most settings can be changed while the model is in the memory, but changing datasource related settings and attribute settings will drop the model from the memory. Steps to edit settings:

  1. Select the project where the model is located.
  2. Open the Models tab.
  3. Select the model and select one of the following options: Properties, Attributes, Notifications or Business Calender (model level settings are organized into these dialogs).
  4. After viewing or editing properties, close the dialog by clicking OK.

See more about model level settings:

Loading, Dropping and Reloading Model

  1. Select the project where the model is located.
  2. Open the Models tab.
  3. Select the model and select one of the following options:
    • Load to start loading the model into memory. This option is available when the model is offline.
    • Drop to drop the model from the memory (for example to free memory resources). This option is available when the model is online or loading.
    • Reload to reload the model into the memory (i.e. drop and immediately start loading). Reloading is needed in order to get the latest data into the model after new data is imported to datatables. This option is available when the model is online or loading.

Creating Model

  1. On the left side projects hierarchy, select the project where you want to create the model.
  2. Open the Models tab.
  3. Click the New button and click Model. Define a name for the model and click Create. Note that model names must be unique within a project.

Deleting Model

When a model is deleted, it's not permanently removed, and can be recovered from the recycle bin. Note that possible datatables used by the deleted models, are not deleted. Steps to delete models:

  1. Select the project where the model(s) to be deleted are located.
  2. Open the Models tab.
  3. Select one or several models to be deleted.
  4. Click the Delete button and click Delete to the confirmation message.

Renaming Model

  1. Select the project where the model to be renamed is located.
  2. Open the Models tab.
  3. Select the model to be renamed.
  4. Click the Rename button.
  5. Change the model name in the opening dialog and click OK.

Moving Model

Models can be moved by dragging them with a mouse from the right side list to the target project in the left side hierarchy. Alternatively, models to be moved can be selected, from the context menu select Move to and then select the target project.

Duplicating Model

When a model is duplicated, datatables that are possibly used by the model, are not duplicated so the duplicate model will refer to the same datatables as the original model (datatables can be duplicated separately if desired). Steps to duplicate a model:

  1. Select the project where the model to be duplicated is located.
  2. Open the Models tab.
  3. Select the model to be duplicated.
  4. Click the Duplicate button. A duplicate of the model is created.

Importing Model

When a .pacm file is imported, a new model is created from the file, so it's not possible to import data from .pacm file to an existing model.

Steps to import model:

  1. From the left side projects hierarchy select the project where you want to import the model.
  2. Open the Models tab.
  3. Click the New button, and select Import Model.
  4. Select a .pacm file to be imported.

Exporting Model

Models can be exported to a .pacm file (QPR ProcessAnalyzer compressed model file) to easily move models between QPR ProcessAnalyzer environments. The file contains all the eventlog data and also all model related settings. Steps to export:

  1. Navigate to the project where the model to be exported is located.
  2. Open the Models tab and select the model.
  3. Click the Export button. The exported file can be downloaded.

Datatables

Datatables are used to store any tabular data in QPR ProcessAnalyzer. The data in datatables can be loaded into models by linking models to the datatables. Datatables can also be used as part of the ETL process to store intermediate results. Datatable names are unique within a project.

To create datatables, the global Create models permissions is needed (by default system administrators have it), and for deleting datatables, the project-specific Delete models permission is needed (by default projects administrators have it).

Data stored to datatables have the following limitations: Maximum number of columns in a datatable is 300, and maximum string length that can be stored into a datatable cell is 4000 characters.

Datatables can be created, moved and deleted in the Datatables tab, which shows all datatables in the selected project.

Opening Datatable

Datatable contents can be viewed as follows:

  1. On the left side projects hierarchy, select the project where the datatable to be opened is located.
  2. Open the Datatables tab.
  3. Double-click the datatable in the list, or select the datatable with a single click and click the Open button.
  4. If you want to change the shown information, click the Settings button and edit the settings.
  5. The dialog can be closed by clicking Close button.

Following settings are available:

  • Visible columns can be removed and changed in the Columns tab.
  • Number of shows row can be changed.
  • Sorting of the data can be changed.
  • Dimensioning can be taken into use which will show the Measures tab (for more information, see the chart.
  • Datatable can be exported as an .xlsx or .csv file.

Creating Datatable

  1. On the left side projects hierarchy, select the project where you want to create a datatable.
  2. Open the Datatables tab.
  3. Click the New button and click Datatable. Define a name for the datatable and click Create. Note that datatable names must be unique within a project.

Importing Data to Datatable from CSV File

  1. On the left side projects hierarchy, select the project where the target datatable is located.
  2. Open the Datatables tab, and select the datatable where to import data.
  3. Click the Import button, and select the CSV file to be imported.
  4. Check the suggested data type and conversion settings for the columns, and adjust them if needed. You can import data to the existing datatable columns, new datatable columns, or ignore individual CSV file columns in the import (more information about CSV file import).
  5. Click Start import.

Deleting Datatable

  1. Select the project where the datatable(s) to be deleted are located.
  2. Open the Datatables tab.
  3. Select one or several datatables to be deleted.
  4. Click the Delete button and click Delete to the confirmation message.

Renaming Datatable

  1. Select the project where the datatable to be renamed is located.
  2. Open the Datatables tab.
  3. Select the datatable to be renamed.
  4. Click the Rename button.
  5. Change the datatable name in the opening dialog and click OK.

Moving Datatable

Datatables can be moved by dragging them with a mouse from the right side list to the target project in the left side hierarchy. Alternatively, datatables to be moved can be selected, from the context menu select Move to and then select the target project.

Duplicating Datatable

Datatable duplication (copying) creates a full copy of the datatable where also the data contents is duplicated. If the datatable contains lot of data, duplicating the data might take some time. Copying the data from the original datatable to the new datatable is performed in the background, so the user doesn't need to wait for it. Note that during the data copying, the workspace might temporarily show that the new datatable has less rows than the original.

  1. Select the project where the datatable to be duplicated is located.
  2. Open the Datatables tab.
  3. Select the datatable to be duplicated.
  4. Click the Duplicate button. A duplicate of the datatable is created.

Recycle Bin

Deleted projects and models go to the Recycle bin, where they can be either deleted forever or restored. Purpose of the recycle bin is that accidentally deleted items can still be restored. Note that currently dashboards and scripts don't go to the recycle bin, but they are deleted forever right away. Note also that when a project is deleted (moved to the recycle bin), also models in the project appear in the recycle bin.

Only the system administrators can see the recycle bin, and delete forever and restore items from there.

Emptying Recycle Bin

  1. Click Bin in the left side projects hierarchy.
  2. Click the Empty bin button on top right.
  3. Click Delete forever for the confirmation dialog.

Deleting Items Forever

  1. Click Bin in the left side projects hierarchy.
  2. Select items in the recycle bin that you want to delete forever.
  3. Click the Delete forever button.
  4. Click Delete forever for the confirmation dialog.

Restoring Items

  1. Click Bin in the left side projects hierarchy.
  2. Select items in the recycle bin that you want to restore.
  3. Click the Restore button. (Selected items are restored to their original locations.)