CCM-12774: Updated event names. Added reporting architecture (#77)

tdroza-nhs · web-flow · commit 839038ebc61a · 2025-10-21T09:24:38.000+01:00
* CCM-12774: Started to make naming consistent between diagrams

* CCM-12774: Updated event names, icons. Added agreed reporting architecture
diff --git a/docs/architecture/c4/notifhir/mesh/statusreporter/index.md b/docs/architecture/c4/notifhir/mesh/statusreporter/index.md
@@ -8,7 +8,7 @@ is_not_draft: false
 last_modified_date: 2025-10-15
 owner: Ross Buggins
 author: Tom D'Roza
-diagrams: [c4code-mesh-statusreporter]
+diagrams: [c4code-mesh-statusreporter-scheduler, c4code-mesh-statusreporter-generator, c4code-mesh-statusreporter-sender]
 events-raised: [mesh-status-report-sent]
 events-consumed: [reporting-daily-report-generated]
 c4type: code
diff --git a/docs/assets/aws-icons-mermaid.json b/docs/assets/aws-icons-mermaid.json
diff --git a/docs/collections/_diagrams/c4code-mesh-poller.md b/docs/collections/_diagrams/c4code-mesh-poller.md
@@ -10,7 +10,7 @@ title: c4code-mesh-poller
 architecture-beta
     group meshPoller(cloud)[MeshPoller]
     service meshDownloaded(aws:res-amazon-eventbridge-event)[Scheduled Poll Event]
-    service pdmSaved(aws:res-amazon-eventbridge-event)[MESHFileAvailable Event]
+    service pdmSaved(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
     service meshPollLambda(logos:aws-lambda)[MeshPoll] in meshPoller
     service mesh(server)[MESH]
 
diff --git a/docs/collections/_diagrams/c4code-mesh-retriever.md b/docs/collections/_diagrams/c4code-mesh-retriever.md
@@ -10,8 +10,8 @@ title: c4code-mesh-retriever
 ```mermaid
 architecture-beta
     group meshRetriever(cloud)[MeshRetriever]
-    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHFileAvailable Event]
-    service pdmSaved(aws:res-amazon-eventbridge-event)[MESHFileDownloaded Event]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
+    service pdmSaved(aws:res-amazon-eventbridge-event)[ MESHInboxMessageDownloaded Event]
     service meshDownloadQueue(logos:aws-sqs)[MeshDownload Queue] in meshRetriever
     service meshDownloadLambda(logos:aws-lambda)[MeshDownload] in meshRetriever
     service mesh(server)[MESH]
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-generator.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-generator.md
@@ -0,0 +1,25 @@
+---
+
+title: c4code-mesh-statusreporter-generator
+
+---
+
+## Decisions
+
+1. ReportScheulder lambda publishes a `GenerateReport` event for each trust that has new report data in the previous 24 hours.
+2. The event metadata contains the trust ID so the ReportGenerator lambda knows which trust to generate a report for.
+
+```mermaid
+architecture-beta
+    group reportGenerator(cloud)[ReportScheduler]
+    service generateReportEvent(aws:res-amazon-eventbridge-event)[GenerateReport Event]
+    service reportGeneratorLambda(logos:aws-lambda)[Report Generator] in reportGenerator
+    service s3(logos:aws-s3)[Reports] in reportGenerator
+    service reportsdb(logos:aws-dynamodb)[Reports] in reportGenerator
+    service reportGeneratedEvent(aws:res-amazon-eventbridge-event)[ReportGenerated Event]
+
+    generateReportEvent:R -- L:reportGeneratorLambda
+    reportGeneratorLambda:T <-- B:reportsdb
+    reportGeneratorLambda:B --> T:s3
+    reportGeneratorLambda:R --> L:reportGeneratedEvent
+```
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-scheduler.md
@@ -1,14 +1,20 @@
 ---
 
-title: c4code-mesh-statusreporter-2
+title: c4code-mesh-statusreporter-scheduler
 
 ---
 
+## Decisions
+
+1. ReportScheulder lambda publishes a `GenerateReport` event for each trust that has new report data in the previous 24 hours.
+2. The event metadata contains the trust ID so the ReportGenerator lambda knows which trust to generate a report for.
+
 ```mermaid
 architecture-beta
     group reportScheduler(cloud)[ReportScheduler]
     service scheduledEvent(aws:res-amazon-eventbridge-event)[Scheduled Event]
     service reportSchedulerLambda(logos:aws-lambda)[Report Scheduler] in reportScheduler
+    service reportsdb(logos:aws-dynamodb)[Reports] in reportScheduler
     service report1Event(aws:res-amazon-eventbridge-event)[GenerateReport Trust1]
     service report2Event(aws:res-amazon-eventbridge-event)[GenerateReport Trust2]
     service report3Event(aws:res-amazon-eventbridge-event)[GenerateReport TrustN]
@@ -17,6 +23,7 @@ architecture-beta
     junction j3
 
     scheduledEvent:R -- L:reportSchedulerLambda
+    reportSchedulerLambda:T -- B:reportsdb
     reportSchedulerLambda:R -- L:j1
     j1:T -- B:j2
     j1:B -- T:j3
diff --git a/docs/collections/_diagrams/c4code-mesh-statusreporter-sender.md b/docs/collections/_diagrams/c4code-mesh-statusreporter-sender.md
@@ -1,11 +1,10 @@
 ---
 
-title: c4code-mesh-statusreporter
+title: c4code-mesh-statusreporter-sender
 
 ---
 
 
-
 ```mermaid
 architecture-beta
     group reportSender(cloud)[ReportSender]
diff --git a/docs/collections/_diagrams/c4code-pdm-poller.md b/docs/collections/_diagrams/c4code-pdm-poller.md
@@ -7,19 +7,37 @@ description: PDM Poller
 ### Questions
 
 1. What poll interval and duration is needed for the PDM Poller?
-2. Can the polling be managed within the lambda?
+
+### Decisions
+
+1. Use of an SQS Delay Queue to manage polling intervals
+2. `PDMResourceUnavailable` event to contain retry count
+3. PollPDM lambda to determine when max retries exceeded and emit a `PDMResourceRetriesExceeded` event
 
 ```mermaid
 architecture-beta
-    service eventBus(aws:res-amazon-eventbridge-event)[SavedToPDM Event]
-    service pdmReady(aws:res-amazon-eventbridge-event)[PDMDocumentReadyEvent]
+    service pdmResourceSubmitted(aws:res-amazon-eventbridge-event)[PDMResourceSubmitted Event]
+    service pdmResourceAvailable(aws:res-amazon-eventbridge-event)[PDMResourceAvailable Event]
+    service pdmResourceUnavailable2(aws:res-amazon-eventbridge-event)[PDMResourceAvailable Event]
+    service pdmRetriesExceeded(aws:res-amazon-eventbridge-event)[PDMResourceRetriesExceeded Event]
+    service pdmResourceUnavailable(aws:res-amazon-eventbridge-event)[PDMResourceUnavailable Event]
     group checkPdm(cloud)[PDMPoller]
-    service pollPdmQueue(logos:aws-sqs)[PollPDM Queue] in checkPdm
+    service pollPdmQueue(logos:aws-sqs)[PollPDM SQS Delay Queue] in checkPdm
     service pollPdmLambda(logos:aws-lambda)[PollPDM] in checkPdm
     service pdm(server)[PDM]
+    junction j1
+    junction j2
+    junction j3
 
-    eventBus:R -- L:pollPdmQueue
+    pdmResourceSubmitted:B -- T:j3
+    pdmResourceUnavailable:T -- B:j3
+    j3:R --> L:pollPdmQueue
     pollPdmQueue:R --> L:pollPdmLambda
-    pollPdmLambda:B --> L:pdmReady
     pollPdmLambda:R <--> L:pdm
+    pollPdmLambda:B -- T:j1
+    j1:R --> L:pdmResourceUnavailable2
+    j1:B -- T:j2
+    j2:R --> L:pdmResourceAvailable
+    j2:B --> L:pdmRetriesExceeded
+
 ```
diff --git a/docs/collections/_diagrams/c4code-pdm-upload.md b/docs/collections/_diagrams/c4code-pdm-upload.md
@@ -7,8 +7,8 @@ description: PDM Upload
 
 ```mermaid
 architecture-beta
-    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHFileDownloaded Event]
-    service pdmSaved(aws:res-amazon-eventbridge-event)[SavedToPDM Event]
+    service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded Event]
+    service pdmSaved(aws:res-amazon-eventbridge-event)[PDMResourceSubmitted Event]
     group uploadToPdm(cloud)[UploadToPDM]
     service uploadQueue(logos:aws-sqs)[UploadToPDM Queue] in uploadToPdm
     service uploadLambda(logos:aws-lambda)[UploadToPDM] in uploadToPdm
