Skip to content

Commit 9f4f717

Browse files
committed
CCM-13278: Add MESH Acknowledge component & event. Minor updates to other events for consistency
1 parent a5609d7 commit 9f4f717

12 files changed

Lines changed: 103 additions & 32 deletions
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
3+
title: MESH Acknowledger
4+
parent: MESH Services
5+
nav_order: 4
6+
has_children: true
7+
last_modified_date: 2024-10-28
8+
owner: Tom D'Roza
9+
author: Tom D'Roza
10+
diagrams: [c4code-mesh-acknowledger]
11+
events-raised: [mesh-inbox-message-acknowledged]
12+
events-consumed: [mesh-inbox-message-downloaded]
13+
c4type: code
14+
---
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
3+
title: Send letter to print
4+
parent: Print Supplier Services
5+
nav_order: 9
6+
has_children: false
7+
is_not_draft: false
8+
last_modified_date: 2025-12-04
9+
owner: Ross Buggins
10+
author: Tom D'Roza
11+
diagrams: []
12+
events-raised: [external-supplier-api-letter-prepared]
13+
events-consumed: [queue-item-dequeued]
14+
c4type: code
15+
---
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
3+
title: c4code-mesh-acknowledger
4+
5+
---
6+
7+
## MESH Acknowledge
8+
9+
```mermaid
10+
architecture-beta
11+
group meshAcknowledger(cloud)[MeshAcknowledge]
12+
service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded Event]
13+
service meshAcknowledged(aws:res-amazon-eventbridge-event)[ MESHInboxMessageAcknowledged Event]
14+
service meshAckQueue(logos:aws-sqs)[MeshAcknowledgement Queue] in meshAcknowledger
15+
service meshAckLambda(logos:aws-lambda)[MeshAcknowledger] in meshAcknowledger
16+
service mesh(server)[MESH]
17+
18+
meshDownloaded:R -- L:meshAckQueue
19+
meshAckQueue:R --> L:meshAckLambda
20+
meshAckLambda:B --> T:mesh
21+
meshAckLambda:R --> L:meshAcknowledged
22+
```

docs/collections/_diagrams/c4code-mesh-retriever.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ title: c4code-mesh-retriever
1010
```mermaid
1111
architecture-beta
1212
group meshRetriever(cloud)[MeshRetriever]
13-
service meshDownloaded(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
14-
service pdmSaved(aws:res-amazon-eventbridge-event)[ MESHInboxMessageDownloaded Event]
13+
service meshReceived(aws:res-amazon-eventbridge-event)[MESHInboxMessageReceived Event]
14+
service meshDownloaded(aws:res-amazon-eventbridge-event)[ MESHInboxMessageDownloaded Event]
1515
service meshDownloadQueue(logos:aws-sqs)[MeshDownload Queue] in meshRetriever
1616
service meshDownloadLambda(logos:aws-lambda)[MeshDownload] in meshRetriever
1717
service mesh(server)[MESH]
1818
service s3(logos:aws-s3)[DocumentReference] in meshRetriever
1919
20-
meshDownloaded:R -- L:meshDownloadQueue
20+
meshReceived:R -- L:meshDownloadQueue
2121
meshDownloadQueue:R --> L:meshDownloadLambda
2222
meshDownloadLambda:T --> B:mesh
2323
meshDownloadLambda:B --> T:s3
24-
meshDownloadLambda:R --> L:pdmSaved
24+
meshDownloadLambda:R --> L:meshDownloaded
2525
```

