Skip to content

docs(dt): prepare for R24-03 #654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Large diffs are not rendered by default.

Large diffs are not rendered by default.

This file was deleted.

24 changes: 17 additions & 7 deletions docs-kits/kits/Digital Twin Kit/page_adoption-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ back to the public. A priority is the seamless integration with other Catena-X d

### Customer Journey

With the Digital Twin Kit, all roles mentioned in the [Operating Model Whitepaper](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/CX_Operating_Model_Whitepaper_02_12_22.pdf)
With the Digital Twin Kit, all roles mentioned in the [Operating Model Whitepaper](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/CX_Operating_Modelv2.1_final.pdf)
are given the necessary tooling to format their data and APIs in a standardized manner.

<!-- !Mandatory! -->
Expand Down Expand Up @@ -68,7 +68,7 @@ expands with the scope of the model.
- A distributed infrastructure of central and decentral components integrating hand-in-hand with backend-systems southward
and the network northward.

- Extensive meta-model to create a virtual representation of asses across their entire lifecycle.
- Extensive meta-model to create a virtual representation of assets across their entire lifecycle.

### Example

Expand All @@ -83,12 +83,22 @@ For more info how specifically the Asset Administration Shell is used, consult t

### CX-Standards

- [CX - 0001 EDC Discovery API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/9_Data-Discovery-Services/CX_-_0001_EDC_DISCOVERY_API_PlatformCapabilityDS_v_1.0.1-1.pdf)
- [CX - 0002 Digital Twins in Catena-X](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0002-DigitalTwinsInCatena-X-v.1.0.2.pdf)*(linked version 1.0.2, this KIT refers to v2.0.0, to be released in 09/23)*
- CX - 0053 BPN Discovery Services *(v1.0.0 to be released in 09/23)*
- [CX - 0001 EDC Discovery API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0001-EDCDiscoveryAPI_v1.0.2.pdf)
- [CX - 0002 Digital Twins in Catena-X](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_Januar_2024/CX-0002-DigitalTwinsInCatenaX-v2.1.0.pdf)*(version 2.1.0)*
- [CX - 0053 BPN Discovery Service](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_Januar_2024/CX-0053-BPNDiscoveryServiceAPIs-v1.0.1.pdf) *(version 1.0.1)*

### Terminology