diff --git a/docs/collections/_diagrams/c4code-printer-removefromqueue.md b/docs/collections/_diagrams/c4code-printer-removefromqueue.md
@@ -1,19 +1,21 @@
 ---
 
 title: c4code-printer-removefromqueue
-description: PDM Upload
+description: Manage TTL
 ---
 
 
 ```mermaid
 architecture-beta
    group manageTTL(cloud)[ManageTTL]
+   service pollEvent(aws:res-amazon-eventbridge-event)[Scheduled Poll TTL Event]
    service manageLambda(logos:aws-lambda)[Poll TTL] in manageTTL
    service manageDb(logos:aws-dynamodb)[ItemsWithTTL] in manageTTL
    service ttlStream(aws:res-amazon-dynamodb-stream) in manageTTL
    service manageTtlExpiry(logos:aws-lambda)[HandleTTLExpiry] in manageTTL
-   service printTTLExpired(aws:res-amazon-eventbridge-event)[PrintTTLExpired] in manageTTL
+   service printTTLExpired(aws:res-amazon-eventbridge-event)[ItemReady Event] in manageTTL
 
+   pollEvent:R -- L:manageLambda
    manageLambda:R -- L:manageDb
    manageDb:R -- L:ttlStream
    ttlStream:B -- T:manageTtlExpiry
diff --git a/docs/collections/_diagrams/c4code-printer-sendtoqueue.md b/docs/collections/_diagrams/c4code-printer-sendtoqueue.md
@@ -12,8 +12,8 @@ description: PDM Upload
     service db(logos:aws-dynamodb)[ItemsWithTTL] in createTtl
     service createLambda(logos:aws-lambda)[Create PrintLetter TTL] in createTtl
     service queue(logos:aws-sqs)[SQS] in createTtl
-    service storedEvent(aws:res-amazon-eventbridge-event)[MESHFileDownloaded event]
-    service scheduledEvent(aws:res-amazon-eventbridge-event)[PrintingScheduled event]
+    service storedEvent(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded event]
+    service scheduledEvent(aws:res-amazon-eventbridge-event) [ItemEnqueued event]
 
     storedEvent:R --> L:queue
     queue:R --> L:createLambda
diff --git a/docs/collections/_diagrams/c4code-tracker-listener.md b/docs/collections/_diagrams/c4code-tracker-listener.md
@@ -6,18 +6,21 @@ title: c4code-tracker-listener
 
 ```mermaid
 architecture-beta
