Querying the CMDB

The CMDB Query Builder allows you to easily build complex infrastructure and service queries, that span multiple CMDB classes, non-CMDB tables, and that involve many CIs that are connected by different relationships.

The CMDB Query Builder provides a canvas into which you drag the CI classes that you want to include in a query. Then you add relationships, AND/OR operators between the CI classes, and define the relationship properties to query for. You can use saved queries to populate a CMDB group with CIs, and then use scriptable APIs to retrieve the CI list and apply actions collectively to all the CIs in the group.

There are two query types: CMDB Query and a Service Mapping query, which you can use separately or in combination to create queries such as:

• All hardware in my service offering that has Windows installed.
• All CIs of a certain type in an application service. For example, all Apaches/Web Servers/Linux servers per service.
• All virtual servers and the physical servers that host them.
• All servers that are not mapped to any application service.
• All application services and their associated servers and the cost of each server. This query helps evaluate the cost of technology for each application service.

Starting node: The starting point of the query which is labeled as STARTING NODE on the Query Builder canvas. The first class that you drag to the canvas becomes automatically the starting node of the query and you cannot select a different starting node. In a complex query, the starting node must always be the only node connected to an AND/OR operator. If you try to connect a second node to an operator that the starting node is connected to, the query fails to run and a prompt to select a different starting node appears.

Additional information

• For a webinar, see CMDB Query Builder Queries and Reporting - Platform Analytics Academy blog post in the ServiceNow Community.
• For some tips and basic troubleshooting for the CMDB Query Builder, see the CMDB Query Builder [KB0681251].

Intelligent Search for CMDB integration

By default, Intelligent Search for CMDB functionality is integrated into the CMDB Query Builder. When opening the Query Builder, you can use the Intelligent Search search box which appears above the Query Builder canvas. Intelligent Search lets you use everyday natural language query (NLQ) to build a query. Intelligent Search parses, resolves any ambiguities in table names and relationship types, and then converts your search string into a valid query. The query appears fully constructed on the Query Builder canvas where you can run or continue and develop the query.

The integration of Intelligent Search for CMDB with the CMDB Query Builder is controlled by the system property glide.cmdb.query.nlq.activated, which is set to true by default. If you set the property to false, Intelligent Search for CMDB will not be available within the Query Builder.

AI Search and CMDB

NLQ Genius Results for AI Search use natural language queries to find CMDB tables that match your search without leaving a portal or workspace. For more information, see NLQ Genius Results.

Note:

AI Search is a complementary search experience that allows you to surface CMDB records in your normal flow of work, without having to access the CMDB Query Builder. It doesn't replace intelligent Search for CMDB, which is purpose-built and integrated into CMDB Query Builder.

CMDB Query

A query type that queries the infrastructure for CI classes and the relationships and references that connect them. You can optionally add the context of non-CMDB tables to a CMDB query.

You can include Application services in a CMDB query, to find, for example:

• All critical application services in your database.
• All infrastructure in a particular application service.
• All incidents for a particular CI in an application service, or all incidents for all the CIs of an application service.
• All application services with a pattern of a service connected to a database, and where the database has incidents.

The list of available non-CMDB tables includes a subset of tables within the system, which have a reference to the Configuration Item [cmdb_ci] class or its children. The list of non-CMDB tables, includes tables such as Asset, Task, and Problem. You can use the system property glide.cmdb.query.non_cmdb.black_listed_tables to narrow down the list of non-CMDB tables to choose from.

Service Mapping Query

A query type that queries application services. The query is framed within an application service map. You define a pattern, and query for application service maps that have that pattern in their definition. The relationships in Service Mapping queries are matched by single-level direct relationships which is similar to the CMDB queries, and in addition, they are also matched by multi-level indirect relationships if they exist. A query for a relationship between two CI classes is satisfied even if the two CI classes are connected by intermediate CI classes that are not specified in the query.

Combination Query

You can combine the two query types by incorporating a saved Service Mapping query into a CMDB query. For example, create a CMDB query for Windows Servers that are connected to Tomcat WAR. Then connect the Tomcat WAR CI class to a Service Mapping query. The query changes to find Windows Servers that are connected to Tomcat WAR which is included in the services that returned by the Service Mapping query. You can inverse that query by choosing Does Not Belong To Service. This changes the query to find Windows Servers that are connected to Tomcat WAR that is not included in services returned by the Service Mapping query.

Relationship properties

When you connect CI classes on the canvas, the CMDB Query Builder displays the Connection Properties in the right-side bar, where you can configure the properties of the relationship, such as the relationship direction. For Service Mapping queries, you can configure whether to query for related or unrelated CIs.

Connection properties include:

• Relationship type: Query for CIs and descending classes with specific relationship types.
• Relationship direction: Which CI class is the parent and which CI class is the child in the relationship.
• Relationship level: Query only on first-level relationship or also on second-level relationships.
• No relationships: Query for CIs which have no relationship to the set class.
• References fields: A field that the parent and ancestor parent CI classes use to reference the child CI class.

Newly added relationships between CI classes may take up to 30 minutes to appear in the relationship list.

• Domain separation and CMDB Query Builder
  Domain separation is supported in the CMDB Query Builder. Domain separation enables you to separate data, processes, and administrative tasks into logical groupings called domains. You can control several aspects of this separation, including which users can see and access data.
• Build a CMDB query using the CMDB Query Builder
  A CMDB query type that queries the infrastructure for CI classes and optionally non-CMDB tables, and the relationships and references that connect them.
• Build a Service Mapping query using the CMDB Query Builder
  The Service Mapping query type is a pattern consisting of classes and relationships between those classes. After you build the pattern and run the query, the query returns all the Service Mapping services that contain that pattern.
• Sample queries
  Use the following sample queries to build your own CMDB queries and Service Mapping queries.
• Run a partial CMDB query
  You can run a partial query in the CMDB Query Builder by defining a section of a query, and then running it.
• Delete a CMDB query
  Delete a CMDB query that is no longer used or needed.
• Batch size for CMDB Query Builder queries
  In a base system, a global batch size of 100 is allocated for every Query Builder query run. If needed, you can use a system property to override the default global batch size, or optimize the batch size value per saved query.
• Navigation in CMDB Query Builder
  Use the navigation tools to enlarge or shrink the query, to move the query, or to border a section of the query to run.
• Create reports in CMDB Query Builder
  Use CMDB Query Builder reports to show the results of a CMDB query or a Service Mapping query. Create a basic report, or a dynamic report that automatically updates when the results of the associated saved query change.
• Search saved queries
  The CMDB Query Builder allows you to search for a specific saved query using any combination of search criteria such as the query's name, type, custom tags, and who created or updated the query.
• Create a schedule for a CMDB query
  Schedule a saved CMDB query to run once at a scheduled time or on a recurring schedule, and to email the query results to specified users.
• Export and import a CMDB query
  Export a saved CMDB or Service Mapping query definition to an XML file which you can later import and run in the CMDB Query Builder. This process lets you port a saved query between instances, such as from a development environment to a production environment.
• Settings for CMDB Query Builder
  Use settings to control some aspects of the CMDB Query Builder behavior.
• Properties for CMDB Query Builder
  Use the CMDB Query Builder properties to configure query processing.

Related concepts

• CMDB groups