---
sourceDocument: Brazil Workflow Data Fabric
sourceDocumentLink: https://www.servicenow.com/docs/r/integrate-applications

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Workflow Data Fabric

ft:clusterId :

    - crint

bundleId :

    - crint

workflow :

    - Creator


---

# Configure a script consumer

# Configure a script consumer {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
Use a script to import and process data from your Kafka environment.

## Before you begin

* Role required: integration_hub_admin
* This consumer requires a Stream Connect subscription. For more information, see <https://www.servicenow.com/now-platform/workflow-data-fabric.html>.
* The ServiceNow Stream Connect Installer \[com.glide.hub.stream_connect.installer\] plugin is required.
{#configure-script-consumer__ul_qfj_p1l_kvb}

## 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.

{#configure-script-consumer__ol_orv_nx1_mvb}This task covers the consumer creation. For instructions on creating a Kafka stream, see [Create a Kafka stream](https://www.servicenow.com/docs/yhcuYGyyKUpmM_qQz3oEPw "Define a data stream for an Extract Transform Load (ETL), Transform Map, or Script consumer. A Kafka stream defines the stream of data to your consumer.").

## Procedure

1. Navigate to AllIntegrationHubConsumersScript Consumer.
2. Select New.
3. In the form, fill in the fields.  
   {#configure-script-consumer__table_utt_jmq_hvb__entry__2}

   | Field | Description |
   |-|-|
   | Name | Name of the Script consumer. |
   | 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: All messages are delivered at least once. Some messages might be delivered more than once. * Once or not at all: A message isn't delivered more than once. Some messages might not be delivered at all. {#configure-script-consumer__ul_bsl_mmq_hvb} |
   | Serialization format | The serialization format for the message. Select one of the following. * Plain Text: Select this option for any plain-text messages. This is the default format. * Encoded: Select this option for messages in an Apache Avro format. Converting plain-text messages to an Avro format requires a schema. Select the schema registry in the Schema registry field. For more information on schemas, see [Schema management in Stream Connect](https://www.servicenow.com/docs/bw99rPqa9MT1fMcg4EjjTg "Import and create schemas to send and receive messages in an Apache Avro format. Using an Avro format can reduce the size of the payload and simplify your integration to your local Kafka instance."). {#configure-script-consumer__ul_svj_dgf_gbc} |
   | Event consumer | Script to use to consume the messages received from the Kafka topic. |
   | Application | Application scope for the Script Consumer. |
   | Schema registry | Registry for the selected schema. Select one of the following. * Standalone Schema Registry * Confluent Schema Registry {#configure-script-consumer__ul_gsw_qff_gbc} This field appears only when the Serialization format is set to Encoded. For the Confluent Schema Registry, if the received message's schema ID isn't in the schema table, the system imports the schema dynamically, using the configured REST connection. |
   [Table 1. Script consumer]

   {#configure-script-consumer__table_utt_jmq_hvb}
4. Select Save.

## Example

This example shows a sample script for processing messages. It includes the utc_timestamp field, a string-type field in UTC timezone, and the metadata field, which includes the following:

* timestampEpoch, data type: long
* partition, data type: int
* offset, data type: long
* dataCenter, data type: string

{#configure-script-consumer__ul_qfy_plz_tgc}

    (function process(messages) {
      for (var i = 0; i < messages.length; i++) {
        var m = messages[i];

        var headerParts = [];
        for (var j = 0; j < m.headers.length; j++) {
          headerParts.push('header[' + j + ']_key=' + m.headers[j].key + ' | header[' + j + ']_value=' + m.headers[j].value);
        }

        var line = [
          'message_key='     + m.key,
          'message_body='    + m.message,
          'partition='       + m.metadata.partition,
          'offset='          + m.metadata.offset,
          'datacenter_id='   + m.metadata.datacenter_id,
          'utc_timestamp='   + m.utc_timestamp,
          'timestamp_epoch=' + m.metadata.timestamp_epoch
        ].concat(headerParts).join(' | ');

        gs.info('[Kafka Message] ' + line);
      }
    })(messages);

To convert the utc_timestamp field to GlideDateTime, see the following examples.


    // Example 1
    var timestamp = new GlideDateTime("2025-08-19 23:31:45");
    console.log(timestamp.getValue());

    // Example 2 
    var timestamp2 = new GlideDateTime();
    timestamp2.setNumericValue(1755646305218);
    console.log(timestamp2.getValue());

    // Example 3
    var timestamp3 = new GlideDateTime("1970-01-01 00:00:00");
    timestamp3.add(1755646305218);
    console.log(timestamp3.getValue());

## What to do next

[Create a Kafka stream](https://www.servicenow.com/docs/yhcuYGyyKUpmM_qQz3oEPw "Define a data stream for an Extract Transform Load (ETL), Transform Map, or Script consumer. A Kafka stream defines the stream of data to your consumer.") for this consumer. After the stream is
activated, you can start receiving messages from your Kafka environment.

*[\>]: and then