Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(documentation): #915 BPN-EDC configuration documentation #1093

Merged
merged 4 commits into from
Jun 24, 2024
Merged

chore(documentation): #915 BPN-EDC configuration documentation #1093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18e1e2d
chore(documentation): #915 update BPN-EDC configuration in docu
ds-crehm Jun 21, 2024
dc5d161
Merge remote-tracking branch 'origin/main'
ds-crehm Jun 21, 2024
a539fd1
chore(documentation): #915 update BPN-EDC configuration in docu
ds-crehm Jun 24, 2024
121c789
Merge branch 'eclipse-tractusx:main' into main
ds-crehm Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/src/docs/user/user-manual.adoc
View file
Open in desktop
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
View file
Open in desktop
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
Loading