Skip to content

Commit

Permalink
chore(documentation): eclipse-tractusx#915 update BPN-EDC configurati…
Browse files Browse the repository at this point in the history
…on in docu
  • Loading branch information
ds-crehm committed Jun 24, 2024
1 parent dc5d161 commit a539fd1
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 26 deletions.
4 changes: 2 additions & 2 deletions docs/src/docs/user/user-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
....
Expand Down
30 changes: 6 additions & 24 deletions docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit a539fd1

Please sign in to comment.