Skip to main content

Celonis Product Documentation

Installing on-prem clients locally

Limited availability

This functionality is currently in limited availability. If you’re interested in trying it out, get in touch with us through servicedesk@celonis.com.

Installing on-prem clients on your own machine can be useful for training or testing purposes. If you’re an EMS user follow these steps to prepare the installation package with on-prem clients which you can later download for local installation.

image4.png

Note

We recommend installing the on-prem clients on a central server.

Before you begin

Make sure your system meets hardware and software requirements for clients. See System requirements.

1. Preparing the installation package

Procedure:

  1. In your EMS instance, go to Admin & Setting > On-prem clients.

  2. In the upper-right corner, click Set up on-prem clients.

  3. Select Install the clients on your own machine.

  4. Enter a unique package name.

  5. Select the operating system on which you want to install the clients.

    The installer will start downloading automatically.

2. Installing on-prem clients

Procedure:

  1. Install your clients:

    • On Windows:

      1. Extract the ZIP package.

      2. Follow the steps of the installation wizard.

      Once the installation is completed, the On-prem Client Management Tool opens.

    • On MacOS, Linux:

      1. Extract the installation package to the location where you want to install the clients.

      2. Go to the Shared folder and run OPC-Managmenet-Tool.app.

        Tip

        Using a command-line interface?

        • on MacOS:

          1. To make sure you don't run into any permission-related issues, in Terminal, go to the Shared folder and run:

            xattr -cr opc-management-tool.app

            Note

            The -c flag removes all attributes, whereas -r applies recursively for the entire targeted .app directory contents.

          2. Go to Shared > opc-management-tool.app > Contents > MacOS.

          3. Start the On-prem Clients Management Tool using ./opc-management-tool cli.

        • On Linux:

          1. In Terminal, go the Shared folder.

          2. Start the On-prem Clients Management Tool. Run:

            sudo ./opc-management-tool cli

  2. (optional) Generate the encryption key to encrypt sensitive data in the installation package:

    1. Click Generate encryption key.

      Note

      Java Simplified Encryption (Jasypt) is used to store and encrypt sensitive data in the application.yml file.

    2. Define a passphrase which will be used to create the hash for the private encryption key.

    3. Click Save.

    This will automatically create the celonis-kms.yml file and encrypt all sensitive data like the application key and the proxy password.

    Important

    If you already connected your clients and want to enable encryption retroactively, you must authenticate again for the encryption to be applied.

  3. (optional) Define the proxy server between the on-prem client and the source system or between the on-prem client and the EMS:

    1. Click Use proxy for communication.

    2. Define the properties of your proxy connection:

      • protocol: http or https

      • host: the IP address or hostname of the proxy server

      • port: the port at which the server can be reached

      • user (optional): the user name for basic authentication with the proxy

      • password (optional): password for basic authentication with the proxy

    3. Click Save.

    This will automatically ensure that your connection will use the proxy for communication.

  4. Click Connect to EMS to generate the Verification URL.

    Note

    The AppKeys will be stored locally on your machine. We recommend that you additionally encrypt the AppKey in the Encryption Settings.

  5. Copy the Verification URL.

    You'll have to paste the Verification URL into your browser to verify the installation in the next stage.

  6. (Optional) Connect to SAP. This step is only required when automating in SAP. For more information, see Connecting to SAP.

3. Verifying the installation

Procedure:

  1. Go to the Verification URL.

  2. Log in to EMS.

  3. Review the request and select the required permissions.

  4. Click Authorize.

Newly created clients will also now be visible in the On-prem clients overview page under Admin & Settings > On-prem clients.

What’s next 

Create a Data Connection to connect to a specific source system and extract data from it into the EMS. For more information see, Data Connections.

If you want to start creating automations for your on-prem application, create a link between EMS and your on-prem system. See Creating on-prem connections.