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.

Important

If you are still on Confluent Cloud Enterprise, please contact your Confluent Account Executive for more information about using this connector.

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 message 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 Cloud CLI installed and configured for the cluster. See Install and Configure the Confluent Cloud CLI.
  • Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf).
  • 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.

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 an Input message 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. Enter your Kafka Cluster credentials. The credentials are either the cluster API key and secret or the service account API key and secret.
  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.

Note

See Configuration Properties for configuration property 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 Cloud CLI

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

Note

Make sure you have all your prerequisites completed.

Step 1: List the available connectors.

Enter the following command to list available connectors:

ccloud connector-catalog list

Step 2: Show the required connector configuration properties.

Enter the following command to show the required connector properties:

ccloud connector-catalog describe <connector-catalog-name>

For example:

ccloud connector-catalog describe ServiceNowSink

Example output:

Following are the required configs:
connector.class: ServiceNowSink
input.data.format
name
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.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 message 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.api.key" and ""kafka.api.secret": These credentials are either the cluster API key and secret or the service account API key and secret.
  • 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.

Note

See Configuration Properties for all available configuration property descriptions.

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

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

ccloud connector create --config <file-name>.json

For example:

ccloud connector 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:

ccloud connector 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 seconds.

  • 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 Cloud CLI to manage your resources in Confluent Cloud.

../_images/topology.png