Merge pull request #1023 from catenax-ng/feature/536-subsequential-fl…

…ow-in-trace-x feature(tx-backend): #536 draft subsequential flow
eclipse-tractusx · Mar 14, 2024 · 60c0d0a · 60c0d0a
2 parents a466da6 + 14d360f
commit 60c0d0a
Show file tree

Hide file tree

Showing 71 changed files with 1,510 additions and 8,552 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,17 +12,22 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 ### Added
 - #421 Added contract agreement view
 - #515 Service Unavailable Response on Notification failure
-- #536 Added import state PUBLISHED_TO_CX in frontend
+- #536 Added import state PUBLISHED_TO_CORE_SERVICES in frontend
 - #420 add /contracts api to fetch contract agreement information from EDC for assets
 - Added a step to the pull-request-backend.yml which checks if the pom.xml(root) properties have some versions ending with -SNAPSHOT
 - Added a PostConstruct method in PolicyStartUpConfig to allow Integration tests to run without errors in stack traces.
+- #536 added new ImportState to asset PUBLISHED_TO_CORE_SERVICES indicating edc assets and dtr shells were created for given asset
+- #536 added cron job responsible to publish assets in PUBLISHED_TO_CORE_SERVICES import state to edc and dtr
+
 ### Changed
 - Updated RELEASE.md to the latest release guide (added more steps)
 - #515 Fixed notification toast click area
 - #625 increased height of tables
 - #423 Moved errorMessages from investigation/alert to notification list
 - Updated COMPATIBILITY.md matrix adding release C-X 24.3 and 23.12
 - #536 rework /policies to respond with policies from the IRS policy store
+- #536 sync assets logic was adjusted to create IRS jobs only for assets that are not in TRANSIENT or IN_SYNC states
+- #536 Updated Arc42 documentation and user-manual with publish assets informations
 
 ### Removed
 - #625 Removed the header and breadcrumbs section from app layout

diff --git a/charts/traceability-foss/charts/backend/templates/deployment.yaml b/charts/traceability-foss/charts/backend/templates/deployment.yaml
@@ -98,6 +98,12 @@ spec:
               value: {{ .Values.edc.apiKey | quote }}
             - name: EDC_PROVIDER_URL
               value: {{ .Values.edc.providerUrl | quote }}
+            - name: EDC_PROVIDER_DATAPLANE_URL
+              value: {{ .Values.edc.providerDataplaneUrl | quote }}
+            - name: REGISTRY_URL_WITH_PATH
+              value: {{ .Values.registry.urlWithPath | quote }}
+            - name: REGISTRY_ALLOWED_BPNS
+              value: {{ .Values.registry.allowedBpns | quote }}
             - name: SUBMODEL_URL
               value: {{ .Values.submodel.baseUrl | quote }}
             - name: IRS_URL

diff --git a/charts/traceability-foss/charts/backend/values.yaml b/charts/traceability-foss/charts/backend/values.yaml
@@ -169,6 +169,7 @@ irs:
   baseUrl: "https://replace.me"
 registry:
   urlWithPath: "https://replace.me"
+  allowedBpns: "replace me"
 portal:
   baseUrl: "https://replace.me"
 

diff --git a/charts/traceability-foss/values.yaml b/charts/traceability-foss/values.yaml
@@ -293,6 +293,8 @@ backend:
     callbackUrl: "CHANGEME"  # example: http://<irs-helm.nameOverride>:8181/internal/endpoint-data-reference
     callbackUrlEdcClient: "CHANGEME"  # example: https://<backend.ingress.hosts>/api/internal/endpoint-data-reference
     dataEndpointUrl: "CHANGEME"  # example: https://<tractusx-connector.controlplane.ingress.hosts>/management"
+    partsProviderControlplaneUrl: "CHANGEME"  # host of the parts provider EDC
+    partsProviderDataplaneUrl: "CHANGEME"
 
   discoveryfinder:
     baseUrl: "CHANGEME"  # example: https://discoveryfinder.net/discoveryfinder/api/administration/connectors/discovery/search
@@ -301,6 +303,7 @@ backend:
     baseUrl: "https://replace.me"  # https://<irs-helm.ingress.host>
   registry:
     urlWithPath: "https://replace.me"  # digitalTwinRegistry /semantics/registry/api/v3.0
+    allowedBpns: "BPN1,BPN2"  # "," separated list of allowed bpns for creating shells
   portal:
     baseUrl: "https://replace.me"
 

diff --git a/docs/RELEASE.md b/docs/RELEASE.md
@@ -4,7 +4,6 @@
 </div>
 
 ## Release an app
-
 Prerequisite:
 Make sure eclipse / catena git repositories are in sync
 

