Skip to main content

NATS Messaging Integration with Orkes Conductor

To use the Event task or enable Change Data Capture (CDC) in Orkes Conductor, you must integrate your Conductor cluster with the necessary message brokers. This guide explains how to integrate NATS Messaging with Orkes Conductor to publish and receive messages from queues. Here’s an overview:

  1. Get the required credentials from the NATS server.
  2. Configure a new NATS Messaging integration in Orkes Conductor.
  3. Set access limits to the message broker to govern which applications or groups can use them.

Step 1: Get the NATS server credentials

To integrate NATS Messaging with Orkes Conductor, retrieve the following credentials from your NATS server:

Step 2: Add an integration for NATS Messaging

After obtaining the credentials, add a NATS Messaging integration to your Conductor cluster.

To create a NATS Messaging integration:

  1. Go to Integrations from the left navigation menu on your Conductor cluster.
  2. Select + New integration.
  3. In the Message Broker section, choose NATS Messaging.
  4. Select + Add and enter the following parameters:
ParemetersDescriptionRequired / Optional
Integration nameA name for the integration.Required.
ServerThe NATS server URL.Required.
Connection TypeThe preferred connection type. Supported values:
  • Default–Standard NATS connection.
  • Jetstream–Advanced NATS connection with streaming capabilities.
Required.
Connection MechanismThe connection mechanism for the Jetstream connection. Supported values:
  • With stream–The regular approach in a Jetstream connection, where each stream defines how the messages are stored and the retention limits.
  • With consumer–The mechanism that acts as an interface for clients to consume a subset of messages stored in a stream.
Required if the Connection Type is Jetstream.
Stream nameThe name of the stream for Jetstream connection.Required if:
  • Connection Type is JetStream
  • Connection Mechanism is With consumer.
Consumer nameThe name of the consumer for Jetstream connection.Required if:
  • Connection Type is JetStream
  • Connection Mechanism is With consumer.
Consumer typeThe type of consumer for Jetstream connection. Supported values:
  • Push–The server actively delivers messages to the client.
  • Pull–The client requests messages from the server when ready.
Required if:
  • Connection Type is JetStream
  • Connection Mechanism is With consumer.
Batch Poll Consumers CountThe number of consumers to be polled per batch when using the Pull consumer type.Required if:
  • Connection Type is JetStream
  • Connection Mechanism is With consumer.
  • Consumer Type is Pull.
Authentication TypeThe preferred authentication method. Supported values:
  • With Credentials
  • Without Credentials
Required.
UsernameThe username of the NATS server.Required if Authentication Type is With Credentials.
PasswordThe password associated with the username.Required if Authentication Type is With Credentials.
Select security protocolThe security protocol for authenticating the connection. Supported values:
  • NONE
  • JWT–If selected, upload the JWT Credentials file.
  • TOKEN_BASED_AUTHENTICATION–If selected, obtain the JWT token from your NATS server using an API.
Required.
Transport Layer SecurityThe Transport Layer Security (TLS) security mechanism. Supported values:
  • NONE–No TLS security.
  • PEM–Uses PEM files for TLS security. If selected, upload the CA certificate PEM file.
  • JKS–Uses Java KeyStore for TLS security. If selected, upload the CA certificate JKS file.
Required.
Trust Store AuthenticationThe preferred trust store authentication type. Supported values:
  • NONE–No TLS authentication.
  • usingPassword–Uses the trust store password for TLS authentication. If opted, enter the Trust Store Password.
Required if Transport Layer Security is JKS.
DescriptionA description of the integration.Required.

NATS Messaging Integration with Orkes Conductor

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

Step 3: Set access limits to integration

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

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 message broker and toggle the necessary permissions.

Configuring RBAC for Nats Messaging Integration

The group or application can now access the message broker according to the configured permissions.

Next steps

With the integration in place, you can now: