ServiceNow Sink Connector for Confluent Cloud

The Kafka Connect ServiceNow Sink connector for Confluent Cloud is used to capture Apache Kafka® records and sink them to a ServiceNow Table in real time. Data is consumed using the ServiceNow Table API.

Features

The ServiceNow Sink connector supports the following features:

  • At least once delivery: This connector guarantees that records from the Kafka topic are delivered at least once.

  • Supports multiple tasks: The connector supports running one or more tasks. More tasks may improve performance.

  • Automatically creates topics: The following three topics are automatically created when the connector starts:

    The suffix for each topic name is the connector’s logical ID. In the example below, there are the three connector topics and one pre-existing Kafka topic named pageviews.

    ServiceNow Sink Connector Topics

    Connector Topics

    If the records sent to the topic are not in the correct format, or if important fields are missing in the record, the errors are recorded in the error topic, and the connector continues to run.

  • Supported data formats: The connector supports Avro, JSON Schema (JSON-SR), and Protobuf input formats. Schema Registry must be enabled to use these Schema Registry-based formats.

See Configuration Properties for configuration property values and descriptions. See Cloud connector limitations for additional information.

Quick Start

Use this quick start to get up and running with the Confluent Cloud ServiceNow Sink connector. The quick start provides the basics of selecting the connector and configuring it to stream events.

Prerequisites
  • Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud Platform (GCP).
  • An authorized ServiceNow user and credentials for the connector.
  • The Confluent CLI installed and configured for the cluster. See Install the Confluent CLI.
  • Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Environment Limitations for additional information.
  • At least one source Kafka topic must exist in your Confluent Cloud cluster before creating the sink connector.

Using the Confluent Cloud Console

Step 1: Launch your Confluent Cloud cluster.

See the Quick Start for Apache Kafka using Confluent Cloud for installation instructions.

Step 2: Add a connector.

In the left navigation menu, click Data integration, and then click Connectors. If you already have connectors in your cluster, click + Add connector.

Step 3: Select your connector.

Click the ServiceNow Sink connector icon.

ServiceNow Sink Connector Icon

Step 4: Set up the connection.

Note

  • Make sure you have all your prerequisites completed.
  • An asterisk ( * ) in the UI designates a required entry.
  1. Select one or more topics.
  2. Enter a connector Name.
  3. Select the Input Kafka record value format (data coming from the Kafka topic): AVRO, JSON_SR (JSON Schema), or PROTOBUF. A valid schema must be available in Schema Registry to use a schema-based message format (for example, Avro, JSON_SR (JSON Schema) or Protobuf).
  4. Select the way you want to provide Kafka Cluster credentials. You can either select a service account resource ID or you can enter an API key and secret (or generate these in the Cloud Console).
  5. Enter the ServiceNow connection details. The ServiceNow Instance URL can be in the format https://dev1000.service-now.com/.
  6. Enter the HTTP request timeout and Maximum number of retries. The HTTP request timeout defaults to 50000 (50 seconds). The default value for maximum retries is 3.
  7. Enter the number of tasks to use with the connector. More tasks may improve performance.
  8. Transforms and Predicates: See the Single Message Transforms (SMT) documentation for details.

See Configuration Properties for configuration property values and descriptions.

Step 5: Launch the connector.

Verify the connection details and click Launch.

Step 6: Check the connector status.

The status for the connector should go from Provisioning to Running.

Step 7: Check for records.

Verify that the ServiceNow table is getting updated.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Tip

When you launch a connector, a Dead Letter Queue topic is automatically created. See Dead Letter Queue for details.

Using the Confluent CLI

Complete the following steps to set up and run the connector using the Confluent CLI.

Note

  • Make sure you have all your prerequisites completed.
  • The example commands use Confluent CLI version 2. For more information see, Confluent CLI v2.

Step 1: List the available connectors.

Enter the following command to list available connectors:

confluent connect plugin list

Step 2: Show the required connector configuration properties.

Enter the following command to show the required connector properties:

