bcgov / bcgov/itvr

ITVR - Automation: Email Notification for Errors in CRA File Exchange Automation

Open
#414 1 comment 0 reactions 0 assignees View on GitHub
Low Story
Dominant language
Python
Stars
2
Forks
9
PR merge metrics
No merged PRs in 30d

Description

**Description:**
The goal of this task is to create a mechanism to notify government users and the development team via email whenever there's a failure in the CRA file exchange process. This will help the respective stakeholders to be promptly informed and act on the issue, ensuring smooth and uninterrupted operations.

- The system should detect any failures in the file exchange process.
- Upon error detection, an email should be sent to both the government console users and the dev team. The email should detail the nature of the error and the stage at which the error occurred.
- Both government users and the dev team should confirm receipt and clarity of the error notification email.

**Acceptance Criteria:**
Given I am a government console user and developer,
When there is a problem with the automated CRA data file exchange,
Then I want to receive an email notifying me the data file exchange has failed.

**Development Checklist:**
- [ ] Understand and map out the CRA file exchange process.
- [ ] Define and code the error conditions based on the error points mentioned.
- [ ] Test the error detection and email notification module for different error scenarios.
- [ ] The system should detect any failures in the file exchange process.
- [ ] Upon error detection, an email should be sent to both the government console users and the dev team. The email should detail the nature of the error and the stage at which the error occurred.
- [ ] Both government users and the dev team should confirm receipt and clarity of the error notification email.

**Error Points:**
These error points should be the triggers to send a notification email.
- Failure to upload the file to the CRA system.
- Uploaded file cannot be processed by the CRA system.
- The file processed and returned by CRA fails to upload into the console.
# Dependencies

## Blocked By

- [ ] bcgov/itvr/issues/566

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.