Installing on-prem clients on Windows
This guide provides step-by-step instructions on how to set up the Celonis on-prem clients on Windows. The installation process consists of three stages which are performed by a Celonis Platform user with Admin rights, and an IT admin interchangeably.
Before you begin
Make sure your system meets hardware and software requirements for clients. See System requirements.
For security reasons, we advise you to install the on-prem agent package using a non-admin Windows user account.
If you’re a 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:
In your Celonis Platform instance, go to Admin & Settings > On-prem clients.
In the upper-right corner, click Set up on-prem clients.
Select Install the clients on a central server.
Enter a unique installation package name.
Select the operating system on which you want to install the clients.
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.
Procedure:
Using the link from the email you received from the Celonis Platform user, download the installation package.
Extract the ZIP package.
Install your clients using the installer or with the manual installation folder:
Tip
The installer can be used only once. If you want to install multiple on-prem clients on the same machine, use the manual installation folder.
Using the installer
Double-click Celonis_On_Prem_Clients_Installer.exe to run the installer.
Follow the steps of the installation wizard.
Using the manual installation folder
Go to the Celonis On-prem Clients Manual Installation folder.
Copy the Celonis On-prem Clients folder and paste it to the Program Files folder.
Go to the Shared folder and open the On-prem Client Management Tool.
Tip
If you need to set up SNC for SAP, see Setting up the agents with SNC.
Once the installation is completed, the On-prem Client Management Tool opens.
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:
Click Generate encryption key.
Tip
We use java.security and javax.crypto fameworks to store and encrypt sensitive data in the application.yml file.
Define a passphrase which will be used to create the hash for the private encryption key.
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:
Click Use proxy for communication.
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
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.
If you’re a Celonis Platform user and you received a request to verify the on-prem client installation from your IT admin, follow these steps.
Important
To verify the on-prem clients' installation, you must be Celonis Platform admin or you must have "edit agent" permissions assigned to your role.
Procedure:
Go to the Verification URL sent by the IT admin.
Log in to Celonis Platform.
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.
If you're having trouble connecting the on-prem clients to Celonis Platform, see Manual authentication.
To establish a connection between Celonis Platform and SAP, you must download the SAP Java Connector (SAP JCo) library, version 3.1 or later, and place it in your local directory. SAP Jco allows applications to communicate with SAP systems using SAP's RFC protocol.
Download the respective package from the SAP Support Portal.
Note
Only SAP Service users (S-user) can download software from SAP portals. Usually, a customer's SAP BASIS has this access.
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 ].
Copy the Library files directly into the external folder located at
{installation_folder}/shared/libraries/externalThe Celonis Agent is configured to read the library from this directory.
Note
After setting up the SAP Jco, the Windows Service Celonis Agent needs to be restarted for the SAP Jco-related changes to take effect.
Restart the on-prem clients:
If you're using Windows:
Go to the On-prem Client Management Tool.
In tabs for the automation client and SAP extractor click Stop and then Start to restart both services.
If you're using Linux, or MacOS:
Go to the On-prem Client Management Tool. In Terminal run:
./opc-management-tool-cli
In tabs for the automation client and SAP extractor click Stop and then Start to restart both services.
Related topics: