Skip to content

Commit

Permalink
add sequence diagram to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ekl176 committed Jan 29, 2025
1 parent 0e4c777 commit 9ea9c19
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,43 @@

Java SpringBoot service that handles erv for a2j.

The erv wrapper connects to two external services in its current state. FitConnect and an EGVP Enterprise instance.
The interface of the EGVP-Enterprise instance is wrapped in a Restful http client.


Currently, the flow of a submission is supposed to flow like the graph describes:
```mermaid
sequenceDiagram
participant A2J
participant ErvWrapper
participant EGVPClient
participant FitConnect
A2J->>ErvWrapper: submit
activate ErvWrapper
ErvWrapper->>FitConnect: sendSubmission
deactivate ErvWrapper
FitConnect->>+ErvWrapper: incomingSubmissions
ErvWrapper-->>-EGVPClient: sendMessage
activate EGVPClient
alt poll until delviery confirmed
ErvWrapper->>EGVPClient: check Delviery Status
activate ErvWrapper
EGVPClient->>ErvWrapper: delivery Pending
deactivate ErvWrapper
else
EGVPClient->>ErvWrapper: Message Delivered
deactivate EGVPClient
activate ErvWrapper
ErvWrapper->>FitConnect: send confirmation to BundId
deactivate ErvWrapper
end
```

## Test Deployment
The Erv Wrapper and EGVPClient must share a filesystem to reference files to be sent.
Polling messages is disabled by default. Run the wrapper with ```--egvp.pollDeliveryStatus``` to enable polling to
retrieve message delivery confirmations.

## Prerequisites

Java 21, Docker for building + running the containerized application:
Expand Down

0 comments on commit 9ea9c19

Please sign in to comment.