Table of Contents

• Getting Started
  • Helpful Background Information
  • Prerequisites
  • External Dependencies
  • Adapters
  • How to Install
  • Testing
• Using this Workflow Project
  • Produce Message - Kafka - Library
• Additional Information
  • Support

Getting Started

This section is helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

Workflows often include logic that varies from business to business. As a result, we often find that our Workflow Projects are more useful as modular components that can be incorporated into a larger process. In addition, they often can add value as a learning tool on how we integrate with other systems and how we do things within the Itential Automation Platform.

While these can be utilized, you may find more value in using them as a starting point to build around.

Prerequisites

Itential Workflow Projects are built and tested on particular versions of IAP. In addition, Workflow Projects are often dependent on external systems and as such, these Workflow Projects will have dependencies on these other systems. This version of Apache - Kafka - Library has been tested with:

• IAP 2023.2

External Dependencies

Adapters

How to Install

To install the Workflow Project:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Supported IAP Versions section in order to install the Example Project.
• Import the Example Project in Admin Essentials.

Testing

Cypress is generally used to test all Itential Example Projects. While Cypress is an opensource tool, at Itential we have internal libraries that have been built around Cypress to allow us to test with a deployed IAP.

When certifying our Example Projects for a release of IAP we run these tests against the particular version of IAP and create a release branch in GitLab. If you do not see the Example Project available in your version of IAP please contact Itential.

While Itential tests this Example Project and its capabilities, it is often the case the customer environments offer their own unique circumstances. Therefore, it is our recommendation that you deploy this Example Project into a development/testing environment in which you can test the Example Project.

Using this Workflow Project

Workflow Projects contain 1 or more workflows. Each of these workflows have different inputs and outputs.

Produce Message - Kafka - Library

Produce messages on a Kafka topic

Capabilities include:

• Produce messages on a Kafka topic

Entry Point IAP Component

The primary IAP component to run Produce Message - Kafka - Library is listed below:

Inputs

The following table lists the inputs for Produce Message - Kafka - Library:

Kafka

test-topic

[
  "test message1",
  "test message2"
]

true

Outputs

The following table lists the outputs for Produce Message - Kafka - Library:

{
  "status": "success",
  "code": 200,
  "response": {
    "test": {
      "0": 22
    }
  }
}

Success

Query Output

The following items show how to query successful results from the output of Produce Message - Kafka - Library:

kafkaStatus

kafkaStatus

The following items show how to query failure results from the output of Produce Message - Kafka - Library:

kafkaStatus

kafkaStatus

Example Inputs and Outputs

Example 1

Input:

{
  "adapterId": "Kafka",
  "topic": "test-topic",
  "messages": ["test message1", "test message2"],
  "suppressMessage": false
} 

Output:

{
  "adapterId": "Kafka",
  "topic": "test",
  "messages": [
    "test message"
  ],
  "suppressMessage": false,
  "_id": "b6dae5bf1d344164bdeccd17",
  "initiator": "admin@pronghorn",
  "messagesArr": [
    {
      "topic": "test",
      "messages": [
        "test message"
      ]
    }
  ],
  "kafkaResponse": {
    "status": "success",
    "code": 200,
    "response": {
      "test": {
        "0": 22
      }
    }
  },
  "kafkaStatus": "Success",
  "responseBody": {
    "status": "success",
    "code": 200,
    "response": {
      "test": {
        "0": 22
      }
    }
  }
} 

API Links

Additional Information

Support

Please use your Itential Customer Success account if you need support when using this Workflow Project.