Skip to content

Commit

Permalink
Annex Overview Constraints and final editorial fixes (#510)
Browse files Browse the repository at this point in the history
* remove zip file, was not added on purpose

* fix #333 recursion depth max 32

* fix #333 recursion depth continues
fix #388 UML Cardinality

* fix #396 continued

* matching strategy references

* fix figure ContainerElement in SubmodelElement Overview

* check to mention all issues closed in v3.1

* minor editorial changes
fix chapter structure in mapping

* fix #509 Annex Overview Constraints
  • Loading branch information
BirgitBoss authored Dec 15, 2024
1 parent 2dfc645 commit 0d19c9b
Show file tree
Hide file tree
Showing 14 changed files with 91 additions and 47 deletions.
5 changes: 4 additions & 1 deletion documentation/IDTA-01001/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ SPDX-License-Identifier: CC-BY-4.0
* xref:general.adoc[General]
// BEGIN Metamodel

* xref:spec-metamodel/index.adoc[Specification (normative)]
Expand All @@ -58,7 +59,7 @@ SPDX-License-Identifier: CC-BY-4.0
** xref:spec-metamodel/constraints.adoc[Constraints]
// END Designators
// END Metamodel
* xref:data-specifications.adoc[Data Specifications]
Expand All @@ -84,6 +85,8 @@ SPDX-License-Identifier: CC-BY-4.0
** xref:./annex/handling-constraints.adoc[Handling Constraints]
** xref:./annex/overview-constraints.adoc[Overview Constraints]
** xref:./annex/usage-metamodel.adoc[Usage Metamodel]
** xref:./annex/metamodel-with-inheritance.adoc[Metamodel With Inheritance]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Illustrations:
Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
////


[[annex-handling-of-constraints]]
= Handling of Constraints

Constraints are prefixed with *AASd-* followed by a three-digit number.
Expand Down
24 changes: 0 additions & 24 deletions documentation/IDTA-01001/modules/ROOT/pages/annex/nav_annex.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,3 @@ SPDX-License-Identifier: CC-BY-4.0

////

////
:page-partial:
[appendix]

* xref:Annex/ConceptsAAS.adoc[Concepts AAS]
* xref:Annex/Requirements.adoc[Requirements]
* xref:Annex/ValueOnlySerializationExample.adoc[Value Only Serialization Example]
* xref:Annex/BackusNaurForm.adoc[Backus Naur Form]
* xref:Annex/UMLTemplates.adoc[UML Templates]
* xref:Annex/UML.adoc[UML]
* xref:Annex/HandlingConstraints.adoc[Handling Constraints]
* xref:Annex/UsageMetamodel.adoc[Usage Metamodel]
* xref:Annex/MetamodelWithInheritance.adoc[Metamodel with Inheritance]
* xref:Annex/ChangeLog.adoc[Change Log]
* xref:Annex/bibliography.adoc[Bibliography]
////
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
////
Copyright (c) 2023 Industrial Digital Twin Association

This work is licensed under a [Creative Commons Attribution 4.0 International License](
https://creativecommons.org/licenses/by/4.0/).

SPDX-License-Identifier: CC-BY-4.0

Illustrations:
Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
////


[appendix]
= Overview Constraints (non-normative)

This annex gives an overview of the constraints contained in this document. No additional comments are added, for details please refer to the normative parts of the specification.

For handling of constraints see xref:annex/handling-constraints.adoc[].

{aasd002}
{aasd005}
{aasd006}
{aasd007}
{aasd012}
{aasd014}
{aasd020}
{aasd021}
{aasd022}
{aasd077}
{aasd080}
{aasd081}
{aasd090}
{aasd107}
{aasd108}
{aasd109}
{aasd114}
{aasd115}
{aasd116}
{aasd117}
{aasd118}
{aasd119}
{aasd121}
{aasd122}
{aasd123}
{aasd124}
{aasd125}
{aasd126}
{aasd127}
{aasd128}
{aasd129}
{aasd130}
{aasd131}
{aasd133}
{aasd134}
8 changes: 6 additions & 2 deletions documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,30 @@ https://github.com/admin-shell-io/aas-specs/issues/471[#471],
** update examples to provide Value-Only serialization for every submodel element (not in the context of a Submodel as before)
** add clause for Submodel Example (with properties from SMT Technical Data, not Families any longer)
* update Schema for JSON-Value Serialization (https://github.com/admin-shell-io/aas-specs/issues/389[#389])
* remove recommendation to use external references for semanticId (https://github.com/admin-shell-io/aas-specs/issues/376[#376]) and related attributes like valueId and isCaseOf (https://github.com/admin-shell-io/aas-specs/issues/396[#396], https://github.com/admin-shell-io/aas-specs/issues/396[#396])
* remove recommendation to use external references for semanticId (https://github.com/admin-shell-io/aas-specs/issues/376[#376]) and related attributes like valueId, semanticIdListElement and isCaseOf (https://github.com/admin-shell-io/aas-specs/issues/396[#396], https://github.com/admin-shell-io/aas-specs/issues/396[#396])
* add note: A maximum recursion depth of 32 for Container-Elements should be supported.
This means for certification a maximum of 32 recursion test cases should be tested. (https://github.com/admin-shell-io/aas-specs/issues/333[#333])
* remove clauses on OPC UA and AutomationML mappings (https://github.com/admin-shell-io/aas-specs/issues/373[#373], https://github.com/admin-shell-io/aas-specs/issues/397[#397])
* update explanatory text and notes in the context of AdministrativeInformation (https://github.com/admin-shell-io/aas-specs/issues/331[#331])
* Transfer from .docx to asciidoc (.adoc) and maintenance in GitHub (including (https://github.com/admin-shell-io/aas-specs/issues/318[#318], https://github.com/admin-shell-io/aas-specs/issues/316[#316] )
* Transfer of all UML figures to PlantUML (.puml) and maintenance in GitHub, no XMI presenation part of release any longer (https://github.com/admin-shell-io/aas-specs/issues/439[#439])
* Transfer of all UML figures to PlantUML (.puml), changed notation for model references; maintenance in GitHub, no XMI presenation part of release any longer (https://github.com/admin-shell-io/aas-specs/issues/439[#439])

Editorial Bugfixes:

* Replace xs:dateType with xs:dateTime (https://github.com/admin-shell-io/aas-specs/issues/467[#467])
* Correct Example for Reference (https://github.com/admin-shell-io/aas-specs/issues/481[#481])
* improve UML Template description with respect to cardinality (https://github.com/admin-shell-io/aas-specs/issues/388[#388])


Minor Changes:

* update Constraint AASd-116 (https://github.com/admin-shell-io/aas-specs/issues/298[#298])
* remove information on OPC UA mapping (https://github.com/admin-shell-io/aas-specs/issues/373[#373])
* remove information on AutomationML mapping (https://github.com/admin-shell-io/aas-specs/issues/397[#397])
* update bibliography (newer versions, link update, removal of entries not referenced)
* consistent usage of idShortPath and IRDI-Path (https://github.com/admin-shell-io/aas-specs/issues/385[#385])
* add example for deprecated attribute in class in Annex UML
* enhanced explantion for AASd-130
* editorial changes (including https://github.com/admin-shell-io/aas-specs/issues/345[#345],
https://github.com/admin-shell-io/aas-specs/issues/361[#361],
https://github.com/admin-shell-io/aas-specs/issues/385[#385])
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ The JSON properties of the environment correspond to these three aggregations.

To simplify exploration of the JSON data, identifiable instances are only available at the level of the environment, and nowhere else.

=== Mapping Rules
[[json-mapping-rules]]
=== JSON Mapping Rules

==== Classes to JSON definitions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Note 1: the RDF scheme/OWL files (.ttl files) are maintained in the repository "
Note 2: example files can be found n the repository "aas-specs" of the GitHub project admin-shell-io xref:bibliography.adoc#bib51[[51\]] in folder {rdf-examples}[/schemas/rdf/examples]
====


[[rdf-mapping-rules]]
=== RDF Mapping Rules

The concepts of the RDF and the derived RDF serialization of the AAS are explained by the mapping rules.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ To simplify exploration of the XML data, identifiable instances are only availab

We now continue to see how to serialize the instances and their properties.

=== Mapping Rules
[[xml-mapping-rules]]
=== XML Mapping Rules

Building blocks of an XML document include only
https://www.w3schools.com/xml/xml_elements.asp[XML elements],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Asset Administration Shell supports three widely used formats:
* RDF

====
Note: the mapping specifications and schemata for XML, JSON and RDF are part of {git-repo}.
Note: the schemata for XML, JSON and RDF are part of {git-repo}.
====

== Content Format Types
Expand Down Expand Up @@ -66,17 +66,17 @@ Only the reference to the found element is returned; potential child elements ar

Blobs require the following encoding: base64 string.

include::encodings/grammar-serialization-reference.adoc[]
include::encodings/grammar-serialization-reference.adoc[leveloffset=+1]

include::encodings/embedded-data-specifications.adoc[]
include::encodings/embedded-data-specifications.adoc[leveloffset=+1]

include::encodings/metadata-objects.adoc[]
include::encodings/metadata-objects.adoc[leveloffset=+1]

include::encodings/valueonly.adoc[]
include::encodings/valueonly.adoc[leveloffset=+1]

include::encodings/valueonly-json-schema.adoc[]

include::encodings/idshortpath.adoc[]
include::encodings/idshortpath.adoc[leveloffset=+1]

== Format "Reference"

Expand Down
2 changes: 1 addition & 1 deletion documentation/IDTA-01001/modules/ROOT/pages/preamble.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ To create a detailed specification of the Administration Shell according to the
As many ideas as possible from the discussion papers were considered.
See Annex xref:annex/concepts-aas.adoc[] for more information.

The partners represented in the Plattform Industrie 4.0 and the Industrial Digital Twin Association (IDTA) and associations such as ZVEI, VDMA, VDI/ VDE and Bitkom, ensure that there is broad sectoral coverage of process, hybrid, and factory automation and in terms of integrating information technology (IT) and operational technology (OT).
The partners represented in the link:https://github.com/admin-shell-io/aas-specs-iec61360/issues/43[Plattform Industrie 4.0] and the link:https://industrialdigitaltwin.org/[Industrial Digital Twin Association (IDTA)] and associations such as link:https://www.zvei.org/[ZVEI], link:https://www.vdma.org[VDMA], link:https://www.vdi.de/en/home[VDI]/link:https://www.vde.com/en[VDE] and link:https://www.bitkom.org/EN[Bitkom], ensure that there is broad sectoral coverage of process, hybrid, and factory automation and in terms of integrating information technology (IT) and operational technology (OT).

Design alternatives were intensively discussed within the working group.
An extensive feedback process of this document series is additionally performed within the working groups of Plattform Industrie 4.0 and IDTA.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -584,9 +584,12 @@ Examples: a submodel is the name space for the properties directly contained in
|===
h|Class: 3+e|[[Referable]]Referable \<<abstract>>
h|Explanation: 3+a|
Note1 : an element that is referable by its idShort.
This ID is not globally unique.
Element that is referable by its idShort.

====
Note 1: this ID is not globally unique.
This ID is unique within the name space of the element.
====


====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1025,7 +1025,7 @@ a|Submodel
{empty} +

[#constraints]
== Constraints
== Constraints for References

{aasd121}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -918,9 +918,7 @@ a|
Semantic ID which the submodel elements contained in the list match


====
Note: it is recommended to use an external reference.
====



|xref:spec-metamodel/referencing.adoc#Reference[Reference] |0..1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ abstract class SubmodelElement {

!include https://raw.githubusercontent.com/admin-shell-io/aas-specs/IDTA-01001-3-1_working/documentation/IDTA-01001/modules/ROOT/partials/diagrams/classes/relationship-element.puml
!include https://raw.githubusercontent.com/admin-shell-io/aas-specs/IDTA-01001-3-1_working/documentation/IDTA-01001/modules/ROOT/partials/diagrams/classes/annotated-relationship-element.puml
!include https://raw.githubusercontent.com/admin-shell-io/aas-specs/IDTA-01001-3-1_working/documentation/IDTA-01001/modules/ROOT/partials/diagrams/classes/container-element.puml
!include https://raw.githubusercontent.com/admin-shell-io/aas-specs/IDTA-01001-3-1_working/documentation/IDTA-01001/modules/ROOT/partials/diagrams/classes/data-element.puml
!include https://raw.githubusercontent.com/admin-shell-io/aas-specs/IDTA-01001-3-1_working/documentation/IDTA-01001/modules/ROOT/partials/diagrams/classes/property.puml
!include https://raw.githubusercontent.com/admin-shell-io/aas-specs/IDTA-01001-3-1_working/documentation/IDTA-01001/modules/ROOT/partials/diagrams/classes/multi-language-property.puml
Expand Down Expand Up @@ -50,14 +51,16 @@ EventElement <|-- BasicEventElement
Operation ..> OperationVariable
OperationVariable ..> SubmodelElement
RelationshipElement <|-- AnnotatedRelationshipElement
ContainerElement <|-- AnnotatedRelationshipElement
SubmodelElement <|-- Capability
SubmodelElement <|-- DataElement
SubmodelElement <|--- Entity
ContainerElement <|--- Entity
SubmodelElement <|--- EventElement
SubmodelElement <|-- Operation
SubmodelElement <|--- RelationshipElement
SubmodelElement <|-- SubmodelElementCollection
SubmodelElement <|--- SubmodelElementList
SubmodelElement <|-- ContainerElement
ontainerElement<|-- SubmodelElementCollection
ontainerElement <|--- SubmodelElementList
SubmodelElementCollection ..> SubmodelElement
SubmodelElementList ..> SubmodelElement
@enduml

0 comments on commit 0d19c9b

Please sign in to comment.