Skip to main content

Relational Database Integration with Orkes Conductor

To use a JDBC task in Orkes Conductor, you must integrate your Conductor cluster with the necessary relational database providers.

The choice of database depends on your use case—whether for transaction processing, analytical queries, or data warehousing. It also varies based on required functionalities such as indexing, partitioning, and replication, as well as data management needs like integrity enforcement, concurrency control, and recovery.

note

Orkes Conductor currently supports integration with PostgreSQL.

This guide explains how to integrate a Relational Database with Orkes Conductor. Here’s an overview:

  1. Get the required credentials from the database provider.
  2. Configure a new Relational Database integration in Orkes Conductor.
  3. Add tables to the integration.
  4. Set access limits to the database tables to govern which applications or groups can use them.

Step 1: Get the credentials from the PostgreSQL database​

Set up PostgreSQL and retrieve the following database credentials:

  • Database username
  • Password
  • Database URL

Step 2: Add an integration for Relational Database​

After obtaining the credentials, add a Relational Database integration to your Conductor cluster.

To create a Relational Database integration:

  1. Go to Integrations from the left navigation menu on your Conductor cluster.
  2. Select + New integration.
  3. In the RDBMS section, choose Relational Database.
  4. Select + Add and enter the following parameters:
ParameterDescription
Integration nameA name for the integration.
Database TypeSelect the type of database to integrate. Currently supports Postgres.
Database UserThe database username.
Database PasswordThe password associated with the database username.
Database URLThe database URL, which is the JDBC connection string in the format: jdbc:database://url/databaseName.
DescriptionA description of the integration.

Create Relational Database Integration

  1. (Optional) Toggle the Active button off if you don’t want to activate the integration instantly.
  2. Select Save.

Step 3: Add Relational Database table​

Once you’ve integrated a Relational Database, the next step is to configure specific tables.

To add a table to the integration:

  1. Go to the Integrations page and select the + button next to the integration created.

Create Relational Database Integration Table from Listed Integrations

  1. Select + New Table.
  2. Enter the Table name and a Description.

Create Relational Database Integration Table

  1. (Optional) Toggle the Active button off if you don’t want to activate the table instantly.
  2. Select Save.

This saves the table for future use in JDBC tasks within Orkes Conductor.

Step 4: Set access limits to integration​

Once the integration is configured, set access controls to manage which applications or groups can use the database tables.

To provide access to an application or group:

  1. Go to Access Control > Applications or Groups from the left navigation menu on your Conductor cluster.
  2. Create a new group/application or select an existing one.
  3. In the Permissions section, select + Add Permission.
  4. In the Integration tab, select the required relational database providers and toggle the necessary permissions.
  5. Select Add Permissions.

Add Permissions for Integrations

The group or application can now access the database tables according to the configured permissions.

With the integration in place, you can now create workflows using the JDBC task.