Table of Contents

Using the DOM Viewer

Tip

To get to know this tool, you can follow Kata #54 on DataMiner Dojo and deploy the tutorial package Tutorial - DOM Viewer from the Catalog. This package includes the DOM Viewer itself as well as the example modules used in Kata #54.

The DOM Viewer application consists of several pages:

  • SDM Modules: Displays the Standard Data Model (SDM) modules in an interactive graph.

  • All Modules: Displays all modules found in the DataMiner System in an interactive graph.

  • All Descriptors: Allows you to easily find and visualize field descriptors across any module, definition, or section.

  • Tools: Allows you to generate markup code to document a DOM module.

SDM Modules

This page shows the Standard Data Model if it is present in your DataMiner System. The Standard Data Model is a single unified DOM model to capture a wide range of business and operational data. Several low-code apps available in the Catalog, including all MediaOps applications, are built on this model.

Note

The DOM Viewer will only be able to display the SDM information if the Standard Data Model is present in your DataMiner System.

Working with the module overview graph

In the node-edge graph, DOM definitions are represented as nodes. If you hover over a node, general information will be displayed such as the DOM module and the number of sections and field descriptors.

Definition Hover Panel

The displayed pop-up panel contains two buttons:

Button Description
Open Definition Table button Open Definition Table button. Displays a table with all field descriptors that are part of that definition, grouped by sections displayed as tabs at the top. For example:
Table Definition
Open State Transitions button Open State Transitions button. Displays a state transitions graph, which shows which states an instance of the definition can move through (i.e. the behavior definition). For example:
Behavior Definition

The edges in the graph show the relationships between the definitions. If you hover over an edge, a pop-up panel will show which field descriptor is referencing the other DOM definition.

Relationship Hover Panel

All Modules

The All Modules page contains an interactive graph similar to that on the SDM Modules page, which can be used in the same way. This graph will display all DOM modules found in your DataMiner System.

You can also filter on specific DOM modules and/or DOM definitions with the filter boxes on the left, so that only these are displayed in the graph.

All Modules

All Descriptors

This page lists all the available field descriptors.

You can filter the list by module, definition, and section using the filter boxes on the left, in order to quickly reach the field descriptor you are looking for.

Different field descriptors can be viewed simultaneously across different modules.

Field Descriptors

Generating markup

The DOM Viewer application was also designed to aid with documentation. As models grow and change, documentation needs to keep up, which can be challenging, especially if you need to do this manually.

This is why on the Tools page of the DOM Viewer, you can have markup tables generated automatically by selecting the modules you want to document and clicking the Generated .md tables button.

Generate Markup

Improve this page