4___STMD.adoc

Simulation Task Meta Data File Format

The Simulation Task Meta Data file (short: STMD file) is an implementation of a Glue Particle for simulation tasks. It is specified to support traceability, quality assurance and re-usability for simulation tasks in terms of a credible simulation process as it is specified in Document Reference. The following subchapters describe the structure of an STMD file.

SimulationTaskMetaData

The SimulationTaskMetaData element is the all enclosing top level XML element of STMD files.

Figure 1. SimulationTaskMetaData element structure and attributes

The SimulationTaskMetaData element is structured by following subordinated element.

Table 1. SimulationTaskMetaData element structure

Sub element name	Optional / Mandatory
GeneralInformation	Optional
AnalysisPhase	Optional
RequirementsPhase	Optional
DesignPhase	Optional
ImplementationPhase	Optional
ExecutionPhase	Optional
EvaluationPhase	Optional
FulfillmentPhase	Optional
GElementCommon

The SimulationTaskMetaData element is associated with the following attributes.

Table 2. SimulationTaskMetaData element attributes

Attribute name	Optional / Mandatory	Atrribute description
version	Mandatory	Version of STMD format, 0.x for this pre-release.
name	Mandatory	This attribute gives the simulation task a name, which can be used for purposes of presenting the simulation task to the user, e.g. when selecting individual variant STMDs from an SSP.
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.
author	Optional	This attribute gives the name of the author of this file’s content.
fileversion	Optional	This attribute gives a version number for this file’s content.
copyright	Optional	This attribute gives copyright information for this file’s content.
license	Optional	This attribute gives license information for this file’s content.
generatingTool	Optional	This attribute gives the name of the tool that generated this file.
generationDateAndTime	Optional	This attribute gives the date and time this file was generated.
GUID	Mandatory	GUID identifier of this STMD file. Must be globally unique and MUST change, whenever a new file with differing information is written.

GeneralInformation

The GeneralInformation element is used to encapsulate general information about the simulation task, which is not part of any specific phase or step.

For the details of the GeneralInformation element structure and attributes see chapter [sec-generalinformationtype].

AnalysisPhase

In the analysis phase, the simulation-relevant information is taken from the higher-level commissioning engineering process and the essential simulation relevant requirements and goals of the simulation task are derived from it. It is important that at the end of the analysis phase the essential simulation requirements and the objectives of the simulation task fully and clearly understood.

The AnalysisPhase element documents all relevant information.

Figure 2. AnalysisPhase element structure and attributes

The AnalysisPhase element is structured by the following subordinated element.

Table 3. AnalysisPhase element structure

Sub element name	Optional / Mandatory
AnalyzeSimulationTaskAndObjectives	Optional
VerifyAnalysis	Optional
GPhaseCommon	Mandatory

The AnalysisPhase element is associated with the following attributes.

Table 4. AnalysisPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

AnalyzeSimulationTaskAndObjectives

For the details of the AnalyzeSimulationTaskAndObjectives element structure and attributes see chapter [sec-steptype]

VerifyAnalysis

For the details of the VerifyAnalysis element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

RequirementsPhase

In the requirements phase, the requirements for the simulation that were agreed and defined in the analysis phase are broken down to the individual components required for the simulation. This includes the requirements for the models, parameters, test cases and the simulation environment, but also for the integration of all components and for measures to assure the process quality. In addition, all requirements must be finally verified to ensure the integrity and consistency of the requirements.

The RequirementsPhase element documents all relevant information.

Figure 3. RequirementsPhase element structure and attributes

The RequirememtsPhase element is structured by the followuing subordinated element.

Table 5. RequirementsPhase element structure

Sub element name	Optional / Mandatory
DefineModelRequirements	Optional
DefineParameterRequirements	Optional
DefineSimulationEnvironmentRequirements	Optional
DefineSimulationIntegrationRequirements	Optional
DefineTestCaseRequirements	Optional
DefineQualityAssuranceRequirements	Optional
VerifyRequirements	Optional
GPhaseCommon	Mandatory

The RequirementsPhase element is associated with the following attributes.

Table 6. RequirementsPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

DefineModelRequirements

For the details of the DefineModelRequirements element structure and attributes see chapter [sec-steptype]

DefineParameterRequirements

For the details of the DefineParameterRequirements element structure and attributes see chapter [sec-steptype]

DefineSimulationEnvironmentRequirements

For the details of the DefineSimulationEnvironmentRequirements element structure and attributes see chapter [sec-steptype]

DefineSimulationIntegrationRequirements

For the details of the DefineSimulationIntegrationRequirements element structure and attributes see chapter [sec-steptype]

DefineTestCaseRequirements

For the details of the DefineTestCaseRequirements element structure and attributes see chapter [sec-steptype]

DefineQualityAsuranceRequirements

For the details of the DefineQualityAssuranceRequirements element structure and attributes see chapter [sec-steptype]

VerifyRequirements

For the details of the VerifyRequirements element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

DesignPhase

In the design phase, based on the requirements for the individual components of the simulation defined in the requirements phase, the required components of the simulation are specified, i.e. the models, parameters, test cases and the simulation environment, but also the necessary measures for integrating all components and for assuring the process quality. In addition, all specifications must be finally verified to ensure the integrity and consistency of the specifications.

The DesignPhase element documents all relevant information.

Figure 4. DesignPhase element structure and attributes

The DesignPhase element is structured by the following subordinated element.

Table 7. DesignPhase element structure

Sub element name	Optional / Mandatory
DefineModelDesignSpecification	Optional
DefineParaneterDesignSpecification	Optional
DefineSimulationEnvironmentDesignSpecification	Optional
DefineSimulationIntegrationDesignSpecification	Optional
DefineTestCaseDesignSpecification	Optional
DefineQualityAssuranceDesignSpecification	Optional
VerifyDesignSpecification	Optional
GPhaseCommon	Mandatory

