Events

2024-05-28 | 📑 1742 words | ⏱ 18 mins | 🧾 History | ✍ Ross Buggins | 🔑 NHS Notify

Events

Known Issues / Todo

• ⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Full Screen

Events Summary

MESH Services

Consumes	Microservice	Produces
	MESH Report Sender
	MESH Timer
	MESH Poller	MESHInboxMessageReceived
MESHInboxMessageDownloaded	MESH Acknowledger	MESHInboxMessageAcknowledged
MESHInboxMessageReceived	MESH Retriever	MESHInboxMessageDownloaded

Messages Client

Consumes	Microservice	Produces
	Notify Callbacks
PDMResourceAvailable	Notify Client	MessageRequestSubmitted

PDM Services

Consumes	Microservice	Produces
MESHInboxMessageDownloaded	PDM Uploader	PDMResourceSubmitted
PDMResourceSubmitted PDMResourceUnavailable	PDM Poller	PDMResourceAvailable PDMResourceUnavailable PDMResourceRetriesExceeded

Print Supplier Services

Consumes	Microservice	Produces
ItemDequeued	Send letter to print
EXTERNAL SupplierAPIPrintStatusUpdated	Events from Supplier API	PrintLetterTransitioned

Queue Services

Consumes	Microservice	Produces
	Timer
	Dequeuer	ItemDequeued
DigitalLetterRead	Remover	ItemRemoved
MESHInboxMessageDownloaded	Enqueuer	ItemEnqueued

Reporting

Consumes	Microservice	Produces
GenerateReport	Report Generator	ReportGenerated
MESHInboxMessageDownloaded MESHInboxMessageReceived MessageRequestSubmitted PDMResourceRetriesExceeded PDMResourceSubmitted LetterPrinted DigitalLetterRead ItemEnqueued ItemRemoved ItemDequeued	Report Recorder
ReportGenerated	Report Sender	ReportSent
	Report Scheduler	GenerateReport

Shared Event Bus

Consumes	Microservice	Produces
MessageRequestSubmitted MESHInboxMessageDownloaded MESHInboxMessageReceived PDMResourceRetriesExceeded LetterPrinted DigitalLetterRead	EXTERNAL - Notify Reporting
	EXTERNAL - Supplier API	EXTERNAL SupplierAPIPrintStatusUpdated

Viewer Services

Consumes	Microservice	Produces
	Letter Viewer Callbacks	DigitalLetterRead

Events Detailed Information

MESH Services

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
MESHInboxMessageAcknowledged	mesh-inbox-message-acknowledged	uk.nhs.notify.digital.letters.mesh.inbox.message.acknowledged.v1	MESH Acknowledger		uk.nhs.notify.digital.letters.mesh.inbox.message.acknowledged.v1.schema.json	digital-letters-mesh-inbox-message-acknowledged-data.schema.json
MESHInboxMessageDownloaded	mesh-inbox-message-downloaded	uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1	MESH Retriever	Enqueuer PDM Uploader Report Recorder MESH Acknowledger EXTERNAL - Notify Reporting	uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1.schema.json	digital-letters-mesh-inbox-message-downloaded-data.schema.json
MESHInboxMessageReceived	mesh-inbox-message-received	uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1	MESH Poller	Report Recorder MESH Retriever EXTERNAL - Notify Reporting	uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1.schema.json	digital-letters-mesh-inbox-message-received-data.schema.json

Messages Client

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
MessageRequestRejected	messages-request-rejected	uk.nhs.notify.digital.letters.messages.request.rejected.v1			uk.nhs.notify.digital.letters.messages.request.rejected.v1.schema.json	messages.status.rejected-data.v1.schema.json
MessageRequestSkipped	messages-request-skipped	uk.nhs.notify.digital.letters.messages.request.skipped.v1			uk.nhs.notify.digital.letters.messages.request.skipped.v1.schema.json	messages.request.skipped-data.v1.schema.json
MessageRequestSubmitted	messages-request-submitted	uk.nhs.notify.digital.letters.messages.request.submitted.v1	Notify Client	Report Recorder EXTERNAL - Notify Reporting	uk.nhs.notify.digital.letters.messages.request.submitted.v1.schema.json	messages.request.submitted-data.v1.schema.json

