Skip to content

Commit

Permalink
Merge pull request #1093 from ds-crehm/main
Browse files Browse the repository at this point in the history
chore(documentation): #915 BPN-EDC configuration documentation
  • Loading branch information
ds-mwesener committed Jun 24, 2024
2 parents cac9e41 + 121c789 commit 61ed31a
Show file tree
Hide file tree
Showing 2 changed files with 31 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[]

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]
....
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
22 changes: 22 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,22 @@
@startuml
skinparam monochrome true
skinparam shadowing false
skinparam defaultFontName "Architects daughter"

title Receive EDC URLs
participant "Trace-X" as TX
participant "BPN-EDC configuration" as BEC
participant "DiscoveryFinder" as DF

activate TX
TX -> BEC: Look up URLs for configured BPN
activate BEC
BEC --> TX: URLs
deactivate BEC
TX -> DF: Look up URLs for configured BPN
activate DF
DF --> TX: URLs
deactivate DF
TX -> TX: Merge URLs into list (no duplicates)

@enduml

0 comments on commit 61ed31a

Please sign in to comment.