Skip to content

Redis Integration with Orkes Conductor

Available since

  • v5.3.0 and later

Integrating Redis with Orkes Conductor lets you build workflows that interact with the Redis database using the following operations:

  • Set Value
  • Get Value
  • Set Hash Field
  • Get Hash
  • List Keys
  • Delete Keys
  • Get TTL
  • Increment By
  • Publish Message
  • Get Info

This guide explains how to set up and use the integration. Here's an overview:

  1. Get the required credentials from Redis.
  2. Configure a new Redis integration in Orkes Conductor.
  3. Use Redis integration in workflows.

Step 1: Get the Redis credentials

Note

You can use this integration in either of the following scenarios: - Conductor is running locally, and Redis server is running locally. - Conductor is running in the cloud, and the Redis server is exposed via a secure tunnel or hosted on a cloud database service.

To integrate Redis with Orkes Conductor, get the following credentials from your Redis server:

Required:

  • Host
  • Port

Optional:

  • Database index
  • Username (if using Redis ACL)
  • Password (if authentication is enabled)

Step 2: Add an integration for Redis

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

To create an integration:

  1. Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
  2. Select + New integration.
  3. In the Database section, choose Redis.
  4. Select + Add and enter the following parameters:
Parameter Description Required/Optional
Integration name A name for the integration. Required.
Host The Redis server hostname or IP address. Required.
Port The Redis server port. Default is 6379. Required.
User The Redis ACL username. Omit for the default user. Optional.
Password The Redis password or ACL secret. Optional.
Database The Redis database index (0–15). Default is 0.

Note: Many Redis cluster deployments only support DB 0.		 Optional.
TLS Whether to enable TLS/SSL when connecting to Redis. Default is No. Required.
Description A description of the integration. Required.
  1. (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
  2. Select Save.

Step 3: Use Redis integration in workflows

Once the integration is ready, this can be used directly within the workflows.

To use Redis integration in a workflow:

  1. Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
  2. Select + Define workflow.
  3. In your workflow, select the (+) icon and select Connected Apps.
  4. In Add Task panel on the right, search for Redis, and select the integration created in Step 2.

The following operations are available for use with this integration.

Operation Description
Set Value Sets a string value with optional expiration and conditional write support.
Get Value Retrieves a key's string value.
Set Hash Field Upserts a single field in a hash.
Get Hash Retrieves all fields from a hash key.
List Keys Lists keys matching a specified pattern.
Delete Keys Deletes one or more keys.
Get TTL Retrieves a key's TTL in seconds.
Increment By Increments a counter key by a delta.
Publish Message Publishes a message to a channel.
Get Info Retrieves generic Redis instance information.
  1. Select the required operation, configure the parameters, and select Save > Confirm.
  2. Select Execute to run the workflow.

For the complete operations parameters and output reference, see Redis Operations Reference.