Skip to main content

Running the JDBC Extractor

There are two ways to run the JDBC Extractor on Windows/Linux servers:

Important

Before running the JDBC Extractor, you must have configured the uplink values in the extractor configuration. If you have not already done so, see (REQUIRED) Configuring Uplink connection values.

Note

Your on-premise JDBC Extractor must be running before using it to connect your database to the Celonis Platform.

Run an on-premise JDBC Extractor via command line

Start the JAR file by running the following command in the extractor installation directory:

 java -Xmx8g -Dspring.config.location=application-local.yml -jar connector-jdbc.jar

After you start the JDBC Extractor, you can check the Uplink connection status in the Celonis Platform by following the steps in Checking your Uplink connection status.

Note

After starting the JDBC Extractor, if you encounter connection issues, see Troubleshooting JDBC connections.

Running multiple extractors

If you have multiple on-premise extractors in the same folder, you must rename the application-default.yml files so that each is distinct. You can then start the respective extractor based on the following command:

 java -Dspring.config.location=configuration_file_name.yml -Xmx8g -jar extractor_file_name.jar

Run an on-premise JDBC Extractor as a service

The major benefit of running an extractor as a service is that the extractor can be automatically started when the server is boots.

On Linux

To ensure the extractor starts automatically at system boot, configure it as a standard Linux service using systemd.

For this, you need to create a unit file and put it in the directory /etc/systemd/system/. You can use the following example unit file named celonis_extractor.service:

Note

If you have multiple extractors, and you are using the example below, each requires a unique .service file. If you are a more advanced user, you can also use a Systemd Unit Template to manage multiple services from a single master file.

[Unit]
Description=Celonis Extractor Service.

[Service]
Type=simple
User=username
WorkingDirectory=[path to installation folder]
ExecStart=/usr/bin/java -Xmx8g -jar connector-jdbc.jar
Restart=always

[Install]
WantedBy=multi-user.target

To enable and start the service, execute the following commands:

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

After you start the JDBC Extractor, you can check the Uplink connection status in the Celonis Platform by following the steps in Checking your Uplink connection status.

Note

After starting the JDBC Extractor, if you encounter connection issues, see Troubleshooting JDBC connections.

On Windows

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

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

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

  • startup.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 must run the batch file as an Administrator. To do so, right-click on the respective file, and select Run as administrator.

After you start the JDBC Extractor, you can check the Uplink connection status in the Celonis Platform by following the steps in Checking your Uplink connection status.

Note

After starting the JDBC Extractor, if you encounter connection issues, see Troubleshooting JDBC connections.

Checking your Uplink connection status

Once you have configured your JDBC Extractor and it is running on your server, you can check it connection status in the Celonis Platform:

  1. In the Celonis Platform, navigate to Admin & Setting > Uplink Integrations.

  2. Locate your uplink in the list, and verify the status is successful, shown by a Uplink status successful in the Status column.

    Note

    It may take several minutes for the status to update on the initial connection.

    If the status remains Uplink status unlinked (unlinked), see Troubleshooting JDBC connections to help resolve possible issues.