confluent connect plugin describe <connector-catalog-name>

For example:

confluent connect plugin describe ServiceNowSink

Example output:

Following are the required configs:
connector.class: ServiceNowSink
input.data.format
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
servicenow.url
servicenow.table
servicenow.user
servicenow.password
topics

Step 3: Create the connector configuration file.

Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties.

{
  "connector.class": "ServiceNowSink",
  "input.data.format": "AVRO",
  "name": "ServiceNowSink_0",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "****************",
  "kafka.api.secret": "************************************************",
  "servicenow.url": "<servicenow-URL>",
  "servicenow.table": "<table-name>",
  "servicenow.user": "<authorized-username>",
  "servicenow.password": "<user-password>",
  "tasks.max": "1",
  "topics": "orders"
}

Note the following property definitions:

  • "connector.class": Identifies the connector plugin name.
  • "input.data.format": Sets the input Kafka record value format (data coming from the Kafka topic). Valid entries are AVRO, JSON_SR, and PROTOBUF. You must have Confluent Cloud Schema Registry configured if using a schema-based message format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  • "name": Sets a name for your new connector.
  • "kafka.auth.mode": Identifies the connector authentication mode you want to use. There are two options: SERVICE_ACCOUNT or KAFKA_API_KEY (the default). To use an API key and secret, specify the configuration properties kafka.api.key and kafka.api.secret, as shown in the example configuration (above). To use a service account, specify the Resource ID in the property kafka.service.account.id=<service-account-resource-ID>. To list the available service account resource IDs, use the following command:

    confluent iam service-account list
    

    For example:

    confluent iam service-account list
    
       Id     | Resource ID |       Name        |    Description
    +---------+-------------+-------------------+-------------------
       123456 | sa-l1r23m   | sa-1              | Service account 1
       789101 | sa-l4d56p   | sa-2              | Service account 2
    
  • servicenow.<> Required ServiceNow connection details. The URL should be in the format https://dev1000.service-now.com/.

  • "tasks.max": Enter the maximum number of tasks for the connector to use. More tasks may improve performance.

  • "topics": Enter the topic name or a comma-separated list of topic names.

Single Message Transforms: See the Single Message Transforms (SMT) documentation for details about adding SMTs using the CLI.

See Configuration Properties for configuration property values and descriptions.

Step 4: Load the properties file and create the connector.

Enter the following command to load the configuration and start the connector:

confluent connect create --config <file-name>.json

For example:

confluent connect create --config servicenow-sink-config.json

Example output:

Created connector ServiceNowSink_0 lcc-do6vzd

Step 5: Check the connector status.

Enter the following command to check the connector status:

confluent connect list

Example output:

ID           |             Name           | Status  | Type | Trace
+------------+----------------------------+---------+------+-------+
lcc-do6vzd   | ServiceNowSink_0           | RUNNING | sink |       |

Step 6: Check for records.

Verify that the ServiceNow table is updating.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect section.

Tip

When you launch a connector, a Dead Letter Queue topic is automatically created. See Dead Letter Queue for details.

Configuration Properties

The following connector configuration properties can be used with the ServiceNow Sink connector for Confluent Cloud.

servicenow.url

The IP address or hostname and port. The URL can be in the format https://dev1000.service-now.com/.

  • Type: string
  • Importance: high
servicenow.table

The ServiceNow table name to export data to.

  • Type: string
  • Importance: high
servicenow.user

The username used when connecting to ServiceNow.

  • Type: string
  • Importance: high
servicenow.password

The password used when connecting to ServiceNow.

  • Type: password
  • Importance: high
connection.timeout.ms

The HTTP request timeout in milliseconds (ms). The default is 50000 ms (50 seconds).

  • Type: int
  • Default value: 50000
  • Importance: low
retry.max.times

The maximum number of times to retry a request. The default is 3 times.

  • Type: int
  • Default value: 3
  • Importance: low

Next Steps

See also

For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud ksqlDB, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.

../_images/topology.png