mpmX Docs

https://help.mpmx.com
Admin
Comprehensive documentation for the mpmX Process Intelligence Platform, covering process mining,...
Tokens:245,549
Snippets:4,484
Trust Score:8.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Installation Notebook

Source: https://help.mpmx.com/platform/databricks/installation_and_update

The installation notebook guides the user through the setup process. It includes cells for configuring installation parameters and checking prerequisites.

```python
from mpmx_databricks.install import install

install(
    app_name="mpmX - Process Mining for Databricks",
    install_source_catalog="mpmx_marketplace_catalog",
    admin_group="account users",
    sql_warehouse="marketplace-serverless-warehouse"
)
```

--------------------------------

### Transform Phase (02transform) Example

Source: https://help.mpmx.com/platform/qlik/tags/setup

Combine two tables into one data view using an SAP example.

```sql
Combine two tables into one data view using an SAP example
```

--------------------------------

### Example 1: Inline Subprocess Definition

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/use-an-event-log/use-an-event-log-NOT-created-with-mpmX/define_subprocesses_v2

Defines a subprocess with specific start and end activities, including minimum and maximum time constraints. Use this for straightforward process definitions.

```qlik
SubprocessDefinition_$(mvProcessDescription):

Load * Inline [

Qualifier,         StartActivity,                               IncludeStartActivity,   MinMaxStartActivity,    EndActivity,    IncludeEndActivity,     MinMaxEndActivity,  TargetTime,     TargetTimeOperator  

Payment Process,   Record Service Entry|Record Goods Receipt,   y,                      Max,                    Pay Invoice,    n,                      Min,                60,              <  

WIP,               Take in charge ticket,                       y,                      Min,                    Wait,           n,                      Max,                45,              >  

];  

```

--------------------------------

### Helpdesk Example: Customize CaseInformation Fields

Source: https://help.mpmx.com/platform/qlik/v3.0/use-apps-and-scripts/use-an-event-log/use-an-event-log-NOT-created-with-mpmX/reuse_the_context_information_template

Configure the CaseInformation table for a Helpdesk example, mapping fields like 'PurchaseOrderItem' to 'CaseID' and including specific case-related dimensions.

```qlik
Left Keep(EventLog)  
[CaseInformation_$(mvProcessDescription)]:  
LOAD distinct  
PurchaseOrderItem as CaseID,  
    Supplier,  
    Company,  
    SpendArea,  
    ProductClass,  
    ProcessPathUniqueNo,  
    City  
FROM [lib://helpdesk/HelpdeskEventlog.qvd] (qvd);  

```

--------------------------------

### Helpdesk Example: Load Case Information

Source: https://help.mpmx.com/platform/qlik/v3.0/use-apps-and-scripts/use-an-event-log/use-an-event-log-created-with-mpmX/reuse_the_context_information_template

An example demonstrating how to load distinct case information for a helpdesk scenario, mapping specific fields to the CaseID and other dimensions. This illustrates how to adapt the template for a particular use case.

```qlik
Left	Join([CaseInformation_$(mvProcessDescription)])

  

LOAD	distinct

    PurchaseOrderItem	as	CaseID,
    Supplier,
    Company,
    SpendArea,
    ProductClass,
    ProcessPathUniqueNo,
    City
  
FROM	[lib://helpdesk/HelpdeskEventlog.qvd]	(qvd);

```

--------------------------------

### Install the App from the shared private listing

Source: https://help.mpmx.com/platform/snowflake/installation_and_update

SQL commands to install the mpmX Snowflake app using the MPMX_ADMIN role.

```sql
USE ROLE MPMX_ADMIN;

CREATE APPLICATION MPMX_APP FROM LISTING GZSYZPF2MY BACKGROUND_INSTALL = TRUE;
```

--------------------------------

### Helpdesk Example: Customize CaseInformation Table Fields

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/use-an-event-log/use-an-event-log-NOT-created-with-mpmX/reuse_the_context_information_template

Load distinct case information for a Helpdesk example, mapping fields like 'PurchaseOrderItem' to 'CaseID'. Custom fields such as 'Supplier', 'Company', and 'SpendArea' can be included.

```qlikview
Left Keep(EventLog)  

[CaseInformation_$(mvProcessDescription)]:  

LOAD distinct  

PurchaseOrderItem as CaseID,  

    Supplier,  

    Company,  

    SpendArea,  

    ProductClass,  

    ProcessPathUniqueNo,  

    City  
FROM [lib://helpdesk/HelpdeskEventlog.qvd] (qvd);  

```

--------------------------------

### Create MPMX_ADMIN role and grant permissions