-    group reportGenerator(cloud)[ReportGenerator]
-    service report1Event(aws:res-amazon-eventbridge-event)[GenerateReport Trust1]
-    service reportGenerated(aws:res-amazon-eventbridge-event)[ReportGenerated Event]
-    service reportGeneratorLambda(logos:aws-lambda)[Report Generator] in reportGenerator
-    service ddb(aws:arch-amazon-dynamodb)[LetterRequests] in reportGenerator
-    service s3(logos:aws-s3)[Reports] in reportGenerator
-    junction j1 in reportGenerator
+    group statusRecorder(cloud)[StatusRecorder]
+    service report1Event(aws:res-amazon-eventbridge-event)[DigitalLetterRead Event]
+    service report2Event(aws:res-amazon-eventbridge-event)[PrintingDispatched Event]
+    service report3Event(aws:res-amazon-eventbridge-event)[NHSAppMessageRequested Event]
+    service reportGeneratorLambda(logos:aws-lambda)[Status Recorder] in statusRecorder
+    service ddb(aws:arch-amazon-dynamodb)[LetterRequests] in statusRecorder
+    junction j1
+    junction j2
 
-    report1Event:R -- L:reportGeneratorLambda
-    reportGeneratorLambda:B <-- T:ddb
-    reportGeneratorLambda:R -- L:j1
-    j1:B --> T:s3
-    j1:R --> L:reportGenerated
+    j2:B -- T:j1
+    report1Event:R -- L:j2
+    report2Event:R -- L:j1
+    report3Event:R -- B:j1
+
+    j1:R --> L:reportGeneratorLambda
+    reportGeneratorLambda:B --> T:ddb
 
 ```
diff --git a/docs/collections/_diagrams/c4component-pdm.md b/docs/collections/_diagrams/c4component-pdm.md
@@ -10,8 +10,8 @@ title: c4component-pdm
     Container_Boundary(meshcontainer, "PDM Services Container") {
 
          Component(poller, "Trigger getting message list")
-         Component(retriemeta, "Get Message List")
-         Component(saver, "Save message contents")
+         Component(retriemeta, "PDM Poller")
+         Component(saver, "PDM Uploader")
 
 
     }
diff --git a/docs/collections/_diagrams/c4component-print.md b/docs/collections/_diagrams/c4component-print.md
@@ -9,7 +9,7 @@ title: c4Component-print
     title Mesh Component
     Container_Boundary(meshcontainer, "Print Supplier Services Container") {
 
-         Component(timer, "Send To Printer")
+         Component(printer, "Send To Printer")
          Component(poller, "Get Callbacks from printer")
 
 
diff --git a/docs/collections/_diagrams/c4component-queue.md b/docs/collections/_diagrams/c4component-queue.md
@@ -7,7 +7,7 @@ title: c4component-queue
 ```mermaid
     C4Component
     title Queue Component
