Skip to main content

Celonis Product Documentation

Installing SAP Extractor on Linux
1. Set up the Connection in the Celonis Cloud => Admin and Settings

  1. Go to Admin and Settings and then system/Uplink integrations.

  2. Create a new uplink with the type "Connector" (independent of which Connector type you would like to connect).

  3. Copy the keys and save them temporarily as they will be needed later in the process.

2. Download and Configure the Extractor

  1. Download the extractor package from here (SAP) or here (JDBC).

  2. Add the copied keys to config file application-local.yml (see the example below)

Spacing in the configuration

Please make sure not to change anything regarding the white spaces in the configuration file application-local.yml. The different elements need to be spaced exactly as in the original example.

Change the following settings:

  • The file name after "file:" indicates the name of the log file into which the extractor writes. The file will be automatically created.

  • The following options need to be configured:

    • url: You need to adapt the team name - it should point to the team that the data should be send to - https://{team}.{cluster}.celonis.cloud/uplink/api/public/uplink

    • clientId: The client ID of the uplink endpoint that you have already set-up

    • clientSecret: The client secret of the uplink endpoint that you have already set-up

If you would like to use a proxy (optional), please refer to the proxy configuration page.

3. Setup the JCo (applicable only for SAP Extractor)

To communicate with the Celonis RFC module, the Extractor 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:

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.

  • Copy the Library files into the dedicated folder in the Extractor Package

The Library contains 2 files - a Java part “sapjco3.jar”, and an operating system-specific part, for example, sapjco3.[.dll | .so | .sl ].

After downloading the files make sure to copy the to the following folder on the extractor server "Extractor path\jco". The extractor is configured to read the Library from this directory.

4. Run the Extractor

You can run the Extractor in of the following ways:

Run the Extractor 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:

 java -Xmx8g -jar connector_file_name.jar

Running multiple extractors

If you like to run multiple on premise extractors in the same folder, you need to rename the application-default.yml files so that they are distinct. Then you need to start the respective extractor with the following command:

 java -Dspring.config.location=configuration_file_name.yml -Xmx8g -jar extractor_file_name.jar
Running an on-premise Extractor as a service

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

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_extractor.service:

celonis_extractor.service

[Unit]
Description=Celonis Extractor Service.

[Service]
Type=simple
User=username
WorkingDirectory=[path to folder of installation]
ExecStart=/usr/bin/java -Xmx8g -jar connector-sap.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_extractor.service # starts the service
sudo systemctl enable celonis_extractor.service # registers the service so that it is started on boot

On Windows

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

  1. Celonis<ConnectionType>Extractor.xml: The configuration file of the service. Normally, you do not need to make any changes to this file.

  2. install.bat: The batch file to install the services on the service.

  3. startup.bat: The batch file to start the service manually.

  4. 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 as an administrator. To do that, simply right click on the respective file and then select "Run as administrator".

JDBC Extractor Setup on Docker (applicable only for JDBC extractor)

Separate driver

You specify the driver in the following way when running the Extractor:

Supply the driver

-v <path_to_driver_locally>:<path_to_driver_in_the_container> <connector_package_name> # insert the local and container path to the driver

  1. Load the extractor package image into docker:

    docker load --input <connector_package_name>.tar.gz

  2. Steps to run the extractor in the command line:

    docker run \ 
-e UPLINK_ENABLED=true \ 
-e UPLINK_URL=https://{team}.{cluster}.celonis.cloud/uplink/api/public/uplink \ # insert the team url, it should point to the team that the data should be send to. 
-e UPLINK_CLIENTID=<clientID>\ # insert the client ID of the uplink endpoint that you have already set-up 
-e UPLINK_CLIENTSECRET=<clientsecret>\ # insert the client secret of the uplink endpoint that you have already set-up 
-p <port>:<port>\ # insert the port 
-v <connector_package_name> # provide the package name
Additional information

Using log files of the on-premise Extractor

If you encounter an error when starting or running the Extractor, it is very helpful to have a look at the log file that the Extractor produces. It can be found in the same folder as the Extractor and it has the name given in the configuration file (see above), by default &lt;ConnectionType&gt;_connector.log. Please also share this file with the Celonis Service Desk if you would like to report an issue.