Delivery Status via Email

[JohnNKing]

Story

As an ETOR partner, in order to confirm that messages I submitted were delivered to the correct location, I need to receive an email report identifying the messages I sent and their delivery status.


Pre-conditions

• No automation needed at this time

Acceptance Criteria

• We've documented the process for determining the delivery status of a message for a given partner.
• An email has been sent to a to a partner identifying the messages sent and the delivery status

Tasks

Research

• Determine email accounts to send to
• Determine means of identifying messages (ex. Message Control ID)

Engineering

• Engineering work needed to complete the story
• Foundational: Technical runway work to support this and future efforts

Definition of Done

• Documentation tasks completed
  • Documentation and diagrams created or updated
    • ADRs (/adr folder)
    • Main README.md
    • Other READMEs in the repo
    • If applicable, update the ReportStream Setup section in README.md
  • Threat model updated
  • API documentation updated
• Code quality tasks completed
  • Code refactored for clarity and no design/technical debt
  • Adhere to separation of concerns; code is not tightly coupled, especially to 3rd party dependencies
• Testing tasks completed
  • Load tests passed
  • Additional e2e tests created
  • Additional RS e2e assertions created in the rs-e2e project for any new transformations. Includes improvements to the assertion code required to make the new assertions
• Build & Deploy tasks completed
  • Build process updated
  • API(s) are versioned
  • Feature toggles created and/or deleted. Document the feature toggle
  • Source code is merged to the main branch

Note: Please remove any DoD items that are not applicable

Research Questions

• Optional: Any initial questions for research

Decisions

• Optional: Any decisions we've made while working on this story

Notes

• this applies to all messages a partner sends in some timeframe; successes and errors
• do we want to apply a time scope to this, regarding what messages show up in the report?
• cannot use PHI if sending by email
• what should the email look like?
• what data?
• "report" as attachment
• messages can come in via SFTP or REST
• process starts when we pull message
• manual API call to link messages together? might already be linked in the metadata table
• think of it as 2 things: pull data out of RS, pull data from SFTP ingest
• can we just start in RS? what are the chances that something doesn't actually get into RS?
• if there are any pending or error statuses, what would the partner do with that information?
• how quickly does the partner need the final delivery status information?