diff --git a/docs/src/docs/arc42/runtime-view/data-provisioning.adoc b/docs/src/docs/arc42/runtime-view/data-provisioning.adoc
@@ -2,7 +2,7 @@
 
 This sequence diagrams describes the process of importing data from a Trace-X Dataformat
 
-Modul 1
+== Modul 1
 
 Data will be imported by the Trace-X Frontend into Trace-X backend and will be persisted as asset by a Trace-X instance in a transient state.
 The raw data which is needed for the shared services (DTR / EDC) will be persisted as well.
@@ -13,7 +13,7 @@ The raw data which is needed for the shared services (DTR / EDC) will be persist
 include::../../../uml-diagrams/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul1-sequence.puml[]
 ....
 
-Modul 2 - DRAFT
+== Modul 2
 
 The frontend is able to select assets and publish / syncronize them with the shared services. DTR / EDC / Submodel API.
 
@@ -23,7 +23,7 @@ The frontend is able to select assets and publish / syncronize them with the sha
 include::../../../uml-diagrams/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul2-sequence.puml[]
 ....
 
-Modul 3 - DRAFT
+== Modul 3
 
 The backend is able to persist the data in the DTR / EDC and allows to use IRS for resolving assets.
 
@@ -33,6 +33,9 @@ The backend is able to persist the data in the DTR / EDC and allows to use IRS f
 include::../../../uml-diagrams/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul3-sequence.puml[]
 ....
 
-TODO: Add all scenarios for data-provisioning
 
 include::data-provisioning/return-import-report.adoc[leveloffset=+1]
+
+include::data-provisioning/publish-assets.adoc[leveloffset=+1]
+
+include::data-provisioning/publish-assets-error.adoc[leveloffset=+1]
diff --git a/docs/src/docs/arc42/runtime-view/data-provisioning/publish-assets-error.adoc b/docs/src/docs/arc42/runtime-view/data-provisioning/publish-assets-error.adoc
@@ -0,0 +1,14 @@
+= Scenario 3: Publish assets Error on EDC or DTR
+
+This section describes user interaction when publishing assets fails due to EDC or DTR error ( for example services are unavailable )
+
+[plantuml,target=import-report-receive,format=svg]
+....
+include::../../../../uml-diagrams/arc42/runtime-view/data-provisioning/publish-assets-error.puml[]
+....
+
+== Overview
+
+When a user publishes assets, TraceX-FOSS checks if the user has an adequate role ('ROLE_ADMIN').
+If yes, then endpoint starts to publish assets to network.
+If any of required Services are not available or returns Error response upon executing flow assets are set to ERROR state and user can retry publishing them at any time when services are available
diff --git a/docs/src/docs/arc42/runtime-view/data-provisioning/publish-assets.adoc b/docs/src/docs/arc42/runtime-view/data-provisioning/publish-assets.adoc
@@ -0,0 +1,13 @@
+= Scenario 2: Publish assets
+
+This section describes user interaction when publishing assets
+
+[plantuml,target=import-report-receive,format=svg]
+....
+include::../../../../uml-diagrams/arc42/runtime-view/data-provisioning/publish-assets.puml[]
+....
+
+== Overview
+
+When a user publishes assets, TraceX-FOSS checks if the user has an adequate role ('ROLE_ADMIN').
+If yes, then endpoint starts to publish assets to network.
diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc
@@ -199,7 +199,10 @@ The following table explains the different import state an asset can have:
 |Asset is uploaded but not synchronized with the Item Relationship Service (IRS).
 
 |in_synchronization
-|Asset is in the process of synchronizing with the IRS.
+|Asset is ready to be published.
+
+|published_to_core_services
+|Asset is published, EDC assets, DTR shell, Submodel are created
 
 |persistent
 |Asset is successfully synchronized with the IRS.

diff --git a/docs/src/uml-diagrams/arc42/runtime-view/data-consumption-process.puml b/docs/src/uml-diagrams/arc42/runtime-view/data-consumption-process.puml
@@ -24,7 +24,7 @@ TraceX -> TraceX: Extract globalAssetId as CatenaX UUID
 TraceX -> TraceX: Filter for new CX UUIDs
 
 	loop for each new CX_UUID
-        TraceX -> IRS: Register job to get submodel data
+        TraceX -> IRS: Register job for assets not in TRANSIENT or IN_SYNC import states to get submodel data
             rnote right TraceX
                 aspects, globalAssetId, bomLifecycle, collectAspects, direction, depth
             end rnote

