DOCSEARCHbyAlgolia
Submit Docs

erm4sn Documentation

website·Indexed 31 days ago

https://docs.erm4sn.com

Documentation for erm4sn, a visualization tool for ServiceNow. It includes guides for system analysis, schema consistency checks, and managing ServiceNow instances, tables, and applications. Features include integration with Enterprise Architect, Health Dashboards for customization trends, and administrative configurations for OIDC, IP access, and user management.

Tokens
8.8K
Snippets
6
Records
71
Agent score
49%

What's inside erm4sn

  1. Overview of erm4sn for ServiceNow

    erm4sn is a visualization tool designed for ServiceNow that transforms complex data models into actionable insights. It is primarily used by developers for troubleshooting schema issues, administrators for managing platform upgrades, and analysts for designing new features.

  2. Interpret Health Dashboard metrics and views

    The Health Dashboard provides visibility into technical debt across application scopes through several views:

    • Main Dashboard: Displays the overall Health Score (0-100), the number of 'At Risk' scopes (those with ≥40% customization), and lists of improving vs. degrading scopes.
    • Application Scopes Table: A searchable list showing individual Health Scores, trends, and the count of Customized vs. Custom records per scope.
    • Scope Detail View: Provides a deep dive into a specific scope, including a Snapshot Comparison table (showing deltas), a Customization Trend History chart, and a Class-Level Breakdown (pie chart/table) showing which record types (e.g., UX Macroponent Definition) are customized.

  3. Understand the purpose of the Release feature in erm4sn

    The Release feature is used to create, manage, and analyze snapshots of modifications in the ServiceNow dictionary over time within a single instance. This ensures traceability and consistency by visualizing the evolution of schema modifications. It differs from the Comparison feature, which is used to compare multiple ServiceNow versions or different instances to highlight differences across environments or upgrades.

  4. Configure Data Density calculation

    Data Density calculation uses ServiceNow's aggregate functions to collect metadata about which tables and columns contain data.

    Constraints and Requirements:

    • The REST API user must have admin privileges to retrieve these statistics.
    • It is not recommended to enable this feature on production instances.
    • This feature queries statistics only and does not access actual customer data.

    Updating Data Density: Data density is not refreshed automatically. To update, click 'Clear Data Density Details' and then trigger a manual instance refresh.

  5. Troubleshoot orphaned columns and data access

    If erm4sn displays a warning about 'Orphaned Columns', it means column definitions (sys_dictionary) were found without corresponding table records (sys_db_object). This typically indicates incomplete synchronization or insufficient permissions. To resolve this, ensure the REST API user has both the admin and snc_read_only roles.

  6. Explore ServiceNow data models with erm4sn

    erm4sn provides a set of tools to analyze and visualize ServiceNow data structures. Key capabilities include:

    • Hierarchical Table View: A browsable format to explore table inheritance, relationships, and dependencies.
    • Graphical ERDs: One-click generation of UML-style Entity Relationship Diagrams that can be exported for use in DrawIO or Enterprise Architect.
    • Customization Reports: Visualization of customizations across ServiceNow instances to track changes and inconsistencies.
    • Instance Comparison: Schema difference analysis between multiple ServiceNow instances or versions to ensure environment consistency.
    • Schema Health Insights: Monitoring tools for the overall quality and health of the ServiceNow schema configuration.

  7. Analyze field type and length consistency

    The Type Consistency tool provides an overview of field type and length combinations across the schema to ensure similar attributes are defined consistently.

    Usage:

    1. Browse the Type Summary list of detected type and length combinations.
    2. Click a specific type name to see all locations where that combination is used in the schema.
    3. Click Download to export the results to Excel.

  8. Navigate from column search results to table views

    In the Table Column search listing, clicking on a specific column name opens its corresponding table view. This view provides detailed information about the column and its context within the table, which is useful for troubleshooting or optimizing configurations.

  9. Manage releases from the Release Listing page

    The Release Listing page provides an overview of all existing releases with the following actions:

    • View Details: Click on the snapshot timestamp to open the detailed view of a release.
    • Edit Release: Click on the release name to modify its details.
    • Add New Release: Click the 'New' button to create a new release.

  10. Navigate and explore ServiceNow data using the erm4sn Navigation Bar

    The erm4sn navigation bar provides access to several specialized views for analyzing ServiceNow schemas:

    • Scope: Explore tables within specific Application Scopes to understand data organization.
    • App: View tables grouped by Applications (mirroring the ServiceNow Left Navigation structure).
    • Table: Access a complete list of tables and their parent/child hierarchical relationships.
    • Column: Review detailed column metadata, including data types, lengths, and references.
    • Health: Identify customizations and configurations that may impact system stability or performance.
    • Release: Compare releases to track schema changes over time.
    • Diagram: Generate graphical Entity Relationship Diagrams (ERDs) to visualize table dependencies.
    • Analyze: Compare schemas across different ServiceNow instances or versions to ensure consistency during upgrades.

  11. Explore ServiceNow applications in erm4sn

    Applications in erm4sn are organized based on the ServiceNow navigation structure to provide a unified view of how tables and scopes are combined. The Applications list displays all detected applications within a ServiceNow instance. Clicking an application name opens its detailed view.

  12. Switch between ServiceNow instances in erm4sn

    The Instance Switcher allows users to move between different ServiceNow environments (e.g., development, testing, and production).

    Key behaviors:

    • Sync Status: Hover over the instance name to view the timestamp of the last synchronization with ServiceNow.
    • Availability Indicator: Instance names appear grayed out if the currently selected table or scope is not available in that specific instance.