Skip to content

Commit

Permalink
Merge pull request #20 from admin-shell-io/BiBo/#2_relationship_path
Browse files Browse the repository at this point in the history
closes #2 support deprecated namespace www.admin-shell.io
  • Loading branch information
BirgitBoss authored Apr 19, 2024
2 parents aee4ede + fdb9ad2 commit 41212bf
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 16 deletions.
40 changes: 24 additions & 16 deletions documentation/IDTA-01005/modules/ROOT/pages/aasx.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,13 @@ The Asset Administration Shell Package (AASX) format is derived from the Open Pa
* file extension for the AASX format *.aasx*,
* MIME-type for the AASX format: application/asset-administration-shell-packagefootnote:[The current MIME-type is provisory and needs to be requested officially.],
* *icon* for the AASXfootnote:[No official icon for aasx extension available so far.],
* identification of the AASX format by the file extension and content (MIME) type, which can be identified content-wise when reading the first relationship file /_rels/.rels (as defined in Open Packaging Conventions) and looking for a relationship type *\http://admin-shell.io/aasx/relationships/aasx-origin* (which is the entry point for the logical model of the Asset Administration Shell),
* note that the following paths and filenames in the package are already reserved by the Open Packaging Conventions specification and shall therefore not be used for any derivative format: /[Content_Types].xml; /_rels/.rels; /_<file_path>_/_rels/_<filename>_.rels (where <__filename__> is a file in the package that is source of relationships and _<file_path>_ is the path to that file),
* the AASX format does not have to be opened in any existing Office Open XML / Open Packaging Conventions compatible Office application (e.g. Microsoft Office, LibreOffice), because the required relationships and files for the different office "models" may not be present (e.g. \http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument for "docx" document).
* identification of the AASX format by the file extension and content (MIME) type, which can be identified content-wise when reading the first relationship file `/_rels/.rels` (as defined in Open Packaging Conventions) and looking for a relationship type `\http://admin-shell.io/aasx/relationships/aasx-origin` (which is the entry point for the logical model of the Asset Administration Shell),
* note that the following paths and filenames in the package are already reserved by the Open Packaging Conventions specification and shall therefore not be used for any derivative format: `/[Content_Types].xml`; `/_rels/.rels`; `/<file_path>/_rels/<filename>.rels` (where `<filename>` is a file in the package that is source of relationships and `<file_path>` is the path to that file),
* the AASX format does not have to be opened in any existing Office Open XML / Open Packaging Conventions compatible Office application (e.g. Microsoft Office, LibreOffice), because the required relationships and files for the different office "models" may not be present (e.g. `\http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument` for "docx" document).

====
The following relationship path is deprecated: `\http://www.admin-shell.io/aasx/relationships`
====