diff --git a/docs/src/uml-diagrams/arc42/runtime-view/data-provisioning/publish-assets-error.puml b/docs/src/uml-diagrams/arc42/runtime-view/data-provisioning/publish-assets-error.puml
@@ -0,0 +1,23 @@
+@startuml
+skinparam monochrome true
+skinparam shadowing false
+autonumber "<b>[000]"
+
+actor TraceXApiConsumer
+activate TraceXApiConsumer
+
+box "Trace-X FOSS" #LightGrey
+participant TraceX
+activate TraceX
+
+TraceXApiConsumer -> TraceX : POST /assets/publish
+TraceX -> TraceX : Module 2 fails to create EDC Assets or DTR shells
+TraceXApiConsumer -> TraceXApiConsumer : GET /assets
+TraceXApiConsumer -> TraceX : POST /assets/publish
+TraceX -> TraceX : Module 2 process successfully
+TraceXApiConsumer -> TraceXApiConsumer : GET /assets
+
+
+
+
+@enduml
diff --git a/docs/src/uml-diagrams/arc42/runtime-view/data-provisioning/publish-assets.puml b/docs/src/uml-diagrams/arc42/runtime-view/data-provisioning/publish-assets.puml
@@ -0,0 +1,21 @@
+@startuml
+skinparam monochrome true
+skinparam shadowing false
+autonumber "<b>[000]"
+
+actor TraceXApiConsumer
+activate TraceXApiConsumer
+
+box "Trace-X FOSS" #LightGrey
+participant TraceX
+activate TraceX
+
+TraceXApiConsumer -> TraceX : POST /assets/publish
+TraceX -> TraceX : Module 2
+TraceXApiConsumer -> TraceXApiConsumer : GET /assets
+
+
+
+
+
+@enduml
diff --git a/...s/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul2-sequence.puml b/...s/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul2-sequence.puml
@@ -1,15 +1,17 @@
 @startuml
 participant FE
 participant BE
+autonumber "<b>[000]"
 
-FE -> BE: [001] request assets: GET/assetsAsxxx
-BE --> FE: [002] return assets_as_built OR assets_as_planned
-FE -> FE: [003] present assets
-FE -> BE: [004] select assets to synchronize: GET/policies
-BE --> FE: [005] return policies
-FE -> FE: [006] open detailview & assign policy (via dropdown)
-FE -> BE: [007] register assets for publishing: POST/assets/sync
-BE --> FE: [008] update asset state to IN_SYNC
-BE -> BE: [008] trigger 'publish AAS Workflow' (Job scheduler)
-FE -> FE: [009] refresh of FE view
+FE -> BE: request assets: GET/assetsAsxxx
+BE --> FE: return assets_as_built OR assets_as_planned
+FE -> FE: present assets
+FE -> BE: select assets to synchronize: GET/policies
+BE --> FE: return policies
+FE -> FE: open detailview & assign policy (via dropdown)
+FE -> BE: register assets for publishing: POST/assets/publish
+BE -> BE: update asset state to IN_SYNC
+BE -> BE: trigger 'publish AAS Workflow' (Job scheduler)
+BE -> BE: trigger 'data consumption process'
+FE -> FE: refresh of FE view
 @enduml
diff --git a/...s/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul3-sequence.puml b/...s/arc42/runtime-view/data-provisioning/trace-x-data-import-interface-modul3-sequence.puml
@@ -3,19 +3,32 @@ participant BE
 participant EDC
 participant Registry
 participant Submodels
+participant Irs
+autonumber "<b>[000]"
 
-BE ->> BE: [001] scheduler job
-BE ->> BE: [002] receive list of IN_SYNC_assets
-BE ->> EDC: [003] create asset in EDC: POST/create/asset
-EDC -->> BE: [004] response
-BE ->> EDC: [005] create policy in EDC: POST/create/policy
-EDC -->> BE: [006] response
-BE ->> EDC: [007] create contract in EDC: POST/create/contract
-EDC -->> BE: [008] response
-BE ->> Submodels: [009] create submodel: POST/submodel
-Submodels -->> BE: [010]
-BE ->> Registry: [011] register shell in registry: POST/semantics/registry
-Registry -->> BE: [012]
-BE ->> BE: [013] update asset state PUBLISHED_TO_CX
-BE ->> BE: [014] trigger IRS sync
+BE ->> BE: scheduler job
+BE ->> BE: receive list of IN_SYNC assets
+BE ->> Irs: get policy for assets from policy store: GET/irs/policies
+Irs -->> BE: response
+BE ->> EDC: create policy in EDC: POST/create/policy
+EDC -->> BE: response
+BE ->> EDC: create DTR asset in EDC: POST/create/asset
+EDC -->> BE: response
+BE ->> EDC: create DTR contract in EDC: POST/create/contract
+EDC -->> BE: response
+BE ->> EDC: create Submodel asset in EDC: POST/create/asset
+EDC -->> BE: response
+BE ->> EDC: create Submodel contract in EDC: POST/create/contract
+EDC -->> BE: response
+BE ->> Submodels: create submodel: POST/submodel
+Submodels -->> BE:
+BE ->> Registry: [017] register shell in registry: POST/semantics/registry
+alt Successful DTR shell creation
+Registry -->> BE: shell created
+BE ->> BE: update asset state PUBLISHED_TO_CORE_SERVICES
+BE ->> BE: trigger IRS sync
+else DTR shell was not created
+Registry -->> BE: create shell not successful or service unavailable
+BE ->> BE: update asset state ERROR
+end
 @enduml
