Skip to content

Commit

Permalink
Merge pull request #67 from PMSFIT/peter-lobner-schema-review
Browse files Browse the repository at this point in the history 
Review SSP Traceability Schema and add missing documentation
  • Loading branch information
@pmai
pmai authored Jan 20, 2024
2 parents 7d2fbdf + e361fc2 commit 2b742e9
Show file tree
Hide file tree
Showing 4 changed files with 602 additions and 229 deletions.
312 changes: 195 additions & 117 deletions DTMD.xsd
View file
Original file line number Diff line number Diff line change
@@ -1,120 +1,198 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" xmlns:dtmd="http://ssp-standard.org/SSPTraceability1/DecisionTaskMetaData" xmlns:stc="http://ssp-standard.org/SSPTraceability1/SSPTraceabilityCommon" xmlns:ssc="http://ssp-standard.org/SSP1/SystemStructureCommon" targetNamespace="http://ssp-standard.org/SSPTraceability1/DecisionTaskMetaData" elementFormDefault="qualified" vc:minVersion="1.1">
<xs:import namespace="http://ssp-standard.org/SSP1/SystemStructureCommon" schemaLocation="ssp-standard/schema/SystemStructureCommon.xsd"/>
<xs:import namespace="http://ssp-standard.org/SSPTraceability1/SSPTraceabilityCommon" schemaLocation="STC.xsd"/>
<xs:element name="DecisionTaskMetaData">
<xs:complexType>
<xs:sequence>
<xs:element name="GeneralInformation" minOccurs="0" type="stc:GeneralInformationType"/>
<xs:element name="AnalysisPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Analysis Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="AnalyzeEngineeringTask" type="stc:StepType" minOccurs="0"/>
<xs:element name="VerifyAnalysis" type="stc:StepType" minOccurs="0"/>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="DefinitionPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Definition Phase of the overall Decision Task,
where the individual sub-tasks to be performed are defined.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="DefineTasks" type="stc:StepType" minOccurs="0"/>
<xs:element name="DefineResultQuality" type="stc:StepType" minOccurs="0"/>
<xs:element name="VerifyTasks" type="stc:StepType" minOccurs="0"/>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="ExecutionPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Performance Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PerformTasks" type="stc:StepType" minOccurs="0"/>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="EvaluationPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Evaluation Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="EvaluateResults" type="stc:StepType" minOccurs="0"/>
<xs:element name="AssureResultQuality" type="stc:StepType" minOccurs="0"/>
<xs:element name="DeriveResultQualityVerdict" type="stc:StepType" minOccurs="0"/>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="FulfillmentPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Fulfillment Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="DecideEngineeringObjectiveFulfillment" type="stc:StepType" minOccurs="0"/>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:group ref="stc:GElementCommon"/>
</xs:sequence>
<xs:attribute name="version" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
Version of DTMD format, 1.0.0-beta2 for this pre-release.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:normalizedString">
<xs:pattern value="[0-9]+[.][0-9]+([.][0-9]+)?(-.*)?"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
This attribute gives the Decision Task a name, which can be used
for purposes of presenting the Decision Task to the user, e.g.
when selecting individual variant DTMDs from an SSP.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="ssc:ABaseElement"/>
<xs:attributeGroup ref="ssc:ATopLevelMetaData"/>
<xs:attribute name="GUID" use="required" type="xs:string">
<xs:annotation>
<xs:documentation xml:lang="en">
GUID identifier of this DTMD file. Must be globally unique and MUST
change, whenever a new file with differing information is written.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:import namespace="http://ssp-standard.org/SSP1/SystemStructureCommon" schemaLocation="ssp-standard/schema/SystemStructureCommon.xsd"/>
<xs:import namespace="http://ssp-standard.org/SSPTraceability1/SSPTraceabilityCommon" schemaLocation="STC.xsd"/>
<xs:element name="DecisionTaskMetaData">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the structure of the Credible Decision Process.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="GeneralInformation" type="stc:GeneralInformationType" minOccurs="0"/>
<xs:element name="AnalysisPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Analysis Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="AnalyzeEngineeringTask" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step the necessary information required for the execution of this
decision task is determined and provided from the overall product
development process.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VerifyAnalysis" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step the outputs and credibility documentation of the phase are
verified and the result is documented.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="DefinitionPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Definition Phase of the overall Decision Task,
where the individual sub-tasks to be performed are defined.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="DefineTasks" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step the development or test strategy is defined. This means
that a set of individual tasks is defined, from their individual
results an overall evaluation can be made.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DefineResultQuality" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step the expected result quality of the tasks to be performed
is defined.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="VerifyTasks" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step the outputs and credibility documentation of the phase are
verified and the result is documented.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="ExecutionPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Performance Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PerformTasks" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step all sub-tasks are performed and the output according to
the simulation objectives and confidence is provided.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="EvaluationPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Evaluation Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="EvaluateResults" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step an overall evaluation regarding the requirements from the
decision task is carried out based on the individual results.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AssureResultQuality" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step quality assurance for the decision task and result is
performed. Quality information about the according tasks is provided,
according to the criticality of the decision of the task.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DeriveResultQualityVerdict" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step an assessment of the quality of the decision task and
result is carried out.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:element name="FulfillmentPhase" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the Fulfillment Phase of the overall Decision Task.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="DecideEngineeringObjectiveFulfillment" type="stc:StepType" minOccurs="0">
<xs:annotation>
<xs:documentation xml:lang="en">
In this step the decision is made whether the requirements and
objectives of the engineering task have been fulfilled.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="stc:GPhaseCommon"/>
</xs:sequence>
<xs:attributeGroup ref="ssc:ABaseElement"/>
</xs:complexType>
</xs:element>
<xs:group ref="stc:GElementCommon"/>
</xs:sequence>
<xs:attribute name="version" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
Version of DTMD format, 1.0.0 for this release.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:normalizedString">
<xs:pattern value="[0-9]+[.][0-9]+([.][0-9]+)?(-.*)?"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
This attribute gives the Decision Task a name, which can be used
for purposes of presenting the Decision Task to the user, e.g.
when selecting individual variant DTMDs from an SSP.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="ssc:ABaseElement"/>
<xs:attributeGroup ref="ssc:ATopLevelMetaData"/>
<xs:attribute name="GUID" type="xs:string" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
GUID identifier of this DTMD file. Must be globally unique and MUST
change, whenever a new file with differing information is written.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>
24 changes: 14 additions & 10 deletions SRMD.xsd
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" elementFormDefault="qualified"
vc:minVersion="1.1"
xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" vc:minVersion="1.1"
xmlns:srmd="http://ssp-standard.org/SSPTraceability1/SimulationResourceMetaData"
xmlns:stc="http://ssp-standard.org/SSPTraceability1/SSPTraceabilityCommon"
xmlns:ssc="http://ssp-standard.org/SSP1/SystemStructureCommon"
targetNamespace="http://ssp-standard.org/SSPTraceability1/SimulationResourceMetaData">

