Quick start tests for Configuration Management Database (CMDB)

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Quick start tests for Configuration Management Database (CMDB)

    These quick start tests help ServiceNow customers verify that the Configuration Management Database (CMDB) functions correctly after configuration changes such as upgrades or application development. To use these tests, the Configuration Management (CMDB) plugin and the CMDB - ATF Tests plugin must be activated in your instance. The tests can be customized with your instance-specific data to ensure accuracy and relevance.

    Show full answer Show less

    Test Suites and Their Purposes

    • CMDB BSM: Dependency Views - Validates Dependency Views APIs that retrieve maps and related items for a given CI, using the itil user role. (Available since New York release)
    • CMDB HEALTH: CMDB Health Dashboard - Checks basic functionality of the CMDB Health Dashboard, including status of long-running health jobs and validation of health completeness metrics such as recommended fields and inclusion rules. (Available since New York release)
    • CMDB IRE: Identification Reconciliation Engine - Tests Identification and Reconciliation Engine features including validation of CI identifiers, and operations on reconciliation and identification rules with itil and itiladmin roles. (Available since Madrid and Paris releases)
    • CMDB QB: Query Builder - Verifies the ability of users with cmdbquerybuilder and cmdbquerybuilderread roles to create, access, run, and save queries in the CMDB Query Builder. (Available since New York release)
    • CMDB REL: Relationship Editor and Formatter - Confirms functionality for adding and deleting CI relationships and verifies accurate display of CI information and relationships using the relationship formatter with itil user role. (Available since New York release)
    • CMDB SDK: SDK REST API - Validates REST API operations such as querying CMDB metadata, creating, updating, querying, and deleting CIs and relationships using CMDB REST APIs. (Available since New York release)

    Practical Benefits for ServiceNow Customers

    Implementing these test suites allows customers to quickly confirm that key CMDB capabilities remain intact after any system changes. This includes ensuring data integrity, API functionality, user role permissions, and dashboard accuracy. Utilizing these tests supports proactive maintenance and reduces risk of disruptions in CMDB-dependent processes.

    By customizing and running these tests regularly, customers can confidently maintain a healthy CMDB, streamline troubleshooting, and accelerate validation during upgrades or development cycles.

    Validate that Configuration Management Database (CMDB) still works after you make any configuration change such as apply an upgrade or develop an application. Copy and customize these quick start tests to pass when using your instance-specific data.

    Configuration Management Database (CMDB) quick start tests require activating the Configuration Management (CMDB) plugin (com.snc.cmdb) and the CMDB - ATF Tests plugin (com.snc.cmdb.atf).

    Table 1. CMDB BSM: Dependency Views test suiteTest suite to check functionality of Dependency Views APIs.
    Test Description Release version
    CMDB BSM: Dependency Views Test functionality of Dependency Views APIs. These APIs retrieve Dependency Views map and associated map items such as context menu items, for a given CI sys_id and using itil user role. New York
    Table 2. CMDB HEALTH: CMDB Health Dashboard test suiteTest suite to check whether CMDB CMDB Health Dashboard is functional at a basic level.
    Test Description Release version
    CMDB HEALTH: Health Job Status Checks whether any CMDB Health dashboard jobs, which were started 30 or more days ago, are still in progress. New York
    CMDB HEALTH: CMDB Health Completeness/ Recommended Checks whether the recommended metric (included in the CMDB Health completeness KPI) is fully functional.
    This test validates:
    • Creation of a health inclusion rule for the recommend metric.
    • Creation of a recommended field that satisfies the health inclusion rule.
    • Validate that the health inclusion rule is correctly applied to a test record with missing data in the recommended field.
    		 New York
    Table 3. CMDB IRE: Identification Reconciliation Engine test suiteTest suite to check Identification and Reconciliation Engine (IRE) functionality.
    Test Description Release version
    CMDB IRE: IRE Validation Validate CI identifiers and reconciliation definitions and check indexes for CI identifiers. Madrid
    CMDB IRE: Reconciliation Rule

    Check operations on a reconciliation rule, in CI Class Manager, using itil and itil_admin roles. Operations include create, edit, and delete a reconciliation rule.

    Also, check for active and not active setting, and derived rules.

    		 Paris
    CMDB IRE: Identification Rule

    Check operations on an identification rule, in CI Class Manager, using itil and itil_admin roles. Operations include create, edit, and delete an identification rule.

    Also, check for active and not active setting, and derived rules.

    		 Paris
    Table 4. CMDB QB: Query Builder test suiteTest suite to verify CMDB Query Builder functions such as create query, read query, and execute query using two related user roles - cmdb_query_builder and cmdb_query_builder_read.
    Test Description Release version
    CMDB QB: Query Builder - cmdb_query_builder Role Verify that cmdb_query_builder user role can save queries, and access and run all saved queries, in CMDB Query Builder. New York
    CMDB QB: Query Builder - cmdb_query_builder_read Role Verify that cmdb_query_builder_read user role can access and run all saved queries, and cannot save any query, in CMDB Query Builder. New York
    Table 5. CMDB REL: Relationship Editor and Formatter test suiteTest suite to verify functionality of Relationship Editor and Relationship Formatter.
    Test Description Release version
    CMDB REL EDITOR:Relationship Editor Check addition of relations to a CI and deletion of relations from a CI using itil user role. New York
    CMDB REL FORMATTER:Relationship Formatter Check accuracy of CI information, relationship types, relationships, associated records such as change tickets, and settings such as CMDB views (relationship filters), displayed for a specific CI in relationship formatter using itil user role. New York
    Table 6. CMDB SDK: SDK REST API test suiteTest suite to verify functionality of CMDB SDK Rest APIs.
    Test Description Release version
    CMDB SDK: Query CMDB Metadata Test querying CMDB metadata. New York
    CMDB SDK: Create a relation for a CI using REST APIs Test creation of a relationship for a CI in the CMDB using the CMDB REST APIs. New York
    CMDB SDK: Delete a relation for a CI using REST APIs Test deletion of a relationship for a CI using CMDB REST APIs. New York
    CMDB SDK: Create a CI using REST API Test creation of a CI using CMDB REST APIs. New York
    CMDB SDK: Query CMDB using REST APIs Test querying the CMDB using CMDB REST APIs. New York
    CMDB SDK: Update a CI using REST APIs Test updating of a CI using CMDB REST APIs. New York
    CMDB SDK: Query for a CI using REST APIs Test querying a CI using CMDB REST APIs. New York