Skip to main content
ServiceNow

ServiceNow

BETA
In this section, we provide guides and references to use the ServiceNow connector. Configure and schedule ServiceNow metadata workflows from the OpenMetadata UI:

​
How to Run the Connector Externally

To run the Ingestion via the UI you’ll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

External Schedulers

Get more information about running the Ingestion Framework Externally

​
Requirements

To fetch metadata from ServiceNow into OpenMetadata you will need:
  1. An accessible ServiceNow instance URL (e.g. https://your-instance.service-now.com).
  2. A ServiceNow username with read access to sys_db_object and sys_dictionary tables.
  3. The password for the ServiceNow user.

​
Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to ServiceNow. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server. The workflow is modeled around the following JSON Schema

​
1. Define the YAML Config

This is a sample config for ServiceNow:

​
2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: 
metadata ingest -c <path-to-yaml>
Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.

​
Advanced Configuration

​
Connection Options

Additional connection options can be configured in YAML: 
source:
  type: servicenow
  serviceConnection:
    config:
      type: ServiceNow
      hostPort: https://your-instance.service-now.com
      username: your_username
      password: your_password
      connectionOptions:
        key: value

​
Connection Arguments

Additional connection arguments can be configured in YAML: 
source:
  type: servicenow
  serviceConnection:
    config:
      type: ServiceNow
      hostPort: https://your-instance.service-now.com
      username: your_username
      password: your_password
      connectionArguments:
        key: value

​
Table Filter Pattern

You can filter tables to include or exclude using regex patterns: 
source:
  type: servicenow
  serviceConnection:
    config:
      type: ServiceNow
      hostPort: https://your-instance.service-now.com
      username: your_username
      password: your_password
      tableFilterPattern:
        includes:
          - "^sys_.*"  # Include all system tables
          - "^u_.*"    # Include all user-defined tables
        excludes:
          - ".*_temp$"  # Exclude temporary tables