Project Workspace in QPR ProcessAnalyzer Excel Client

From QPR ProcessAnalyzer Wiki
Jump to: navigation, search

In the Project Workspace dialog, the Project dropdown menu shows all projects. Projects contain Models and Data Tables. Also scripts can be linked to projects.

Models List

The Models tab lists the models in the selected project. The following information is displayed on the Models tab by default:

  • Type: Shows the type of the object in the list: Project.png Project, Model.png Model, or ModelLoadScript.png Model with a Script.
  • Project: the project to which the model belongs.
  • Model: the name of the model.
  • Created On: the date and time the project or model was created.
  • Created By: the user who created the project or model.
  • Filters: the total amount of filters that exist for the project or model.
  • Events: the total number of events in the project or model.
  • Cases: the total number of cases in the project or model.
  • Event Types: the total number of event types in the project or model.
  • Case Attributes: the total number of case attributes in the project or model. There can be a maximum of 300 case attributes in one model.
  • Event Attributes: the total number of event attributes in the project or model. There can be a maximum of 300 event attributes in one model.
  • Opens: the total amount of times the project or model has been opened.
  • Last Modified On: the date and time the project or model was last modified.
  • Last Modified By: the user who last made changes to the project or model.

In addition, the following columns are available but hidden by default:

  • Model Compatibility Version: shows the client compatibility version for the model. For projects, the maximum model compatibility version of all the models in the project is shown. If the cell is empty, the model/project has not been modified by a version of QPR ProcessAnalyzer supporting compatibility versions for models.
  • Deleted By: the user who deleted the model.
  • Deleted On: the date and time when the model was deleted.
  • Id: Id of the object.
  • Models: applicable for projects, the number of models inside the project.
  • Project Id: the id of the project in which the model exists.
  • Replaced With: the name of the model that replaced this model.
  • Replaced With Id: the id of the model that replaced this model.

Model Properties

Model Properties dialog shows following information of the model:

  • Name: Model name. For the scripts to work, special characters such as " and # should not be used.
  • Id: Id of the model. <None> when creating a new model.
  • Project: Project name where the model is located. Models can be moved to different projects by changing another project in the dropdown list.
  • Description: Model description. Can be used freely to e.g. documenting the model.
  • Configuration: Model settings stored in a JSON format. Click the property name to see all available JSON settings. To be able to save the JSON settings, the configuration must be valid JSON. You can use for example the following validator to find syntax errors in JSON definitions: https://jsonlint.com/.

Export button in the Model Properties dialog export the model into a .pam or .pacm file. The model is exported as a .pam (uncompressed) or .pacm (compressed) file. If the model has a ModelDefault filter that has hidden event types, cases or variations, then a message should be displayed, a notification message of that is displayed.

Note that it is not possible to make modifications for a deleted model.

Creating Model from Excel Worksheet

  1. Open the Microsoft Excel file that contains the data you want to analyze.
  2. On the QPR tab, click Project Workspace.
  3. In the Project Workspace dialog, click the Import button.
  4. In the Import Wizard, select Events or Case Attributes, depending on you data to be imported and click Next.
  5. Select Current Worksheet and click Next.
  6. Select Create New Model.
  7. From the Project drop-down menu, select the project to which you want to create the model. With sufficient rights, you can also choose to create a new project.
  8. Type in a name for the model. Do not use special characters ## or '.
  9. Click Import.

Notes:

  • When importing Event Data, the Start Time column must be in DateTime format.
  • If you cancel a running import, the data already successfully imported before cancelling will be available for use in the model.
  • If you get error 'Out of present range. (Exception from HRESULT: 0x8002000A (DISP_E_OVERFLOW))' when a running import, check your data in Excel sheet. Example numerical values may have datetime format in Excel and you see '###########' in cell and pop info show text 'Dates and times that are negative or too large show as #######.'

Creating Model from CSV File

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Click the Import button.
  3. The Import Wizard opens. Select Events or Case Attributes (depending what kind of data you are going to import) and click Next.
  4. Select Text File and click Next.
  5. Click Select and browse to the CSV file containing the data to import.
  6. Define the Delimiter, Text Qualifier, TimeDate Format, and Import start row to suit the data in the CSV file, and click Next.
  7. Select Create New Model.
  8. From the Project drop-down menu, select the project to which you want to create the model. With sufficient rights, you can also choose to create a new project.
  9. Type in a name for the model. Do not use special characters ## or '.
  10. Click Import.

Note: If you cancel a running import, the data already successfully imported before cancelling will be available for use in the model.

Creating Model from Data in SQL Server

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Click the Import button.
  3. The Import Wizard opens. Select Events or Case Attributes to be imported and click Next.
  4. Select Database via SQL Query and click Next.
  5. Define the Connection String and the SQL Query to be used, and click Next.
  6. Select Create New Model.
  7. From the Project drop-down menu, select the project to which you want to create the model. With sufficient rights, you can also choose to create a new project.
  8. Type in a name for the model. Do not use special characters ## or '.
  9. Click Import.

Note: If you cancel a running import, the data already successfully imported before cancelling will be available for use in the model.

Importing Model from PACM File

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Click the Import button.
  3. The Import Wizard opens. Select QPR ProcessAnalyzer File and click Next.
  4. Click Select... and browse to the .pacm or .xes file.
  5. With the file selected, click Open and then Next.
  6. Select either Create New Model or Add to Existing, define the Project and Model Name, and click Import.

