Merge pull request #5614 from raft-tech/5599-email-template-updates

Update Submission Email Templates

Author: elipe17

tdrs-backend/tdpservice/email/helpers/data_file.py

@@ -63,6 +63,22 @@ def get_tanf_aggregates_context_count(datafile_summary):
     }
 
 
+def get_tanf_total_errors_context_count(datafile_summary):
+    """Return the sum of total errors across all months for aggregate/stratum TANF files."""
+    case_aggregates = datafile_summary.case_aggregates or {}
+    total_errors = 0
+
+    if "months" in case_aggregates:
+        for month in case_aggregates["months"]:
+            total_errors += (
+                month["total_errors"]
+                if "total_errors" in month and month["total_errors"] != "N/A"
+                else 0
+            )
+
+    return {"total_errors": total_errors}
+
+
 def get_fra_aggregates_context_count(datafile_summary):
     """Return the relevant context data from case aggregates for FRA files."""
     case_aggregates = datafile_summary.case_aggregates or {}
@@ -104,6 +120,11 @@ def send_data_submitted_email(
     fiscal_year = datafile.fiscal_year
     submitted_by = datafile.submitted_by
 
+    is_aggregate = datafile.section in (
+        DataFile.Section.AGGREGATE_DATA,
+        DataFile.Section.STRATUM_DATA,
+    )
+
     context = {
         "stt_name": stt_name,
         "submission_date": submission_date,
@@ -113,6 +134,7 @@ def send_data_submitted_email(
         "file_type": file_type,
         "status": datafile_summary.status,
         "has_errors": datafile_summary.status != DataFileSummary.Status.ACCEPTED,
+        "is_aggregate": is_aggregate,
         "url": settings.FRONTEND_BASE_URL,
     }
 
@@ -133,7 +155,10 @@ def send_data_submitted_email(
             | DataFile.ProgramType.SSP
             | DataFile.ProgramType.TRIBAL
         ):
-            context.update(get_tanf_aggregates_context_count(datafile_summary))
+            if is_aggregate:
+                context.update(get_tanf_total_errors_context_count(datafile_summary))
+            else:
+                context.update(get_tanf_aggregates_context_count(datafile_summary))
 
             template_options = {
                 DataFileSummary.Status.ACCEPTED: TanfDataFileEmail.ACCEPTED.value,

tdrs-backend/tdpservice/email/helpers/test/test_data_file.py

@@ -6,6 +6,8 @@
 
 from tdpservice.data_files.models import DataFile
 from tdpservice.email.helpers.data_file import (
+    get_tanf_aggregates_context_count,
+    get_tanf_total_errors_context_count,
     send_data_submitted_email,
     send_stuck_file_email,
 )
@@ -200,6 +202,120 @@ def test_send_data_submitted_email(
     assert mail.outbox[0].body == msg
 
 
+class TestGetTanfAggregatesContextCount:
+    """Tests for get_tanf_aggregates_context_count."""
+
+    def test_with_case_data(self):
+        """Test aggregation with typical case data months."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = {
+            "months": [
+                {
+                    "month": "Jan",
+                    "accepted_without_errors": 10,
+                    "accepted_with_errors": 2,
+                },
+                {
+                    "month": "Feb",
+                    "accepted_without_errors": 8,
+                    "accepted_with_errors": 3,
+                },
+                {
+                    "month": "Mar",
+                    "accepted_without_errors": 12,
+                    "accepted_with_errors": 1,
+                },
+            ],
+            "rejected": 5,
+        }
+        result = get_tanf_aggregates_context_count(dfs)
+        assert result == {
+            "cases_without_errors": 30,
+            "cases_with_errors": 6,
+            "records_unable_to_process": 5,
+        }
+
+    def test_with_na_values(self):
+        """Test aggregation handles N/A values from rejected status."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = {
+            "months": [
+                {
+                    "month": "Jan",
+                    "accepted_without_errors": "N/A",
+                    "accepted_with_errors": "N/A",
+                },
+            ],
+            "rejected": 0,
+        }
+        result = get_tanf_aggregates_context_count(dfs)
+        assert result == {
+            "cases_without_errors": 0,
+            "cases_with_errors": 0,
+            "records_unable_to_process": 0,
+        }
+
+    def test_with_empty_aggregates(self):
+        """Test aggregation handles empty/None case_aggregates."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = None
+        result = get_tanf_aggregates_context_count(dfs)
+        assert result == {
+            "cases_without_errors": 0,
+            "cases_with_errors": 0,
+            "records_unable_to_process": 0,
+        }
+
+
+class TestGetTanfTotalErrorsContextCount:
+    """Tests for get_tanf_total_errors_context_count."""
+
+    def test_with_total_errors_data(self):
+        """Test aggregation sums total_errors across months."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = {
+            "months": [
+                {"month": "Jan", "total_errors": 5},
+                {"month": "Feb", "total_errors": 3},
+                {"month": "Mar", "total_errors": 7},
+            ],
+        }
+        result = get_tanf_total_errors_context_count(dfs)
+        assert result == {"total_errors": 15}
+
+    def test_with_na_values(self):
+        """Test aggregation handles N/A values from rejected status."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = {
+            "months": [
+                {"month": "Jan", "total_errors": "N/A"},
+                {"month": "Feb", "total_errors": "N/A"},
+            ],
+        }
+        result = get_tanf_total_errors_context_count(dfs)
+        assert result == {"total_errors": 0}
+
+    def test_with_empty_aggregates(self):
+        """Test aggregation handles empty/None case_aggregates."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = None
+        result = get_tanf_total_errors_context_count(dfs)
+        assert result == {"total_errors": 0}
+
+    def test_with_mixed_values(self):
+        """Test aggregation handles mix of numeric and N/A values."""
+        dfs = DataFileSummary()
+        dfs.case_aggregates = {
+            "months": [
+                {"month": "Jan", "total_errors": 5},
+                {"month": "Feb", "total_errors": "N/A"},
+                {"month": "Mar", "total_errors": 10},
+            ],
+        }
+        result = get_tanf_total_errors_context_count(dfs)
+        assert result == {"total_errors": 15}
+
+
 @pytest.mark.django_db
 def test_send_stuck_file_email(user, stt):
     """Test that the send_stuck_file_email function runs."""

tdrs-backend/tdpservice/email/templates/datafile_base.html

@@ -47,9 +47,15 @@
     <p>
       {% block end_message %}
       {% endblock %}
+      {% if file_type == "FRA" %}
+      <a href="https://tdp-project-updates.app.cloud.gov/knowledge-center/submitting-fra-data.html#:~:text=your%20previous%20submission.-,Viewing,-FRA%20Submission%20History" target="_blank">
+          Read more about using Submission History
+      </a>
+      {% else %}
       <a href="https://tdp-project-updates.app.cloud.gov/knowledge-center/view-submission-history.html" target="_blank">
           Read more about using Submission History
       </a>
+      {% endif %}
     </p>
 
     <p>

tdrs-backend/tdpservice/email/templates/fra-data-submitted.html

@@ -1,7 +1,7 @@
 {% extends '../datafile_base.html' %}
 
 {% block message %}
-Your <b>{{ file_type }}</b> data files submitted by <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> have been processed and accepted.
+Your <b>{{ file_type }}</b> data files submitted for <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> have been processed and accepted.
 {% endblock %}
 
 {% block table %}
@@ -29,5 +29,5 @@
 {% endblock %}
 
 {% block end_message %}
-The data file can now be accessed via the Submission History tab of the Data Files page.
+The data file can now be accessed on the FRA Data Files page.
 {% endblock %}

tdrs-backend/tdpservice/email/templates/fra/accepted.html

@@ -1,7 +1,7 @@
 {% extends '../datafile_base.html' %}
 
 {% block message %}
-Your <b>{{ file_type }}</b> data files submitted by <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> have been processed, but <b>some cases within your data contain errors</b>. Review the error report(s) for more details, and <b>resubmit your data files</b> once the errors have been corrected.
+Your <b>{{ file_type }}</b> data files submitted for <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> have been processed, but <b>some cases within your data contain errors</b>. Review the error report(s) for more details, and <b>resubmit your data files</b> once the errors have been corrected.
 {% endblock %}
 
 {% block table %}
@@ -39,5 +39,5 @@
 {% endblock %}
 
 {% block end_message %}
-The data file and the error report can now be accessed via the Submission History tab of the Data Files page.
+The data file and the error report can now be accessed on the FRA Data Files page.
 {% endblock %}

tdrs-backend/tdpservice/email/templates/fra/accepted_with_errors.html

@@ -1,7 +1,7 @@
 {% extends '../datafile_base.html' %}
 
 {% block message %}
-Your <b>{{ file_type }}</b> data files submitted by <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> were <b>unable to be processed</b>. Review the error report(s) for more details, and <b>resubmit your data files</b> once the errors have been corrected.
+Your <b>{{ file_type }}</b> data files submitted for <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> were <b>unable to be fully processed</b>. Review the error report(s) for more details, and <b>resubmit your data files</b> once the errors have been corrected.
 {% endblock %}
 
 {% block table %}
@@ -39,5 +39,5 @@
 {% endblock %}
 
 {% block end_message %}
-The data file and the error report(s) can now be accessed via the Submission History tab of the Data Files page.
+The data file and the error report(s) can now be accessed on the FRA Data Files page.
 {% endblock %}

tdrs-backend/tdpservice/email/templates/fra/partially_accepted.html

@@ -1,7 +1,7 @@
 {% extends '../datafile_base.html' %}
 
 {% block message %}
-Your <b>{{ file_type }}</b> data files submitted by <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> were <b>unable to be processed</b>. Review the error report(s) for more details, and <b>resubmit your data files</b> once the errors have been corrected.
+Your <b>{{ file_type }}</b> data files submitted for <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> were <b>unable to be processed</b>. Review the error report(s) for more details, and <b>resubmit your data files</b> once the errors have been corrected.
 {% endblock %}
 
 {% block table %}
@@ -39,5 +39,5 @@
 {% endblock %}
 
 {% block end_message %}
-The data file and the error report(s) can now be accessed via the Submission History tab of the Data Files page.
+The data file and the error report(s) can now be accessed on the FRA Data Files page.
 {% endblock %}

tdrs-backend/tdpservice/email/templates/fra/rejected.html

@@ -1,7 +1,7 @@
 {% extends '../datafile_base.html' %}
 
 {% block message %}
-Your <b>{{ file_type }}</b> data files submitted by <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> have been processed and accepted.
+Your <b>{{ file_type }}</b> data files submitted for <b>{{ stt_name }}</b> on <b>{{ submission_date }}</b> in Fiscal Year <b>{{ fiscal_year }}</b> have been processed and accepted.
 {% endblock %}
 
 {% block table %}
@@ -14,15 +14,23 @@
             <th>Section</th>
             <th>Submitted By</th>
             <th>Status</th>
+            {% if is_aggregate %}
+            <th>Total Errors</th>
+            {% else %}
             <th>Cases Without Errors</th>
+            {% endif %}
         </tr>
     </thead>
     <tbody>
         <tr>
             <td>{{ section_name }}</td>
             <td>{{ submitted_by }}</td>
             <td>{{ status }}</td>
+            {% if is_aggregate %}
+            <td>{{ total_errors }}</td>
+            {% else %}
             <td>{{ cases_without_errors }}</td>
+            {% endif %}
         </tr>
     </tbody>
 </table>