Connecting to PostgreSQL (extractor)
The Celonis PostgreSQL extractor allows you to transfer data from PostgreSQL databases into the Celonis Platform for process mining and analysis. It supports the following basic features:
Note
There are two Celonis PostgreSQL extractors:
PostgreSQL
PostgreSQL encrypted
Except where noted, this documentation refers to both extractors collectively as the PostgreSQL extractor. For connection setup, they share the same features, authentication method, and connection parameters, with the exception of their JDBC string formats.
Prerequisites
This section details important prerequisites or prerequisite knowledge for using this extractor.
Before creating a connection between your database and the Celonis Platform you must decide which connection type you want to use. Except where stated in Supported database types, all databases have two basic connection types: Direct connections and Uplink connections via an on-premise extractor, as described below:
Direct connections: Use direct connections when you want to allow the Celonis Platform direct access to your database without additional infrastructure. Meaning, you do not need to install, patch, or maintain on-premises extractors, which speeds up implementation, reduces complexity, and simplifies operations.
Note
By default, all cloud-based extractors are direct connections.
Uplink connections via an on-premise extractor: Use uplink connections when you don't want to or can't allow the Celonis Platform to directly access your on-premise or private cloud database. The connection between the database and Celonis is then established using an on-premise extractor that's installed within your network ideally on a dedicated server.
The role of the extractor is to poll and fetch job requests from the Celonis Platform, before then submitting the execution information the the database via an SQL query. Once the data is retrieved from the database, the extractor fetches it and sends it back to the Celonis Platform. As such, the connection between the database and the Celonis Platform is always made by the extractor, with it continuously querying the Celonis Platform Celonis Platform for any extractions to execute.
Note
To use an uplink connection, you must install an on-premise extractor. For more information, see Installing an on-premise extractor for uplink connections.
Note
Only perform these actions if you will use an uplink connection to connect your database to the Celonis Platform.
To use an uplink connection, you must install an on-premise extractor in your environment. To do so, see Setting up. Additionally, if you want to use a proxy (optional), see Proxy settings for on-prem clients.
For the database extractor to communicate with your database and the Celonis Platform, you must modify your network settings to allow access.
Note
Follow the instructions in the sections based on which connection type you using. Additionally, ensure you follow the instructions in Celonis Platform IP addresses depending on the cluster as applicable.
The following network settings apply only for direct connections:
Source system | Target system | Port | Protocol | Description |
|---|---|---|---|---|
Celonis Platform | Source system | Depending on the database, typical ports are 5432 for PostgresSQL and 30015 for HANA for example | TCP | JDBC connection from the Celonis Platform to the database. The port is the one you normally use to connect to the database. The IPs of the Celonis Platform depending on the cloud cluster (which can be seen in the URL). |
The following network settings apply only for uplink connections (via the on-premise extractor):
Source system | Target system | Port | Protocol | Description |
|---|---|---|---|---|
On-premise extractor server | Source system | Depending on the database, typical ports are 5432 for PostgresSQL and 30015 for HANA for example. | TCP | JDBC connection from on-premise extractor server to the database. The port is the one you normally use to connect to the database. |
On-premise extractor server | Celonis Platform | 443 | TCP | HTTPS connection from on-premise extractor server to Celonis cloud endpoint. The IPs of the Celonis Platform depending on the cloud cluster (which can be seen in the URL). |
The respective clusters use multiple IPs each, so you need to enable all three of them in your firewall configuration to connect the on-premise extractor server and the cloud endpoint.
For a complete list of inbound and outbound Celonis Platform IP addresses to be allowlisted if needed, see: Allowlisting Celonis domain names, IP addresses, and third-party domains
This extractor can connect to the database using a database user account. Provide the username and password for this account to authenticate the connection. Ensure this database user has sufficient permissions to access the data to be extracted.
Configuring the PostgreSQL extractor
This section describes the basic setup of configuring the PostgreSQL extractor. To configure the extractor:
In the Celonis Platform left navigation, select Data > Data Integration.
On the Data Pools screen, select the data pool you want to use for the extraction.
Note
If you do not have a data pool to use for this extraction, see Creating and managing data pools for instructions on how to create one.
In the Data Integration section, select Connect to Data Source.
In the Add Data Connection window, select Connect to Data Source.
In the Connect to Data Source window, depending on your use case, select either Database – On Premise or Database – Cloud.
Note
Select Database – On Premise to connect to on-premise or private cloud databases.
If you selected Database – On Premise, follow the on-screen instructions.
In the New Database Data Connection window, fill in the following information:
For Name, provide a name for this configuration.
For Database Type, select either PostgreSQL or PostgreSQL encrypted.
For Connection Type, select either Standard or Custom JDBC Connection String.
If you selected Standard:
For Host, enter the hostname or IP address of your server.
For Port, provide the port to connect to (Default is
443).For Database Name, enter the name of the database that contains the data you want to extract.
(Optional) For Schema Name, enter the name of the schema that contains the tables to extract.
(Optional) For Additional Properties, enter any additional connection properties required by your database or driver. Separate each with
;.
If you selected Custom JDBC Connection String:
For JDBC Connection String, provide your string. Use the format:
For PostgreSQL:
jdbc:postgresql://<host>:<port>/<database>
For PostgreSQL encrypted:
jdbc:postgresql://<host>:<port>/<database>?ssl=true&sslmode=require
Note
For more information on connecting to PostgresSQL with JDBC strings, see the PostgresSQL documentation.
Optionally, provide values for:
Schema Name: Enter the name of the schema that contains the tables to extract.
Additional Properties: Enter any additional connection properties required by your database or driver. Separate each with
;.
For Credentials, provide the username and password of the database user for this connection.
Note
Ensure this database user has sufficient permissions to access the data to be extracted.
If desired, select Advanced Settings, and update these parameters as needed.
Note
The Validate Certificate parameter (Default:
DISABLED) controls whether the extractor validates the server’s SSL/TLS certificate:Disabled: Disables certificate validation.
Enabled: Enforces certificate validation.
Removed: Uses the driver’s default behavior. Check the driver documentation to confirm the default.
Select the Test Connection button to confirm the extractor can connect to the host system. If the test fails, adjust the data in the configuration fields as needed.
Once the test connection passes, select the Save button to continue. This returns you to the Data Integration window.