CCM-12608: Added C4 diagrams for nhsapp callback (#74)

* CCM-12608: Added C4 diagrams for nhsapp callback

* CCM-12608: Separated sequence diagram

* CCM-12608: Added C4 diagrams for nhsapp callback

* CCM-12608: Separated sequence diagram

* Merged.

* removed direct ref to diagram include in report generator page.

---------

Co-authored-by: Ross Buggins <ross.buggins@nhs.net>

Author: tdroza-nhs

docs/_includes/diagram.html

@@ -2,7 +2,7 @@
     | where_exp:"diagram", "diagram.title == include.title"
     | first %}
 
-<h3>{{ diagram.title }}</h3>
+<h3>{{ include.title }}</h3>
 <div>{{ diagram.description }}</div>
 <div>C4: {{ diagram.c4type }}</div>
 

docs/_layouts/architecture.html

@@ -10,11 +10,11 @@ <h2>Diagrams</h2>
 
 {% for diagramtitle in page.diagrams %}
 
-  {% assign diagram = site.diagrams
+  <!-- {% assign diagram = site.diagrams
       | where_exp:"diagram", "diagram.title == diagramtitle"
-      | first %}
+      | first %} -->
 
-  {% include diagram.html title=diagram.title %}
+  {% include diagram.html title=diagramtitle %}
 {% endfor %}
 
 

docs/architecture/c4/notifhir/tracker/listener/index.md

@@ -5,12 +5,13 @@ parent:  Digital Letter Status Reports
 nav_order: 1
 has_children: true
 is_not_draft: false
-last_modified_date: 2024-05-28
-owner: Ross Buggins
-author: Ross Buggins
-diagrams: [c4code-tracker-listener]
+last_modified_date: 2025-10-17
+owner: Tom D'Roza
+author: Tom D'Roza
+diagrams: [c4code-tracker-listener, c4component-nhsapp-callback, sequence-nhsapp-callback]
 events-raised: [reporting-daily-report-generated]
 events-consumed: []
 description: Listens to all events and generates up the report
 c4type: code
+
 ---

docs/collections/_diagrams/c4Component-nhsapp-callback.md

@@ -0,0 +1,22 @@
+---
+
+title: c4Component-nhsapp-callback
+
+---
+
+```mermaid
+architecture-beta
+    group CallbackHandler(cloud)[NHSApp Callback Handler]
+    service nhsapp(server)[NHS App]
+    service apiGateway(aws:arch-amazon-api-gateway)[API Gateway]
+    service lambda(logos:aws-lambda)[NHS App Callback Handler] in CallbackHandler
+    service sqs(logos:aws-sqs)[Callback Queue] in CallbackHandler
+    service ddb(logos:aws-dynamodb)[Items With TTL] in CallbackHandler
+    service docReadEvent(aws:res-amazon-eventbridge-event)[DigitalLetterRead Event]
+
+    nhsapp:R --> L:apiGateway
+    apiGateway:R --> L:sqs
+    sqs:R --> L:lambda
+    lambda:B --> T:ddb
+    lambda:R --> L:docReadEvent
+```

docs/collections/_diagrams/c4code-printer-sendtoqueue.md

@@ -9,7 +9,7 @@ description: PDM Upload
    architecture-beta
     group createTtl(cloud)[Time_To_Live]
 
-    service db(logos:aws-dynamodb)[DynamoDB] in createTtl
+    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]

docs/collections/_diagrams/c4component-nhsapp-callback.md

@@ -0,0 +1,22 @@
+---
+
+title: c4component-nhsapp-callback
+
+---
+
+```mermaid
+architecture-beta
+    group CallbackHandler(cloud)[NHSApp Callback Handler]
+    service nhsapp(server)[NHS App]
+    service apiGateway(aws:arch-amazon-api-gateway)[API Gateway]
+    service lambda(logos:aws-lambda)[NHS App Callback Handler] in CallbackHandler
+    service sqs(logos:aws-sqs)[Callback Queue] in CallbackHandler
+    service ddb(logos:aws-dynamodb)[Items With TTL] in CallbackHandler
+    service docReadEvent(aws:res-amazon-eventbridge-event)[DigitalLetterRead Event]
+
+    nhsapp:R --> L:apiGateway
+    apiGateway:R --> L:sqs
+    sqs:R --> L:lambda
+    lambda:B --> T:ddb
+    lambda:R --> L:docReadEvent
+```

docs/diagrams/nhsapp-callback-sequence.md

@@ -0,0 +1,26 @@
+---
+
+title: sequence-nhsapp-callback
+
+---
+
+```mermaid
+    sequenceDiagram
+    participant nhsapp as NHSApp
+    participant apig as API Gateway
+    participant sqs as SQS<br/>Callback Queue
+    participant lambda as Lambda<br/>NHS App Callback Handler
+    participant ddb as DynamoDB<br/>Items With TTL
+    participant eb as Event Bridge
+
+    nhsapp ->> apig: POST /callback
+    activate apig
+    apig ->> sqs: Send message
+    apig -->> nhsapp: 200 OK
+    deactivate apig
+    sqs ->> lambda: Invoke asynchronously
+    activate lambda
+    lambda ->> ddb: Delete TTL
+    lambda ->> eb: DigitalLetterRead event
+    deactivate lambda
+```