Generate a maturity report
A maturity report is one HTML file describing a model against one Enabler at a moment: the engineering findings first, the modeling completeness second. This page produces one and reads it.
Produce the report
- In the containment tree, select the «Enabler» package. The action is enabled for exactly one selected Enabler in a project carrying the Touchstone Profile, and for nothing else. A project that never loaded the profile does not show it.
- Right-click it and choose Tools › Generate Maturity Report….
- Accept or change the proposed file name,
<enabler>-maturity-<yyyyMMdd>.html, and save.
The tool shows a progress status while every rule is evaluated once over the individuals of its
Concept, and the completeness of each Concept and Objective is read as the specification window reads
it. A balloon then names the file and the time the generation took, and offers to open it; the same
line goes to the log under Touchstone. The report opens in the system browser.
The file is self-contained: fonts, icons, stylesheet and a copy of its own data travel inside it, so
it can be mailed or archived on its own.
Read the two registers
Engineering opens first. One row per approved Objective with its description and its number of findings. A finding is one individual failing an engineering rule. Open the Objective to see each rule, its score, and the findings by name. Findings are never averaged into any other figure: each rule is a question the engineers decide on.
Modeling shows the same Objectives with their completeness, the mean of the modeling rules over
the Concepts they justify. Open an Objective to see each Concept, each rule and the individuals that
fail it. A Concept with no individual in the project shows —: nothing is measured, and no vacuous
100 % is shown. The Modeling tile above the tabs is the Enabler's own figure: the mean over every
Concept of the Enabler, whatever the Objectives justify.
Both tabs list the approved Objectives only. A postponed or rejected Objective does not appear, and a rule on a Concept no approved Objective justifies appears on neither tab.
Concepts and Rules read the model raw. Concepts lists every Concept of the Enabler with its completeness and, under it, every rule on it with the individuals that fail. Rules lists every rule in one sortable table with a kind filter. An Enabler that declares no Objective yet still gets a full report through these two tabs.
Every rule shows its name and its specification, so EX-4 reads EX-4 An Exchange has an exchanged
Item; a rule with only one of the two shows that one.
Details
The Details switch at the right of the tab row shows, under each individual, its qualified name with its metaclass and stereotypes, and under each rule, on every tab including the Rules table, the text of its expression. Off, hovering an individual shows the same qualified name.
Printing, or exporting to PDF, stacks the four tabs under their titles and opens every collapsed section. The Details switch applies to print as well.
When a rule reads no verdicts
The engine produced no verdict for the rule: its expression does not parse or a reference does not
resolve. The log carries the reason under the Touchstone category, one WARN line per rule per
evaluation; The expression language lists every cause.