From 75361b616c63663d4cfe8de171f1850cabdf7133 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 27 Nov 2023 14:19:59 +0100 Subject: [PATCH 01/10] docs(ess):[#209] Improve ESS admin manual documentation --- charts/irs-helm/CHANGELOG.md | 3 +++ charts/irs-helm/templates/configmap-spring-app-config.yaml | 2 +- charts/irs-helm/values.yaml | 4 ++-- irs-api/src/main/resources/application.yml | 2 +- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md index a00af20634..92c609d095 100644 --- a/charts/irs-helm/CHANGELOG.md +++ b/charts/irs-helm/CHANGELOG.md @@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +### Changed +- Rename property `edc.provider.host` to `ess.edc.host` + ### Fixed - Fixed templating for `management.health.dependencies` diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml index 5c56bec786..5ff6169b67 100644 --- a/charts/irs-helm/templates/configmap-spring-app-config.yaml +++ b/charts/irs-helm/templates/configmap-spring-app-config.yaml @@ -118,7 +118,7 @@ data: cacheTTL: {{ .Values.edc.connectorEndpointService.cacheTTL | quote }} ess: localBpn: {{ tpl (.Values.bpn | default "") . | quote }} - localEdcEndpoint: {{ tpl (.Values.edc.provider.host | default "") . | quote }} + localEdcEndpoint: {{ tpl (.Values.ess.edc.host | default "") . | quote }} managementPath: {{ tpl (.Values.ess.managementPath | default "/management/v2") . | quote }} irs: url: {{ tpl (.Values.irsUrl | default "") . | quote }} diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml index 573713e871..b7fee13259 100644 --- a/charts/irs-helm/values.yaml +++ b/charts/irs-helm/values.yaml @@ -159,8 +159,6 @@ portal: clientId: # clientSecret: # edc: - provider: - host: # EDC Provider Host URL controlplane: endpoint: data: "" # @@ -208,6 +206,8 @@ discovery: oAuthClientId: portal # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client ess: + edc: + host: # EDC base URL - used for creation of EDC assets for ESS notifications and as sender EDC for sent notifications mockEdcResult: # Map of BPNs and YES/NO strings - this configures the ESS mock response in case it called to investigate a BPN mockRecursiveEdcAsset: # List of BPNs for which the special, mocked notification asset should be used managementPath: "/management/v2" # EDC management API path - used for notification asset creation diff --git a/irs-api/src/main/resources/application.yml b/irs-api/src/main/resources/application.yml index cc5bf4150f..78b54d4787 100644 --- a/irs-api/src/main/resources/application.yml +++ b/irs-api/src/main/resources/application.yml @@ -222,7 +222,7 @@ bpdm: # ESS Module specific properties ess: localBpn: ${ESS_LOCAL_BPN:} # BPN value of product - used during EDC notification communication - localEdcEndpoint: ${EDC_PROVIDER_URL:} # EDC Provider Url - used during EDC notification communication + localEdcEndpoint: ${ESS_EDC_URL:} # EDC base URL - used for creation of EDC assets for ESS notifications and as sender EDC for sent notifications managementPath: ${EDC_MANAGEMENT_PATH:/management/v2} # EDC management API path - used for notification asset creation irs: url: "${IRS_URL:}" # IRS Url to connect with From 8ee60f7a50707cfcd58a683a91bab6cca8715091 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 27 Nov 2023 14:21:41 +0100 Subject: [PATCH 02/10] docs(installation):[#209] Fix broken links --- DataChainKit.md | 6 +++--- INSTALL.md | 14 +++++++------- README.md | 47 +++++++++++++++++++++++++++++------------------ 3 files changed, 39 insertions(+), 28 deletions(-) diff --git a/DataChainKit.md b/DataChainKit.md index a5f937f13b..8ed6308b74 100644 --- a/DataChainKit.md +++ b/DataChainKit.md @@ -16,14 +16,14 @@ The Item Relationship Service (IRS) is the first reference application of the Da ### Requirements The IRS needs to be deployed with the following components in the same environment: -- [Eclipse Dataspace Connector](https://github.com/eclipse-dataspaceconnector/DataSpaceConnector) +- [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc) -The Service interacts with the Catena-X [Digital Twin Registry](https://catena-x.net/en/angebote/digitaler-zwilling) and is built upon the Catena-X Semantic Models which are stored in the [Semantic Hub](https://catena-x.net/en/angebote/digitaler-zwilling). +The Service interacts with the Catena-X [Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) and is built upon the Catena-X Semantic Models which are stored in the [Semantic Hub](https://github.com/eclipse-tractusx/sldt-semantic-hub). ### Tools and documentation - 🖥 Item Relationship Service Video -- 📄 [Item Relationship Service Product Page](https://catena-x.net/en/angebote/item-relationship-service) +- 📄 [Item Relationship Service Product Page](https://catena-x.net/en/offers-standards/item-relationship-service) - 📄 [Item Relationship Service Documentation](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/README.md) - 📄 [IRS REST API Documentation](https://eclipse-tractusx.github.io/item-relationship-service/docs/api-specification/api-specification.html) - 📄 Catena-X Kit's diff --git a/INSTALL.md b/INSTALL.md index e56ca69744..0dd04e0ead 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -10,11 +10,11 @@ Everything else needs to be provided externally. ## Data Chain Kit You can use the Data Chain Kit to deploy the whole demo scenario with all participating components. -Instructions can be found here: [Data Chain Kit](https://eclipse-tractusx.github.io/docs/kits/Data%20Chain%20Kit/Operation%20View/). +Instructions can be found here: [Data Chain Kit](https://eclipse-tractusx.github.io/docs-kits/kits/Data%20Chain%20Kit/Operation%20View). ## Installation -The IRS Helm repository can be found here: [https://eclipse-tractusx.github.io/item-relationship-service/index.yaml](https://eclipse-tractusx.github.io/docs/kits/Data%20Chain%20Kit/Operation%20View/) +The IRS Helm repository can be found here: [index.yaml](https://eclipse-tractusx.github.io/item-relationship-service/index.yaml) Use the latest release of the "irs-helm" chart. It contains all required dependencies. @@ -44,10 +44,10 @@ Or create a new Helm chart and use the IRS as a dependency. dependencies: - name: irs-helm repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 3.x.x - - name: irs-edc-consumer # optional - repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 1.x.x + version: 6.x.x + - name: tractusx-connector + repository: https://eclipse-tractusx.github.io/tractusx-edc + version: 0.5.x ``` Then provide your configuration as the values.yaml of that chart. @@ -62,4 +62,4 @@ A detailed instruction on how to configure the IRS and EDC can be found here: [A IRS provides a local setup which can be deployed to kubernetes. This setup includes all third-party services which IRS uses and interacts with. -Instructions can be found here [README.md](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/local/deployment/full-irs/README.md). \ No newline at end of file +Instructions can be found here [README.md](README.md). \ No newline at end of file diff --git a/README.md b/README.md index 3fc6f1f816..843f0d2a78 100644 --- a/README.md +++ b/README.md @@ -12,26 +12,28 @@ [![OWASP Dependency Check](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/owasp.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/owasp.yml) [![Spotbugs](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/spotbugs.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/spotbugs.yml) [![Eclipse-dash](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/eclipse-dash.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/eclipse-dash.yml) -[![Tavern IRS API test](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/tavern.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/tavern.yml) +[![Tavern IRS API test](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/tavern.yml/badge.svg)](https://github.com/eclipse-tractusx/item-relationship-service/actions/workflows/tavern.yml) ## What is the IRS? -Within the [Catena-X network](https://catena-x.net/), the so-called Item Relationship Service (IRS) forms an essential +Within the [Catena-X network](https://catena-x.net/), the so-called Item Relationship Service (IRS) forms an essential foundation for various services and products. Within the Catena-X use cases, the IRS serves to increase business value. -For example, the IRS provides functionalities to serve requirements, such as occasion-based Traceability, -from the Supply Chain Act. In doing so, IDSA and Gaia-X principles, such as data interoperability and sovereignty, are -maintained on the Catena-X network and access to dispersed data is enabled. Data chains are established as a common asset. - -With the help of the IRS, data chains are to be provided ad-hoc across n-tiers within the Catena-X network. -To realize these data chains, the IRS relies on data models of the Traceability use case and provides the federated -data chains to customers or applications. Furthermore, the target picture of the IRS includes the enablement of new +For example, the IRS provides functionalities to serve requirements, such as occasion-based Traceability, +from the Supply Chain Act. In doing so, IDSA and Gaia-X principles, such as data interoperability and sovereignty, are +maintained on the Catena-X network and access to dispersed data is enabled. Data chains are established as a common +asset. + +With the help of the IRS, data chains are to be provided ad-hoc across n-tiers within the Catena-X network. +To realize these data chains, the IRS relies on data models of the Traceability use case and provides the federated +data chains to customers or applications. Furthermore, the target picture of the IRS includes the enablement of new business areas by means of data chains along the value chain in the automotive industry. ## Usage ### Local deployment -The following subsection provides instructions for running the infrastructure on docker-compose and the application in the IDE. +The following subsection provides instructions for running the infrastructure on docker-compose and the application in +the IDE. #### Docker-compose + IDE @@ -47,10 +49,12 @@ The following subsection provides instructions for running the infrastructure on ### Helm deployment -see [INSTALL.md](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/INSTALL.md) +see [INSTALL.md](INSTALL.md) ### Sample calls +#### IRS + Start a job for a globalAssetId: ```bash @@ -71,6 +75,7 @@ curl -X 'POST' \ ``` Retrieve the job results by using the jobId returned by the previous call: + ```bash curl -X 'GET' 'http://localhost:8080/irs/jobs/' -H 'accept: application/json' -H 'Authorization: Bearer ' ``` @@ -81,7 +86,8 @@ curl -X 'GET' 'http://localhost:8080/irs/jobs/' -H 'accept: application/j ## Licenses -For used licenses, please see the [NOTICE](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/NOTICE.md). +For used licenses, please see +the [NOTICE](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/NOTICE.md). ## Notice for Docker image @@ -94,14 +100,19 @@ Eclipse Tractus-X product(s) installed within the image: - GitHub: https://github.com/eclipse-tractusx/item-relationship-service - Project home: https://projects.eclipse.org/projects/automotive.tractusx - Dockerfile: https://github.com/eclipse-tractusx/item-relationship-service/blob/main/Dockerfile -- Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/LICENSE) +- Project + license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/LICENSE) **Used base image** + - [eclipse-temurin:20-jre-alpine](https://github.com/adoptium/containers) -- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin -- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin -- Additional information about the Eclipse Temurin images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin +- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin +- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin +- Additional information about the Eclipse Temurin + images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin -As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained). +As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc +from the base distribution, along with any direct or indirect dependencies of the primary software being contained). -As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within. +As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies +with any relevant licenses for all software contained within. From 87b0e4dfc1612b18ca6a4c28417ce654e1ba6ef7 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 27 Nov 2023 14:22:58 +0100 Subject: [PATCH 03/10] docs(arc42):[#209] Fix formatting for documentation license --- docs/src/docs/administration/administration-guide.adoc | 4 ++-- docs/src/docs/index.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/docs/administration/administration-guide.adoc b/docs/src/docs/administration/administration-guide.adoc index 186242a7a7..18f6ab4890 100644 --- a/docs/src/docs/administration/administration-guide.adoc +++ b/docs/src/docs/administration/administration-guide.adoc @@ -7,9 +7,9 @@ include::installation.adoc[leveloffset=+1] include::configuration.adoc[leveloffset=+1] include::troubleshooting.adoc[leveloffset=+1] -## NOTICE +== NOTICE -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). +This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0]. - SPDX-License-Identifier: Apache-2.0 - SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) diff --git a/docs/src/docs/index.adoc b/docs/src/docs/index.adoc index 1efb94519c..42ba1b47a3 100644 --- a/docs/src/docs/index.adoc +++ b/docs/src/docs/index.adoc @@ -10,9 +10,9 @@ xref:api-specification/api-specification.adoc[OpenApi specification] - xref:arc42/index.adoc[Single chapters] - xref:arc42/full.adoc[Full document] -## NOTICE +== NOTICE -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). +This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0]. - SPDX-License-Identifier: Apache-2.0 - SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) From 94f8b41b1ec5a41cf520b3c468ff76434577a341 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 27 Nov 2023 14:23:40 +0100 Subject: [PATCH 04/10] docs(arc42):[#209] Fix formatting for documentation license --- docs/src/docs/arc42/full.adoc | 4 ++-- docs/src/docs/arc42/index.adoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/src/docs/arc42/full.adoc b/docs/src/docs/arc42/full.adoc index 330350a68f..db4a4f8ab9 100644 --- a/docs/src/docs/arc42/full.adoc +++ b/docs/src/docs/arc42/full.adoc @@ -12,9 +12,9 @@ include::cross-cutting/full.adoc[leveloffset=+1] include::quality/index.adoc[leveloffset=+1] include::glossary.adoc[leveloffset=+1] -## NOTICE +== NOTICE -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). +This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0]. - SPDX-License-Identifier: Apache-2.0 - SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) diff --git a/docs/src/docs/arc42/index.adoc b/docs/src/docs/arc42/index.adoc index 2e51c5f33a..4bdc00ce39 100644 --- a/docs/src/docs/arc42/index.adoc +++ b/docs/src/docs/arc42/index.adoc @@ -11,9 +11,9 @@ - xref:quality/index.adoc[Quality requirements] - xref:glossary.adoc[Glossary] -## NOTICE +== NOTICE -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). +This work is licensed under the https://www.apache.org/licenses/LICENSE-2.0[Apache-2.0]. - SPDX-License-Identifier: Apache-2.0 - SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) From 286fc3f4d12be498ee8dd1714ccb3a72fea829be Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Mon, 27 Nov 2023 14:24:50 +0100 Subject: [PATCH 05/10] docs(arc42):[#209] Add additional documentation for ESS --- README.md | 28 +++++++++++++++++ .../src/docs/administration/installation.adoc | 10 +++---- .../introduction-goals/requirements.adoc | 3 +- .../ess-top-down/ess-top-down-scenario-1.adoc | 2 +- .../ess-top-down/ess-top-down-scenario-2.adoc | 2 +- .../ess-top-down/ess-top-down.adoc | 30 +++++++++++++++++-- docs/src/docs/arc42/runtime-view/full.adoc | 1 - ...ss_top_down_sequence_determine_result.puml | 27 +++++++++++++++++ 8 files changed, 91 insertions(+), 12 deletions(-) create mode 100644 docs/src/uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_down_sequence_determine_result.puml diff --git a/README.md b/README.md index 843f0d2a78..e0af92871f 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,34 @@ Retrieve the job results by using the jobId returned by the previous call: curl -X 'GET' 'http://localhost:8080/irs/jobs/' -H 'accept: application/json' -H 'Authorization: Bearer ' ``` +#### Environmental and Social Standards (ESS) + +Start an ESS investigation for a globalAssetId and Incident BPNS. + +```bash +curl -X 'POST' \ + 'http://localhost:8080/ess/bpn/investigations' \ + -H 'accept: application/json' \ + -H 'Content-Type: application/json' \ + -H 'Authorization: Bearer ' \ + -d '{ + "key": { + "globalAssetId": "urn:uuid:3d61ada2-1a50-42a0-b411-40a932dd56cc", + "bpn": "BPNL00ARBITRARY6" + }, + "incidentBPNSs": [ + "BPNS00ARBITRARY7" + ], + "bomLifecycle": "asPlanned" + }' +``` + +Retrieve the investigation results by using the jobId returned by the previous call: + +```bash +curl -X 'GET' 'http://localhost:8080/ess/bpn/investigations/' -H 'accept: application/json' -H 'Authorization: Bearer ' +``` + ## Documentation - [Item Relationship Service Documentation](https://eclipse-tractusx.github.io/item-relationship-service/docs/) diff --git a/docs/src/docs/administration/installation.adoc b/docs/src/docs/administration/installation.adoc index 152c0e550b..6eec2c1f73 100644 --- a/docs/src/docs/administration/installation.adoc +++ b/docs/src/docs/administration/installation.adoc @@ -6,7 +6,7 @@ https://eclipse-tractusx.github.io/item-relationship-service/index.yaml Use the latest release of the "irs-helm" chart. It contains all required dependencies. -If you also want to set up your own EDC consumer, use the "irs-edc-consumer" chart. +If you also want to set up your own EDC consumer, use the https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector[tractusx-connector] chart. Supply the required configuration properties (see chapter xref:configuration.adoc#_configuration[Configuration]) in a values.yaml file or override the settings directly. @@ -31,10 +31,10 @@ Create a new Helm chart and use the IRS as a dependency. dependencies: - name: irs-helm repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 5.x.x - - name: irs-edc-consumer # optional - repository: https://eclipse-tractusx.github.io/item-relationship-service - version: 1.x.x + version: 6.x.x + - name: tractusx-connector # optional + repository: https://eclipse-tractusx.github.io/tractusx-edc + version: 0.5.x ---- diff --git a/docs/src/docs/arc42/introduction-goals/requirements.adoc b/docs/src/docs/arc42/introduction-goals/requirements.adoc index 10a6496a1a..141c95eeb8 100644 --- a/docs/src/docs/arc42/introduction-goals/requirements.adoc +++ b/docs/src/docs/arc42/introduction-goals/requirements.adoc @@ -14,4 +14,5 @@ The IRS is a: - functionality of IRS provider will be handled by providers submodel servers - federated IRS service - 'asBuild' BoM of serialized components -- provides endpoints for submodel-descriptors \ No newline at end of file +- provides endpoints for submodel-descriptors +- start recursive Environmental and Social Standard investigations throughout the network based on the "asPlanned" lifecycle diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc index 2ee41c83f2..f1a5b40f89 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc @@ -4,7 +4,7 @@ This section describes what happens when user creates an ess order. == Register an Ess-Investigation-Order -[plantuml,target=submodel-processing,format=svg] +[plantuml, target=ess-topdown-order,format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/3_ess_top_down_sequence-RegisterEssInvestigationOrder.puml[] .... diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc index 7f469ac102..748b28f234 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc @@ -4,7 +4,7 @@ This section describes what happens when user creates an ess job. == Register an Ess-Investigation Job -[plantuml,target=submodel-processing,format=svg] +[plantuml, target=ess-topdown-order-job,format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/4_ess_top_down_sequence_RegisterEssInvestigationJob.puml[] .... diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc index d2ab5e630d..d7cb68f9a6 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc @@ -14,7 +14,7 @@ The BoM as planned aspect models consists of three aspect models: == Overall flow -[plantuml,target=submodel-processing,format=svg] +[plantuml, target=ess-top-down,format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/0-ess-top-down-sequence.puml[] .... @@ -49,7 +49,7 @@ Note: ESS supplier responses are involved in each step of the process. == Flow on company level -[plantuml,target=submodel-processing,format=svg] +[plantuml, target=ess-top-down-highlevel,format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/1_ess-top-down-sequence-highlevel.puml[] .... @@ -92,11 +92,35 @@ The response of each direct supplier may contain the following results; In case at least one "YES" is received, the process step 3 ends +[cols="6,1,1,1"] +|=== +|Case |YES |NO |UNKNOWN +|All assets on all nodes does not contain assets with incidentBPNs |x | | +|At least one node contains assets with incidentBPNs | |x | +|At least one node does not contain PartSiteInformationAsPlanned aspect OR for at least one node PartSiteInformationAsPlanned aspect is not accessible | | |x +|At least one node contains PartSiteInformationAsPlanned with missing BPNS | | |x +|At least one child node does not exist or is not accessible | | |x +|=== + +[cols="1,1,1,2,5"] +|=== +| State 1 | State 2 | State n | Result State | Description +| YES | NO | UNKOWN | YES | If any part is impacted then whole Supply is impactes +| YES | NO | NO | YES | Yes if any BPN is impacted even if all are not impacted. +| NO | UNKNOW | NO | UNKNOW | Unknown if no Yes and at leat one bpn is unknown state. +| NO | NO | NO | NO | No if complete SupplyChain is not impacted +|=== + +[plantuml, target=ess_top_down_sequence-result,format=svg] +.... +include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_down_sequence_determine_result.puml[] +.... + == Application Functionality Overview === Register an Ess-Investigation-Order -[plantuml,target=submodel-processing,format=svg] +[plantuml, target=ess-top-down-highlevel,format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/1_ess-top-down-sequence-highlevel.puml[] .... diff --git a/docs/src/docs/arc42/runtime-view/full.adoc b/docs/src/docs/arc42/runtime-view/full.adoc index 21aa1e6b2b..dfd1d44398 100644 --- a/docs/src/docs/arc42/runtime-view/full.adoc +++ b/docs/src/docs/arc42/runtime-view/full.adoc @@ -21,4 +21,3 @@ This recursive scenario is illustrated using the various use cases realized in t include::ess-top-down/ess-top-down.adoc[leveloffset=+1] include::ess-top-down/ess-top-down-scenario-1.adoc[leveloffset=+1] include::ess-top-down/ess-top-down-scenario-2.adoc[leveloffset=+1] -include::ess-top-down/ess-top-down-scenario-3.adoc[leveloffset=+1] diff --git a/docs/src/uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_down_sequence_determine_result.puml b/docs/src/uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_down_sequence_determine_result.puml new file mode 100644 index 0000000000..409d66a25d --- /dev/null +++ b/docs/src/uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_down_sequence_determine_result.puml @@ -0,0 +1,27 @@ +@startuml +skinparam monochrome true +skinparam shadowing false +skinparam defaultFontName "Architects daughter" + +start +if (Twin is available in DTR) then (No) + :Unknown; + stop +else (Yes) +if (Twins has PartSiteInformationAsPlanned) then (No) + :Unknown; + stop +else (Yes) +if (PartSiteInformation contains BPNS) then (No) + :Unknown; + stop +else (Yes) +if (PartSiteInformation contains incident BPNS) then (No) + :No; + stop +else (Yes) + :Yes; + stop +endif + +@enduml \ No newline at end of file From 199f8ba53797c0de33f12bb661269b1b9a45e5a3 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 28 Nov 2023 09:53:15 +0100 Subject: [PATCH 06/10] docs(arc42):[#209] Add missing ESS parts to building block and runtime view --- .../building-block-view/whitebox-overall.adoc | 3 +++ .../ess-top-down/ess-top-down-scenario-2.adoc | 2 +- docs/src/docs/arc42/runtime-view/full.adoc | 5 +---- docs/src/docs/arc42/runtime-view/index.adoc | 14 +++++--------- .../runtime-view/irs-iterative/irs-iterative.adoc | 4 ---- .../whitebox_overall_decentral.puml | 6 +++++- .../uml-diagrams/deployment-view/level-0-dev.puml | 8 ++++---- 7 files changed, 19 insertions(+), 23 deletions(-) diff --git a/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc b/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc index e72cf6b2e2..0c42ced7ad 100644 --- a/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc +++ b/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc @@ -96,6 +96,9 @@ include::../../../uml-diagrams/building-block-view/whitebox_overall_decentral.pu | 16 | *IRS* accessing the *decentral DigitalTwinRegistry* on Tier Level using the *EDC* + +| 17 +| *IRS* sending notifications to the *IRS-ESS* instance running at the data provider using the *EDC* |=== diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc index 748b28f234..0645188cc4 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc @@ -1,4 +1,4 @@ -= Scenario 1: Register an Ess-Investigation-Job += Scenario 2: Register an Ess-Investigation-Job This section describes what happens when user creates an ess job. diff --git a/docs/src/docs/arc42/runtime-view/full.adoc b/docs/src/docs/arc42/runtime-view/full.adoc index dfd1d44398..2237751caf 100644 --- a/docs/src/docs/arc42/runtime-view/full.adoc +++ b/docs/src/docs/arc42/runtime-view/full.adoc @@ -1,10 +1,8 @@ = Runtime view - - == IRS Iterative -This section covers the main processes of the IRS and explains how data is transferred and processed when a job is executed. +This section describes the iterative flow, the main processes of the IRS, and explains how data is transferred and processed when a job is executed. include::irs-iterative/irs-iterative.adoc[leveloffset=+1] include::irs-iterative/scenario-1.adoc[leveloffset=+1] @@ -17,7 +15,6 @@ include::irs-iterative/scenario-4.adoc[leveloffset=+1] This section covers the main processes of the IRS in a recursive scenario in a network. This recursive scenario is illustrated using the various use cases realized in the scenario. - include::ess-top-down/ess-top-down.adoc[leveloffset=+1] include::ess-top-down/ess-top-down-scenario-1.adoc[leveloffset=+1] include::ess-top-down/ess-top-down-scenario-2.adoc[leveloffset=+1] diff --git a/docs/src/docs/arc42/runtime-view/index.adoc b/docs/src/docs/arc42/runtime-view/index.adoc index 09f232725a..5a1d5235ff 100644 --- a/docs/src/docs/arc42/runtime-view/index.adoc +++ b/docs/src/docs/arc42/runtime-view/index.adoc @@ -1,27 +1,23 @@ = Runtime view -This section covers the main processes of the IRS and explains how data is transferred and processed when a job is executed. - -Please see the subpages for the relevant scenarios: - == IRS Iterative +This section describes the iterative flow, the main processes of the IRS, and explains how data is transferred and processed when a job is executed. + - xref:irs-iterative/irs-iterative.adoc[Overall] - xref:irs-iterative/scenario-1.adoc[Scenario 1: Create Job] - xref:irs-iterative/scenario-2.adoc[Scenario 2: Job Execution] - xref:irs-iterative/scenario-3.adoc[Scenario 3: Request for JobResponse] - xref:irs-iterative/scenario-4.adoc[Scenario 4: Cancel job execution] - - == IRS Recursive This section covers the main processes of the IRS in a recursive scenario in a network. This recursive scenario is illustrated using the various use cases realized in the scenario. -=== Use Case: ESS (Environmental and Social Standards) Top-Down approach - -include::ess-top-down/ess-top-down.adoc[leveloffset=+1] +- xref:ess-top-down/ess-top-down.adoc[Use Case: ESS (Environmental and Social Standards) Top-Down approach] +- xref:ess-top-down/ess-top-down-scenario-1.adoc[Scenario 1: Register an Ess-Investigation-Order] +- xref:ess-top-down/ess-top-down-scenario-2.adoc[Scenario 2: Register an Ess-Investigation-Job] diff --git a/docs/src/docs/arc42/runtime-view/irs-iterative/irs-iterative.adoc b/docs/src/docs/arc42/runtime-view/irs-iterative/irs-iterative.adoc index 5b21ab0bb7..ba7fe41999 100644 --- a/docs/src/docs/arc42/runtime-view/irs-iterative/irs-iterative.adoc +++ b/docs/src/docs/arc42/runtime-view/irs-iterative/irs-iterative.adoc @@ -1,7 +1,3 @@ -= IRS iterative - -This section describes the iterative flow of the IRS - [plantuml, target=overall, format=svg] .... include::../../../../uml-diagrams/runtime-view/api-call-asynchrous-sequence.puml[] diff --git a/docs/src/uml-diagrams/building-block-view/whitebox_overall_decentral.puml b/docs/src/uml-diagrams/building-block-view/whitebox_overall_decentral.puml index fb52eccddd..4181023169 100644 --- a/docs/src/uml-diagrams/building-block-view/whitebox_overall_decentral.puml +++ b/docs/src/uml-diagrams/building-block-view/whitebox_overall_decentral.puml @@ -19,7 +19,8 @@ package [**OEM**] <> as consumer { component [**EDC (Provider)**] <> as EDCProviderOEM component [**SubmodelServer**] <> as SubmodelServerOEM component [**decentral Digital Twin Registry**] <> as DT_REG_OEM - } + component [**IRS-ESS**] <> as EssOEM + } } @@ -37,6 +38,7 @@ package [**N-Tier**] <> as provider { component [**EDC (Provider)**] <> as EDCProvider component [**SubmodelServer**] <> as SubmodelServer component [**decentral Digital Twin Registry**] <> as DT_REG + component [**IRS-ESS**] <> as EssProvider } actor IrsApiConsumer @@ -47,6 +49,7 @@ IAM_IRS <..> Portal_IdP : **[03]** EDCProviderOEM <-> SubmodelServerOEM : **[04]** EDCProviderOEM <--> DT_REG_OEM : **[05]** +EDCProviderOEM <--> EssOEM : **[17]** miw <..> EDCProviderOEM : **[12]** IRS <.d.> EDC : **[06]** @@ -63,6 +66,7 @@ EDC <..> EDCProviderOEM : **[13]** miw <..> EDCProvider : **[14]** EDCProvider <--> SubmodelServer : **[15]** EDCProvider <--> DT_REG : **[16]** +EDCProvider <-> EssProvider : **[17]** miw -[hidden]d- IAM_IRS miw -[hidden]r- discovery_finder diff --git a/docs/src/uml-diagrams/deployment-view/level-0-dev.puml b/docs/src/uml-diagrams/deployment-view/level-0-dev.puml index f3ed29d642..949fa49998 100644 --- a/docs/src/uml-diagrams/deployment-view/level-0-dev.puml +++ b/docs/src/uml-diagrams/deployment-view/level-0-dev.puml @@ -11,17 +11,17 @@ node "Kubernetes Cluster" as k8s { component IRS component Minio - component "Decentral Registry" as dtr + component "Digital Twin Registry" as dtr component "EDC Consumer" as consumer component "EDC Provider" as provider - component "DAPS" as daps + component "Managed Identity Wallet" as miw collections "Submodel Provider" as submodel IRS --> Minio IRS -> consumer - consumer --> daps - provider --> daps + consumer --> miw + provider --> miw consumer <--> provider provider --- submodel provider --- dtr From 2b0d2d187b5e41d26285838f4238dc3631520be3 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 28 Nov 2023 09:54:58 +0100 Subject: [PATCH 07/10] docs(arc42):[#209] Minor grammar fix --- docs/src/docs/arc42/building-block-view/level-2.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/docs/arc42/building-block-view/level-2.adoc b/docs/src/docs/arc42/building-block-view/level-2.adoc index e538a91875..2dfc2f86b7 100644 --- a/docs/src/docs/arc42/building-block-view/level-2.adoc +++ b/docs/src/docs/arc42/building-block-view/level-2.adoc @@ -35,7 +35,7 @@ include::../../../uml-diagrams/building-block-view/level-2-int.puml[] == RecursiveJobHandler -The *RecursiveJobHandler* component provide the logic to build jobs with recursive logic to retrieve items over the complete C-X network and assembles the partial results into a single item graph result. +The *RecursiveJobHandler* component provide the logic to build jobs recursively to retrieve items over the complete C-X network and assembles the partial results into a single item graph result. === Component diagram From 316cf8016ffd6c973c0fb44429d56f667e87f155 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 28 Nov 2023 11:04:04 +0100 Subject: [PATCH 08/10] docs(arc42):[#209] Fix puml includes --- .../ess-top-down/ess-top-down-scenario-1.adoc | 2 +- .../ess-top-down/ess-top-down-scenario-2.adoc | 2 +- .../arc42/runtime-view/ess-top-down/ess-top-down.adoc | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc index f1a5b40f89..d0ddca85f3 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-1.adoc @@ -4,7 +4,7 @@ This section describes what happens when user creates an ess order. == Register an Ess-Investigation-Order -[plantuml, target=ess-topdown-order,format=svg] +[plantuml, target=ess-topdown-order, format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/3_ess_top_down_sequence-RegisterEssInvestigationOrder.puml[] .... diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc index 0645188cc4..311a0be698 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down-scenario-2.adoc @@ -4,7 +4,7 @@ This section describes what happens when user creates an ess job. == Register an Ess-Investigation Job -[plantuml, target=ess-topdown-order-job,format=svg] +[plantuml, target=ess-topdown-order-job, format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/4_ess_top_down_sequence_RegisterEssInvestigationJob.puml[] .... diff --git a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc index d7cb68f9a6..091e7e98f8 100644 --- a/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc +++ b/docs/src/docs/arc42/runtime-view/ess-top-down/ess-top-down.adoc @@ -14,7 +14,7 @@ The BoM as planned aspect models consists of three aspect models: == Overall flow -[plantuml, target=ess-top-down,format=svg] +[plantuml, target=ess-top-down, format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/0-ess-top-down-sequence.puml[] .... @@ -49,7 +49,7 @@ Note: ESS supplier responses are involved in each step of the process. == Flow on company level -[plantuml, target=ess-top-down-highlevel,format=svg] +[plantuml, target=ess-top-down-highlevel, format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/1_ess-top-down-sequence-highlevel.puml[] .... @@ -111,7 +111,7 @@ In case at least one "YES" is received, the process step 3 ends | NO | NO | NO | NO | No if complete SupplyChain is not impacted |=== -[plantuml, target=ess_top_down_sequence-result,format=svg] +[plantuml, target=ess_top_down_sequence-result, format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_down_sequence_determine_result.puml[] .... @@ -120,7 +120,7 @@ include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/5_ess_top_d === Register an Ess-Investigation-Order -[plantuml, target=ess-top-down-highlevel,format=svg] +[plantuml, target=ess-top-down-highlevel, format=svg] .... include::../../../../uml-diagrams/runtime-view/use-case-ess-top-down/1_ess-top-down-sequence-highlevel.puml[] .... From 3085fb9941a30cebaae47775608a19ecbd985df2 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Tue, 28 Nov 2023 11:04:24 +0100 Subject: [PATCH 09/10] docs(arc42):[#209] Update ESS description --- docs/src/docs/arc42/building-block-view/level-2.adoc | 2 +- docs/src/docs/arc42/building-block-view/whitebox-overall.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/docs/arc42/building-block-view/level-2.adoc b/docs/src/docs/arc42/building-block-view/level-2.adoc index 2dfc2f86b7..ed4ba92255 100644 --- a/docs/src/docs/arc42/building-block-view/level-2.adoc +++ b/docs/src/docs/arc42/building-block-view/level-2.adoc @@ -35,7 +35,7 @@ include::../../../uml-diagrams/building-block-view/level-2-int.puml[] == RecursiveJobHandler -The *RecursiveJobHandler* component provide the logic to build jobs recursively to retrieve items over the complete C-X network and assembles the partial results into a single item graph result. +The *RecursiveJobHandler* component provide the logic to build jobs recursively to retrieve items over the complete C-X network and assembles the partial results into a single item graph result. === Component diagram diff --git a/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc b/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc index 0c42ced7ad..f8b5043a83 100644 --- a/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc +++ b/docs/src/docs/arc42/building-block-view/whitebox-overall.adoc @@ -98,7 +98,7 @@ include::../../../uml-diagrams/building-block-view/whitebox_overall_decentral.pu | *IRS* accessing the *decentral DigitalTwinRegistry* on Tier Level using the *EDC* | 17 -| *IRS* sending notifications to the *IRS-ESS* instance running at the data provider using the *EDC* +| In case of the use-case Environmental and Social Standards, *IRS* sends notifications to the *IRS-ESS* instance running at the data provider using the *EDC*. |=== From 07902d3e092469fa5856052cbcc017a6542bf923 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann <57985712+ds-jhartmann@users.noreply.github.com> Date: Mon, 4 Dec 2023 16:39:13 +0100 Subject: [PATCH 10/10] docs(arc42):[#209] Update deployment view level 0 Co-authored-by: ds-mkanal <100209308+mkanal@users.noreply.github.com> --- docs/src/uml-diagrams/deployment-view/level-0-dev.puml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/uml-diagrams/deployment-view/level-0-dev.puml b/docs/src/uml-diagrams/deployment-view/level-0-dev.puml index 949fa49998..90536e65a7 100644 --- a/docs/src/uml-diagrams/deployment-view/level-0-dev.puml +++ b/docs/src/uml-diagrams/deployment-view/level-0-dev.puml @@ -11,7 +11,7 @@ node "Kubernetes Cluster" as k8s { component IRS component Minio - component "Digital Twin Registry" as dtr + component "Decentral Digital Twin Registry" as dtr component "EDC Consumer" as consumer component "EDC Provider" as provider component "Managed Identity Wallet" as miw