targetNamespace="http://ssp-standard.org/SSPTraceability1/SimulationResourceMetaData"
elementFormDefault="qualified">

<xs:import namespace="http://ssp-standard.org/SSP1/SystemStructureCommon" schemaLocation="ssp-standard/schema/SystemStructureCommon.xsd"/>
<xs:import namespace="http://ssp-standard.org/SSPTraceability1/SSPTraceabilityCommon" schemaLocation="STC.xsd"/>

<xs:element name="SimulationResourceMetaData">
<xs:annotation>
<xs:documentation xml:lang="en">
This element specifies the structure of a Simulation Resource Meta Data file.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:group ref="stc:GElementCommon"></xs:group>
<xs:group ref="stc:GElementCommon"/>
<xs:attribute name="version" use="required">
<xs:annotation>
<xs:documentation xml:lang="en">
Version of SRMD format, 1.0.0-beta2 for this pre-release.
Version of SRMD format, 1.0.0 for this release.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
Expand Down Expand Up @@ -66,10 +71,9 @@
</xs:documentation>
</xs:annotation>
</xs:attribute>

<xs:attributeGroup ref="ssc:ABaseElement"/>
<xs:attributeGroup ref="ssc:ATopLevelMetaData"/>
<xs:attributeGroup ref="ssc:ATopLevelMetaData"/>
</xs:complexType>
</xs:element>
</xs:schema>

Loading

0 comments on commit 2b742e9

Please sign in to comment.