From a539fd13ca339da8317517ed07e2427a3243a966 Mon Sep 17 00:00:00 2001 From: Christian Rehm Date: Mon, 24 Jun 2024 10:59:06 +0200 Subject: [PATCH] chore(documentation): #915 update BPN-EDC configuration in docu --- docs/src/docs/user/user-manual.adoc | 4 +-- .../user-manual/bpn-edc-configuration.puml | 30 ++++--------------- 2 files changed, 8 insertions(+), 26 deletions(-) diff --git a/docs/src/docs/user/user-manual.adoc b/docs/src/docs/user/user-manual.adoc index b4ae90302f..00f0240ff8 100644 --- a/docs/src/docs/user/user-manual.adoc +++ b/docs/src/docs/user/user-manual.adoc @@ -97,8 +97,8 @@ In the BPN-EDC configuration screen an admin user can add URLs for BPNs. Existin image::https://raw.githubusercontent.com/eclipse-tractusx/traceability-foss/main/docs/src/images/user-manual/navigation/bpn_edc_configuration.png[] -In case a URL is defined in this configuration, that URL will be used first to send requests to the specified BPN. If the request is unsuccessful, the EDC DiscoveryFinder will be used to fetch any URLs configured by the receiving BPN. After trying to send the request to all of those URLs in order and still finding no success, the request is cancelled. -If no URL is defined here, the EDC DiscoveryFinder will be directly used to find the URLs. +Any configured BPNs will have their URLs merged in addition to the URLs found by the DiscoveryService. +The resulting list of URLs will be used whenever a notification is sent to those BPNs. In case an URL returns an error response, the remaining URLs will be used as backup. [plantuml, target=bpn-edc-configuration, format=svg] .... diff --git a/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml b/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml index 8ab7ed1aa6..206fc07f88 100644 --- a/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml +++ b/docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml @@ -3,38 +3,20 @@ skinparam monochrome true skinparam shadowing false skinparam defaultFontName "Architects daughter" -title BPN-EDC configuration (simplified) +title Receive EDC URLs participant "Trace-X" as TX +participant "BPN-EDC configuration" as BEC participant "DiscoveryFinder" as DF -participant "Receiver BPN" as R -participant "BPN-EDC config" as BEC activate TX -TX -> BEC: Look up URL for receiver +TX -> BEC: Look up URLs for configured BPN activate BEC -BEC --> TX: URL +BEC --> TX: URLs deactivate BEC -TX -> R: Request -activate R -alt Request with config URL successful -R --> TX: Response -deactivate R -else Request with config URL unsuccessful -TX -> DF: Look up URLs for receiver +TX -> DF: Look up URLs for configured BPN activate DF DF --> TX: URLs deactivate DF -loop For each provided URL -TX -> R: Request -activate R -break Success -R --> TX: Response -deactivate R -end -end -alt Request with all DiscoveryFinder URLs unsuccessful -TX -> TX: Error -end -end +TX -> TX: Merge URLs into list (no duplicates) @enduml