Manage Kafka Data Streams

Required permissions: Data Streams

This page helps you set up and subscribe to a Kafka data stream. CXone Mpower provides IVRClosed Interactive Voice Response. Automated phone menu contacts use via voice or key inputs to obtain information, route an inbound voice call, or both. logs as a stream, so you must set up a method of consuming the data at a destination that you control. A full setup includes configuration steps in CXone Mpower along with setting up the service or system that will subscribe to and consume the stream.

When configuring the stream in CXone Mpower, you can choose to consume the data in the following schema formats:

  • PROTO
  • JSON
  • AVRO
  • JSON with Line Feed
  • JSON AVRO with Line Feed

Set Up a Kafka Data Stream

First, plan how you will use the Kafka stream. You must have the technical resources to create a destination that can subscribe to the stream. This requires you to accommodate the security requirements:

  • Providing IPv4 CIDRs that you want to use to access the Kafka topics. This assures CXone Mpower that your IPs are legitimate and allowed. You can have two IP CIDRs added at a time.

  • An authentication method to use the username and password credentials from CXone Mpower.

Create a Kafka Data Stream in CXone Mpower

The following instructions help you create a data stream, generate a set of credentials, and add the IP CIDRs that you will use to subscribe to the data stream.

  1. Click the app selector icon of app selector and select Admin.
  2. Go to Account Settings > Event Data Stream.

  3. Click Create New Data Stream.

  4. Enter the data stream's Name and optionally a Description.

  5. Select IVR Log as the Event Type.

  6. For Data Format, choose which schema format you want the data to be in.

  7. For Target Stream Type, select Kafka External.

  8. Generate a set of credentials. This is the username and password that you can use to subscribe to the Kafka stream.

    1. Click Manage in the Security section of the New Data Stream page; a security manager window opens.

    2. For Alias, enter a unique name for the set of credentials. You must enter at least six characters that are alphanumeric. The only special characters allowed are a dash (-) or an underscore (_).

      You can only have two sets of credentials created for a data stream at a time. If necessary, you can delete a set of credentials then create a new one.

    3. Click Create and Download. This downloads the username and password as a CSV file.

  9. In the same security manager window, scroll down and enter the IP CIDRs that you want to use for the data stream:

    1. Scroll down to the Allowed IP CIDRs section.

    2. For IP CIDR, enter the full CIDR of the IP addresses that you want to subscribe through. Be sure to include both the IP address and subnet mask for the full CIDR address. You can enter multiple CIDRs at one time, separated by a comma.

      • You can only have two sets of IP CIDRs for a data stream at a time. You can delete an IP CIDR if necessary.
      • Data Streams currently supports IPv4.
      • The maximum allowed range is between /24 to /32.

    3. Click Ok.

  10. Click Create.

After creating the data stream, the Stream Details display at the bottom. This includes the broker details, consumer group ID, and the topic name. You can use these to set up your service or system that will consume the data.

Also, the data stream typically becomes active immediately after creation. At a maximum, it may take 15-30 minutes.

Set Up a Destination to Subscribe to the Kafka Stream

In your own Kafka destination , you must insert the stream broker details that you generated in the previous section. Your technical team must use their expertise to do so.

Delete Kafka Credentials

For security purposes, you may want or need to replace a set of credentials. In CXone Mpower, you have the option to soft delete or hard delete a set of credentials. Soft deleting means that the credentials become inactive for two days, after which they are completely deleted. This allows you time to generate a set of new credentials and implement them for your Kafka subscription. A hard delete is an immediate deletion.

  1. Click the app selector icon of app selector and select Admin.
  2. Go to Account Settings > Event Data Stream.
  3. Select your desired data stream.
  4. In the Security section where your credential aliases are listed, click Manage.
  5. Click the delete icon in the Action column for the credentials you want to delete. A confirmation notification appears.
  6. Choose whether you want to soft delete or hard delete the credentials:
    • To soft delete, confirm the deletion. The Status icon changes to yellow. After two days, the credentials will be permanently deleted.
    • To hard delete, enable the checkbox to delete the credentials immediately, then confirm the deletion.

Troubleshoot Issues with Kafka Data Streams

If your data stream subscription is not functioning correctly, check the following:

  • You entered the correct broker details in the system that is subscribed to the stream. These can be found in CXone Mpower in the Stream Details section of the data stream's details.

  • The data stream's details to ensure you entered the correct IPv4 CIDRs. Ensure that these IPs are also shown as Active in the CXone Mpower interface.

  • That the credentials are correct in the system consuming the data stream.