Apache Kafka Send Message Activity¶
Introduction¶
An Apache Kafka Send Message activity, using its Apache Kafka connection, sends streams of data into a topic in an Apache Kafka cluster and is intended to be used as a target to consume data in an operation.
Create an Apache Kafka Send message Activity¶
An instance of an Apache Kafka Send Message activity is created from an Apache Kafka connection using its Send Message activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.
An existing Apache Kafka Send Message activity can be edited from these locations:
- The design canvas (see Component Actions Menu in Design Canvas).
- The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
Configure an Apache Kafka Send message Activity¶
Follow these steps to configure an Apache Kafka Send Message activity:
-
Step 1: Enter a Name
Enter a name for the activity. -
Step 2: Review the Data Schemas
Any request or response schemas generated from the endpoint are displayed.
Step 1: Enter a Name¶
In this step, enter a name for the activity. Each user interface element of this step is described below.
-
Name: Enter a name to identify the activity. The name must be unique for each Apache Kafka Send Message activity and must not contain forward slashes
/or colons:. -
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Review the Data Schemas¶
Any request or response schemas generated from the endpoint are displayed. Each user interface element of this step is described below.
- Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.
The Apache Kafka connector uses the Apache Kafka Core API. Refer to the API documentation for information on the schema nodes and fields.
The request and response data schemas consist of these nodes and fields:
| Request Schema Node/Field | Description |
|---|---|
sendMessagesRequest | Node representing the activity request |
messages | Node representing the message being sent |
item | Node representing the items within the message being sent |
topic | String with the name of the topic the message is being sent to |
message | String containing the message |
| Response Schema Node/Field | Description |
|---|---|
sendMessagesResponse | Node representing the activity response |
response | Node representing the response |
item | Node representing the items within the response |
success | Boolean containing the success (true) or failure (false) of the message retrieval |
message | String containing the message |
topic | String with the name of the topic the message has been sent to |
error | Node containing any errors |
errorMessage | String containing error messages, if applicable |
-
Refresh: Click the refresh icon
or the word Refresh to regenerate schemas from the Apache Kafka endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation. -
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Finished: Click to save the configuration for all steps and close the activity configuration.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Next Steps¶
After configuring an Apache Kafka Send Message activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.
Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.
Apache Kafka Send Message activities can be used as a target with these operation patterns:
- Transformation Pattern
- Two-transformation Pattern (as the first or second target)
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.