Skip to main content

Installation and Update

Prerequisites​

The Databricks App can be installed via the Databricks Marketplace using a private exchange.

To get access, contact your MPMX sales representative and provide them with your Databricks sharing identifier.

info

Find your Databricks sharing identifier by navigating to the Catalog page in your Databricks Workspace. Click the ⚙︎ symbol above the catalog browser and select Delta Sharing. From the dropdown in the upper right corner, copy your sharing identifier.

Copy sharing identifier
Copy sharing identifier

Compute​

Installing and using the app involves setting up various computes.

PurposeWarehouse Size
Installation
(Click to zoom)
(Click to zoom)
Usually you will use Serverless compute to run notebooks. For running the installation notebook (see below), select it from the upper right corner.
Using the app
(Click to zoom)
(Click to zoom)
The Databricks App interacts with the Databricks Platform via SQL statements, which in turn require a Serverless SQL warehouse to be executed. The warehouse size 2X-Small is sufficient here. The app is set up during the installation process with the Serverless SQL warehouse selected in the setup configuration dialog. It can be changed later in the Databricks App configuration.
Process Mining
(Click to zoom)
(Click to zoom)
(Click to zoom)
(Click to zoom)
In the App Settings, a default warehouse is configured. This Serverless SQL warehouse is used for process mining if no other warehouse has been configured for a scenario. We recommend using a warehouse of size 2X-Small. The initial setup is done during the installation process with the Serverless SQL Warehouse selected in the setup configuration dialog. It can be changed later in the app and it can be overridden with a SQL warehouse of an appropriate size for each scenario, depending on your data set. See Task Execution » Task Execution Warehouse

Groups and permissions​

To install the Databricks App using the installation notebook, you need Workspace Admin permissions.

During the installation, you will be asked to choose at least one account group which will become the App Admin. This account group has to be created by an account admin before executing the installation notebook.

Preview features​

Before running the installation notebook, enable the following:

  1. Databricks Apps - On-Behalf-Of User Authorization — required so mpmX can execute SQL statements on behalf of the signed-in user.

    1. Navigate to Previews in your Databricks workspace.
    2. Search for Databricks Apps - On-Behalf-Of User Authorization.
    3. Toggle the feature On.

  2. Serverless SQL Warehouse (Preview Channel) — the mpmX app requires a Serverless SQL Warehouse whose Channel is set to Preview.

    1. Go to SQL Warehouses in your Databricks workspace.
    2. Select or create a Serverless SQL Warehouse.
    3. In the Channel setting, ensure it is set to Preview.

Installation​

  1. Make sure that you have the permissions and preview features you need to install the app (see above and Preview features).

  2. Once we have shared the app with you, navigate to Marketplace in the left hand menu in your workspace. Search for mpmX - Process Mining for Databricks, open the listing and click on the "Get instant access" button in the upper right corner.

    Shared Listings
    Shared Listings

  3. If you want to change the name, expand the More options block and enter an appropriate name.

    Check the box and continue with "Get instant access".

    Get the listing
    Get the listing

  4. The dialog closes and at the bottom you see a sample notebook called Install_mpmX. Click Preview Notebook, then Import Notebook in the upper right corner. Open the imported notebook.

  5. Follow the instructions in the upper cell of the notebook. Check if all prerequisites are met before you install the app.

    Click Run all so the form appears in the 2: Configuration cell. Use that dialog to configure your installation.

    App identity

    • App Name - The name of the Process Mining Databricks App. By using different names, you can install multiple instances of the app if needed. The app name also appears in the managed App Principal display name; that display name cannot be customized separately.
    • App Catalog Name - Unity Catalog the app will use. Leave empty to keep the default (App Name with - replaced by _). An existing empty catalog (no schemas other than information_schema / default) may be reused so you can pre-provision catalogs via Terraform/DBT. This cannot be changed when updating an existing app.

    Install source

    • Install Source Catalog - The catalog that contains the mpmX install package. For Marketplace installs, choose the catalog created when you got access to the listing (the name may differ from the listing name if you changed it during the process described above). If we shared several listings with you, e.g. the sample data listing, make sure to pick the right one for the app installation.

    Access

    Compute

    • SQL Warehouse - The SQL Warehouse which is used for statements run by the app and the default SQL Warehouse for running the Process Mining Jobs (see Compute). Prefer a 2X-Small warehouse to reduce costs.

    Advanced (optional)

    • Catalog ownership
      • Transfer ownership (default) — make the app service principal the catalog owner.
      • Grant privileges — keep the current owner (e.g. a platform identity). Can only be used when the current user has MANAGE. Install then grants USE CATALOG, CREATE SCHEMA, and MANAGE to the app instead of changing the owner. Requires a pre-provisioned catalog.
    • Managed Storage Location - Optional path for the app catalog when it should use a storage location other than the metastore root. Locked when the catalog already exists. See CREATE CATALOG » MANAGED LOCATION.
    Installation dialog
    Installation dialog

  6. The installation process will take some minutes. Once the installation has finished, you will see the URL of your app in the output.

    Installation dialog
    Installation dialog

    It can also be found by navigating to Compute » Apps. Clicking on the app's name will take you to a screen where you can find the app's URL. Note that only users from the app admins groups use the app.

    App overview
    App overview
    App details
    App details

    When a user opens the app for the first time they must authorize the app to execute SQL queries on their behalf. This is necessary because the app must perform certain actions in the context of the current user to respect their privileges on the Unity Catalog.

    Permission request
    Permission request

This completes the setup and you are ready to take the first steps, e.g. create a process scenario.

Update​

When an updated version of the Process Mining App is provided for your account, the installation notebook described above must be executed again. It should be re-imported from the listing to make sure that the latest version containing any changes and bugfixes will be used.

Execute it as described above. This time, the app already exists which is why the button caption changes to Update mpmX. Running the update will copy the current code to your Databricks workspace. All changes that need to be done to existing tables, jobs or queries are also done. When everything has been updated, the app will be re-deployed and can be used again.

Update dialog
Update dialog