Events

2024-05-28 | 📑 1643 words | ⏱ 17 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
MESHInboxMessageDownloaded MESHInboxMessageInvalid	MESH Acknowledger	MESHInboxMessageAcknowledged
MESHInboxMessageReceived	MESH Downloader	MESHInboxMessageDownloaded MESHInboxMessageInvalid
	MESH Report Sender
	MESH Timer
	MESH Poller	MESHInboxMessageReceived MESHInboxMessageInvalid

Messages Client

Consumes	Microservice	Produces
PDMResourceAvailable	Notify Client	MessageRequestSubmitted
	Notify Callbacks

PDM Services

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

Print Supplier Services

Consumes	Microservice	Produces
FileSafe	Print Analyser	PDFAnalysed
PDFAnalysed	Print Sender
ItemDequeued	Print Scanner	FileSafe FileQuarantined
	Events from Supplier API	PrintLetterTransitioned

Queue Services

Consumes	Microservice	Produces
	Dequeuer	ItemDequeued
	Timer
MESHInboxMessageDownloaded	Enqueuer	ItemEnqueued
	Remover

Reporting

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

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 Downloader	Enqueuer PDM Uploader Report Recorder EXTERNAL - Notify Reporting MESH Acknowledger	uk.nhs.notify.digital.letters.mesh.inbox.message.downloaded.v1.schema.json	digital-letters-mesh-inbox-message-downloaded-data.schema.json
MESHInboxMessageInvalid	mesh-inbox-message-invalid	uk.nhs.notify.digital.letters.mesh.inbox.message.invalid.v1	MESH Downloader	MESH Acknowledger	uk.nhs.notify.digital.letters.mesh.inbox.message.invalid.v1.schema.json	digital-letters-mesh-inbox-message-invalid-data.schema.json
MESHInboxMessageReceived	mesh-inbox-message-received	uk.nhs.notify.digital.letters.mesh.inbox.message.received.v1	MESH Poller	Report Recorder EXTERNAL - Notify Reporting MESH Downloader	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
FileQuarantined	file-quarantined	uk.nhs.notify.digital.letters.print.file.quarantined.v1	Print Scanner		uk.nhs.notify.digital.letters.print.file.quarantined.v1.schema.json	digital-letters-print-file-quarantined-data.schema.json
FileSafe	file-safe	uk.nhs.notify.digital.letters.print.file.safe.v1	Print Scanner	Print Analyser	uk.nhs.notify.digital.letters.print.file.safe.v1.schema.json	digital-letters-print-file-safe-data.schema.json
InvalidAttachmentReceived	invalid-attachment-received	uk.nhs.notify.digital.letters.print.invalid.attachment.received.v1			uk.nhs.notify.digital.letters.print.invalid.attachment.received.v1.schema.json	digital-letters-print-invalid-attachment-received-data.schema.json
PDFAnalysed	pdf-analysed	uk.nhs.notify.digital.letters.print.pdf.analysed.v1	Print Analyser	Print Sender	uk.nhs.notify.digital.letters.print.pdf.analysed.v1.schema.json	digital-letters-print-pdf-analysed-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
DigitalLetterRead	queue-digital-letter-read	uk.nhs.notify.digital.letters.queue.digital.letter.read.v1			uk.nhs.notify.digital.letters.queue.digital.letter.read.v1.schema.json	digital-letters-queue-digital-letter-read-data.schema.json
ItemDequeued	queue-item-dequeued	uk.nhs.notify.digital.letters.queue.item.dequeued.v1	Dequeuer	Print Scanner Report Recorder Extract Attachment	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

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