[#ecma-376-rels]
== ECMA-376 Relationships
Expand All @@ -59,8 +63,12 @@ The following name spaces are defined:
[cols="18%,82%",options="header"]
|===
|*Namespace* |*Value*
|<rel> |\http://schema.openxmlformats.org/package/2006/relationships
|<rel_aas> |\http://admin-shell.io/aasx/relationships
|`<rel>` a|`\http://schema.openxmlformats.org/package/2006/relationships`
|`<rel_aas>` a|`\http://admin-shell.io/aasx/relationships`

and

(\<<Deprecated>>) `\http://www.admin-shell.io/aasx/relationships`
|===

Each relationship typefootnote:[To avoid the long names of the relationship types, the short name is used in the text.] as denoted in <<aasx-rels>> is described in the following.
Expand All @@ -70,7 +78,7 @@ Each relationship typefootnote:[To avoid the long names of the relationship type
|===
|*Relationship Type* |
|*Source File of Relationship Type:* |*--*
|*Namespace:* |*<rel>*
|*Namespace:* |`<rel>`
|===
[.appendix-table]
[cols="30%,10%,60%",options="header"]
Expand Down Expand Up @@ -108,8 +116,8 @@ It is the entry point for all aas specific relationships and files inside the pa
[cols="30%h,70%"]
|===
|*Relationship Type* |
|*Source File of Relationship Type:* |*<rel>/digital-signature/origin*
|*Namespace:* |*<rel>* |
|*Source File of Relationship Type:* |`<rel>/digital-signature/origin`
|*Namespace:* |`<rel>` |
|===
[.appendix-table]
[cols="30%,10%,60%", options="header"]
Expand All @@ -130,8 +138,8 @@ Note: see <<digital-signatures>> for more information.
[cols="30%h,70%"]
|===
|*Relationship Type* |
|*Source File of Relationship Type:* |*<rel>/digital-signature/signature*
|*Namespace:* |*<rel>* |
|*Source File of Relationship Type:* |`<rel>/digital-signature/signature`
|*Namespace:* |`<rel>` |
|===
[.appendix-table]
[cols="30%,10%,60%", options="header"]
Expand All @@ -152,8 +160,8 @@ Note: see <<digital-signatures>> for more information.
[cols="30%h,70%"]
|===
|*Relationship Type* |
|*Source File of Relationship Type:* |*<rel_aas>/aasx-origin*
|*Namespace:* |*<rel_aas>* |
|*Source File of Relationship Type:* |`<rel_aas>/aasx-origin`
|*Namespace:* |`<rel_aas>` |
|===
[.appendix-table]
[cols="30%,10%,60%", options="header"]
Expand All @@ -172,8 +180,8 @@ Typical formats contained are XML and/or JSON.
[cols="30%h,70%"]
|===
|*Relationship Type* |
|*Source File of Relationship Type:* |*<rel_aas>/aas-spec*
|*Namespace:* |*<rel_aas>* |
|*Source File of Relationship Type:* |`<rel_aas>/aas-spec`
|*Namespace:* |`<rel_aas>` |
|===
[.appendix-table]
[cols="30%,10%,60%", options="header"]
Expand Down Expand Up @@ -216,7 +224,7 @@ Using the ECMA-376 relationships (see <<ecma-376-rels>>) allows to locate files
[[logical-to-physical-map]]
image::logical-to-physical-map.png[]

In addition to the AASX specific files, files common to all ECMA-376 packages – such as relationship parts (*.rels) and the Content Types stream ([Content_Types].xml) – must be contained in an AASX package in its physical representation as a .zip archive.For more information on these files, please refer to the ECMA-376 specification.
In addition to the AASX specific files, files common to all ECMA-376 packages – such as relationship parts (*.rels) and the Content Types stream (`[Content_Types].xml`) – must be contained in an AASX package in its physical representation as a .zip archive. For more information on these files, please refer to the ECMA-376 specification.

.AASX File Structure (Physical Model)
[[aasx-file-structure]]
Expand All @@ -225,7 +233,7 @@ image::aasx-file-structure.png[]
[#digital-signatures]
== Digital Signatures

A digital signing feature is already provided by the Open Packaging ­­­­Conventions specification xref:bibliography.adoc#bib4[[4\]].Hence, this signing framework for packages can also be used for AASX packages.To ensure the integrity of the AAS data, all relevant files within the package (aasx-origin file, AAS structure specification file, supplementary files) and the associated relationship parts shall be signed.
A digital signing feature is already provided by the Open Packaging Conventions specification xref:bibliography.adoc#bib4[[4\]].Hence, this signing framework for packages can also be used for AASX packages.To ensure the integrity of the AAS data, all relevant files within the package (aasx-origin file, AAS structure specification file, supplementary files) and the associated relationship parts shall be signed.

== Encryption

Expand Down
2 changes: 2 additions & 0 deletions documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ This annex lists the changes from version to version of the file exchange format
Major Changes:

* CHANGE: aasx/data.<extension> is only a recommendation (change from shall to should) (https://github.com/admin-shell-io/aas-specs-aasx/issues/10[#10])
* CHANGE: support both relationship paths: `\http://admin-shell.io/aasx/relationships` (as specified and recommended)
and (deprecated) `\http://www.admin-shell.io/aasx/relationships` (https://github.com/admin-shell-io/aas-specs-aasx/issues/2[#2])
* CHANGE: Terms and Definitions adopted to IEC 63278-1:2023 (before IEC 63278-1 Draft July 2022 was the basis),
(https://github.com/admin-shell-io/aas-specs/issues/365[#365])
also abbreviations partly adopted; changes:
Expand Down

0 comments on commit 41212bf

Please sign in to comment.