Source: https://help.mpmx.com/platform/snowflake/installation_and_update

SQL commands to create the MPMX_ADMIN role and grant necessary global privileges for application installation.

```sql
CREATE ROLE IF NOT EXISTS MPMX_ADMIN COMMENT = 'mpmX Admin';

GRANT CREATE APPLICATION ON ACCOUNT TO ROLE MPMX_ADMIN;

GRANT IMPORT SHARE ON ACCOUNT TO ROLE MPMX_ADMIN;
```

--------------------------------

### Ideal CSV File Structure Example

Source: https://help.mpmx.com/platform/qlik/import-wizard/create_CSV_files

This example demonstrates the recommended structure for a CSV file intended for import into Qlik, including header row and sample data.

```csv
EventID;CaseID;ActivityName;UserName;ActivityStartTimestamp;ActivityEndTimestamp;CaseDimension1;CaseDimension2;CaseDimension3;CaseDimension4;CaseDimension5;EventDimension1;EventDimension2;EventDimension3;CaseValue1;CaseValue2;EventValue1;EventValue2;Geofield;Ressource  
1;1;Assign seriousness;User 1;2012-10-09 14:50:17.000000000;2012-10-09 14:50:25.600000000;Variant 12;12;Variant 12;Value 1;Value 1;Value 1;Value 1;Value 1;0,457;16,180;1,599;1,843;Karlsruhe;Ressource1  
2;1;Take in charge ticket;User 1;2012-10-09 14:51:01.000000000;2012-10-09 14:57:01.600000000;Variant 12;12;Variant 12;Value 1;Value 1;Value 1;Value 1;Value 1;0,976;13,943;18,062;3,081;Karlsruhe;Ressource2  
3;1;Take in charge ticket;User 2;2012-10-12 15:02:56.000000000;2012-10-12 15:04:23.666666666;Variant 12;12;Variant 12;Value 1;Value 1;Value 1;Value 1;Value 1;0,677;15,805;1,937;0,699;Karlsruhe;Ressource2  
4;1;Resolve ticket;User 1;2012-10-25 11:54:26.000000000;2012-10-25 12:40:36.000000000;Variant 12;12;Variant 12;Value 1;Value 1;Value 1;Value 1;Value 1;5,909;14,305;19,473;2,408;Karlsruhe;Ressource3  
5;1;Closed;User 3;2012-11-09 12:54:39.000000000;2012-11-09 13:45:18.000000000;Variant 12;12;Variant 12;Value 1;Value 1;Value 1;Value 1;Value 1;5,470;16,070;11,364;1,208;Karlsruhe;Ressource4  
6;2;Assign seriousness;User 4;2012-04-03 08:55:38.000000000;2012-04-03 08:55:41.500000000;Variant 1;1;Variant 1;Value 1;Value 2;Value 2;Value 1;Value 1;8,746;9,500;9,685;4,959;Karlsruhe;Ressource1  
7;2;Take in charge ticket;User 4;2012-04-03 08:55:53.000000000;2012-04-03 09:06:51.250000000;Variant 1;1;Variant 1;Value 1;Value 2;Value 2;Value 1;Value 1;6,784;1,565;11,431;0,452;Karlsruhe;Ressource2  
8;2;Resolve ticket;User 4;2012-04-05 09:15:52.000000000;2012-04-05 09:34:21.000000000;Variant 1;1;Variant 1;Value 1;Value 2;Value 2;Value 1;Value 1;3,287;26,935;11,114;0,459;Karlsruhe;Ressource3  
9;2;Closed;User 5;2012-05-19 09:00:28.000000000;2012-05-19 09:03:43.666666666;Variant 1;1;Variant 1;Value 1;Value 2;Value 2;Value 1;Value 1;3,526;16,643;6,057;1,099;Karlsruhe;Ressource4  
10;3;Assign seriousness;User 6;2010-10-29 10:14:06.000000000;2010-10-29 10:15:06.800000000;Variant 1;1;Variant 1;Value 1;Value 3;Value 3;Value 1;Value 2;8,934;9,717;1,597;4,975;Karlsruhe;Ressource1  
```

--------------------------------

### Extract Phase (01qvdbuilder)

Source: https://help.mpmx.com/platform/qlik/tags/etl

Code examples for the Extract Phase.

```text
See code used in examples for the Extract Phase
```

--------------------------------

### Helpdesk Example: Customize EventLog Table Fields

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/use-an-event-log/use-an-event-log-NOT-created-with-mpmX/reuse_the_context_information_template

Adapt the EventLog table for a Helpdesk example by renaming fields like 'User' to 'ActivityUserName' and 'Activity' to 'ReworkEvent'. Custom dimensions like 'EventResource' and 'CumNetWorth' can be mapped.

