Generate References Report

Overview

This helpers generates a report of references of nested model elements.

Applicable To	All
Menu Entry	Power Pack  Reporting Tools  Generate References Report  All Power Pack  Reporting Tools  Generate References Report  External
Demonstration	Watch the Video

Overview

The helper:

1. Registers the starting Unit.

a. This will be the starting element itself if it is a unit, otherwise it’s owning unit.

2. Gathers all nested elements under the selected element.

3. Builds a map of elements and their references.

a. Any elements that have no references are automatically excluded

4. If the External* menu option was selected, then any references that are owned by the same Unit as the starting Unit (or any of its child units) are also excluded.

5. Generates a HTML report of the results (see below)

*This option is useful when working with REF units – if a new version of the unit is used then the report can help with impact analysis by showing only those elements outside of this unit that have references to elements inside it.

References Report

The generated report includes a sidebar and a home page:

References may be explored in two ways:

References by Unit

The home page displays a map of the Units that have elements with references along with how many elements. This information is also available in the sidebar on the Refs by Unit tab:

Clicking a node in the map or a link in the sidebar displays the page for that unit which lists the model elements with references in that Unit (grouped by type), along with the referenced element(s):

Referenced Elements by Type

The Elements with Refs tab in the sidebar lists all referenced elements:

Clicking a referenced element in the sidebar shows all its references. These are organized onto tabs for the owning unit and then grouped by type:

Filtering the Report by Changes

If the following property is set to true AND the External menu has been selected, then the helper will filter the report to only include elements in scope (with references) that have been changed:

RhapsodyPowerPack.GenerateReferencesReport.CheckForChangedElements

To perform the check there must be a second Rhapsody instance open with the same model loaded (that is the GUIDs of both models must match). This will typically be a copy of the model or a version of the model in ELM. Not all changes may be detected; these are detailed here: Comparing Model Elements

If change detection is enabled, then the welcome page and sidebar display a notification to that effect:

In addition the details page for each ‘Element with Refs’ includes the changes:

Grouping and Sorting

By default, the sidebar groups elements by type and orders them alphabetically (A-Z) but there are two other sort options:

· By Count: The elements are still grouped by type but inside the groups they are ordered by the number of references.

· Flat: The grouping is removed, and a flat list of elements is presented ordered by the number of references.

Viewing the Report

After generation the report opens automatically:

· Inside Rhapsody (Rhapsody 10 or above)

· In the system web browser

· Both

Depending on the value of the following property:

RhapsodyPowerPack.ReportingTools.OpenInBrowser