ServiceNow metadata collector
Provides read-only access to metadata from a ServiceNow instance.
The collector harvests metadata from ServiceNow instances including system applications, application scopes, tables, fields, views, and Data Fabric tables. Catalogs ServiceNow Data Fabric metadata for virtualized data integration.
Metadata cataloged
The collector catalogs the following information.
| Object | Information cataloged |
|---|---|
| ServiceNow Instance | Instance URL, Connection metadata |
| System Application | App Name, Vendor, Version, Active status, Short Description, Source Table |
| Application Scope | Scope Name, Scope Identifier, Vendor, Version, Active status, Source Table |
| Table | Table Name, Is Extendable, sys_updated_on (timestamp), Source Table, Parent Table (for table inheritance) |
| Data Fabric Table | Inherits all Table properties, Plus: Association with external DatabaseTable |
| View | Inherits all Table properties, Plus: View Definition (SQL definition including source tables and join conditions) |
| Field | Field Name, Column Label, Reference Table (for reference fields), Mandatory, Is Primary (for Data Fabric fields), SQL Type (for Data Fabric fields) Enhanced metadata: Field type, Field size, Max length, Nullable (true/false), Default value, Internal Type |
| View Table Mapping | Maps To Table, WHERE clause conditions, Is Left Join, Variable Prefix, Mapping Order |
| Data Product | Data Product Name, Description, State (lifecycle status), Tags, Created By, Created On, Updated On, Source Table |
| Data Interfaces | Table Name, Is Extendable, sys_updated_on (timestamp), Source Table, Parent Table (for table inheritance) |
| Vault Data Classification | Classification Name, Description, Classification Type, Parent Classification (for hierarchical relationships), Source Table |
| Dashboard | Name, Description, Active, Certified, UI Generation (Next Experience or Core UI), Workspace Visible In, Categories, Users Granted To, Owner, Created By, Last Modified By, Requested By, Created At, Last Modified At |
| Visualization | Name, Description, Active, Certified, UI Generation, Created By, Last Modified By, Created At, Last Modified At, Granted To, Requested By, Owner |
| Indicator | Name, Description, Active, Type (Automated/Formula/Manual/External), Collection Frequency, Unit, Granted To, Created By, Modified By, Created At, Last Modified At |
| Indicator Source | Name, Description, Facts Table, Conditions, Collection Frequency, Created By, Last Modified By, Created At, Last Modified At |
| Dashboard Tab | Name, Display Order, UI Generation |
| Breakdown | Name, Description, Type (Automated/Manual/External), Created By, Last Modified By, Created At, Last Modified At |
| Breakdown Source | Name, Active, Conditions, Facts Table, Facts Field, Created By, Last Modified By, Created At, Last Modified At |
| Data Collection Job | Name, Description, Active, Run Type, Run Time, Collect Scope (scores only, text indexes only, or both), Created By, Modified By, Created At, Last Modified At |
Relationships between objects
Catalog pages show relationships between the following data asset types:
| Data asset page | Relationship |
|---|---|
| ServiceNow Instance | Contains Application Scopes, System Applications, Tables, Data Interfaces |
| System Application | Contained within Application Scope |
| Application Scope | Contains System Applications and Tables (via has scoped data asset), Data Interfaces |
| Table | Contained within Application Scope, Has Fields, May extend another Table (via extends table), May be extended by child Tables |
| Data Fabric Table | Inherits all Table relationships, Plus: Derived from external DatabaseTable (via prov:wasDerivedFrom) |
| View | Inherits all Table relationships, Has View Table Mappings |
| Field | Belongs to a Table (via has field), May reference another Field (for reference/foreign key fields) |
| View Table Mapping | Belongs to a View (via has view table mapping), Maps To Table (via maps to table), Selects data from Table |
| Data Product | Contained within Application Scope, Has Data Content (contains Tables and Views) |
| Data Interface | Contained within Application Scope, Has Fields, May extend another Table (via extends table), May be extended by child Tables |
Lineage for ServiceNow
The following lineage information is collected by the ServiceNow collector.
| Object | Lineage available |
|---|---|
| View | View Table Mappings show:
|
| Table | Table inheritance lineage:
|
| Field | Reference field lineage:
|
| Data Fabric Table | External data source lineage. External DatabaseTable from which data is virtualized (via prov:wasDerivedFrom) |
| Data Interfaces | Table inheritance lineage:
|
| Vault Data Classification | May have Parent Classification (via parent classification), May have Child Classifications, Classifies Fields and Tables (via has classification) |
| Dashboard | Contained within Application Scope, Tabs contained in the Dashboard |
| Dashboard Tab | Dashboard the Tab is contained within |
| Data Collection Job | Contained within Application Scope, Indicators the Data Collection Job collects |
| Indicator | Contained within Application Scope, Data Collection Jobs that collect this Indicator |
| Indicator Source | Contained within Application Scope |
| Visualization | Contained within Application Scope |
| Breakdown | Contained within Application Scope |
| Breakdown Source | Contained within Application Scope |
Lineage for ServiceNow
The following lineage information is collected by the ServiceNow collector:
| Object | Lineage available |
|---|---|
| View | View Table Mappings show:
|
| Table | Table inheritance lineage:
|
| Field | Reference field lineage:
|
| Data Fabric Table | External data source lineage:
|
| Data Interfaces | Table inheritance lineage:
|
| Dashboard | Visualizations embedded in the Dashboard, Tables and Fields the Dashboard uses data from, Indicators the Dashboard uses |
| Dashboard Tab | Visualizations embedded in the Dashboard Tab |
| Indicator | Indicator Sources the Indicator uses data from, Fields or Tables the Indicator uses data from, Indicators the Indicator calculates values from, Breakdowns that segment Indicator values, Dashboards that use the Indicator, Visualizations that use the Indicator |
| Indicator Source | Indicators that use the Indicator Source, Table the Indicator Source sourced data from |
| Breakdown | Breakdown Sources that define segment values for the Breakdown, Tables and Fields the Breakdown segments its values from, Indicators whose values are segmented by the Breakdown |
| Visualization | Dashboards that embed the Visualization, Dashboard Tabs that embed the Visualization, Indicators the Visualization uses data from, Tables or Fields the Visualization uses data from |
| Breakdown Source | Breakdowns which the Breakdown Source defines segment values for, Fields it derives elements from |
ServiceNow version supported
Supports ServiceNow instances that expose the Table API. Tested with ServiceNow Zurich and Australia releases.
Authentication supported
The collector authenticates to ServiceNow using Basic Authentication (User name and Password).