The DesignPhase element is associated with the following attributes.

Table 8. DesignPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

DefineModelDesignSpecification

For the details of the DefineModelDesignSpecification element structure and attributes see chapter [sec-steptype]

DefineParaneterDesignSpecification

For the details of the DefineParaneterDesignSpecification element structure and attributes see chapter [sec-steptype]

DefineSimulationEnvironmentDesignSpecification

For the details of the DefineSimulationEnvironmentDesignSpecification element structure and attributes see chapter [sec-steptype]

DefineSimulationIntegrationDesignSpecification

For the details of the DefineSimulationIntegrationDesignSpecification element structure and attributes see chapter [sec-steptype]

DefineTestCaseDesignSpecification

For the details of the DefineTestCaseDesignSpecification element structure and attributes see chapter [sec-steptype]

DefineQualityAssuranceDesignSpecification

For the details of DefineQualityAssuranceDesignSpecification element structure and attributes see chapter [sec-steptype]

VerifyDesignSpecification

For the details of the VerifyDesignSpecification element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

ImplementationPhase

In the implementation phase, all specified components of the simulation are implemented, i.e. the models, parameters, test cases and the simulation environment is set up. All components are then integrated and the specified measures to ensure process quality are implemented. In addition, it must be determined by a quality verdict that the entire setup of the simulation meets all technical and quality requirements.

The ImplementationPhase element documents all relevant information.

Figure 5. ImplementationPhase element structure and attributes

The ImplementationPhase element is structured by the following subordinated element.

Table 9. ImplementationPhase element structure

Sub element name	Optional / Mandatory
ImplementModel	Optional
ImplementParameter	Optional
ImplementSimulationEnvironment	Optional
ImplementTestCase	Optional
IntegrateSimulation	Optional
AssureSimulationSetupQuality	Optional
DeriveSimulationSetupQualityVerdict	Optional
GPhaseCommon	Mandatory

The ImplementationPhase element is associated with the following attributes.

Table 10. ImplementationPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

ImplementModel

For the details of the ImplementModel element structure and attributes see chapter [sec-steptype]

ImplementParameter

For the details of the ImplementParameter element structure and attributes see chapter [sec-steptype]

ImplementSimulationEnvironment

For the details of the ImplementSimulationEnvironment element structure and attributes see chapter [sec-steptype]

ImplementTestCase

For the details of the ImplementTestCase element structure and attributes see chapter [sec-steptype]

IntegrateSimulation

For the details of the IntegrateSimulation element structure and attributes see chapter [sec-steptype]

AssureSimulationSetupQuality

For the details of the AssureSimulationSetupQuality element structure and attributes see chapter [sec-steptype]

DeriveSimulationSetupQualityVerdict

For the details of the DeriveSimulationSetupQualityVerdict element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

ExecutionPhase

In the execution phase, the previously set up simulation is executed.

The ImplementationPhase element documents all relevant information.

Figure 6. ExecutionPhase element structure and attributes

The ExecutionPhase element is structured by the followeing subordinated element.

Table 11. ExecutionPhase element structure

Sub element name	Optional / Mandatory
ExecuteSimulation	Optional
GPhaseCommon	Mandatory

The ExecutionPhase element is associated with the following attributes.

Table 12. ExecutionPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

ExecuteSimulation

For the details of the ExecuteSimulation element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

EvaluationPhase

In the evaluation phase, the simulation results are evaluated and quality assurance measures are implemented. In addition, it must be determined by a quality verdict that the simulation meets all technical and quality requirements.

The EvaluationPhase element documents all relevant information.

Figure 7. EvaluationPhase element structure and attributes

The EvaluationPhase element is structured by the following subordinated element.

Table 13. EvaluationPhase element structure

Sub element name	Optional / Mandatory
EvaluateSimulationResults	Optional
AssureSimulationQuality	Optional
DeriveSimulationQualityVerdict	Optional
GPhaseCommon	Mandatory

The EvaluationPhase element is associated with the following attributes.

Table 14. EvaluationPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

EvaluateSimulationResults

For the details of the EvaluateSimulationResults element structure and attributes see chapter [sec-steptype]

AssureSimulationQuality

For the details of the AssureSimulationQuality element structure and attributes see chapter [sec-steptype]

DeriveSimulationQualityVerdict

For the details of the DeriveSimulationQualityVerdict element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

FulfillmentPhase

In the fulfillment phase, it is checked and decided whether the entire simulation task, including the simulation results, fulfills the requirements placed on the simulation by the commissioning higher-level engineering task and whether the simulation tasks can be completed.

The FulfillmentPhasePhase element documents all relevant information.

Figure 8. FulfillmentPhase elements structure and attributes

The FulfillmentPhase element is structured by the following subordinated element.

Table 15. FulfillmentPhase element structure

Sub element name	Optional / Mandatory
DecideSimuzlationObjectiveFulfillment	Optional
GPhaseCommon	Mandatory

The FulfillmentPhase element is associated with the following attributes.

Table 16. FulfillmentPhase element attributes

Attribute name	Optional / Mandatory	Atrribute description
id	Optional	This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.
description	Optional	This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

DecideObjectiveFulfillment

For the details of the DecideObjectiveFulfillment element structure and attributes see chapter [sec-steptype]

GPhaseCommon

For the details of the GPhaseCommon element structure and attributes see chapter [sec-gphasecommon]

GElementCommon

For the details of the GElementCommon element structure and attributes see chapter [sec-gelementcommon]