ServiceNow

ServiceNow offers a data catalog within its Workflow Data Fabric ecosystem, allowing organizations to manage and discover data assets. However, ServiceNow does not natively support configuring and running scheduled data quality policies. The Acceldata Data Observability Cloud (ADOC) integration with ServiceNow bridges this gap by pushing Data Quality scores, quality badges, and policy execution details from ADOC directly into the ServiceNow Data Catalog.

This integration follows the same design pattern as ADOC's existing data catalog integrations, including Atlan, Alation, and Collibra.

What this Integration Enables

Once integrated and configured, ADOC automatically pushes the following to mapped assets in ServiceNow after each policy execution:

  • Data Quality Score: The aggregated quality score for the mapped asset, calculated from the latest policy execution results.
  • Quality Badge: A status indicator powered by ADOC, reflecting the current quality state of the asset — Good, Warning, or Deprecated — based on configured thresholds.
  • Policy Execution Details: A list of policies configured on the mapped asset, including the latest execution status, result, and a direct hyperlink back to the corresponding policy execution page in ADOC.

Note Updates are triggered in real time after each ADOC policy execution. ServiceNow processes incoming data through its internal pipeline, which may introduce a delay of a few minutes before scores and badges are visible in the ServiceNow UI.

Prerequisites

Before configuring the ServiceNow integration, ensure the following are in place:

In ServiceNow

  • Create a Custom Scripted REST API for Database Discovery

ADOC uses a custom Scripted REST API on your ServiceNow instance to retrieve the list of external database connections available for mapping. This is required because the underlying ServiceNow table that stores external connection details restricts access to admin-level accounts. The Scripted REST API exposes only the fields ADOC needs, without requiring admin access to be granted to the integration service account.

To create the Scripted REST API:

  1. In the Filter Navigator, go to System Web Services -> Scripted REST APIs and click New.

  2. Fill in the following fields:

    1. Name: External DB Connection Info
    2. API ID: db_connection_info
    3. API namespace: snc
  3. Click Submit.

  4. On the newly created API record, scroll to the Resources related list and click New.

  5. Fill in the following fields:

    1. Name: List External DB Connections
    2. HTTP method: GET
    3. Relative path: /
  6. In the Script field, paste the following:

Javascript
Copy
  1. Under the Security tab, configure the following:
  2. Require authentication: Enabled
  3. Default ACLs: Scripted REST External Default
  4. Click Submit.

Note If the Scripted REST API returns an empty response despite database connections existing in your ServiceNow instance, the integration service account may lack read access to the sn_dcg_cc_kos_database_connection_ info table. To resolve this, add a read ACL on that table granting access to the service account, or configure the Scripted REST API to run with elevated privileges using a custom role.

Remaining Prerequisites

  • OAuth 2.0 Client ID and Client Secret for the ServiceNow instance.
  • The ServiceNow instance must have the Workflow Data Fabric or Data Catalog and Governance Core enabled and accessible.
  • The data assets you want to map must already be crawled and visible in the ServiceNow Data Catalog.
  • The ServiceNow instance must be reachable from the ADOC Control Plane network.

Required Roles and Permissions

The ServiceNow service account used for this integration must be configured as a machine identity with web service access only. The account requires the following roles to be assigned before the integration can be configured in ADOC.

RoleApplicationPurpose
snc_platform_rest_api_accessServiceNow PlatformRequired for all REST API access. Mandatory for any API call made by ADOC.
dq_api_publicServiceNow Data Catalog Core (sn_dcg_core)Required for all Data Quality API endpoints, including submitting check runs and publishing quality badges.

The service account also requires access to the custom Scripted REST API used for database discovery. This access is configured directly on the Scripted REST API record in ServiceNow, not through the roles list.

Note Do not grant the admin role to the service account. This integration is designed to operate with least-privilege access. The admin role is not required and should not be assigned.

In ADOC

  • ADOC environment with Data Reliability enabled.
  • The data source you want to link to ServiceNow must already be registered and configured in ADOC.
  • At least one Data Quality policy must be configured and executed on the data source you intend to map.
  • Access rights to add new data catalog integrations under Register > Data Sources.

Add ServiceNow as a Data Source

Follow these steps to register ServiceNow as a data catalog integration in ADOC.

Step 1: Enter Basic Details

  1. Navigate to Control Center -> Integrations in ADOC.
  2. Click Add Data Source.
  3. Under Data Catalogs, select ServiceNow.
  4. Enter a Data Source Name and an optional Description.
  5. Click Next to proceed to the Connection Details page.