The following figure is also a non-normative part of CX-0002 "Digital Twins in Catena-X" v2.0.0. When published, that
standard can be found in the [Catena-X standard library](https://catena-x.net/de/standard-library).
The following figure is also a non-normative part of CX-0002 "Digital Twins in Catena-X" v2.0.0. It explains the realtions
between terms used in this Kit and the domain of Digital Twins in Catena-X.
All standards can be found in the [Catena-X standard library](https://catena-x.net/de/standard-library).
![How words relate in the DT Kit](assets/img/DTKIT_terminology.svg)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this image owned by Catena-X e.V.?
If yes, please add license information according to: https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-07/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed this one entirely. The association grants to rights to its standards or their content, it appears.



## Notice

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation
- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc)
6 changes: 5 additions & 1 deletion docs-kits/kits/Digital Twin Kit/page_changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ sidebar_position: 1

### Digital Twin KIT

All notable changes to this Kit will be documented in this file.
## [1.2.0] - 2024-03-02

- Added more details on interaction patterns
- Added guidance on confidentiality classification of properties
- bugfixes, clarifications

## [1.1.0] - 2023-12-05

Expand Down
28 changes: 20 additions & 8 deletions docs-kits/kits/Digital Twin Kit/page_software-operation-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,25 @@ Digital Twins the Catena-X-way. This infrastructure empowers Data Consumers to c
each Data Provider and facilitated by an Operating Company. They run central and decentral services that allow them to
discover each other, exchange information and contextualize it according to a standardized semantics.

| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) |
|-----------------------|----------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| Discovery Finder | A microservice resolving a type of identifiers against a set of BPN-Discovery Servers. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 |
| BPN Discovery | A microservice resolving a particular assetId against the registered BPN of its owner. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 |
| EDC Discovery | A microservice that resolves a BPN against an EDC endpoint. | [Tractus-X Portal including EDC Discovoery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 |
| Digital Twin Registry | An exhaustive list of all Submodel Servers, with link to their assets, adhering to the AAS Registry API. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 |
| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. | [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service), [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk), [AASX Server](https://github.com/admin-shell-io/aasx-server) | CX - 0002 |
The APIS for digital twins are based on the specifications of the Asset Administration Shell (AAS) as defined in
CX-0002.

| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) |
|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| Discovery Finder | A microservice resolving type of identifiers against a set of BPN-Discovery Servers. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 |
| BPN Discovery | A microservice resolving a particular assetId against the registered BPN of its owner. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 |
| EDC Discovery | A microservice that resolves a BPN against an EDC endpoint. | [Tractus-X Portal including EDC Discovery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 |
| Digital Twin Registry | A registry for digital twins, each digital twin providing the endpoints of its submodels. <br/> The registry is adhering to the AAS Registry API. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 |
| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. | [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service), <br/> [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk), <br/> [AASX Server](https://github.com/admin-shell-io/aasx-server) | CX - 0002 |

![High Level Architecture of an App leveraging the Digital Twin Kit](assets/img/DTKIT_high_level_arch.svg)

![High Level Architecture of an App leveraging the Digital Twin Kit](assets/img/DTKIT_high_level_arch.svg)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a self created image especially for the KIT please follow: https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-07

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TRG-7 says "if a figure in docs is self-created, the ##NOTICE paragraph at the end of the file is sufficient." The Adoption View already has one.



## Notice

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation
- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc)
14 changes: 0 additions & 14 deletions docs-kits_versioned_sidebars/version-3.1.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -817,20 +817,6 @@
}
]
},
{
"type": "category",
"label": "Digital Twin Kit",
"link": {
"type": "generated-index"
},
"collapsed": true,
"items": [
{
"type": "autogenerated",
"dirName": "kits/Digital Twin Kit"
}
]
},
{
"type": "category",
"label": "Traceability KIT",
Expand Down
20 changes: 15 additions & 5 deletions openApi/dt/discovery-finder-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ components:
- type
- description
- endpointAddress
- timeToLive
properties:
type:
type: string
Expand All @@ -151,6 +152,10 @@ components:
maxLength: 500
resourceId:
type: string
timeToLive:
type: integer
minimum: 1
maximum: 31536000
SearchRequest:
title: SearchRequest
required:
Expand Down Expand Up @@ -209,7 +214,8 @@ components:
"type": "oen",
"description": "Service to discover BPN to a particular OEN",
"endpointAddress": "http://...",
"documentation": "http://.../swagger/index.html"
"documentation": "http://.../swagger/index.html",
"timeToLive": 31536000
}
discovery-endpoint-result:
value:
Expand All @@ -218,7 +224,8 @@ components:
"description": "Service to discover BPN to a particular OEN",
"endpointAddress": "http://...",
"documentation": "http://.../swagger/index.html",
"resourceId": "ec6f407b-4296-418c-9e4e-fb739fe72a67"
"resourceId": "ec6f407b-4296-418c-9e4e-fb739fe72a67",
"timeToLive": 31536000
}
discovey-endpoint-search:
value:
Expand All @@ -234,21 +241,24 @@ components:
"description": "Service to discover BPN to a particular OEN",
"endpointAddress": "http://...",
"documentation": "http://.../swagger/index.html",
"resourceId": "ec6f407b-4296-418c-9e4e-fb739fe72a67"
"resourceId": "ec6f407b-4296-418c-9e4e-fb739fe72a67",
"timeToLive": 31536000
},
{
"type": "bpid",
"description": "Service to discover BPN to a particular Battery Pass ID",
"endpointAddress": "http://...",
"documentation": "http://.../swagger/index.html",
"resourceId": "08702529-3714-4c4f-b022-346b9b4fbbe2"
"resourceId": "08702529-3714-4c4f-b022-346b9b4fbbe2",
"timeToLive": 31536000
},
{
"type": "bpn",
"description": "Service to discover EDC to a particular BPN",
"endpointAddress": "http://...",
"documentation": "http://.../swagger/index.html",
"resourceId": "316417cd-0fb5-4daf-8dfa-8f68125923f1"
"resourceId": "316417cd-0fb5-4daf-8dfa-8f68125923f1",
"timeToLive": 31536000
}
]
}