Configure an Extract Transform Load (ETL) consumer

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 1 minute to read
  • Import and process data from your Kafka environment using your existing Robust Transform Engine (RTE) configurations.

    Before you begin

    • Role required: integration_hub_admin
    • This consumer requires a Stream Connect subscription. For more information, see https://www.servicenow.com/products/automation-engine.html.
    • The following plugins are required.
      • The ServiceNow IntegrationHub Kafka Consumer [com.glide.hub.kafka_consumer] plugin.
      • The ServiceNow IntegrationHub ETL Consumer - Kafka [com.glide.hub.etl_consumer.kafka] plugin.
    • This consumer requires a robust import set transformer.

    About this task

    To configure a consumer, you need to create two records.
    1. The consumer record, which specifies how to import and process data.
    2. A record for the Kafka stream, which defines the stream of data to your consumer.
    This task covers the consumer creation. For instructions on creating a Kafka stream, see Create a Kafka stream.

    Procedure

    1. Navigate to All > IntegrationHub > Consumers > ETL Consumer.
    2. Select New.
    3. In the form, fill in the fields.
      Table 1. Kafka ETL Consumer
      Field Description
      Name Name of the ETL consumer.
      Robust import set transformer Name of the robust import set transformer to use to process data.
      Delivery guarantee If there's a node failure, option to specify the delivery guarantee for incoming messages. Select one of the following.
      • No lost but duplicates: Ensures that all messages are delivered at least once. Some messages might be delivered more than once.
      • Once or not at all: Ensures that a message isn’t delivered more than once. Some messages might not be delivered at all.
      Data in single column Option to have the import set table store data in single column.
      Column mapping Option to specify whether the message's JSON key maps the data to the column's name or label in the import set table. Select one of the following.
      • Label
      • Column name
      This field appears only when the Data in a single column check box is cleared.
      Application Application scope for the ETL Consumer.
    4. Select Save.

    What to do next

    Create a Kafka stream for this consumer. After the stream is activated, you can start receiving messages from your Kafka environment.