chore(uml):[TRI-1417] add more details

eclipse-tractusx · Sep 26, 2023 · cf73c1b · cf73c1b
1 parent 474815f
commit cf73c1b
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 27 deletions.
diff --git a/docs/src/uml-diagrams/irs-recursive/ess-bottom-up/ess-customer-notifications-submodel.puml b/docs/src/uml-diagrams/irs-recursive/ess-bottom-up/ess-customer-notifications-submodel.puml
@@ -0,0 +1,20 @@
+@startuml
+skinparam monochrome true
+skinparam shadowing false
+skinparam defaultFontName "Architects daughter"
+
+entity  Customers {
+     businessPartnerNumberLegalEntity : string
+}
+entity  CustomerParts{
+    globalAssetId : string
+}
+entity  Sites{
+    businessPartnerNumberSite : string
+}
+
+Customers "0..*" - "1..*" CustomerParts
+
+CustomerParts "0..*" - "1..*" Sites
+
+@enduml
diff --git a/docs/src/uml-diagrams/irs-recursive/ess-bottom-up/sequence/aggregate-bpnl.puml b/docs/src/uml-diagrams/irs-recursive/ess-bottom-up/sequence/aggregate-bpnl.puml
@@ -0,0 +1,13 @@
+@startuml
+@startuml
+skinparam monochrome true
+skinparam shadowing false
+skinparam defaultFontName "Architects daughter"
+
+autonumber "<b>[000]"
+
+participant
+participant
+
+
+@enduml
diff --git a/...nce/ess-bottim-up-sequence-highlevel.puml → ...nce/ess-bottom-up-sequence-highlevel.puml b/...nce/ess-bottim-up-sequence-highlevel.puml → ...nce/ess-bottom-up-sequence-highlevel.puml
@@ -32,37 +32,40 @@ ClientApp <-- dDTR_Tier_N : Array [{AAS shells}]
 
 ClientApp -> ClientApp : Extract globalAssetId
 
-ClientApp -> dDTR_Tier_N : /ess/broadcast/recipients/orders
+ClientApp -> dDTR_Tier_N : /ess/customers/investigations/orders
     note left
-        globalAssetIds [
-            bpn : <bpnl>
-            globalAssetIds : <globalAssetIds>
-        ]
-        bomLifecycle : asPlanned,
-        direction : upwards (SingleLevelUsageAsPlanned),
-        depth : 1,
-        filters [
+        Investigation of customers who must be notified about an incident.
+        parameters:
             {
-              validityTimestamp : <validityTimestamp>
-            },
-         ],
-        incidentBpns [<bpns>,..]
-
+            keys [
+                bpn : <bpnl>
+                globalAssetIds : <globalAssetIds>
+            ]
+            bomLifecycle : asPlanned,
+            direction : upwards (SingleLevelUsageAsPlanned),
+            depth : 1,
+            incidentBpns [<bpns>,..],
+            filterExpressions :  [
+                        {
+                          validityTimestamp : <validityTimestamp>
+                        },
+                     ]
+            }
     end note
 
     ref over dDTR_Tier_N, dDTR_Tier_3, SubmodelServer_Tier_3
         Determining relationships 1 tier level upwards
     end ref
 
-    dDTR_Tier_N -> dDTR_Tier_N : deduplicateBPNLs
+    dDTR_Tier_N -> dDTR_Tier_N : aggregateBPNLs
     note left
         Aggregate bpns numbers for each bpnl
     end note
     dDTR_Tier_N <-- dDTR_Tier_N : [{globalAssetId,businessPartnerNumberLegalEntity, [businessPartnerNumberSite]}]
 
     dDTR_Tier_N -> dDTR_Tier_N : validityPeriodChecker
     note left
-        validtyPeriodCheck: Checks if passed timestamp is in validity period defined with
+        validityPeriodCheck: Checks if passed timestamp is in validity period defined with
         validityPeriod.validFrom and  PartAsPlanned.validityPeriod.validTo
 
         PartAsPlanned.validityPeriod.validFrom
@@ -77,16 +80,22 @@ ClientApp -> dDTR_Tier_N : /ess/broadcast/recipients/orders
     ClientApp <-- dDTR_Tier_N : Get a batch with a given batchId for a given orderId.
     ClientApp --> dDTR_Tier_N : GET /irs/jobs/{id}
     ClientApp <-- dDTR_Tier_N : Return job with item graph for the requested id.
-    note left
-        [
-            {
-                globalAssetId : <globalAssetId>
-                bpnl : <bpnl>
-                bpns [
-                 <bpns>
-                 ]
-            },
-        ]
-    end note
     User <-- ClientApp : Return job with item graph for the requested id.
+      note left
+            {
+                customers : [
+                    {
+                        businessPartnerNumberLegalEntity : <bpnl>,
+                        "customerParts" [
+                            {
+                                globalAssetId:   <globalAssetId>,
+                                sites : [
+                                    {<bpns>},
+                                ],
+                             }, ...
+                        ]
+                    },
+                ]
+            }
+        end note
 @enduml