```qlikview
//Event information  

//Here you can add other event-related information (dimensions and values)  

    User as ActivityUserName,  

    if(WildMatch("User", '*Batch*','*1*'), 0, 1) as RealUser,  

    if(Wildmatch(Activity,'*Delete*','*Change*','*Cancel*') > 0, 1, 0) as ReworkEvent,  

    EventResource, //EventDimension1  

    CumNetWorth //EventDimension2  
FROM [lib://helpdesk/HelpdeskEventlog.qvd] (qvd)  

where len(Activity) > 1;  

```

--------------------------------

### Configure mpmX Initial Settings

Source: https://help.mpmx.com/platform/qlik/v3.0/installation-setup-integration/mpmx-installation/install-analytics

This script sets up essential mpmX variables and executes the main script. Adjust mpmXvVersion, mpmXvBaseLib, and mpmXvScripts to match your environment. The call to mpmX_execute is mandatory.

```qlik
SET mpmXvVersion = 'VX.X.X';

SET mpmXvBaseLib = 'lib://mpmX_VX.X.X:mpmX Deployment/Shared Documents/';

SET mpmXvScripts = '$(mpmXvBaseLib)mpmX_scripts/$(mpmXvVersion)/';
      
LET mvProcessDescription = 'ExampleProcess';
SET mpmXvAppConfigAlias = '';
  
  
$(Must_Include='$(mpmXvScripts)mpmX_api.qvs');  
  
  
call mpmX_execute;
  
exit script;
```

--------------------------------

### Qlik Script: Avoiding Loops in BPMN Files

Source: https://help.mpmx.com/platform/qlik/v3.0/troubleshooting

This example illustrates a BPMN file structure to avoid, where a loop starts and ends in the same place. Modifying the BPMN to prevent such loops is necessary for successful import.

```qlik-script
From the example you can see that after the test fixes the software, it's ready to test again. Therefore, try to change your BPMN to the following:
```

--------------------------------

### Initial Configuration for mpmX Template App

Source: https://help.mpmx.com/platform/qlik/installation-setup-integration/mpmx-installation/install-analytics

This script sets up essential variables for the mpmX Template App, including version, library paths, and script paths. It also includes a mandatory call to mpmX_execute and exits the script.

```qlikview
SET mpmXvVersion = 'VX.X.X';

SET mpmXvBaseLib = 'lib://mpmX_VX.X.X:mpmX Deployment/Shared Documents/';

SET mpmXvScripts = '$(mpmXvBaseLib)mpmX_scripts/$(mpmXvVersion)/';

LET mvProcessDescription = 'ExampleProcess';

SET mpmXvAppConfigAlias = '';


$(Must_Include='$(mpmXvScripts)mpmX_api.qvs');


call mpmX_execute;

exit script;
```

--------------------------------

### Define Shift Times Inline Table

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/use-an-event-log/use-an-event-log-NOT-created-with-mpmX/use_a_factory_and_shift_calendar_template

Load shift start and end times using an inline table. This example defines shifts for Monday through Saturday, including multi-shift days and overnight shifts.

```qlik
ShiftTimes:

load *
inline [
weekday_Event, shift, startTime, endTime

Mon,    1,  08:30,  14:30

Tue,    1,  00:00,  23:59

Wed,    1,  08:30   13:30

Wed,    2,  14:30,  18:30

Thu,    1,  08:30,  13:30

Thu,    2,  14:30,  18:30

Fri,    1,  08:30,  13:30

Fri,    2,  14:30,  23:59

Sat,    1,  00:00,  02:30

];
```

--------------------------------

### Example 2: Inline Subprocess Definition with Multiple Activities

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/use-an-event-log/use-an-event-log-NOT-created-with-mpmX/define_subprocesses_v2

Defines a subprocess that includes multiple possible start and end activities, along with time constraints. This is useful for processes with branching or alternative paths.

```qlik
SubprocessDefinition_$(mvProcessDescription):

Load * Inline [

Qualifier,  StartActivity,                          IncludeStartActivity,   MinMaxStartActivity, EndActivity,           IncludeEndActivity, MinMaxEndActivity, TargetTime, TargetTimeOperator  

WIP,        Take in charge ticket|Insert ticket,    y,                      Max,                 Wait|Require upgrade,  n,                  Min,                60,         <  

WIP_old,    Take in charge ticket,                  y,                      Min,                 Wait,                  n,                  Max,                45,         >  

];  

```

--------------------------------

### Example Usage of IMPORT_AND_INITIALIZE_SCENARIO

Source: https://help.mpmx.com/platform/snowflake/external_sql_api