Importing Data to Existing Model from Excel Worksheet

  1. Open the Microsoft Office Excel file that contains the data you want to import.
  2. On the QPR tab, click Project Workspace.
  3. The Workspace dialog opens. Click the Import button.
  4. The Import Wizard opens. Select Events or Case Attributes (depending on the data you have on the currently open worksheet) to be imported and click Next.
  5. Select Current Worksheet and click Next.
  6. Select Add to Existing Model.
  7. From the Project drop-down menu, select the project in which the target model exists.
  8. Select the model from the drop-down list and click Import.

Note: When importing Event Data, the Start Time column must be in DateTime format.
Note: If you cancel a running import, the data already successfully imported before cancelling will be available for use in the model.

Importing Data to Existing Model from CSV File

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Click the Import button.
  3. The Import Wizard opens. Select Events or Case Attributes (depending what kind of data you are going to import) and click Next.
  4. Select Text File and click Next.
  5. Click Select and browse to the CSV file containing the data to import.
  6. Define the Delimiter, Text Qualifier, TimeDate Format, and Import start row to suit the data in the CSV file, and click Next. The TimeDate is used only for the start time field and the supported 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.
  7. Select Add to Existing Model.
  8. From the Project drop-down menu, select the project in which the target model exists.
  9. Select the model from the drop-down list and click Import.

Note: When importing a CSV file, QPR ProcessAnalyzer tries to identify the correct character encoding. If the identification fails and you see some incorrect characters, save the CSV file in UTF-8 encoding before the import, for example in the following way:

  1. Open the file in Notepad.
  2. Select File > Save As.
  3. Change the Encoding to be UTF-8.

Note: If you cancel a running import, the data already successfully imported before cancelling will be available for use in the model.

Importing Data to Existing from SQL Server

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Click the Import button.
  3. The Import Wizard opens. Select Events or Case Attributes to be imported and click Next.
  4. Select Database via SQL Query and click Next.
  5. Define the Connection String and the SQL Query to be used, and click Next.
  6. Select Add to Existing Model.
  7. From the Project drop-down menu, select the project in which the target model exists.
  8. Select the model from the drop-down list and click Import.

Note: If you cancel a running import, the data already successfully imported before cancelling will be available for use in the model.

Exporting Model

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Select the model to be exported and click Properties.
  3. The Model Properties dialog opens. Click Export.
  4. Type in a file name for the export file and click Save.

Note: If the model has a Model Default filter that contains filter rules, only a subset of the events and cases will be exported.

Creating Project

To create a new empty project:

  1. On the QPR tab, click Project Workspace.
  2. On the Project Workspace dialog, click the New button and select New Project.
  3. Give the new project a Name and Description. Do not use special characters ## or ' in the name.
  4. Click OK.

Creating Empty Model

When a new QPR ProcessAnalyzer model is created, by default it loads from datatables. Create a new QPR ProcessAnalyzer model as follows:

  1. On the QPR tab, click Project Workspace.
  2. Click the New button and select New Model.
  3. The Create Model dialog opens. Give the model a Name. Do not use special characters ## or '.
  4. Select the Project to which you want to create the new model.
  5. Click OK.

Note that you then need to give sufficient user rights for the users, so that they are able to import data into the model.

Copying Model

To copy a model:

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. Select the model from which you want to create a copy. Note: If the model you are copying has a Model Default filter that contains filter rules, only a subset of the events and cases will be copied.
  3. Click Copy. A copy of the model is created in the same project as the original model.

Note: Copying a large model with a large number of events may take a long time.

Moving Model to Another Project

It may be a good idea to first create a new model and import data into it in a private project, and after that move the model to a project with other users in it.
To move a model:

  1. On the QPR tab, click Project Workspace.
  2. The Workspace dialog opens. From the Project drop-down menu, select the project containing the model to be moved.
  3. If you want to leave behind a model to the private project, select the model and click Copy.
  4. Select the model to be moved and click Properties.
  5. The Model Properties dialog opens. From the Project drop-down menu, select the project to which you want to move the model and click OK.

Deleting Project

Deleting a project will also delete all models that the project contains. To delete a project:

  1. In the Excel client on the QPR tab, click Project Workspace.
  2. In the opening dialog, uncheck the [Type]<>'Project' check box to show all projects.
  3. Select the project (indicated with Project.png icon) to be deleted and click Delete.
  4. Answer Yes to the confirmation question.

Deleting Model

To delete a model:

  1. In the Excel client on the QPR tab, click Project Workspace.
  2. In the opening dialog, from the Project drop-down menu, select the project containing the model you want to delete.
  3. Select the model to be deleted and click Delete.
  4. Answer Yes to the confirmation question.

Deleted models are not deleted permanently but they are stored into the recycle bin. The models in the recycle bin can be permanently deleted by setting the value of the DeleteModelsInRecycleBinOnStartup key in the PA_CONFIGURATION table in the QPR ProcessAnalyzer database to 1, and then restarting the QPR ProcessAnalyzer Server. After restarting, the DeleteModelsInRecycleBinOnStartup value is automatically set to 0, so the bin is not emptied every time the service is started.