Touchstone
Reference

The maturity report

Every zone of the page the Generate Maturity Report… action writes, and the definition of every figure on it. The figures are the derived properties of the profile and three sums and means stated here; the report computes nothing else.

Subject

One «Enabler». Its Objectives are the «Objective»s under its «ObjectivePackage»s, recursively, in containment order, whose status is Approved or unset; a Postponed or Rejected Objective is not part of the report. Its Concepts are the «Concept»s under its «OntologyPackage»s, the same way; its rules are the «ModelingRule»s and «EngineeringRule»s whose context Concept is one of those Concepts, wherever the rule sits. A rule constraining anything but exactly one Concept, Attribute or Relation has no context Concept, and the report leaves it out.

Two readings

The Engineering and Modeling tabs read the model through the approved Objectives: each lists the Objectives, and under each the Concepts it justifies, directly or through an Attribute or a Relation, with their rules. A rule on a Concept no approved Objective justifies appears on neither.

The Concepts and Rules tabs read the model raw: every Concept of the Enabler and every rule, whether or not an Objective justifies it. Every rule is evaluated once, and both readings show the same figures for the same rule. An Enabler with no approved Objective yields empty Engineering and Modeling tabs and full Concepts and Rules tabs.

States

ElementStateConditionConsequence
RuleEvaluatedverdicts exist, or the Concept has no individualshows its figures
RuleNo verdictsits Concept has individuals and the engine produced no verdictshows no verdicts; the log names the reason

Figures

FigureWhereDefinition
Individualsrule, Concept, groupindividuals of the context Concept
Failing, findingsrulefailing of the rule; the same list is called Findings under an engineering rule and Failing under a modeling rule
Scorerulescore: passing over all individuals; absent when there is no individual
CompletenessConceptcompleteness: the mean of the scores of its modeling rules, including those on its Attributes and Relations; absent when none has a score
CompletenessObjectivecompleteness: the mean of the completeness of the elements it justifies; absent when nothing has a score
FindingEngineering tileone pair (engineering rule, failing individual); an individual failing two rules is two findings
Findings of the EnablerEngineering tilethe sum of failing sizes over the engineering rules the approved Objectives list, each rule once; the tile also counts those rules and the Objectives with at least one finding
Enabler completenessModeling tile, Modeling tab countthe mean of completeness over the Concepts of the Enabler that have one, whatever the Objectives justify; absent when none has

A mean over nothing is absent and renders —. Engineering figures never enter a completeness, and completeness never enters a finding count.

A percentage shows two decimals, truncated, so that nothing short of every individual passing reads as 100: 40 of 41 is 97.56 %, and a completeness of 0.99996 is 99.99 %. Only 1.0 reads 100 %.

Rule titles

A rule shows its name in monospace followed by its specification. A rule with no name shows the specification alone; a rule with no specification shows the name alone.

Zones

ZoneContent
Mastheadthe mark, Maturity report, the Enabler's name; project, Enabler, generation time (yyyy-MM-dd HH:mm, local zone), duration of the generation to the millisecond, and the version of the Touchstone build that wrote the report
Engineering tilefindings, rules with findings, Objectives with findings
Modeling tileEnabler completeness with a bar
TabsEngineering, Modeling, Concepts, Rules, with a count each; the Details switch
Engineering panelper approved Objective: icon, name, documentation, findings badge; engineering rules grouped by Concept; findings by name. A note when the Enabler has no approved Objective
Modeling panelper approved Objective: icon, name, documentation, completeness; modeling rules grouped by Concept with the Concept's individuals and completeness; failing individuals by name; the same note
Concepts panelper Concept: icon, name, individuals, findings badge, completeness; then its modeling rules and its engineering rules as full rows with their failing individuals
Rules panelone row per rule: rule, kind, context, individuals, failing, score; the expression under the rule with Details on; kind chips; sortable columns
Footerthe owner row, © <year> MBSE Consulting. Licensed under LicenseRef-mbseconsulting-software-1.0 with the licence linked; the Geist attribution; the SIL Open Font License behind a disclosure

Individuals

An individual shows the icon the containment tree shows and the tree's display text. Its hover, and its inline line under Details, read Qualified::Name · Metaclass «Stereotype, Stereotype». Its element id sits in the embedded JSON and nowhere on the page.

Color

Azure marks everything engineering: tile, tab count, band, bars, badges, at any score. Modeling bars grade by score: green at 90 % and above, amber below 90 %, red below 60 %. The thresholds are constants of the report.

The embedded JSON

A script element of type application/json and id touchstone-report holds the whole model: Enabler, project, generation time, duration in milliseconds, version, the two Enabler figures, the approved Objectives with groups and rules, Concepts with rules, and the icon table. Each rule, individual, Objective, Concept and group carries its element id. Nothing reads it today; it lets a later tool correlate two reports.

The file

One HTML file with its stylesheet, script, Geist and Geist Mono Latin subsets, the mark, the icons as the tool's SVG icons, or a 64 px PNG when an icon has no SVG source, as data URIs, and the JSON inline. It opens with no network. Printing stacks the four panels and opens every disclosure. Without script the page shows every panel's content open, without collapsing, sorting, filtering or the Details switch.

On this page