docs/collections/_diagrams/c4code-mesh-statusreporter-sender.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,22 @@ architecture-beta
1010
group reportSender(cloud)[ReportSender]
1111
service reportGenerated(aws:res-amazon-eventbridge-event)[ReportGenerated Event]
1212
service sqs(logos:aws-sqs)[ReportSender Queue] in reportSender
13-
service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in reportSender
1413
service reportSenderLambda(logos:aws-lambda)[Report Sender] in reportSender
15-
service s3(logos:aws-s3)[Reports] in reportSender
16-
service reportSent(aws:res-amazon-eventbridge-event)[StatusReportSent Event]
1714
service mesh(server)[MESH]
18-
junction j1
15+
service clientConfig(aws:res-aws-systems-manager-parameter-store)[Client Configuration] in reportSender
16+
service s3(logos:aws-s3)[Reports] in reportSender
17+
junction j1 in reportSender
1918
junction j2
20-
junction j3
19+
service reportSent(aws:res-amazon-eventbridge-event)[ReportSent Event]
20+
2121
2222
reportGenerated:R --> L:sqs
2323
sqs:R --> L:reportSenderLambda
24-
clientConfig:B --> T:reportSenderLambda
25-
reportSenderLambda:B <-- T:s3
26-
reportSenderLambda:R -- L:j1
27-
j1:T -- B:j2
28-
j2:R --> L:mesh
29-
j1:B -- T:j3
30-
j3:R --> L:reportSent
24+
clientConfig:R -- T:reportSenderLambda
25+
s3:L -- T:reportSenderLambda
26+
j1:B --> T:reportSenderLambda
27+
reportSenderLambda:B --> T:mesh
28+
reportSenderLambda:R -- L:j2
29+
j2:R --> L:reportSent
3130
3231
```

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,21 @@ title: c4code-printer-sendtoprint
77

88
```mermaid
99
architecture-beta
10-
service itemReady(aws:res-amazon-eventbridge-event)[MESHInboxMessageDownloaded Event]
11-
service printQueue(logos:aws-sqs)[UploadToPDM Queue] in sendToPrint
10+
service itemDequeued(aws:res-amazon-eventbridge-event)[ItemDequeued Event]
11+
service printQueue(logos:aws-sqs)[Print Queue] in sendToPrint
1212
service printLambda(logos:aws-lambda)[Print] in sendToPrint
1313
service docRefBucket(logos:aws-s3)[DocumentReference] in sendToPrint
1414
service digLtrsBucket(logos:aws-s3)[DigitalLetters] in sendToPrint
15-
service pdmSubmitted(aws:res-amazon-eventbridge-event)[PDMResourceSubmitted Event]
16-
service pdmFailed(aws:res-amazon-eventbridge-event)[PDMResourceSubmissionFailed Event]
17-
group sendToPrint(cloud)[UploadToPDM]
15+
service letterPrepared(aws:res-amazon-eventbridge-event)[LetterPrepared Event]
16+
group sendToPrint(cloud)[SendToPrint]
1817
junction j1
1918
2019
21-
itemReady:R -- L:printQueue
20+
itemDequeued:R -- L:printQueue
2221
printQueue:R --> L:printLambda
2322
printLambda:B <-- T:docRefBucket
2423
printLambda:T --> B:digLtrsBucket
25-
printLambda:R -- L:j1
26-
j1:R --> L:pdmSubmitted
27-
j1:B --> L:pdmFailed
24+
printLambda:R --> L:letterPrepared
25+
2826
2927
```

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: c4code-printer-sendtoqueue
3-
description: PDM Upload
43
---
54

65
```mermaid

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,11 @@ additionalProperties: false
66
properties:
77
senderId:
88
$ref: ../defs/requests.schema.yaml#/properties/senderId
9+
reportPeriodStartTime:
10+
$ref: ../defs/mesh.schema.yaml#/properties/reportPeriodStartTime
11+
reportPeriodEndTime:
12+
$ref: ../defs/mesh.schema.yaml#/properties/reportPeriodEndTime
913
required:
1014
- senderId
15+
- reportPeriodStartTime
16+
- reportPeriodEndTime

src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ additionalProperties: false
66
properties:
77
senderId:
88
$ref: ../defs/requests.schema.yaml#/properties/senderId
9-
meshMailboxId:
10-
$ref: ../defs/mesh.schema.yaml#/properties/meshMailboxId
9+
meshMailboxReportsId:
10+
$ref: ../defs/mesh.schema.yaml#/properties/meshMailboxReportsId
1111
required:
1212
- senderId
13-
- meshMailboxId
13+
- meshMailboxReportsId

src/cloudevents/domains/digital-letters/2025-10-draft/defs/mesh.schema.yaml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,24 @@ properties:
1212
meshMailboxId:
1313
type: string
1414
minLength: 1
15-
description: Id of the mailbox
15+
description: Id of the mailbox used to submit letter requests and receive acknowledgements
1616
examples:
1717
- "MAILBOX01"
18+
meshMailboxReportsId:
19+
type: string
20+
minLength: 1
21+
description: Id of the mailbox used to receive daily reports
22+
examples:
23+
- "MAILBOX02"
24+
reportPeriodStartTime:
25+
type: string
26+
format: date-time
27+
description: Start time of the reporting period
28+
examples:
29+
- "2025-12-03T00:00:00Z"
30+
reportPeriodEndTime:
31+
type: string
32+
format: date-time
33+
description: End time of the reporting period
34+
examples:
35+
- "2025-12-04T23:59:59Z"

0 commit comments

Comments
 (0)