diff --git a/frontend/src/app/mocks/services/parts-mock/partsAsBuilt/partsAsBuilt.model.ts b/frontend/src/app/mocks/services/parts-mock/partsAsBuilt/partsAsBuilt.model.ts
@@ -66,7 +66,7 @@ export const mockBmwAssets = [
     'receivedQualityAlertIdsInStatusActive': [],
     'sentQualityInvestigationIdsInStatusActive': [],
     'receivedQualityInvestigationIdsInStatusActive': [],
-    'importState': 'PUBLISHED_TO_CX',
+    'importState': 'PUBLISHED_TO_CORE_SERVICES',
     'importNote': 'This is a test import note.'
   },
   {

diff --git a/frontend/src/app/modules/page/parts/model/parts.model.ts b/frontend/src/app/modules/page/parts/model/parts.model.ts
@@ -176,7 +176,7 @@ export enum ImportState {
   IN_SYNCHRONIZATION = "IN_SYNCHRONIZATION",
   ERROR = "ERROR",
   UNSET = "UNSET",
-  PUBLISHED_TO_CX="PUBLISHED_TO_CX"
+  PUBLISHED_TO_CORE_SERVICES="PUBLISHED_TO_CORE_SERVICES"
 }
 
 export enum ImportStateInCamelCase {
@@ -185,7 +185,7 @@ export enum ImportStateInCamelCase {
   IN_SYNCHRONIZATION = "In Synchronization",
   ERROR = "Error",
   UNSET = "Unset",
-  PUBLISHED_TO_CX="Published to CX"
+  PUBLISHED_TO_CORE_SERVICES="Published to Core Services"
 }
 
 export enum FilterOperator {

diff --git a/frontend/src/app/modules/shared/components/chip/chip.component.scss b/frontend/src/app/modules/shared/components/chip/chip.component.scss
@@ -23,7 +23,7 @@
     background-color: rgb(255,236,189);
   }
 
-  &__PUBLISHED_TO_CX {
+  &__PUBLISHED_TO_CORE_SERVICES {
     background-color: rgb(218, 245, 255);
   }
 

diff --git a/frontend/src/assets/locales/de/common.json b/frontend/src/assets/locales/de/common.json
@@ -145,7 +145,7 @@
     "IN_SYNCHRONIZATION": "IN SYNCHRONISATION",
     "ERROR": "FEHLER",
     "UNSET": "UNDEFINIERT",
-    "PUBLISHED_TO_CX": "VERÖFFENTLICHT"
+    "PUBLISHED_TO_CORE_SERVICES": "VERÖFFENTLICHT"
   },
   "severity": {
     "MINOR": "Gering",
@@ -336,7 +336,7 @@
       "IN_SYNCHRONIZATION": "In Synchronisation",
       "ERROR": "Fehler",
       "UNSET": "Undefiniert",
-      "PUBLISHED_TO_CX": "Veröffentlicht"
+      "PUBLISHED_TO_CORE_SERVICES": "Veröffentlicht"
     }
   },
   "parts": {

diff --git a/frontend/src/assets/locales/en/common.json b/frontend/src/assets/locales/en/common.json
@@ -143,7 +143,7 @@
     "IN_SYNCHRONIZATION": "IN SYNCHRONIZATION",
     "ERROR": "ERROR",
     "UNSET": "UNSET",
-    "PUBLISHED_TO_CX": "PUBLISHED"
+    "PUBLISHED_TO_CORE_SERVICES": "PUBLISHED"
   },
   "severity": {
     "MINOR": "Minor",
@@ -338,7 +338,7 @@
       "IN_SYNCHRONIZATION": "In Synchronization",
       "ERROR": "Error",
       "UNSET": "Unset",
-      "PUBLISHED_TO_CX": "Veröffentlicht"
+      "PUBLISHED_TO_CORE_SERVICES": "Veröffentlicht"
 
     }
   },