You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The SSP Traceability Specification is a free specification intended as a third-party layered standard upon SSP 2.0 to support traceability of simulation tasks.
2
-
This is a development version of the specification.
1
+
Document version: 1.0-rc.1
2
+
3
+
July 14, 2025
4
+
5
+
This document is the first release candidate of release 1.0 of the SSP Layered Standard Traceability (SSP-LS-Traceability).
6
+
7
+
This specification, as well as supporting XML schema files, is provided on the SSP site (https://ssp-standard.org/).
3
8
https://github.com/modelica/ssp-ls-traceability/releases[Releases] and https://github.com/modelica/ssp-ls-traceability/issues[issues] can be found on https://github.com/modelica/ssp-ls-traceability[github.com/modelica/ssp-ls-traceability].
Article (3a) of this license requires that modifications of this work must clearly label, demarcate or otherwise identify that changes were made.
61
+
62
+
The XML schema files that accompany this document are available under the BSD 2-Clause license (https://opensource.org/license/bsd-2-clause/).
63
+
64
+
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights.
65
+
Modelica Association shall not be held responsible for identifying such patent rights.
66
+
67
+
If you have improvement suggestions, please send them to the SSP development group at [email protected].
68
+
____
69
+
70
+
<<<
71
+
72
+
*Abstract*
73
+
74
+
The SSP Layered Standard Traceability is a layered standard provided by MAP SSP upon SSP 2.0 to support traceability of simulation tasks.
75
+
The standard is comprised of a set of XML-based formats to interchange process-relevant resources and information in the sense of process metadata for Credible Decision Processes and Credible Simulation Processes, as well as arbitrary further metadata as part of SSP packages used to exchange the structural and parametrization aspects of a system.
76
+
77
+
<<<
7
78
8
-
////
9
-
Copyright notice and license information will go here.
10
-
////
79
+
*Conventions used in this Document*
11
80
12
-
{empty}
81
+
* The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in RFC 2119 [RFC2119].
82
+
* Non-normative text is given in square brackets in italic font: [ _especially examples are defined in this style._ ].
Copy file name to clipboardExpand all lines: specification/1___introduction.adoc
+8-18Lines changed: 8 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,23 +9,23 @@ It is therefore important that design decisions are based on reliable informatio
9
9
In order to make design decisions based on credible simulation results, it is essential that underlying simulation tasks are planned, executed and documented in a transparent and comprehensible manner and that there is a high degree of confidence in the correctness and validity of simulation results.
10
10
This is essential not only to make reliable design decisions (__quality assurance__), but also to be able to understand design decisions retrospectively (__traceability__).
11
11
12
-
Improving traceability of decisions and simulations is the core objective of the SSP Traceability specification, based on consistent and compatible documentation of decision processes and simulation process that produces the decision-relevant simulation results.
13
-
Other goals of the SSP Traceability specification are to provide the ability to re-run a simulation later and to provide the ability to re-use parts of the simulation setup for similar simulations (__reusability__).
12
+
Improving traceability of decisions and simulations is the core objective of the SSP Layered Standard Traceability, based on consistent and compatible documentation of decision processes and simulation process that produces the decision-relevant simulation results.
13
+
Other goals of the SSP Layered Standard Traceability are to provide the ability to re-run a simulation later and to provide the ability to re-use parts of the simulation setup for similar simulations (__reusability__).
14
14
15
15
=== Credible Simulation Process Framework
16
16
17
-
The SSP Traceability Specification applies in a __Credible Simulation Process Framework__ as procedural framework, which consists of a __Credible Decision Process__ and a __Credible Simulation Process__, coupled by a __Simulation Request__ and a __Simulation Delivery.__
17
+
The SSP Layered Standard Traceability applies in a __Credible Simulation Process Framework__ as procedural framework, which consists of a __Credible Decision Process__ and a __Credible Simulation Process__, coupled by a __Simulation Request__ and a __Simulation Delivery.__
18
18
19
-
As the traceability of decision and simulation processes improve by applying the SSP Traceability Specification, it is expected that the reliability and credibility of simulation results will increase.
19
+
As the traceability of decision and simulation processes improve by applying the SSP Layered Standard Traceability, it is expected that the reliability and credibility of simulation results will increase.
20
20
This is expected not only when decisions and simulations are performed within a company, but also when the Credible Simulation Process Framework is spread across companies and when simulation results are requested, exchanged and shared across companies.
21
21
Since the commissioning, preparation and execution of a simulation in that case are usually carried out by different persons or departments, sometimes even by different companies, a common understanding of the simulation task and the objectives of the simulation is essential for the quality and credibility of simulation results.
22
22
Traceable documentation of simulation requests and simulation deliveries is therefore just as important as traceable documentation of the decision processes and simulation processes themselves.
23
23
24
24
=== Applying SSP Traceability
25
25
26
-
The SSP Traceability Specification defines and describes a concept for assuring traceability for the processes of the Credible Simulation Process Framework.
27
-
The specification proposes to document Credible Decision Processes and Credible Simulation Processes by binding __(gluing)__ together all process-relevant resources and information in the sense of process metadata by means of appropriate SSP Traceability files for Credible Decision Processes and Credible Simulation Processes.
28
-
The essential core of the SSP Traceability Specification document is the documentation of the appropriate set of SSP Traceability file data formats.
26
+
The SSP Layered Standard Traceability defines and describes a concept for assuring traceability for the processes of the Credible Simulation Process Framework.
27
+
The standard proposes to document Credible Decision Processes and Credible Simulation Processes by binding __(gluing)__ together all process-relevant resources and information in the sense of process metadata by means of appropriate SSP Traceability files for Credible Decision Processes and Credible Simulation Processes.
28
+
The essential core of the SSP Layered Standard Traceability document is the documentation of the appropriate set of SSP Traceability file data formats.
29
29
30
30
=== Document structure
31
31
@@ -35,17 +35,7 @@ The detail description of the SSP Traceability data formats is subject of <<sec-
35
35
<<sec-dtmd>> describes how the SSP Traceability data format for documenting Credible Decision Processes are structured and <<sec-stmd>> describes the structure of SSP Traceability data formats for the documentation of Credible Simulation Processes.
36
36
<<sec-srmd>> additionally describes a data format for documenting metadata of individual resources in the sense of SSP Traceability.
37
37
<<sec-ssptraceabilitypackaging>> describes how SSP Traceability files can be bundled into an SSP Traceability package.
38
-
The SSP traceability specification concludes with a list of other applicable documents such as relevant standards and referenced literature.
38
+
The SSP Layered Standard Traceability concludes with a list of other applicable documents such as relevant standards and referenced literature.
39
39
40
40
CAUTION: High-quality documentation of simulation tasks using the SSP traceability mechanisms can only reflect the quality and consistency of the simulation task actually performed to the maximum.
41
41
However, the quality of the documentation does not guarantee the quality of the performed process.
42
-
43
-
=== Conventions used in this document
44
-
45
-
* The version number of this specification is to be interpreted according to the _Semantic Versioning Specification (SemVer) 2.0.0_ <<SEMVER200>>.
46
-
47
-
* Non-normative text is given in square brackets in italic font: _[Especially examples are defined in this style.]_
48
-
49
-
* The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *NOT RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in _RFC 2119_ <<RFC2119>>.
50
-
51
-
* All name spaces and reverse domain notation domain names used in this draft version of this document are subject to change once the draft is finalized.
Copy file name to clipboardExpand all lines: specification/2___framework.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ This information transfer is referred to as __Simulation Delivery__ in <<im-cred
16
16
For more information on the processes of the Credible Simulation Process Framework, see Appendix Part H of the prostep ivip SmartSE Recommendation v3 (<<CSP>>).
17
17
18
18
__Note: The Credible Simulation Process Framework actually includes more than just Credible Decision Process and Credible Simulation Process.
19
-
However, the SSP Traceability specification currently only supports traceability with respect to the Credible Decision Process and the Credible Simulation Process.__
19
+
However, the SSP Layered Standard Traceability currently only supports traceability with respect to the Credible Decision Process and the Credible Simulation Process.__
Copy file name to clipboardExpand all lines: specification/3___overview.adoc
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
[#sec-overviewofssptraceability]
2
2
== Overview of SSP Traceability
3
3
4
-
As improving traceability of design decisions and simulations is one the core objectives of the SSP Traceability specification, a consistent and compatible documentation of decision processes and the simulation processes that produce decision-relevant simulation results is essential.
4
+
As improving traceability of design decisions and simulations is one the core objectives of the SSP Layered Standard Traceability, a consistent and compatible documentation of decision processes and the simulation processes that produce decision-relevant simulation results is essential.
5
5
6
6
[#sec-glueparticle]
7
7
=== GlueParticle Approach
8
8
9
-
To enable the documentation of process-relevant information and resources for a Credible Decision Process or a Credible Simulation Process the SSP Traceability Specification introduces the GlueParticle Approach:
9
+
To enable the documentation of process-relevant information and resources for a Credible Decision Process or a Credible Simulation Process the SSP Layered Standard Traceability introduces the GlueParticle Approach:
10
10
11
11
* The **GlueParticle Approach** is a concept for bundling and file-based transfer of process-relevant information and resources of a Credible Decision Process or a Credible Simulation Process.
12
12
@@ -17,20 +17,20 @@ The form in which this bundle exists, e.g. whether it is stored as a file or in
17
17
18
18
* File-based resources linked by a GlueParticle file should be exchanged with the GlueParticle file itself to **take full advantage** of the GlueParticle transfer.
19
19
20
-
NOTE: Although the idea of the GlueParticle approach does not depend on a specific data format or representation in general, the SSP Traceability Specification defines a set of data formats for the file-based representation of a GlueParticle content, i.e. process-relevant information and resources.
20
+
NOTE: Although the idea of the GlueParticle approach does not depend on a specific data format or representation in general, the SSP Layered Standard Traceability defines a set of data formats for the file-based representation of a GlueParticle content, i.e. process-relevant information and resources.
21
21
The reason for this is firstly that the Modelica Association uses XML as a general encoding format for the representation of standards specific data and secondly that SSP Traceability uses System Structure and Parameterization (SSP) Standard 2.0 resources and concepts that are also encoded in XML.
22
22
Independently of this, SSP Traceability files in general and GlueParticle files in particular could use any other applicable data encoding format, e.g. JSON etc.
23
23
24
-
The SSP Traceability specification specifies a set of data formats that can be used to document or link process-relevant information and resources for a Credible Decision Process and a Credible Simulation Process introduced in <<sec-crediblesimulationprocessframework>>.
24
+
The SSP Layered Standard Traceability specifies a set of data formats that can be used to document or link process-relevant information and resources for a Credible Decision Process and a Credible Simulation Process introduced in <<sec-crediblesimulationprocessframework>>.
25
25
The data formats are specified as a set of XML Schema files according to the W3C (https://www.w3.org/) XML Schema standard <<XMLSCHEMA1.1>>.
26
26
27
-
The main data formats specified by this specification are:
27
+
The main data formats specified by this standard are:
28
28
29
29
D**ecision **T**ask **M**eta **D**ata **(DTMD):: XML format representing process-relevant information to the Credible Decision Process (see <<sec-dtmdintroduction>> for an introduction and <<sec-dtmd>> for the detailed specification).
30
30
31
31
S**imulation **T**ask **M**eta **D**ata **(STMD):: XML format representing process-relevant information to the Credible Simulation Process (see <<sec-stmdintroduction>> for an introduction and <<sec-stmd>> for the detailed specification).
32
32
33
-
A third XML format defined by the SSP Traceability specification is:
33
+
A third XML format defined by the SSP Layered Standard Traceability is:
34
34
35
35
S**imulation **R**esource **M**eta **D**ata **(SRMD):: XML format representing metadata for resources (see <<sec-srmdintroduction>> for an introduction and <<sec-srmd>> for the detailed specification).
36
36
@@ -106,7 +106,7 @@ image::STMDBriefSchema.png[]
106
106
[#sec-srmdintroduction]
107
107
=== Simulation Resource Meta Data
108
108
109
-
<<im-srmdbriefschema>> shows the top-level structure of the SRMD XML Schema, which is the structural definition for Simulation Resouce Meta Data files.
109
+
<<im-srmdbriefschema>> shows the top-level structure of the SRMD XML Schema, which is the structural definition for Simulation Resource Meta Data files.
110
110
SRMD files are used to define essential metadata for resources that can help users quickly understand the content and intent of a simulation resource through human-readable attributes without having to examine the resource in detail.
111
111
For example, this support can reduce the effort required to analyze a set of resources received with a simulation request and simplify the selection of appropriate resources from a resource library.
0 commit comments