Integrating Apache Kafka queues with Maximo Manage

Integrate Apache Kafka queues with Maximo® Manage to implement notification messaging.

Before you begin

To configure push notifications, you must configure either JMS queues or Apache Kafka queues.

This example assumes you already have a notification queue created in Kafka. For this example, the notification queue is named notfqueue.

Procedure

  1. Add a Kafka provider.
    1. From Maximo Manage, open the External Systems application.
    2. Add or select the external system and then select Add/Modify Message Providers to open the Message Hub Provider dialog box.
    3. Set a name for your provider, KAFKA for example, and then set the properties required to connect to your Kafka server.
  2. Add the Kafka queue to Maximo Manage.
    1. From the External Systems application, select Add/Modify Queues.
    2. Click the new row icon. For the Message Provider field, click the lookup icon and select the Kafka message provider that you specified.
    3. For the Queue JNDI Name field, click the lookup icon and select the Kafka notification queue.
      For example, notfqueue.
    4. Deselect Inbound.
      Notification queues are sequential outbound.
    5. Click OK.
    For more information, see Adding Kafka queues to external systems.
  3. Create a Kafka cron task instance.
    1. Open the Cron Task Setup application.
    2. From the Cron Task field, search for Kafka.
    3. Click the Kafka row to open the cron task.
    4. From the Cron Task Instances list, click the new row icon to add an instance for the notification queue.
    5. In the Details section, enter a Cron Task Instance Name.
      For example, kafkanotf.
    6. Enter values for Schedule, Run as User, and other fields as required.
    7. Enable the Active? option.
    8. In the Parameters section, enter a name in the Value field of the TOPIC cron task parameter.
      For example, notfqueue.
    9. Set the PARTITION parameter to 0.
    10. Set the MESSAGEPROCESSOR parameter to com.ibm.tivoli.maximo.notification.NotificationMessageProcessor.
    11. Set the MESSAGEHUB parameter to the name of your message provider.
      For example, KAFKA.
    12. Save the record.
    For more information, see Configuration of the Kafka cron task.
  4. Set the notification external system.
    1. Open the External Systems application.
    2. From the System field, search for NOTIFICATION.
    3. Click the NOTIFICATION row to open the NOTIFICATION record.
      The NOTIFICATION system is the default system used for notifications. Use this system for all notification configuration. Do not create a new system to handle notifications.
    4. If the Enable? option is enabled, deselect the option to disable it, and then save the record.
    5. For the Outbound Sequential Queue field, click the lookup icon and select the Kafka notification queue.
      For example, notfqueue.
    6. Enable the Enable? option, and then save the record.