Step 2: Configure OAuth 2.0 Authentication

ServiceNow uses OAuth 2.0 for authentication. ADOC uses the provided credentials to fetch a bearer token, which is then used for all subsequent API communication with the ServiceNow instance.

  1. Enter the Instance URL for your ServiceNow instance. Example: https://your-org.service-now.com.
  2. Enter the Client ID for your ServiceNow OAuth application.
  3. Enter the Client Secret for your ServiceNow OAuth application.
  4. Click Test Connection to validate the credentials. If the connection fails, verify your Instance URL, Client ID, and Client Secret, and ensure the ServiceNow instance is accessible from the ADOC Control Plane.
  5. If the connection is successful, click Next to proceed to the Set Up Observability page.

Step 3: Map Assets and Configure Thresholds

On the Set Up Observability page, map the ServiceNow databases to the corresponding Acceldata data sources. Mappings determine which ADOC data source results are published to which ServiceNow assets.

  1. In the ServiceNow Database column, select a database from the list of external databases available in your ServiceNow instance.
  2. In the Acceldata Datasource column, select the corresponding ADOC data source to link to the selected ServiceNow database.
  3. To map additional databases, click Add Mapping and repeat the steps above.
  4. Configure the quality evaluation thresholds used to determine the status of a quality badge:
ThresholdDescription
Warning ThresholdThe minimum Data Quality score below which the asset badge is set to a warning state. Assets with scores at or above this value but below the deprecated threshold are considered passing with a warning.
Deprecated ThresholdThe minimum Data Quality score below which the asset badge is set to a deprecated (failed) state. Assets with scores below this value are considered unhealthy.
  1. Click Submit to complete the registration. ADOC will begin publishing scores to ServiceNow after the next policy execution on a mapped data source.

Note Without at least one mapping configured, ADOC will not publish any results to ServiceNow. You must map at least one ServiceNow database to an ADOC data source before scores are pushed.

How Score Publishing Works

After a Data Quality policy executes on an ADOC data source that is mapped to a ServiceNow database, ADOC pushes the results to ServiceNow in real time. ServiceNow processes the incoming data through its internal pipeline, which may introduce a short delay of a few minutes before the scores and badges are visible in the ServiceNow UI.

The following logic determines the badge state shown for each mapped asset in ServiceNow:

Badge StateCondition
GoodData Quality score is at or above the Warning Threshold.
WarningData Quality score is below the Warning Threshold but at or above the Deprecated Threshold.
DeprecatedData Quality score is below the Deprecated Threshold.

Viewing Data Quality Results in ServiceNow

Once ADOC begins publishing results, you can view quality scores, badges, and policy details directly within the ServiceNow Data Catalog.

  1. Log in to your ServinceNow instance.
  2. On the Workflow Data Fabric home page, select Explore Data Catalog.
  3. Use the search bar or filters to locate the asset mapped to an ADOC data source. You can filter by Asset Type Category (Table, Database, or Schema) or by Source.
  4. Select the asset name to open its details page.

Quality Badge

On the asset details page, select the Data Quality tab. The tab displays a summary at the top showing the current Data Quality badge status — Good, Warning, or Deprecated — along with the total number of rules and the count of passed rules for the asset.

Policy Execution Details

The Data Quality tab lists all rules published by ADOC for the mapped asset. Each entry includes the following columns:

ColumnDescription
NameThe name of the ADOC policy rule published to ServiceNow.
SourceShows "acceldata" as a hyperlink. Select this link to navigate directly to the corresponding policy execution page in ADOC, where you can view rule-level details, percentage scores, and failed record counts.
Asset typeThe type of the asset in ServiceNow (for example, TABLE).
Asset nameThe name of the asset in ServiceNow to which the rule applies.
CategoryThe policy category in ADOC (for example, data_cadence, schema_drift).
StatusThe latest execution result for the rule — Passed or Failed.
Last updatedThe date and time of the most recent policy execution pushed from ADOC.

Next Steps

After completing the ServiceNow integration setup, consider the following:

  • Schedule regular policy runs in ADOC to ensure Data Quality scores and badges in ServiceNow remain current.
  • Review threshold values for Warning and Deprecated states to ensure badge status accurately reflects your organization's data quality standards.
  • Expand asset mappings to include additional ServiceNow databases and ADOC data sources as needed.
  • Configure policy notifications in ADOC to alert owners when quality scores fall below defined thresholds. For more information, see Policy Notifications.
VariableType to search · ESC to discard
GlossaryType to search · ESC to discard
InsertType to search · ESC to discard
No matches