Skip to main content

Celonis Product Documentation

For Action Flows - Install the Celonis Agent via Installer

Note

Note: The installer includes the newest version of the Agent for Action Flows.

It is only available for Windows. For Linux or MacOS please follow the For Action Flows - Manually setting up Celonis Agent.

Two AF Agents

If you want to install a second Action Flow Agent this won't work with the installer. Please do the manual installation instead.

Quick-Start

You can jointly install the SAP Real-time Extractor and Celonis Agent via the Installer.

Install the Celonis Agent
Step A: Create an Application Key

Create Application Key for Celonis Agent

In the installer, you will be prompted to enter an application key. To obtain one and grant the right permissions, please go to the team you want to install the Celonis Agent on and follow the steps in the link above.

Step B: Download the Installation Package

Download SAP Extractor and on-Prem Agent

The installer download can be found at the page above. You can find the latest version under 'Joint Agent and Extractor Installer' (see screenshot below).

Step C: Install the Agent
  1. Run the installer by double-clicking on the file and click 'Install'.

    Note

    Please make sure that you run the installer with admin right.

    Note

    Please ensure at least Java 11 is installed. See also Set up server for Celonis Agent.

    (Required Microsoft Visual C++ libraries will be installed automatically.)

  2. After successfully checking and installing the respective dependency libraries, the installer will prompt to install the Agent. Click 'Next' to proceed.

  3. If you don't need the SAP Real-Time Extractor, you can skip the Uplink configuration. If you want to install both the Agent and the Extractor, refer to this documentation on how to get the Uplink credentials.

  4. In the next step, you need to configure the Agent by specifying the cluster as well as the team you want to run it on. Additionally, you will be asked to enter the application key you created in Step A as well as the Agent name, which can be randomly chosen by you.

    Example:

    • Team Domain: test-team

    • Realm: eu-1

    • App Key: FTGRJI(%FHJ....

    • Agent Name: agent007

  5. After you click on 'Next', you can specify where you want the agent to be installed.

  6. Once successfully installed, the registered Agent can be viewed in theAgentspage in your EMS team.

    After installation, the Agent folder can be found in the programs:

    In the Agent folder you can e.g. find the execution logs, see also Agent Monitoring

    50727024.png
Step D (optional): Connect to SAP

The Celonis Agent needs to establish a connection to the SAP system and be able to make RFC calls. For this purpose we use an industry standard library - The SAP Java Connector (SAP JCo) - which is maintained and published by SAP itself. The JCo library should be downloaded and setup separately.

This involves 2 steps:

1. Download the respective package from the SAP MArketplace (

Note

SAP Note: This step should be performed by someone who has an SAP Service User (S User), which authorises to download software from SAP portals. Usually customer's SAP BASIS has this access.

2. Copy the Library files into the dedicated jco folder in the "Celonis SAP Shared" folder. The "Celonis SAP Shared" folder is located in the installation directory, the default is.../Program Files/Celonis SAP Components. The downloaded jco folder already contains 2 files: a Java part “sapjco3.jar”, and an operating system-specific part e.g. sapjco3.[.dll | .so | .sl ]. After downloading the files make sure to copy the 2 files to the folder "jco". The Celonis Agent is configured to read the library from this directory.

Note

After setting up the jco, the Windows Service Celonis Agent needs to be restarted for the jco related changes to take effect.

50727024.png
50726488.png
50726924.png
Step E: Add System Connections

Add System Connections

here you can find information on adding system connections.

Update to a New Version

In order to update the Extractor or Agent to the newest version,

  1. Download SAP Extractor and on-Prem Agent (Download the most recent version here)

  2. Start the installation by double-clicking on the installer

  3. Follow the steps in the installer

  4. Confirm the update by clicking "OK" (Note: The services will be automatically stopped, updated and reinstalled. No manual step required.)

50744978.png
(Re-)Configure the Agent

After installing the Agent, you can (re-)configure the Agent for specific setups instead of rerunning the complete installation for small changes. The workflow can be found here in order to rename the agent or set limit for concurrent executions.