Installing on-prem clients on Windows

Click the download link in your Celonis invitation email to save the installation package to your local environment.

Extract the ZIP package.

Optional: Establish an SAP Connection.

Download the SAP Java Connector (SAP JCo) library, version 3.1 or later, to your local directory. The Celonis Agent requires this library to execute Remote Function Calls (RFC) against your SAP instances.

1. Download the respective package from the SAP Support Portal.

   The downloaded SAP Jco folder already contains two files: a Java part “sapjco3.jar”, and an operating system-specific part e.g. sapjco3.[.dll | .so | .sl ].

2. Copy the content of the SAP Jco folder into the following Automation Agent and Extraction Agent folders:

   The Celonis Agent is configured to read the library from this directory.

   • For Automation Agent

     {installation_folder}/Automation Agent/libraries/external

   • For Extraction Agent

     {installation_folder}/Extraction Agent/libraries/external

Install your clients using the installer or with the manual installation folder:

• Using the installer

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

  2. Complete the configuration prompts within the setup wizard to finalize the primary client deployment.

• Using the manual installation folder

  1. Go to the Celonis On-prem Clients Manual Installation folder.

  2. Copy the Celonis On-prem Clients folder and paste it into your Program Files directory. Append a distinct business-process suffix to each folder name to isolate your data pipelines.

     For example, name your directories Celonis On-prem Clients AP for your Accounts Payable extraction pipeline and Celonis On-prem Clients O2C for your Order-to-Cash automation stream.

     Important

     When deploying multiple on-prem clients on a single host machine, ensure every target folder name retains the mandatory Celonis On-prem Clients prefix followed by your process-specific suffix to preserve management tool tracking integrity.

  3. Go to the Shared folder and open the On-prem Client Management Tool.

The On-prem Client Management Tool opens automatically when the installation completes.

In the Management Tool, select the clients you want to install.

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

1. Click Generate encryption key.

   Tip

   We use java.security and javax.crypto fameworks 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.

(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.

Click Connect to Celonis Platform to generate the Verification URL.

Copy the Verification URL and share it with your Celonis Platform user.

(Optional) Connect to SAP. This step is only required when automating in SAP.