PDM Services

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
PDMResourceAvailable	pdm-resource-available	uk.nhs.notify.digital.letters.pdm.resource.available.v1	PDM Poller	Notify Client	uk.nhs.notify.digital.letters.pdm.resource.available.v1.schema.json	digital-letters-pdm-resource-available-data.schema.json
PDMResourceRetriesExceeded	pdm-resource-retries-exceeded	uk.nhs.notify.digital.letters.pdm.resource.retries.exceeded.v1	PDM Poller	Report Recorder EXTERNAL - Notify Reporting	uk.nhs.notify.digital.letters.pdm.resource.retries.exceeded.v1.schema.json	digital-letters-pdm-resource-retries-exceeded-data.schema.json
PDMResourceSubmissionRejected	pdm-resource-submission-rejected	uk.nhs.notify.digital.letters.pdm.resource.submission.rejected.v1			uk.nhs.notify.digital.letters.pdm.resource.submission.rejected.v1.schema.json	digital-letters-pdm-resource-submission-rejected-data.schema.json
PDMResourceSubmitted	pdm-resource-submitted	uk.nhs.notify.digital.letters.pdm.resource.submitted.v1	PDM Uploader	PDM Poller Report Recorder	uk.nhs.notify.digital.letters.pdm.resource.submitted.v1.schema.json	digital-letters-pdm-resource-submitted-data.schema.json
PDMResourceUnavailable	pdm-resource-unavailable	uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1	PDM Poller	PDM Poller	uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1.schema.json	digital-letters-pdm-resource-unavailable-data.schema.json

Print Supplier Services

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
LetterPrinted	print-printed	uk.nhs.notify.digital.letters.print.printed.v1		Report Recorder EXTERNAL - Notify Reporting	uk.nhs.notify.digital.letters.print.printed.v1.schema.json	digital-letter-base-data.schema.json
PrintLetterTransitioned	print-letter-transitioned	uk.nhs.notify.digital.letters.print.letter.transitioned.v1	Events from Supplier API		uk.nhs.notify.digital.letters.print.letter.transitioned.v1.schema.json	digital-letters-print-letter-transitioned-data.schema.json

Queue Services

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
ItemDequeued	queue-item-dequeued	uk.nhs.notify.digital.letters.queue.item.dequeued.v1	Dequeuer	Extract Attachment Report Recorder Send letter to print	uk.nhs.notify.digital.letters.queue.item.dequeued.v1.schema.json	digital-letters-queue-item-dequeued-data.schema.json
ItemEnqueued	queue-item-enqueued	uk.nhs.notify.digital.letters.queue.item.enqueued.v1	Enqueuer	Report Recorder	uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.json	digital-letters-queue-item-enqueued-data.schema.json
ItemRemoved	queue-item-removed	uk.nhs.notify.digital.letters.queue.item.removed.v1	Remover	Report Recorder	uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.json	digital-letters-queue-item-removed-data.schema.json

Reporting

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
GenerateReport	reporting-generate-report	uk.nhs.notify.digital.letters.reporting.generate.report.v1	Report Scheduler	Report Generator	uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.json	digital-letters-reporting-generate-report-data.schema.json
ReportGenerated	reporting-report-generated	uk.nhs.notify.digital.letters.reporting.report.generated.v1	Report Generator	Report Sender	uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.json	digital-letters-reporting-report-generated-data.schema.json
ReportSent	reporting-report-sent	uk.nhs.notify.digital.letters.reporting.report.sent.v1	Report Sender		uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.json	digital-letters-reporting-report-sent-data.schema.json

Shared Event Bus

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
EXTERNAL SupplierAPIPrintStatusUpdated	external-supplier-api-letter-printed	uk.nhs.notify.supplierapi.letter.printed.v1	EXTERNAL - Supplier API	Events from Supplier API	uk.nhs.notify.supplierapi.letter.printed.v1.schema.json	digital-letter-base-data.schema.json

Viewer Services

Nice Name	Title	Type	Produced By	Consumed By	Envelope	Data
DigitalLetterRead	viewer-digital-letter-read	uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1	Letter Viewer Callbacks	Remover Report Recorder EXTERNAL - Notify Reporting	uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.json	digital-letter-base-data.schema.json