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 21, 2024
1 parent 700b9f2 commit 18e1e2d
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/src/docs/user/user-manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,18 @@ Possibility to check the network status based on logfiles and will provide acces

==== BPN-EDC configuration

In the BPN-EDC configuration screen an admin user can add URLs for BPNs. Any URLs here will be used directly for the configured BPN instead of looking up the URL with the EDC DiscoveryFinder service. Existing configurations can be edited or removed.
In the BPN-EDC configuration screen an admin user can add URLs for BPNs. Existing configurations can be edited or removed.

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.

[plantuml, target=bpn-edc-configuration, format=svg]
....
include::../../uml-diagrams/user-manual/bpn-edc-configuration.puml[]
....

==== Contracts - view and export

In the Contracts view an admin user can view contract agreements and sort them by the contract ID.
Expand Down
40 changes: 40 additions & 0 deletions docs/src/uml-diagrams/user-manual/bpn-edc-configuration.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
@startuml
skinparam monochrome true
skinparam shadowing false
skinparam defaultFontName "Architects daughter"

title BPN-EDC configuration (simplified)
participant "Trace-X" as TX
participant "DiscoveryFinder" as DF
participant "Receiver BPN" as R
participant "BPN-EDC config" as BEC

activate TX
TX -> BEC: Look up URL for receiver
activate BEC
BEC --> TX: URL
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
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

@enduml

0 comments on commit 18e1e2d

Please sign in to comment.