Foglight 5.9.1 - Dashboard Support Guide

Foglight™ comes with report templates that you can use to publish module unit tests result to a report. Depending on the level of information that you want to see in the report, you can report on all modules, or selected modules only.

Reporting on all modules results in a flat list of all modules and sub-modules showing the same information that appears on the Module Unit Test Report. For each module and sub-module, it shows the number of functions, queries, along with the numbers and percentages of function and query unit tests.

Reporting on selected module shows more details about unit tests. For example, you can see the numbers of all functions and queries compared to the numbers of the module’s functions and queries that include unit tests. For each unit test, you can see its name, duration, and result, and a list of functions or queries that are missing unit tests. Use this information as a quick reference to investigate unit test results and to identify which components are missing unit tests.

To publish module unit tests to a report:

On the Development Tools page, click Module Unit Test Report.

The Module Unit Test Report dashboard appears in the display area.

Observe the tree view of modules and the available unit tests per module.

To drill down on a module’s sub-modules, expand the module node.

For each module that contains unit tests, you can see the numbers of functions, queries, and the associated unit tests.

Publish unit test results to a report.

To create a report that displays unit test results for specific modules only, select those modules in the list.

In the top-right corner of the display area, click Reports.

A dwell appears.


	TIP: Another way to access this dwell is through the action panel. On the General tab, under Other Actions, click Create report.

To report on all modules, in the dwell, click Unit Tests (All Modules).

To report on the modules selected in Step a, click Unit Tests (Selected Modules).


	TIP: Reporting on module unit tests takes the list of selected modules as input. When reporting on selected modules, it is possible to edit that list to add or remove modules, as required.

The Schedule Report dialog box appears.

Complete the flow to schedule the report.

The newly generated reports can be accessed from the Reports dashboard. For more information about reports, see the Foglight User Help or click the Help button in the dialog box.

To return to the Development Tools page, click Development Tools in the breadcrumb trail.

Exploring Type and Property Definition Inconsistencies

The Types Documentation Report lists all namespaces that exist in your environment. A namespace is a collection of types that share the same concept. For example, each Foglight™ module has a collection of types associated with it. While type names must be unique within a namespace, it is possible to have same type names across multiple namespaces. For each namespace, the list shows the types it contains and their properties, and whether their names follow the standard naming convention, and indicates if they include descriptions and enumeration descriptions (for Enum types) that are identical to their names.

Use this dashboard to quickly evaluate if your model includes any types or properties with inconsistences in their name and description and to list them. Start by selecting a namespace that includes errors. Then, review the types that contain name or definition errors. For each type or property, the table shows its name, the number of properties with errors (types only), whether the first letter is an uppercase letter, the type name is a compound word with each element’s initial letter capitalized, and if the description (and enumeration description for Enum types) exists or is the same as the type name.