Skip to main content

Celonis Product Documentation

Start the Celonis Agent

The Celonis Agent can either be started in the command line or as a service. We recommend running the Agent as a service to ensure automatic restart whenever the server is rebooted.

Responsible role: Server/ infrastructure administrator.

Start the on-prem Agent as a service
On Windows

The Agent package contains four files that enable you to run the Agent as a Windows service:

  • CelonisAgent.xml: The configuration file of the service. Normally, you do not need to make any changes to this file.

  • install_and_start.bat: The batch file to install and start the services on the server.

  • starter.bat: The batch file to start the service manually.

  • shutdown.bat: The batch file to stop the service manually.

To perform an install, a startup or a shutdown, you need to run the batch file. Once started as a service, you can check in your Task Manager whether the Agent is running on your local machine.

57543113.gif
On Linux, MacOS

To start the application on startup of the server, you can use systemd - the standard way to start a Linux service at boot.

For this you need to create a unit file and move it in the directory /etc/systemd/system/. You can use this example unit file below named celonis_agent.service:

[Unit]
Description=Celonis Agent Service.
 
[Service]
Type=simple
User=username
WorkingDirectory=[path to folder of installation]
ExecStart=/usr/bin/java -jar celonis-agent.jar 
Restart=on-abort
 
[Install]
WantedBy=multi-user.target

To enable and start the service execute the following commands

sudo systemctl start celonis_agent.service: # starts the service
sudo systemctl enable celonis_agent.service # registers the service so that it is started on boot

Notes for Mac users

You might have to actively grant permission to open one of the jco files:

  1. Go to Apple menu > System Preferences > Security & Privacy, then click General and Allow Anyway.

  2. Run the service to get a message with 'open' option and click open

Start the on-prem Agent manually in the command line
Windows, Linux, MacOS

  1. Open your command line tool.

  2. Go to the folder where the Agent is located and run the following command:

    java -jar celonis-agent.jar

Tip

Once you've started the Agent, you can check its status (connected/ disconnected) in the Agents page. For more information, see Agent Monitoring.