Release Notes - Semantic Aspect Meta Model

Release 2.2.0

Modeling features and elements

It is now possible to add samm:preferredName, samm:description and samm:see descriptive attributes to namespaces using the samm:Namespace pseudo-element declaration. A corresponding section Declaring Namespaces was added. Issue on Github.
Introduce new samm-e:Quantity Abstract Entity to enable declaring explicit relationships between values and their units in runtime data. Issue on Github.
Allow declaration and description of scalar values by introducing samm:Value. Issue on Github.

Validation

samm-c:RegularExpressionConstraints are now validated for samm:exampleValue. Issue on Github.
Validate that samm:Constraint base Constraint can not directly be used. Issue on Github.
Validate lexical values for xsd:boolean and language tags for rdfs:langString. Issue on Github.
Validate structure of URNs. Issue on Github.

Documentation

Clarification of terms and sections
- Consistent use of terms "must" and "should" in the documentation. Issue on Github.
- Clarify usage of samm:AbstractEntity as a data type. Issue on Github.
- Update documentation on contradicting samm-c:LengthConstraints. Issue on Github.
- Clarify validity of models where samm-c:LengthConstraints are combined with samm-c:Collections. Issue on Github.
- Clarify terms "scale" and "integer" for samm-c:FixedPointConstraint. Issue on Github.
- Specify in detail how prefixes are interpreted in samm:curie values. Issue on Github.
- Fix example value for xsd:int. Issue on Github.
- Fix samm-c:TimeSeries example. Issue on Github.
- Clarify usage of xsd and rdfs RDF prefixes. Issue on Github.
- Clarify use of samm:see for IRDIs in section Adding external references. Issue on Github.
Improvements of JSON payload mapping section
- Provide example for JSON payload mapping. Issue on Github.
- Document mapping of samm-c:Either Characteristic to JSON payloads. Issue on Github.
Improvements of Best Practices
- Greatly improved best practices section on the topics of naming elements, choosing appropriate samm:preferredNames and writing good samm:descriptions. The best practices for descriptions now also state which CommonMark Markdown constructs can be used for structuring documentation. Issue on Github.
- Add a best practices section on SI vs. imperial units. Issue on Github.
- Explain Reusing Elements in best practices. Issue on Github.
Architecture decision records
- Define mapping of namespaces and model elements to files: 0007 - Model Resolution. Issue on Github.
- Specify how copyright and license information is stored in Aspect Models: 0008 - Storage of copyright and license information in Aspect Models. Issue on Github.

Others

The Meta Model Elements diagram is now colored. Issue on Github.

Release 2.1.0

SAMM 2.1.0 is the first feature release on the Eclipse Semantic Modeling Framework with improvements on validation and documentation as follows:

Validation

The validation rule "all Properties defined in an Entity as well as in the Entity or AbstractEntity it is extending must have a unique name" has been removed. This means that it is now valid that multiple Entities inheriting from a common parent may share names. Issue on Github.
Validation of samm-c:TimeSeries was improved: The referenced type is checked by the validation now. Issue on Github.

Documentation

The SAMM project now uses MADR as a template for Architecture Decision Records (ADR). Issue on Github.
Architecture decision records were added to properly document important past design decisions. Issue on Github.
Section on Declaring Events was added; wrong edges in the Meta Model Elements overview diagram were fixed. Issue on Github.
Naming convention for Events was clarified: Events should use UpperCamelCase, like Aspects, Entities, Constraints and Characteristics. Issue on Github.
Section on Model Evolution was added in appendix. Issue on Github.
Reference to outdated terminology "leaf Characteristic" was fixed. Issue on Github.
Japanese sample text in Data Types was fixed. Issue on Github.

Others

The SAMM project was set up to be based on shared esmf-parent Maven parent project. Issue on Github.

Release 2.0.0

This is the first release in the ESMF. Its structure and content is similar to that of the Legacy BAMM Aspect Meta Model 2.0.0, which is why the version number 2.0.0 is kept. This release changes RDF namespaces and prefix names according to the move from the Open Manufacturing Platform (OMP) Semantic Data Structuring (SDS) working group BAMM Aspect Meta Model (BAMM) to the Eclipse Semantic Modeling Framework (ESMF) Semantic Aspect Meta Model (SAMM).

Meta model URNs are changed from urn:bamm:io.openmanufacturing:<element-type>:<version>#<element-name> to urn:samm:org.eclipse.esmf.samm:<element-type>:<version>#<element-name>.
The namespace rules for model elements changed accordingly from bamm to samm in the URN schema.
RDF prefixes are renamed from bamm, bamm-c and bamm-e to samm, samm-c and samm-e, respectively.

Version 1.0.0 of the meta model was released in the scope of the Open Manufacturing Platform (OMP) and was called BAMM Aspect Meta Model (BAMM). Version 2.0.0 was also released as BAMM, then re-released as Eclipse Semantic Modeling Framework (ESMF) Semantic Aspect Meta Model (SAMM) 2.0.0.

Release 2.0.0 (Legacy: BAMM)

Introduce Entity inheritance, the according Meta Model Element bamm:AbstractEntity and bamm:AbstractProperty as well as the bamm:extends attribute to define a hierarchy of Entities. This replaces the concept of refining an entity and the bamm:refines attribute in order to reduce complexity and modeling efforts.
Remove the bamm:name attribute to remove redundancy. The "short" name of an element is the local name part of its URI, i.e., the part following the # symbol.
The meta model elements Unit, QuantityKinds and their corresponding attributes have been moved from the unit namespace to the bamm namespace. The unit namespace is now solely reserved for the units of the unit catalog itself.
The formal description (units.ttl) of the units catalog is now automatically generated from its original source (see Units) and the local adjustments.
The localeCode and languageCode attributes have been moved from the bamm namespace to the bamm-c namespace.
Shared model elements have been adjusted:
- The Point3d Entity has been changed to use Abstract Properties for its components;
- The Time Series Entity has been changed to use an Abstract Property for its value component
The attributes bamm:properties, bamm:operations and bamm:events on bamm:Aspect are now optional, i.e., they do not have to be added any more even when they are empty lists.
Various issues in the specification (including examples) have been fixed and phrasing has been improved.

Release 1.0.0

This is the initial release for the Open Manufacturing Platform.