Skip to main content

Celonis Product Documentation

Start the Celonis Agent

Responsibility: Server/ infrastructure administrator

The Celonis Agent can either be started in the command line or as a service. Alternatively, you can jointly install the extractor and agent via the Installer (see For Action Flows - Install the Celonis Agent via Installer), which will automatically start the agent, too.

Once successfully started, the registered Agents can be monitored in the Agents page, see also Agent Monitoring.

Starting the Agent

There are two ways to start the Agent:

i) in the command line

ii) as a service

Start the Agent in the command line

Start the jar file by opening the terminal/cmd, navigating to the respective folder and running it with the following command:

you can navigate to the respective folder with typing in cd and add the right path behind, e.g. cd Desktop/CelonisAgent

java -jar celonis-agent.jar

Tips on how to navigate in the terminal

Click here to see the tips

1. use cd and then the tabulator key / button to navigate through your folder structure (also used in the gif on the right)

60361551.png

2. use the command 'ls' to see your folder structure

60361553.png

3. use the up button to get the commands executed previously (used to get the java -jar celonis-agent.jar command in the gif on the right)

60361556.png
60361543.gif

FOR MAC USERS

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

Click here to expand and see how to do it...

1. Apple menu > System Preferences, click Security & Privacy, then clickGeneralandAllow Anyway

60361549.png

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

55707940.png
Run the Agent as a service

The major benefit of running it as a service is that the Agent can be automatically started when the server is rebooted.

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.

In order to perform an install, a startup or a shutdown, you need to run the batch file.

  • Please check in your Task Manager whether the Agent is running on your local machine if it is installed there (see GIF below).

  • Enable Agent Alerts to be notified whenever the Celonis Agent disconnects from the EMS.

  • If it is installed on your IT system, please contact your IT administrator to check the Agent status.

57543113.gif
On Linux

If you wish 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 put it in the directory /etc/systemd/system/. You can use this example unit file below named celonis_agent.service:

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

Start the service

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