SystemsModelingAPI 1.0b3 FTF Avatar
  1. OMG Issue

SYSMOAS_ — SysML and KerML OSLC API vocabulary and shapes files need updates for FTF2

  • Key: SYSMOAS_-61
  • Status: open  
  • Source: International Business Machines ( Mr. Jim Amsden)
  • Summary:

    https://www.omg.org/spec/SystemsModelingAPI/20240801/OSLC-Domain-Model.zip, needs updated vocabulary and constraints files for KerML and SysML:

    • KerML Shapes-shapes.xml
    • KerML Vocabulary-vocab.xml
    • SysML Shapes-shapes.xml
    • SysML Vocabulary-vocab.xml

    The vocabulary terms updates include:

    • Use updated SysML.ecore and KerML.ecore source files for generating the vocab files.
    • Add the ontology element to the vocab .ttl file.
    • Generate Turtle instead of RDF/XML
    • KerML and SysML v2 Element subclass oslc_am:Resource to link SysML elements to other lifecycle resources (e.g., requirements, change requests, test cases, etc.)
    • Add rdfs:isDefinedBy oalc_sysmlv2 and rdfs:label to each vocabulary terms
    • Translate the EEnum enumerations to RDF, e.g., FeatureDirectionKind
      See [Defining Enumerations](https://docs.oasis-open-projects.org/oslc-op/core/v3.0/os/core-vocab.html#enumerations). An EEnum would be an rdfs:Class (with label, comment and definedBy). Its enumeration literals have rdf:type of the enumeration class, and just a label.
    • Add SysML subclasses in the SysML vocabulary terms
    • Use the KerML and SysML v2 non-versioned namespace for the vocabulary terms to follow OASIS OSLC namespace guidelines:
      @prefix oslc_sysml: <https://www.omg.org/spec/SysML/vocabulary/>
      @prefix oslc_kerml: <https://www.omg.org/spec/KerML/vocabulary/>
    • Add assertion <https://www.omg.org/spec/SysML/20250201/vocabulary/> owl:sameAs <https://www.omg.org/spec/SysML/vocabulary/> to conform to OMG namespace guidelines. Add a similar assertion for KerML
    • Set rdfs:comment in the vocab file to be the first paragraph in the eCore description with the markup stripped out. rdfs:comment is a string and should not contain markup. Including the complete description in the OASIS vocabulary documents results in unwieldy machine readable documents, poor formatting, and unnecessary duplication of information.
    • Fixed all OSLC ShapeChecker errors
    • Rename the files to replace space in the names with "-"

    The resource shape constraint updates include:

    • Used updated SysML.ecore and KerML.ecore source files for generating shapes files.
    • Add the missing ResourceShapeConstraints element to the shapes.ttl file
    • Generate Turtle instead of RDF/XML (for readability)
    • Add inherited oalc_am:Resource properties to the shapes for KerML and SysML v2 Element to include recommended OSLC core common properties, and link types for integration with other OSLC domains (e.g., Change Management, Requirements Management and Quality Management).
    • Update the versioned namespace for the resource shape constraints:
      @prefix : <https://www.omg.org/spec/SysML/20250201/shapes/> . Similar change for KerML
    • Set dcterms:description in the shapes files to the first paragraph in the eCore description, retaining the markup. dcterms:description is an XMLLiteral so the markup can be retained.
    • Removed the classname_ prefix from all properties constraint names to conform with the JSON Schema naming conventions. One 58 properties have multiple domains (containing classes) and these are scoped in the ResourceShape by using RDF blank nodes for these properties.
    • Add cardinality, range and valueType to shape properties that correspond to the Ecore representation.
    • Fixed all ShapeChecker errors

    The OSLC artifacts for the current abstract syntax, as well as the script to update the artifacts, are available as open source here: https://github.com/oslc-op/oslc-specs/tree/master/specs/sysml.

  • Reported: SystemsModelingAPI 1.0b2 — Wed, 1 May 2024 14:30 GMT
  • Updated: Tue, 26 Nov 2024 17:36 GMT
  • Attachments: