Components installed with CMDB Workspace

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 13 minutes to read
  • Several types of components are installed with the activation of the CMDB Workspace (sn_cmdb_ws) plugin, including properties, tables, user roles, and scheduled jobs.ServiceNow

    Note:
    The Application Files table lists the components that are installed with this application. For instructions on how to access this table, see Find components installed with an application.

    In addition, the CMDB Workspace plugin adds the CMDB Group type 'CMDB Workspace'.

    Properties installed

    The following properties are installed by the Configuration Management (CMDB) (com.snc.cmdb) plugin which is included in base systems.

    Property Description
    sn_cmdb_ws.ci_overview.managed_by_me.enabled​

    Shows/hides the My CIs section of CI Overview on the CMDB Workspace landing page, for users with sn_cmdb_editor role.

    sn_cmdb_ws.total_cis.enabled​

    Shows/hides the Total CIs section on the CMDB Workspace landing page.

    sn_cmdb_ws.ms.discovery_source_not_reporting_max_days

    Number of days after which if one or more discovery sources stop reporting CIs, that CI is included in the CIs not reported by discovery sources chart in the CMDB 360 view.

    • Type: integer
    • Default: 7
    • Location: Navigate to Workspaces > CMDB Workspace and then select CMDB 360. Select Settings and configure Number of days since CIs were last discovered by a discovery source in the Potential issues section.
    • Learn more: Configure the CMDB 360 dashboard.
    sn_cmdb_ws.ms.report_max_limit
    Maximum number of record that appears as list views when drilling down from the following charts:
    • CIs not reported by discovery sources
    • Data mismatch
    • CIs by number of discovery sources
    • CIs with a single source
    Details:
    • Type: integer
    • Default: 100,000
    • Location: Navigate to Workspaces > CMDB Workspace and then select CMDB 360. Select Settings and configure Maximum number of records to process in the Global section.
    • Learn more: Configure the CMDB 360 dashboard.
    sn_cmdb_ws.unifiedmap.map_search_filter.default_levels

    Initial default number of levels from the home node, up and down the CMDB hierarchy, to show on a map. ​Up the hierarchy goes from all parents to their parents up to the specified level. Down the hierarchy goes from all children to their children up to the specified level.

    Editing affects all users and requires the sn_cmdb_admin user role.

    sn_cmdb_ws.unifiedmap.map_search_filter.max_levels​
    Maximum number of levels from the home node, up and down the CMDB hierarchy, to show on a map. ​Up the hierarchy goes from all parents to their parents up to the specified level. Down the hierarchy goes from all children to their children up to the specified level.
    • Type: integer
    • Default: 25
    • Location: System Properties [sys_properties] table

    Editing affects all users and requires the sn_cmdb_admin user role.

    sn_cmdb_ws.list.record_count_limit

    The maximum number of results that the system counts for when using conditional search to search for CIs on the Home view in CMDB Workspace. This count shows for example, at the top of the search results list.

    For example, if a limit of 100,000 is reached, the count shows "100,000 +" to indicate that counting stopped at 100,000 and that there are additional uncounted results.

    Increasing the value of this property directly results in greater impact on performance. However, if a precise count is needed, set this limit to a number that isn't reached by the anticipated count.

    Roles installed

    The following roles are installed by the Configuration Management (CMDB) (com.snc.cmdb) plugin which is included in base systems. These roles are required for access and interaction with the CMDB Workspace, and are included for completeness.

    Role title [name] Description Contains roles
    CMDB Admin

    [sn_cmdb_admin]

    Provides full access to CMDB data, tools, and UIs within CMDB Workspace.

    A CMDB Admin, for example, sets policies in the CI Class Manager and application service requirements. CMDB Admin provides the highest level of access to the CMDB.

    CMDB Admin has read-only access to the Configuration Item [cmdb_ci] table.

    • data_manager_admin
    • canvas_admin
    • sn_cmdb_editor
    • cmdb_ms_admin
    • cmdb_dedup_admin
    CMDB Editor

    [sn_cmdb_editor]

    Provides access to CMDB records within CMDB Workspace and read-only access to the Configuration Item [cmdb_ci] table. A CMDB Editor has writing privileges to CMDB Data Manager tasks and to CIs but can't change policies such as in the CMDB Data Manager or in the CI Class Manager.
    • sn_cmdb_user
    • cmdb_ms_editor
    CMDB User

    [sn_cmdb_user]

    Provides read-only access to the CMDB data and to basic UIs such as CMDB reports and dashboards, within CMDB Workspace.
    • canvas_user
    • data_manager_user
    • cmdb_ms_user
    Multisource CMDB Admin

    [cmdb_ms_admin]

    Provides full access to data, dashboard configurations, and queries related to Multisource CMDB and CMDB 360. cmdb_ms_editor
    Multisource CMDB Editor

    [cmdb_ms_editor]

    Provides access to CMDB 360 records and enables users to create and edit CMDB 360 queries. cmdb_ms_user
    Multisource CMDB User

    [cmdb_ms_user]

    Provides read-only access to multisource data, CMDB 360 queries, and to related UIs such as CMDB 360 reports and dashboards, and Multisource Report Builder. cmdb_read

    Scheduled jobs installed

    Scheduled job Description
    CMDB Workspace Collection Updates the information in all the 7-Day Activity charts such as the CI Activity in Last 7 Days chart.
    Multisource Dashboard Analytics Population Runs daily to calculate the aggregate statistics of CMDB 360 data and populates the CMDB 360 dashboard landing page.
    Multisource Dashboard Collection Collects CMDB 360 data and then invokes the Multisource Dashboard Analytics Population scheduled job.
    Multisource Dashboard Data Generator ( Demo data) Demo job that populates CMDB 360 tables with simulated data, to showcase the CMDB 360 dashboard landing page. Runs on demand.
    insight – cloud non-cloud aggregate Runs every 30 minutes to collect data for the Cloud and non-cloud resources chart.
    Insight - Cloud Applications Collects cloud data for the cmdb_ci_appl table.
    Insight - Non-cloud Applications Collects non-cloud data for the cmdb_ci_appl table.
    Insight - Cloud Object Storage Collects cloud data for the cmdb_ci_cloud_object_storage table.
    Insight - Cloud Service Account Collects cloud data for the cmdb_ci_cloud_service_account table.
    Insight - Cloud DB Instances Collects cloud data for the cmdb_ci_db_instance table.
    Insight - Non-cloud DB Instances Collects non-cloud data for the cmdb_ci_db_instance table.
    Insight - Cloud Kubernetes Cluster Collects cloud data for the cmdb_ci_kubernetes_cluster table.
    Insight - Non-cloud Kubernetes Cluster Collects non-cloud data for the cmdb_ci_kubernetes_cluster table.
    Insight - Cloud Servers​ Collects cloud data for the cmdb_ci_server​ table.
    Insight - Non-cloud Servers​ Collects non-cloud data for the cmdb_ci_server​ table.
    Insight - Cloud Storage Volume​ Collects cloud data for the cmdb_ci_storage_volume​ table.
    Insight - Non-cloud Storage Volume​ Collects non-cloud data for the cmdb_ci_storage_volume table.​
    Insight - Cloud VM Instances Collects cloud data for the cmdb_ci_vm_instance table.
    Insight - Non-cloud VM Instances Collects non-cloud data for the cmdb_ci_vm_instance table.
    CMDB Workspace – Populate aggregates Daily
    Runs daily to collect the latest data from the instance for cards such as the CI Summary chart in the CMDB Workspace landing page, and the following cards in the Insights view:
    • CIs processed by IRE​
    • CIs used in Data Manager policies​
    • CIs used in data attestation​
    • Query Builder queries
    • Intelligent search

    Populates the Base Aggregate Data [sn_cmdb_ws_base_aggregate_data] table with the collected data.

    Once collection completes, invokes the CMDB Workspace Aggregates Daily Collection scheduled job.

    CMDB Workspace – Populate aggregates Monthly
    Runs monthly to collect data from the instance for cards such as the following, in the Insights view:
    • CIs processed by IRE based on source
    • CIs processed by IRE​

    Once collection completes, invokes the CMDB Workspace Aggregates Monthly Collection scheduled job.

    CMDB Workspace Aggregates Daily Collection A Performance Analytics job that stores the latest data generated by the CMDB Workspace – Populate aggregates Daily scheduled job. The stored data is then shown in respective cards in the Insights view.
    CMDB Workspace Aggregates Monthly Collection A Performance Analytics job that stores the latest data generated by the CMDB Workspace – Populate aggregates Monthly scheduled job. The stored data is then shown in respective cards in the Insights view.
    [Demo] — CMDB Workspace Collection

    Supports demo data for CMDB Workspace charts in various views such as the Home view.

    Installed only if Load demo data was checked when the CMDB Workspace store app was installed or upgraded.

    [Demo] — CMDB Workspace demo data

    Activates demo data for CMDB Workspace charts in views such as the Insights view, and CMDB 360 view (if CMDB 360 is enabled). Populates the Base Aggregate Data [sn_cmdb_ws_base_aggregate_data] table with random numbers that illustrate trend lines in charts in the Home and Insights views. It then runs demo data collection scheduled jobs.

    Installed only if Load demo data was checked when the CMDB Workspace store app was installed or upgraded.

    [Demo] CMDB Workspace Aggregates Daily Collection

    A Performance Analytics job that supports demo data for CMDB Workspace charts in various views such as the Insights view and which is installed only if Load demo data was checked when the CMDB Workspace store app was installed or upgraded.

    Stores the demo data generated by the CMDB Workspace – Populate aggregates Daily scheduled job. The demo data is then shown in respective cards in the Insights view.

    [Demo] CMDB Workspace Aggregates Monthly Collection

    A Performance Analytics job that supports demo data for CMDB Workspace charts in various views such as the Insights view and which is installed only if Load demo data was checked when the CMDB Workspace store app was installed or upgraded.

    Stores the demo data generated by the CMDB Workspace – Populate aggregates Monthly scheduled job. The demo data is then shown in respective cards in the Insights view.

    CMDB Workspace Collection On Demand With Lookback

    Collects historical data (past 30 days) for some indicators such as the Integration outliers.

    Runs automatically during install or upgrade and isn't configured with any recurring schedule.

    Tables installed

    Table Description

    CMDB Group Metadata

    [sn_cmdb_ws_group_metadata]

    CMDB group data with count of CIs in each group.

    CMDB Group Query Metadata

    [sn_cmdb_ws_group_query_metadata]

    Encoded queries with count of CIs in each encoded query subgroup.

    NLQ Sample Search

    [sn_cmdb_ws_nlq_sample_search]

    Sample searches that appear when selecting the search box of an Intelligent Search for CMDB widget.

    NLQ Sample Search Table

    [sn_cmdb_ws_nlq_sample_search_table]

    References the actual tables associated with sample searches that appear when selecting the search box of an Intelligent Search for CMDB widget.

    NLQ Excluded Table

    [sn_cmdb_ws_nlq_excluded_table]

    Tables with ambiguous names that should be excluded from Intelligent Search. These tables won’t appear in suggestions, and other tables with similar names are given higher priority in search results.

    Important Actions Configuration

    [sn_cmdb_ws_imp_action_card_config]

    Configuration of appearance and behavior of Important action cards that appear on the landing page of the CMDB Workspace. Editing in this table is accessible only to users with the sn_cmdb_admin role. Authorized users can modify attributes of an important action such as Active and Filter conditions, but can't modify the Type, Persona, and Table attributes.

    Quick Links

    [sn_cmdb_ws_quick_links]

    Quick links that appear on the CMDB Workspace landing page.

    CIs by Number of Sources

    [sn_cmdb_ws_ms_cis_by_number_of_sources]

    CIs grouped by the number of discovery sources they were discovered by. Records appear as a list view when clicking on the CIs by number of discovery sources bar chart in the CMDB 360 view.

    CIs With a Single Source

    [sn_cmdb_ws_ms_cis_with_single_source]

    CIs reported by only one discovery source. Records appear as a list view when selecting the CIs with a single discovery source chart in the CMDB 360 view.

    CMDB Workspace Multisource Class Metadata

    [sn_cmdb_ws_ms_class_metadata]

    Class configuration settings such as class selections and weights, that CMDB Admins can modify from the CMDB 360 view. Used by CMDB 360 analytics population queries to store a sample set of coverage data for the CIs by number of sources and CIs with a single source drill-downs cards.

    Multisource Data Mismatch Records

    [sn_cmdb_ws_ms_data_mismatch]

    Data mismatch records found from attribute discrepancies from various data sources. Records appear as a list view when selecting the Data mismatch chart in the CMDB 360 view.

    CMDB Workspace Multisource Data Mismatch Configurations

    [sn_cmdb_ws_ms_data_mismatch_config]

    Data mismatch settings, such as the selection of classes, attributes, conditions, and weights, that CMDB Admins can modify in the CMDB 360 view. Used by CMDB 360 analytics population queries to store a sample set of data mismatch records in the sn_cmdb_ws_ms_data_mismatch table.

    Discovery sources not reporting CIs

    [sn_cmdb_ws_ms_discovery_sources_not_reporting]

    Data for when one or more discovery sources stop reporting CIs after the specific X number of days (X can be set in the CMDB 360 view and is stored in the sn_cmdb_ws.ms.discovery_source_not_reporting_max_days system property). Records appear as a list view when selecting the CIs not reported by discovery sources chart in the CMDB 360 view.

    Multisource Workspace Settings Weight Type

    [sn_cmdb_ws_ms_settings_weight_type]

    Weight type (automatic or manual) for data mismatch and coverage settings in CMDB 360 view.

    Datacenter Types

    [sn_cmdb_ws_datacenter_type]

    Classifications of datacenter classes which are considered cloud or non-cloud in the organization, which is used for the Cloud and non-cloud resources chart.

    CMDB Insight Query Categories

    [sn_cmdb_ws_insight_query_category]

    Class categories and their status for inclusion in the Cloud and non-cloud resources chart.

    CMDB Insight Data

    [sn_cmdb_ws_insight_data]

    Legacy table for storing data for the Cloud and non-cloud resources chart.

    Starting with CMDB Workspace version 3.4, the CMDB Product Insight Data [sn_cmdb_ws_product_insight_data] table is used instead.

    Base Aggregate Data

    [sn_cmdb_ws_base_aggregate_data]

    Aggregation data for CMDB Workspace cards and parent table to other aggregation tables. When processing for a count completes, State of the existing record for that count is set to retired and a new record for that count is created with the updated count value. Cards in CMDB Workspace views show values only for counts where State = ready.

    Read only.

    Service Graph Connector

    [sn_cmdb_ws_service_graph_connector]

    Details about all Service Graph Connectors that are currently available in the ServiceNow Store (excluding any Innovation Lab connectors). Data is used to provide a current count for the Service Graph Connectors card in the Insights view.

    Read only.​

    Rating Configuration

    [sn_cmdb_ws_rating_config]

    Start and end values for different ratings of a category. For example, start and end values for low, moderate, and high adoption level ratings for the data governance category in the Insights view.

    Read only.​

    Feature Category

    [sn_cmdb_ws_feature_category]

    Metadata of the feature card for most of the features at CMDB Workspace level.

    Read only.​

    CMDB Product Insight Data

    [sn_cmdb_ws_product_insight_data]

    Aggregated count for each class and datacenter class, used for cards in the Insights view.

    Read only.​

    Feature Category Runtime Attributes

    [sn_cmdb_ws_feature_category_runtime_attribute]

    Runtime attributes related to performance insights, that can be used when running various scheduled jobs.

    Read only.​

    Integration Aggregate Data

    [sn_cmdb_ws_integration_aggregate_data]

    Integration outlier information related to performance insights. Details for each Integration with execution records which contain processing rate or rows outliers.

    Read only.​

    Partial Payload Items

    [sn_cmdb_ws_partial_payload_item]

    Extracted partial payload information related to performance insights. Includes discovery source, error, and class, associated with each partial payload item.

    Read only.​

    Application Service Insights Data

    [sn_cmdb_ws_app_svc_insight_data]

    Application services details such as classification (cloud vs. non-cloud, hybrid, or unknown) and count of CIs associated with the application service.

    Read only.​

    Table Attributes

    [sn_cmdb_ws_node_map_table_attributes​]

    Set of extended properties, per class, that appear in the Attributes pane in the contextual side panel for a selected CI in Unified Map.

    For more information, see Configure extended properties for a class.

    Node Map Related Items

    [sn_cmdb_ws_node_map_related_item​]

    Categorization and order of related items, per class, that appear in the Related items pane in the contextual side panel, in CI badges, and in timelines. Applies in Unified Map.

    For more information, see Configure related items.

    Node Map References

    [sn_cmdb_ws_node_map_reference]

    Reference relationships that appear as a dotted line relationship in Unified Map.

    For more information, see Configure map references.

    Class Icons

    [sn_cmdb_ws_class_icon​]

    Maps ServiceNow platform UI Builder (UIB) icon values (for example 'serverbox-outline') to CMDB class display names that they are used for (for example 'Network Disk') in Unified Map.​

    Node Map Profiles

    [sn_cmdb_ws_node_map_profiles​]

    Class profiles that include default filters and some Unified Map settings, per class. A class profile is applied if no filter preset is in effect, to the initial map and when setting the filter preset to Default view.

    Specifying a class profile can be especially useful for Service Mapping data with the Mapped Application Service class.

    For more information, see Configure class profiles.

    CMDB Data Management Certification Task To Document

    [sn_cmdb_ws_dm_certification_task_to_document]

    Mappings between certification tasks and records.

    CMDB Certification Attribute Status

    [sn_cmdb_ws_dm_certification_attribute_status]

    Flattened failed attribute status JSON. Used for reporting certification exceptions.

    CMDB Data Management Task Execution Context

    [sn_cmdb_ws_dm_task_execution_context]

    Mappings between tasks and a policy’s' execution context.