Demonstrates how to call the IMPORT_AND_INITIALIZE_SCENARIO procedure with specific parameters. Adjust the application database name and parameter values as needed for your environment.

```sql
CALL MY_PROCESS_MINING_APP._APPLICATION.IMPORT_AND_INITIALIZE_SCENARIO(
    :scenario_config_json,
    :warehouse_reference_json,
    TRUE,   -- run_mining
    TRUE,   -- wait_for_mining_to_complete
    600     -- mining_wait_timeout_sec
);

```

--------------------------------

### Build warehouse_reference_json with SYSTEM$REFERENCE

Source: https://help.mpmx.com/platform/snowflake/external_sql_api

Constructs the `warehouse_reference_json` by calling `SYSTEM$REFERENCE` to get a serialized warehouse reference string. This is used when registering references for a consumer object. Ensure the consumer account grants `USAGE` on the warehouse to the installed application.

```sql
SET warehouse_reference_json = TO_JSON(
  OBJECT_CONSTRUCT(
    'WAREHOUSE',
    SYSTEM$REFERENCE('warehouse', 'MY_WH', 'PERSISTENT', 'USAGE')
  )
);

CALL MY_PROCESS_MINING_APP._APPLICATION.IMPORT_AND_INITIALIZE_SCENARIO(
  :scenario_config_json,
  :warehouse_reference_json,
  TRUE,   -- run_mining
  TRUE,   -- wait_for_mining_to_complete
  600
);
```

--------------------------------

### Helpdesk Example: Load CaseInformation Data

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/use-an-event-log/use-an-event-log-created-with-mpmX/reuse_the_context_information_template

This Qlik script demonstrates loading distinct case information for a helpdesk scenario, aliasing 'PurchaseOrderItem' as 'CaseID' and mapping other fields like 'Supplier' and 'City'.

```qlik
Left	Join([CaseInformation_$(mvProcessDescription)])

  

LOAD	distinct  

    PurchaseOrderItem	as	CaseID,  

    Supplier,  

    Company,  

    SpendArea,  

    ProductClass,  

    ProcessPathUniqueNo,  

    City  

  

FROM	[lib://helpdesk/HelpdeskEventlog.qvd]	(qvd);

```

--------------------------------

### Call mpmX Algorithm for Process Mining

Source: https://help.mpmx.com/platform/qlik/advanced-features-and-configurations/how_to_load_more_than_one_event_log

This example demonstrates how to call the mw_pa_initMining function to initiate the mpmX algorithm. Ensure all parameters, including scenario name, log table, grouping table (if any), data connection, and QVD storage folder, are correctly specified.

```qlik-script
callmw_pa_initMining('Users','EventLog','','$(DataConnection)','$(mvStorempmXModelQVD)','');
```

--------------------------------

### Timestamp Format Example

Source: https://help.mpmx.com/basics/Glossary

An example of a timestamp format.

```text
DD.MM.YYYY hh:mm:ss
```

--------------------------------

### Set mpmX Initialization Parameters

Source: https://help.mpmx.com/platform/qlik/advanced-features-and-configurations/pre-mining-configurations/use_the_template_app_with_already_mined_data

Configure the mvProcessDescription and mpmXvAppConfigAlias variables in the mpmX init section of the Data Load Editor. mvProcessDescription controls subpath access within the customizing folder, while mpmXvAppConfigAlias manages the call of script files.

```qlikview-css
LET mvProcessDescription = 'PBA';  

SET mpmXvAppConfigAlias = 'sql_backend';  
```

--------------------------------

### Activity Example

Source: https://help.mpmx.com/basics/Glossary

An example of activities within an IT ticket process.

```text
An IT ticket process could have the activities "Insert ticket" , "Assign seriousness" , "Take in charge ticket" , "Wait" , "Resolve Ticket" and "Closed".
```

--------------------------------

### Variable Naming Convention Example

Source: https://help.mpmx.com/basics/Glossary

Examples of how variables are named in mpmX.

```text
$(vField) $(vProfit) $(vColor)
```

--------------------------------

### Wildcard Examples

Source: https://help.mpmx.com/basics/Glossary

Examples of wildcard usage in the Process Modelers Activity List.

```text
[*]
```

```text
[???]
```

```text
[??2]
```

--------------------------------

### Example of Master Item Label Translation

Source: https://help.mpmx.com/platform/qlik/use-apps-and-scripts/template-app/customization/master-items-and-translations/mpmx_masteritems_csv

This example shows how a specific master item's translation is looked up using its ID.

```qlik
$(label(Measure_Label_MasterItemID_140150))
```
Tokens:
Raw