Skip to main content

Celonis Product Documentation

Installing on-prem clients on central server

This guide provides step-by-step instructions on how to set up the Celonis on-prem clients. The installation process consists of the following stages which are performed by an Celonis Platform user (with Admin rights) and an IT admin interchangeably:

  1. Preparing the installation package: in this stage, the Celonis Platform user decides where the package is going to be installed: on a central server or locally and chooses the operating system. If a user decides to install the package locally, they can download the package immediately. When installing the package on a central server, usually an IT admin needs to be involved to run the installation. In this case, the download will be directly shared with the IT admin.

  2. Installing on-prem clients: in this stage, the IT admin installs the agent package based on the settings sent by their Celonis Platform user. Once the installation is complete, the IT admin sends the Celonis Platform user a verification link so that they can finalize the Celonis Platform connection.

  3. Verifying connection: the Celonis Platform user has to click on the link sent by the IT admin to establish the connection.

image3.png
Before you begin

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

If you’re an Celonis Platform user follow these steps to prepare the installation package which you can later send to your IT admin so that they can install it on a central server.

Before you begin:

You need to have admin rights to prepare the installation package.

Procedure:

  1. In your Celonis Platform instance, go to Admin & Settings > On-prem clients.

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

  3. Select Install the clients on a central server.

  4. Enter a unique installation package name.

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

  6. Enter your IT admin email address and click Send.

Your IT admin will receive a link where they can download the package prepared based on the settings you selected. They will also receive detailed instructions on how to install the package on the server. Once they completed the installation, you’ll receive a verification URL or code to verify the connection with the Celonis Platform. If you already received that, jump straight to 3. Verifying the installation.

If you’re an IT admin and you received an installation request from your Celonis Platform users, follow these steps.

Before you begin:

  • Check if your system meets all the necessary requirements listed on this page.

  • On Windows, for security reasons, we advise you to install the on-prem agent package using a non-admin user account.

Procedure:

  1. Using the link from the email you received from the Celonis Platform user, download the installation package.

    • On Windows:

      1. Extract the ZIP package.

      2. Double-click Celonis_On_Prem_Clients_Installer.exe to run the installer.

      3. Follow the steps of the installation wizard.

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

    • On Linux

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

      2. In the extracted folder, go to the Shared folder, and run OPC-Managmenet-Tool.

        Tip

        Using a command-line interface?

        1. In Terminal, go the Shared folder.

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

          sudo ./opc-management-tool-cli
    • On MacOS:

      Tip

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

      1. Extract the installation package to your home folder.

        Tip

        Extracting the installation package to the MacOS home folder will help you avoid any permissions-related problems when running the tool later on.

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

        xattr -cr opc-management-tool.app
      3. From the Shared folder run OPC-Managmenet-Tool.app.

  2. (optional) In the Management Tool, generate the encryption key to encrypt sensitive data in the installation package:

    1. Click Generate encryption key.

      Tip

      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) If necessary, define the proxy server between the on-prem client and the source system or between the on-prem client and the Celonis Platform:

    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 Celonis Platform 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 and share it with your Celonis Platform user.

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

If you’re an Celonis Platform user and you received a request to verify the on-prem client installation from your IT admin, follow these steps.

Procedure:

  1. Go to the Verification URL sent by the IT admin.

  2. Log in to Celonis Platform.

  3. Verify the request and click Authorize.

    On-prem clients can now connect to Celonis Platform and create own AppKeys. 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 Celonis Platform. For more information see, Data Connections.

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