Defining Apache Kafka Jobs

Processes in Automic Automation are combinations of individual steps that are linked to each other. Objects are entities that work together to form coherent automated sequences. As a developer and object designer, you create, edit and work with them in the Process Assembly perspective. Objects that are executing or have been executed are called tasks and they are visible in the Process Monitoring perspective, where you can access their history and monitors.

With the Apache Kafka Agent integration you can define two types of jobs:

  • Producer Jobs

    Automic Automation Producer Jobs write messages to Partitions in Topics on your Apache Kafka environment.

  • Consumer Jobs

    Automic Automation Consumer Jobs listen to Partitions in Topics on your Apache Kafka environment.

Producer and Consumer Jobs are Automic Automation objects, therefore they are one of these steps. As any other Automic Automation object, they consist of several definition pages. After adding a Job, you start configuring it by defining the relevant attributes on its definition pages. Some of these pages are standard and available for all object types. Others are available for some object types only.

This topic describes how to add a new Job to your Automic Automation system. The rest of the topics in this section describe how to configure the Jobs on their definitions pages.

Adding Apache Kafka Jobs

Follow these steps:

  1. In the Automic Web Interface, go to the Process Assembly perspective. It opens to the Explorer view that contains the list of jobs that are available to you in your system.

  2. You have two options:

    • Right-click anywhere on the list and select Add > Add Object.

    • Click the Add Object button on the toolbar.

  3. On the Add Object dialog, start typing Apache Kafka in the Search field. The list of Jobs is then restricted to display Producer Job and Consumer Job only.

  4. Select the type of Jobs that you want to crate and click Add. The Object Name dialog is displayed.

  5. Enter a descriptive Name.

  6. Optionally, enter a short and descriptive Title that helps you recognize the purpose of the object.

  7. Click OK. A new page opens where you can start with the object definitions.

Next Steps

You configure the Job by entering parameters on the following object definition pages:

  1. Jobs-specific page depending on the type of Job that you are creating. For more information, see Apache Kafka Integration: Defining Producer Jobs and Apache Kafka Integration: Defining Consumer Jobs.

  2. RA

    On this page you specify where to store the job report. For more information, see Defining RA/Integration Reports Properties.

  3. Optionally, enter additional configuration parameters on the Job common pages. For more information, see Defining Common Job Properties.

Note:

You can also define and modify Producer and Consumer Job properties using the Automation Engine scripting language. For more information, see Setting Consumer/Producer Job Attributes Through Scripts.

See also: