Skip to content

Commit

Permalink
Merge remote-tracking branch 'admin-shell-io/IDTA-01001-3-1_working' …
Browse files Browse the repository at this point in the history
…into IgGa/minorFixes

# Conflicts:
#	documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/referencing.adoc
#	documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc
  • Loading branch information
zrgt committed Jan 8, 2025
2 parents 410eb65 + b59443e commit d4bd79e
Show file tree
Hide file tree
Showing 39 changed files with 316 additions and 120 deletions.
Binary file removed documentation - Copy.zip
Binary file not shown.
12 changes: 4 additions & 8 deletions documentation/IDTA-01001/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,6 @@ SPDX-License-Identifier: CC-BY-4.0
:xrefstyle: short
////

// no comments between entries !!!

//= image:../../idta-logo.png[width=100%]


// include::./includes/index.adoc[]


* xref:terms-definitions-and-abbreviations.adoc[Terms and Definitions]
Expand All @@ -35,6 +28,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 +52,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 +78,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,85 @@
////
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)
include::../includes/constraints.adoc[]


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}

{aasd107}

{aasd108}

{aasd109}

{aasd114}

{aasd115}

{aasd116}

{aasd117}

{aasd118}

{aasd119}

{aasd121}

{aasd122}

{aasd123}

{aasd124}

{aasd125}

{aasd126}

{aasd127}

{aasd128}

{aasd129}

{aasd130}

{aasd131}

{aasd133}

{aasd134}
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,12 @@ The following kinds of _Types_ are distinguished:
** _<Primitive>:_ Type is no object type (class) but a data type; it is just a value, see Clause xref:spec-metamodel/datatypes.adoc#primitive-data-types[Primitive Data Types]
** _<Enumeration>:_ Type is an enumeration, see <<template-for-enumerations>>

_Card._ is the cardinality (or multiplicity) defining the lower and upper bound of the number of instances of the member element. "\*" denotes an arbitrary infinite number of elements of the corresponding Type. "0..1" means optional. "0..*" or "0..3" etc. means that the list may be either not available (optional) or the list is not empty.
_Card._ is the cardinality (or multiplicity) defining the lower and upper bound of the number of instances of the member element.
"\*" denotes an arbitrary infinite number of elements of the corresponding Type.
"0..1" means optional. "0..*" or "0..3" etc. means that the list may be either not available (optional) or the list is not empty.
In the case of "0..3" there are at most 3 elements in the list.
"1" means the attribute is mandatory.
"1..*" or "1..3" means there is at least 1 element in the list. The "*" denotes as maximum an infinite number of elements of the corresponding type whereas "3" means that there are at most 3 elements in the list - analogeous for other numbers.

====
Note 1: attributes having a default value are always considered to be optional; there is always a value for the attribute because the default value is used for initialization in this case.
Expand Down
6 changes: 4 additions & 2 deletions documentation/IDTA-01001/modules/ROOT/pages/bibliography.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,9 @@ https://profiles.opcfoundation.org/workinggroup/40[Industry 4.0 Asset Administra
[43] OPC UA Information Models. [Online]. Available: https://opcfoundation.org/developer-tools/specifications-opc-ua-information-models
////

[#bib43]
[43] IEC 63278-2 "Asset Administration Shell for industrial applications – Part 2: Metamodel".

[#bib44]
[44] IEC 63278-1:2023 "Asset Administration Shell for industrial applications – Part 1: Asset Administration Shell structure".

Expand Down Expand Up @@ -222,8 +225,7 @@ Available: https://industrialdigitaltwin.org/wp-content/uploads/2022/12/I40-IDTA
Oct. 2020, Plattform Industrie 4.0 [Online] Available: https://www.plattform-i40.de/PI40/Redaktion/EN/Downloads/Publikation/secure_downloadservice.html

[#bib51]
[51] "AAS Repository.
Repository for Information and Code for the Asset Administration Shell".
[51] "Repository of the Industrial Digital Twin Association (IDTA)".
Industrial Digital Twin Association. https://github.com/admin-shell-io

// bib52 see [41]
95 changes: 78 additions & 17 deletions documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,15 @@ Note: before V3.0, the security metamodel and the predefined data specifications
Major Changes:

* New value "Role" to enumeration AssetKind (https://github.com/admin-shell-io/aas-specs/issues/294[#294])
* New abstract class "ContainerElement" as subtype of "SubmodelElement", subtypes: AnnotatedRelationshipElement, Entity, SubmodelElementCollection, SubmodelElementLis. Includes introducing new enumeration for container elements and extending existing enumerations for submodel elements "AasSubmodelElement" etc. (https://github.com/admin-shell-io/aas-specs/issues/333[#333])
* New abstract class "ContainerElement" as subtype of "SubmodelElement", subtypes: AnnotatedRelationshipElement, Entity, SubmodelElementCollection, SubmodelElementList. Includes introducing new enumeration for container elements and extending existing enumerations for submodel elements "AasSubmodelElement" etc. (https://github.com/admin-shell-io/aas-specs/issues/333[#333])
* Data type Identifier: change length from 2000 to 2048 characters (https://github.com/admin-shell-io/aas-specs/issues/306[#306])
* Referable/idShort and Constraint AASd-002: now also allows hyphens to be included in name (https://github.com/admin-shell-io/aas-specs/issues/295[#295])
* Entity/entityType and Constraint AASd-014: entityType now optional (https://github.com/admin-shell-io/aas-specs/issues/287[#287])
* Change RelationshipElement: attributes "first" and "second" now optional (conformant to "min" and "max" of "Range")(https://github.com/admin-shell-io/aas-specs/issues/412[#412]), AnnotatedRelationshipElement inherits from RelationshipElement and is thus also affected.

* Change File and Blob: attribute "contentType" now optional (https://github.com/admin-shell-io/aas-specs/issues/412[#412])
* remove AASd-120: idShort also allowed for elements within a SubmodelElementList (https://github.com/admin-shell-io/aas-specs/issues/432[#432])
* remove AASd-090: category is deprecated (https://github.com/admin-shell-io/aas-specs/issues/514[#514])
* Relaxation of grammar for semantic IDs for metamodel elements in the context of data specifications
(https://github.com/admin-shell-io/aas-specs/issues/307[#307])
* Terms and Definitions adopted to IEC 63278-1:2023 (before IEC 63278-1 Draft July 2022 was the basis),
Expand All @@ -62,34 +63,49 @@ also abbreviations partly adopted; changes:
** changed: Submodel template
** changed: Submodel template element
** removed: technical functionality
* Update clause on matching algorithm for references
(https://github.com/admin-shell-io/aas-specs/issues/350[#350])
** introduce equivalent matching and rename exact matching to value matching
** added notes
* Update clause on matching algorithm for references, include handling of supplementalSemanticIds, isCaseOf etc.
(https://github.com/admin-shell-io/aas-specs/issues/350[#350],
https://github.com/admin-shell-io/aas-specs/issues/471[#471],
https://github.com/admin-shell-io/aas-specs/issues/473[#473],
https://github.com/admin-shell-io/aas-specs/issues/479[#479],
https://github.com/admin-shell-io/aas-specs/issues/347[#347])
* (Editorial) Adding metamodel element IDs to tables themselves for easier usage (besides grammar defining how to derive them) (https://github.com/admin-shell-io/aas-specs/issues/366[#366])
* Update all metamodel element IDs to V3.1 (https://github.com/admin-shell-io/aas-specs/issues/366[#366])
* Transfer of clauses on formats Metadata, Paths and Value-Only from Part 2 API to Part 1 Metamodel (https://github.com/admin-shell-io/aas-specs/issues/325[#325])
* (Editorial) Update clause on Value-Only Serialization, improve documentation (https://github.com/admin-shell-io/aas-specs/issues/370[#370], https://github.com/admin-shell-io/aas-specs/issues/371[#371])
* (Editorial) Update clause on Value-Only Serialization, improve documentation (https://github.com/admin-shell-io/aas-specs/issues/370[#370], https://github.com/admin-shell-io/aas-specs/issues/371[#371], https://github.com/admin-shell-io/aas-specs/issues/411[#411])
** add table similar to metadata table: which attributes are displayed in Value-Only serialization
** 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)
* 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])
** update Schema for JSON-Value Serialization (https://github.com/admin-shell-io/aas-specs/issues/366[#366])
* 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, 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
* 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 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), 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])
* improve formulation of constraints, use "shall" instead of "needs to" etc.


Minor Changes:

* explanation of ValueOnly-Normal round-trip issues (https://github.com/admin-shell-io/aas-specs/issues/364[#364])
* remove recommendation to use external reference 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])
* update information on OPC UA mapping (https://github.com/admin-shell-io/aas-specs/issues/373[#373])
* update information on AutomationML mapping (https://github.com/admin-shell-io/aas-specs/issues/397[#397])
* add Annex with overview of constraints (https://github.com/admin-shell-io/aas-specs/issues/509[#509])
* 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
* editorial changes
* 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])


=== Metamodel Changes V3.1 vs. V3.0.1
Expand All @@ -107,7 +123,7 @@ Minor Changes:
| {empty} | xref:spec-metamodel/submodel-elements.adoc#Blob[Blob/contentType] a| now optional
| {empty} | xref:spec-metamodel/submodel-elements.adoc#Entity[Entity/entityType] a| now optional
| {empty} | xref:spec-metamodel/submodel-elements.adoc#File[File/contentType] a| now optional
| {empty} | xref:spec-metamodel/referencing.adoc#FragmentKeys[ragmentKeys/ContainerElement] a| Add new value "ContainerElement" to enumeration FragmentKeys, because AasSubmodelElements was extended
| {empty} | xref:spec-metamodel/referencing.adoc#FragmentKeys[FragmentKeys/ContainerElement] a| Add new value "ContainerElement" to enumeration FragmentKeys, because AasSubmodelElements was extended
| {empty} | xref:spec-metamodel/datatypes.adoc#Identifier[Identifier] a| data type: change length from 2000 to 2024 characters
| {empty} | xref:spec-metamodel/datatypes.adoc#NameType[NameType] a| implicit change due to change of Constraint AASd-002
| {empty} | xref:spec-metamodel/common.adoc#Referable[Referable/idShort] a| implicit change because constraint AASd-002 now also allows hyphen
Expand Down Expand Up @@ -137,16 +153,61 @@ now also allows hyphens to be included in name

Constraint AASd-002: _idShort_ of __Referable__s shall only feature letters, digits, hyphen ("-") and underscore ("_"); starting mandatory with a letter, and not ending with a hyphen, i.e. ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$.].

|{empty} |AASd-006 |#Update a|
use "shall" instead of "need"

Constraint AASd-006: If both, the value and the valueId of a Qualifier are present, the value needs to be identical to the value of the referenced coded value in Qualifier/valueId.

changed to

Constraint AASd-006: If both, the value and the valueId of a Qualifier are present, the value shall be identical to the value of the referenced coded value in Qualifier/valueId.

|{empty} |AASd-007 |#Update a|
use "shall" instead of "need"

Constraint AASd-007: If both the Property/value and the Property/valueId are present, the value of Property/value needs to be identical to the value of the referenced coded value in Property/valueId.

changed to

Constraint AASd-007: If both the Property/value and the Property/valueId are present, the value of Property/value shall be identical to the value of the referenced coded value in Property/valueId.


|{empty} | AASd-014 | Update a|
Change since Entity/entityType is now optional

Constraint AASd-014: Either the attribute globalAssetId or specificAssetId of an Entity must be set if Entity/entityType is set to "SelfManagedEntity".

|{empty} | AASd-016 | Update a|
|{empty} | AASd-021| Update a|
use "shall" instead of "can"

Constraint AASd-021: Every qualifiable can only have one qualifier with the same Qualifier/valueType.

changed to
Constraint AASd-021: Every qualifiable shall only have one qualifier with the same Qualifier/valueType.

|{empty} | AASd-116 | Update a|
Update version of globalAssetId

Constraint AASd-116:
"globalAssetId" (case-insensitive) is a reserved key for SpecificAssetId/name with the semantics as defined in `\https://admin-shell.io/aas/3/1/AssetInformation/globalAssetId`.

|{empty} |AASd-077 |#Update a|
use "shall" instead of "need"

Constraint AASd-077: The name of an extension (Extension/name) within HasExtensions needs to be unique.

changed to

Constraint AASd-077: The name of an extension (Extension/name) within HasExtensions shall be unique.

|{empty} |AASd-090 |#Removed a|

Constraint AASd-090:
For data elements, category (inherited by Referable) shall be one of the following values: CONSTANT, PARAMETER or VARIABLE. Default: VARIABLE

|{empty} | AASd-120 | Removed a|
Constraint AASd-120: idShort of submodel elements being a direct child of a SubmodelElementList shall not be specified.

|===

== Changes V3.0.1 vs. V3.0
Expand Down
Loading

0 comments on commit d4bd79e

Please sign in to comment.