Migrating from MB2SE 3
Touchstone 4.0.0 renames the resource MB2SE shipped as version 3 and reshapes its profile. Every
renamed element keeps its xmi:id, so a project built on version 3 opens on version 4 with its
stereotypes and tag values in place. One manual step remains, stated first.
The one manual step
«MaturityRule» is abstract. A rule that carried «MaturityRule» in version 3 carries nothing that the
tool can keep; re-apply it as «ModelingRule» when a complete model must satisfy it for every
individual, or as «EngineeringRule» when its ratio is a finding. The tier tag that made this
distinction is removed, so read the old value before upgrading if the choice is not obvious from the
rule.
Resource and files
| Version 3 | Version 4 |
|---|---|
resource MB2SE, id 76974 | resource Touchstone, id 76974, so the resource manager upgrades in place |
MB2SE_Profile.mdzip | Touchstone_Profile.mdzip |
MB2SE_Customization.mdzip | Touchstone_Customization.mdzip |
MB2SE_Validation_Rules.mdzip | Touchstone_Validation.mdzip, five suites of 38 rules |
profile MB2SE Profile, URI …/spec/mb2se/profile | Touchstone Profile, …/spec/touchstone/profile |
customization MB2SE Customization, URI …/spec/mb2se/customization | Touchstone Customization, …/spec/touchstone/customization |
A project that used the profile by file name re-points the usage at the new file once; the tool matches the project id and keeps every reference.
The derived properties individuals on Concept and on «ConceptMapping», and passing, failing,
score and completeness, are Binary expressions inside the customization, backed by classes the
plugin ships. A project saved against the previous customization updates its usage of
Touchstone_Customization.mdzip once, and that one update brings every derived property.
Profile
| Version 3 | Version 4 | Id kept |
|---|---|---|
| «Set» | «ConceptMapping» | yes |
Set.UMLMetaclass | ConceptMapping.metaclasses, now optional when stereotype is set | yes |
Set.includeSubtype | ConceptMapping.includeSubtypes | yes |
Set.query | ConceptMapping.filter, a predicate | yes |
| «AttributeImplementation» | «AttributeMapping» | yes |
AttributeImplementation.UMLProperty | AttributeMapping.metaProperty | yes |
AttributeImplementation.stereotypeTag | AttributeMapping.tag | yes |
AttributeImplementation.stereotypeDerivedProperty | AttributeMapping.derivedProperty | yes |
AttributeImplementation.query | AttributeMapping.query, exactly one of the four tags set | yes |
| «Attribute» on a Concept-typed property | «Relation», applied by the plugin on the next edit of the property | new stereotype |
| «RelationMapping» | new | |
«MaturityRule», concrete, tier | «MaturityRule» abstract; «ModelingRule», «EngineeringRule» | new ids |
MaturityRuleImplementation.expression | MaturityRule.expression, in the Touchstone expression language | new tag |
MaturityRuleImplementation.validationRule [0..1] | [1..1] | yes |
ObjectiveStatus.Developed | ObjectiveStatus.Approved | yes, existing values migrate silently |
MaturityRuleTier | removed | |
UML Metaclasses, UML Properties | UmlMetaclasses, UmlProperties, literals unchanged | yes |
Objective.priority : Integer [0..1] | new | |
Implements.rationale : String [0..1] | new | |
| «ModulePackage» | «Enabler» | yes |
| «BookOfKnowledge» | «ProcessPackage» | yes |
A Concept-typed property that carries «Attribute» from version 3 keeps it: the rules never remove a stereotype. Remove «Attribute» by hand, then retype the property or re-apply «Concept» to its owner so the Relation rule sees it.
Customization
| Version 3 | Version 4 |
|---|---|
Concept.implementedBy | Concept.mappings |
Set.implementedConcept | ConceptMapping.mappedConcept |
Attribute.implementedBy | Attribute.mappings |
AttributeImplementation.implementedAttribute | AttributeMapping.mappedAttribute |
MaturityRule.implementedBy | MaturityRule.implementations |
Concept.maturityRules | Concept.modelingRules, Concept.engineeringRules |
| palette "Constraint Implementation" | "Maturity Rule Implementation" |
_Topic_ Sets | _Topic_ Concept Mappings |
_Topic_ Attribute Implementations | _Topic_ Attribute and Relation Mappings |
_Topic_ Ontology Maturity | _Topic_ Maturity |
Concept.individuals, computed | |
MaturityRule.passing, failing, score; Concept, Attribute, Relation, Objective.completeness, computed | |
| palette "Module Package", "Book of Knowledge" | "Enabler", "Process Package" |
A generic table or matrix of your own that named a version 3 derived property is re-pointed at the new name in its column or criterion definition.
Plugin and Kotlin API
| Version 3 | Version 4 |
|---|---|
package com.mbseconsulting.mb2se, .profile | com.mbseconsulting.touchstone, .profile |
MB2SEProfile, MB2SECustomization | TouchstoneProfile, TouchstoneCustomization |
Mb2seRules, mb2seLog, MB2SE_CATEGORY | TouchstoneRules, touchstoneLog, TOUCHSTONE_CATEGORY |
SetView, isSet(), asSet() | ConceptMappingView, isConceptMapping(), asConceptMapping() |
AttributeImplementationView.UMLProperty | AttributeMappingView.metaProperty |
UMLMetaclasses, UMLProperties | UmlMetaclasses, UmlProperties |
AttributeRule : AutoStereotypeRule<Property> | AttributeRule : ConceptPropertyRule; new RelationRule |
options group MB2SE_GROUP, label "MB2SE" | TOUCHSTONE_GROUP, "Touchstone" |
MB2SE_AUTO_STEREOTYPE_ATTRIBUTE | TOUCHSTONE_AUTO_STEREOTYPE_ATTRIBUTE, narrowed to PrimitiveType and Enumeration types |
MB2SE_AUTO_STEREOTYPE_STEP_ACTION | TOUCHSTONE_AUTO_STEREOTYPE_STEP_ACTION |
TOUCHSTONE_AUTO_STEREOTYPE_RELATION, enabled by default | |
log category MB2SE | Touchstone |
test property mb2se.test.model.autostereotype | touchstone.test.model.autostereotype |
com.mbseconsulting.touchstone.ontology.Ontology | |
Ontology.attributeValues answers EnumerationLiteral values for an Enumeration-typed Attribute | |
isModulePackage(), isBookOfKnowledge() | isEnabler(), isProcessPackage() |
A project option stored under a version 3 id is not read by version 4; a switch a project had turned off returns to enabled and is turned off again in Options → Project → Touchstone.
Build
| Version 3 | Version 4 |
|---|---|
com.mbseconsulting.resources:mb2se, com.mbseconsulting.plugins:mb2se | com.mbseconsulting.resources:touchstone, com.mbseconsulting.plugins:touchstone |
| Anvil 4.2.1 | Anvil 5.0.0 |