-    Container_Boundary(meshcontainer, "Queue Services Container") {
+    Container_Boundary(meshcontainer, "Print Queue Services Container") {
 
          Component(adder, "Add to queue")
          Component(remover, "Remove from queue")
diff --git a/docs/collections/_diagrams/c4component-statusreports.md b/docs/collections/_diagrams/c4component-statusreports.md
@@ -10,13 +10,15 @@ c4type: code
     title Status Reports Component
     Container_Boundary(meshcontainer, "Status Reports Container") {
 
+         Component(reportscheduler, "Daily Report Scheduler")
          Component(dailygenerator, "Daily Report Generator")
-         Component(meshlistener, "MESH Event Listener")
+         Component(reportsender, "Report Sender")
          Component(pdmlistener, "PDM Event Listener")
          Component(printerlistener, "Printer Event Listener")
 
 
-         Rel(meshlistener, dailygenerator, "EventX", "CloudEvent")
+         Rel(reportscheduler, dailygenerator, "GenerateReport", "CloudEvent")
+         Rel(dailygenerator, reportsender, "ReportGenerated", "CloudEvent")
          Rel(pdmlistener, dailygenerator, "EventX", "CloudEvent")
          Rel(printerlistener, dailygenerator, "EventX", "CloudEvent")
 
diff --git a/docs/diagrams/create-print-ttl-sequence.md b/docs/diagrams/create-print-ttl-sequence.md
@@ -1,6 +1,6 @@
 ---
 layout: page
-title: Fallback to Printing Sequence Diagram
+title: Create Print TTL Sequence Diagram
 nav_order: 3
 parent: Diagrams
 has_children: false
@@ -19,7 +19,7 @@ sequenceDiagram
   participant dynamo as DynamoDB
 
 
-  eb ->> sqs: MESHFileDownloaded event
+  eb ->> sqs: MESHInboxMessageDownloaded event
   sqs ->> createTTL:
   createTTL ->> dynamo: Insert (24h TTL)
 ```
diff --git a/docs/diagrams/digital-letters-flow.md b/docs/diagrams/digital-letters-flow.md
@@ -17,10 +17,11 @@ flowchart TD
         Start(["Start"])
         Start --> Mesh[Receive MESH file]
         Mesh --> S3@{shape: disk, label: "Save to S3"}
-        S3 --> FileSize{"PDF < 8MB?"}
-        FileSize -->|Yes| PDM["Upload to PDM"]
-        FileSize -->|No| SupplierAPI@{shape: doc, label:"Send to SupplierAPI"}
-        PDM --> NHSApp["Send NHSApp msg"]
+        S3 --> PDM["Upload to PDM"]
+        PDM --> PDMSuccess{"Upload successful?"}
+        PDMSuccess -->|Yes| NHSApp["Send NHSApp msg"]
+
+        PDMSuccess -->|No| SupplierAPI@{shape: doc, label:"Send to SupplierAPI"}
         NHSApp --> PDFRead{"PDF Read?"}
         PDFRead -->|Yes| End(["End"])
         PDFRead -->|No| SupplierAPI
diff --git a/docs/diagrams/manage-print-ttl-sequence.md b/docs/diagrams/manage-print-ttl-sequence.md
@@ -0,0 +1,29 @@
+---
+layout: page
+title: Mnanage Printing TTL Sequence Diagram
+nav_order: 4
+parent: Diagrams
+has_children: false
+child_nav_order: reversed
+is_not_draft: false
+last_modified_date: 2025-10-08
+owner: Tom D'Roza
+author: Tom D'Roza
+---
+
+```mermaid
+   sequenceDiagram
+     participant eb as Event Bridge
+     participant pollTTLLambda as Lambda<br/>PollTTL
+     participant ddb as DynamoDB
+     participant ttlStream as DynamoDB Stream
+     participant handleTTLLambda as Lambda<br/>HandleTTLExpiry
+
+    eb ->> pollTTLLambda: Scheduled Poll TTL Event
+    pollTTLLambda ->> ddb: Delete items with expired TTL
+    ddb ->> ttlStream: Stream of deleted items
+    ttlStream ->> handleTTLLambda:
+    opt Items with TTL in past (unread attachments)
+      handleTTLLambda ->> eb: PrintTTLExpired Event
+    end
+```
diff --git a/docs/diagrams/pdm-poll.md b/docs/diagrams/pdm-poll.md
@@ -19,15 +19,18 @@ sequenceDiagram
   participant pdmPoller as Lambda<br/>PDMPoller
   participant pdm as PDM
 
-  eventBus -) pdmPollerQueue: SavedToPDM Event(pdmID)
+  eventBus -) pdmPollerQueue: PDMResourceSubmitted Event(pdmID)<br/>PDMResourceUnavailable Event(pdmID)
   activate pdmPollerQueue
   pdmPollerQueue ->> pdmPoller:
   deactivate pdmPollerQueue
+  activate pdmPoller
   loop Until resource contains payload
     pdmPoller ->> pdm: GetSpecificResource(pdmID)
     activate pdm
     pdm -->> pdmPoller: DocumentReference
+    pdm ->> eventBus: PDMResourceUnavailable(pdmID) [if no payload]
     deactivate pdm
   end
-  pdmPoller -) eventBus: PDMDocumentReadyEvent(pdmID)
+  pdmPoller -) eventBus: PDMResourceAvailable(pdmID)
+  deactivate pdmPoller
 ```
diff --git a/docs/diagrams/pdm-upload.md b/docs/diagrams/pdm-upload.md
@@ -20,7 +20,7 @@ sequenceDiagram
   participant s3 as S3
   participant pdm as PDM
 
-  eventBus -) pdmUploadQueue: MESHFileAvailable Event
+  eventBus -) pdmUploadQueue: MESHInboxMessageReceived Event
   activate pdmUploadQueue
   pdmUploadQueue ->> pdmUpload:
   deactivate pdmUploadQueue
@@ -31,6 +31,6 @@ sequenceDiagram
   activate pdm
   pdm -->> pdmUpload: 200 OK
   deactivate pdm
-  pdmUpload -) eventBus: SavedToPDM Event(meshFileId)
+  pdmUpload -) eventBus: PDMResourceSubmitted Event(meshFileId)
   deactivate pdmUpload
 ```
