Merge pull request #1855 from IFRCGo/feature/final-reports-dref-field

New assisted population field in Dref final report

Author: frozenhelium

.changeset/olive-worms-post.md

@@ -0,0 +1,7 @@
+---
+"go-web-app": patch
+---
+
+Update DREF final report form
+
+- The DREF final report form and export now include a new "Assisted Population" field, replacing the "Targeted Population" field.

app/src/views/AccountMyFormsDref/DownloadImportTemplateButton/DownloadImportTemplateModal/useImportTemplateSchema.ts

@@ -592,56 +592,56 @@ function useImportTemplateSchema() {
                 type: 'input',
                 validation: 'number',
                 label: 'Targeted Population: <b>Women</b>',
-                description: '<i>Number, e.g. XX,XXX.</i>',
+                description: '<i>Number, e.g. XX,XXX.</i> If 0, leave the box empty.',
             },
 
             men: {
                 type: 'input',
                 validation: 'number',
                 label: 'Targeted Population: <b>Men</b>',
-                description: '<i>Number, e.g. XX,XXX.</i>',
+                description: '<i>Number, e.g. XX,XXX.</i> If 0, leave the box empty.',
             },
 
             girls: {
                 type: 'input',
                 validation: 'number',
                 label: 'Targeted Population: <b>Girls (under 18)</b>',
-                description: '<i>Number, e.g. XX,XXX.</i>',
+                description: '<i>Number, e.g. XX,XXX.</i> If 0, leave the box empty.',
             },
 
             boys: {
                 type: 'input',
                 validation: 'number',
                 label: 'Targeted Population: <b>Boys (under 18)</b>',
-                description: '<i>Number, e.g. XX,XXX.</i>',
+                description: '<i>Number, e.g. XX,XXX.</i> If 0, leave the box empty.',
             },
 
             total_targeted_population: {
                 type: 'input',
                 validation: 'number',
                 label: 'Targeted Population: <b>Total</b>',
-                description: '<i>Number, e.g. XX,XXX.</i>',
+                description: '<i>Number, e.g. XX,XXX.</i> If 0, leave the box empty.',
             },
 
             disability_people_per: {
                 type: 'input',
                 validation: 'number',
                 label: 'Estimated Percentage: <b>People with Disability</b>',
-                description: '<i>Percentage, e.g. XX%.</i>',
+                description: '<i>Percentage, e.g. XX%.</i> If 0, leave the box empty.',
             },
 
             people_per_urban: {
                 type: 'input',
                 validation: 'number',
                 label: 'Estimated Percentage: <b>Urban</b>',
-                description: '<i>Percentage, e.g. XX%.</i>',
+                description: '<i>Percentage, e.g. XX%.</i> If 0, leave the box empty.',
             },
 
             people_per_local: {
                 type: 'input',
                 validation: 'number',
                 label: 'Estimated Percentage: <b>Rural</b>',
-                description: '<i>Percentage, e.g. XX%.</i>',
+                description: '<i>Percentage, e.g. XX%.</i> If 0, leave the box empty.',
             },
 
             displaced_people: {

app/src/views/DrefFinalReportExport/i18n.json

@@ -22,7 +22,7 @@
         "hasChildProtectionPolicy": "Does your National Society have child protection/child safeguarding policy?",
         "hasWhistleblowerProtectionPolicy": "Does your National Society have whistleblower protection policy?",
         "hasAntiSexualHarassmentPolicy": "Does your National Society have anti-sexual harassment policy?",
-        "peopleAssistedLabel": "People Assisted",
+        "peopleAssistedLabel": "Total Population Assisted",
         "peopleSuffix": " people",
         "operationStartDateLabel": "Operation Start Date",
         "operationTimeframeLabel": "Total Operating Timeframe",
@@ -58,11 +58,11 @@
         "targetingStrategySectionHeading": "Targeting Strategy",
         "peopleAssistedHeading": "Who was targeted by this operation?",
         "selectionCriteriaHeading": "Explain the selection criteria for the targeted population",
-        "targetPopulationSectionHeading": "Total Targeted Population",
-        "womenLabel": "Women",
-        "girlsLabel": "Girls (under 18)",
-        "menLabel": "Men",
-        "boysLabel": "Boys (under 18)",
+        "targetPopulationSectionHeading": "Total Assisted Population",
+        "womenLabel": "Assisted Women",
+        "girlsLabel": "Assisted Girls (under 18)",
+        "menLabel": "Assisted Men",
+        "boysLabel": "Assisted Boys (under 18)",
         "targetedPopulationLabel": "Total targeted population",
         "ruralLabel": "Rural",
         "urbanLabel": "Urban",

app/src/views/DrefFinalReportExport/index.tsx

@@ -384,14 +384,6 @@ export function Component() {
                     valueType="number"
                     strongValue
                 />
-                <TextOutput
-                    className={styles.metaItem}
-                    label={strings.peopleAssistedLabel}
-                    value={drefResponse?.num_assisted}
-                    suffix={strings.peopleSuffix}
-                    valueType="number"
-                    strongValue
-                />
                 <TextOutput
                     className={styles.metaItem}
                     label={strings.eventOnsetLabel}
@@ -718,7 +710,7 @@ export function Component() {
                 {drefResponse?.type_of_dref !== DREF_TYPE_ASSESSMENT && (
                     <BlockTextOutput
                         label={strings.womenLabel}
-                        value={drefResponse?.women}
+                        value={drefResponse?.assisted_num_of_women}
                         valueType="number"
                         strongValue
                     />
@@ -733,7 +725,7 @@ export function Component() {
                 {drefResponse?.type_of_dref !== DREF_TYPE_ASSESSMENT && (
                     <BlockTextOutput
                         label={strings.girlsLabel}
-                        value={drefResponse?.girls}
+                        value={drefResponse?.assisted_num_of_girls_under_18}
                         valueType="number"
                         strongValue
                     />
@@ -748,7 +740,7 @@ export function Component() {
                 {drefResponse?.type_of_dref !== DREF_TYPE_ASSESSMENT && (
                     <BlockTextOutput
                         label={strings.menLabel}
-                        value={drefResponse?.men}
+                        value={drefResponse?.assisted_num_of_men}
                         valueType="number"
                         strongValue
                     />
@@ -764,12 +756,21 @@ export function Component() {
                 {drefResponse?.type_of_dref !== DREF_TYPE_ASSESSMENT && (
                     <BlockTextOutput
                         label={strings.boysLabel}
-                        value={drefResponse?.boys}
+                        value={drefResponse?.assisted_num_of_boys_under_18}
                         valueType="number"
                         strongValue
                     />
                 )}
                 <div className={styles.emptyBlock} />
+                <BlockTextOutput
+                    className={styles.metaItem}
+                    label={strings.peopleAssistedLabel}
+                    value={drefResponse?.num_assisted}
+                    suffix={strings.peopleSuffix}
+                    valueType="number"
+                    strongValue
+                />
+                <div className={styles.emptyBlock} />
                 <BlockTextOutput
                     label={strings.targetedPopulationLabel}
                     value={drefResponse?.total_targeted_population}

app/src/views/DrefFinalReportForm/EventDetail/i18n.json

@@ -29,8 +29,6 @@
         "drefFormEstimatedPeopleInNeed": "Estimated people in need (Optional)",
         "drefFormPeopleInNeed": "People in need (Optional)",
         "drefFormPeopleInNeedDescriptionImminent": "Include all those whose physical security, basic rights, dignity, living conditions or livelihoods are threatened or have been disrupted, and whose current level of access to basic services, goods and social protection will be inadequate to re-establish normal living conditions without additional assistance",
-        "drefFormPeopleAssisted": "Number of people assisted",
-        "drefFormPeopleAssistedDescription": "Include all those whose the National Society assisted",
         "drefFormPeopleInNeedDescriptionSlowSudden": "People in Need (PIN) are those members whose physical security, basic rights, dignity, living conditions or livelihoods are threatened or have been disrupted, and whose current level of access to basic services, goods and social protection is inadequate to re-establish normal living conditions without additional assistance.",
         "drefFormSourceInformationAddButton": "Add New Source Information",
         "drefFormSourceInformationTitle": "Source Information",

app/src/views/DrefFinalReportForm/EventDetail/index.tsx

@@ -45,7 +45,6 @@ interface Props {
 
 const totalPopulationRiskImminentLink = 'https://ifrcorg.sharepoint.com/sites/IFRCSharing/Shared%20Documents/Forms/AllItems.aspx?id=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF%2FHum%20Pop%20Definitions%20for%20DREF%20Form%5F21072022%2Epdf&parent=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF&p=true&ga=1';
 const totalPeopleAffectedSlowSuddenLink = 'https://ifrcorg.sharepoint.com/sites/IFRCSharing/Shared%20Documents/Forms/AllItems.aspx?id=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF%2FHum%20Pop%20Definitions%20for%20DREF%20Form%5F21072022%2Epdf&parent=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF&p=true&ga=1';
-const peopleTargetedLink = 'https://ifrcorg.sharepoint.com/sites/IFRCSharing/Shared%20Documents/Forms/AllItems.aspx?id=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF%2FHum%20Pop%20Definitions%20for%20DREF%20Form%5F21072022%2Epdf&parent=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF&p=true&ga=1';
 const peopleInNeedLink = 'https://ifrcorg.sharepoint.com/sites/IFRCSharing/Shared%20Documents/Forms/AllItems.aspx?id=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF%2FHum%20Pop%20Definitions%20for%20DREF%20Form%5F21072022%2Epdf&parent=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF&p=true&ga=1';
 
 function EventDetail(props: Props) {
@@ -217,28 +216,6 @@ function EventDetail(props: Props) {
                         error={error?.estimated_number_of_affected_boys_under_18}
                         disabled={disabled}
                     />
-                    <NumberInput
-                        label={(
-                            <>
-                                {strings.drefFormPeopleAssisted}
-                                <Link
-                                    title={strings.drefFormClickEmergencyResponseFramework}
-                                    href={peopleTargetedLink}
-                                    external
-                                >
-                                    <WikiHelpSectionLineIcon />
-                                </Link>
-                            </>
-                        )}
-                        name="num_assisted"
-                        value={value?.num_assisted}
-                        onChange={setFieldValue}
-                        error={error?.num_assisted}
-                        hint={strings.drefFormPeopleAssistedDescription}
-                        disabled={disabled}
-                    />
-                    {/* NOTE: Empty div to preserve the layout */}
-                    <div />
                 </InputSection>
                 <InputSection
                     title={

app/src/views/DrefFinalReportForm/Operation/i18n.json

@@ -51,13 +51,13 @@
         "drefChildSafeguardingRiskAnalysisDescription":"Q&A Child Safeguarding Risk Analysis",
         "drefFormSelectionCriteria": "Explain the selection criteria for the targeted population",
         "drefFormSelectionCriteriaDescription": "Explain the rational and logic behind which groups are being targeted and why and address vulnerable groups",
-        "drefFormTargetedPopulation": "Targeted Population",
+        "drefFormTargetedPopulation": "Assisted Population",
         "drefFormTargetingStrategy": "Targeting Strategy",
         "drefFormTotal": "Total Population",
-        "drefFormWomen": "Women",
+        "drefFormWomen": "Assisted Women",
         "drefFormResponseAddButton": "Add",
-        "drefFormAssistedPopulation": "Total Targeted Population",
-        "drefFormBoys": "Boys (under 18)",
+        "drefFormAssistedPopulation": "Total Assisted Population",
+        "drefFormBoys": "Assisted Boys (under 18)",
         "drefFormBudgetTemplateLabel": "Budget template",
         "drefFormOperationDescription": "Description",
         "drefFormEstimatedDisplacedPeople": "Estimated Number of People on the move (if any)",
@@ -66,7 +66,7 @@
         "drefFormEstimatedUrban": "Urban",
         "drefFormEstimatePeopleDisability": "Estimated Percentage People with Disability",
         "drefFormEstimateResponse": "Estimate",
-        "drefFormGirls": "Girls (under 18)",
+        "drefFormGirls": "Assisted Girls (under 18)",
         "drefFormInterventionsLabel": "Select the interventions that apply.",
         "finalReportTotalAllocation": "Total DREF Allocation",
         "drefFinalReportRequestAmountDescription": "General funding requested to fund the interventions. List specific activities that will be carried out as part of the intervention in each sector. The activities should directly address the identified needs and align with the operation’s strategic objectives.",
@@ -77,7 +77,10 @@
         "drefFinalReportRequestAmountDescriptionPoint4": "Consider the type of indicator unit. For example, it’s often simpler and clearer to track and report on the “number of people” rather than a “percentage of people.”",
         "drefFinalReportRequestAmountDescriptionPoint5": "For each indicator, set a target. This helps track progress and measure whether the operation is achieving its key objectives, making it easier to report results later on.",
         "drefFormUploadTargetingSupportingDescription": "Financial report file types: pdf",
-        "drefFormMen": "Men",
-        "drefFinalReportTotalTargeted": "Total targeted population is not equal to sum of other population fields"
+        "drefFormMen": "Assisted Men",
+        "drefFormPeopleAssistedDescription": "Include all those whose the National Society assisted",
+        "drefFormPeopleAssisted": "Total population assisted",
+        "drefFormOperationClickEmergencyResponseFramework": "Click to view Emergency Response Framework",
+        "drefFinalReportTotalTargeted": "Total assisted population is not equal to sum of other population fields"
     }
 }

app/src/views/DrefFinalReportForm/Operation/index.tsx

@@ -3,7 +3,10 @@ import {
     useMemo,
     useState,
 } from 'react';
-import { ErrorWarningFillIcon } from '@ifrc-go/icons';
+import {
+    ErrorWarningFillIcon,
+    WikiHelpSectionLineIcon,
+} from '@ifrc-go/icons';
 import {
     BooleanInput,
     Button,
@@ -60,6 +63,8 @@ function plannedInterventionKeySelector(option: PlannedInterventionOption) {
     return option.key;
 }
 
+const peopleTargetedLink = 'https://ifrcorg.sharepoint.com/sites/IFRCSharing/Shared%20Documents/Forms/AllItems.aspx?id=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF%2FHum%20Pop%20Definitions%20for%20DREF%20Form%5F21072022%2Epdf&parent=%2Fsites%2FIFRCSharing%2FShared%20Documents%2FDREF&p=true&ga=1';
+
 interface Props {
     value: Value;
     setFieldValue: (...entries: EntriesAsList<Value>) => void;
@@ -123,29 +128,29 @@ function Operation(props: Props) {
     }, [setFieldValue, setSelectedIntervention]);
 
     const warnings = useMemo(() => {
-        if (isNotDefined(value?.total_targeted_population)) {
+        if (isNotDefined(value?.num_assisted)) {
             return [];
         }
 
         const w = [];
 
         if (sumSafe([
-            value?.women,
-            value?.men,
-            value?.girls,
-            value?.boys,
-        ]) !== value?.total_targeted_population) {
+            value?.assisted_num_of_women,
+            value?.assisted_num_of_men,
+            value?.assisted_num_of_girls_under_18,
+            value?.assisted_num_of_boys_under_18,
+        ]) !== value?.num_assisted) {
             w.push(strings.drefFinalReportTotalTargeted);
         }
 
         return w;
     }, [
         strings.drefFinalReportTotalTargeted,
-        value?.women,
-        value?.men,
-        value?.girls,
-        value?.boys,
-        value?.total_targeted_population,
+        value?.assisted_num_of_women,
+        value?.assisted_num_of_men,
+        value?.assisted_num_of_girls_under_18,
+        value?.assisted_num_of_boys_under_18,
+        value?.num_assisted,
     ]);
 
     const interventionMap = useMemo(() => (
@@ -328,38 +333,60 @@ function Operation(props: Props) {
                         <>
                             <NumberInput
                                 label={strings.drefFormWomen}
-                                name="women"
-                                value={value.women}
+                                name="assisted_num_of_women"
+                                value={value.assisted_num_of_women}
                                 onChange={setFieldValue}
-                                error={error?.women}
+                                error={error?.assisted_num_of_women}
                                 disabled={disabled}
                             />
                             <NumberInput
                                 label={strings.drefFormMen}
-                                name="men"
-                                value={value.men}
+                                name="assisted_num_of_men"
+                                value={value.assisted_num_of_men}
                                 onChange={setFieldValue}
-                                error={error?.men}
+                                error={error?.assisted_num_of_men}
                                 disabled={disabled}
                             />
                             <NumberInput
                                 label={strings.drefFormGirls}
-                                name="girls"
-                                value={value.girls}
+                                name="assisted_num_of_girls_under_18"
+                                value={value.assisted_num_of_girls_under_18}
                                 onChange={setFieldValue}
-                                error={error?.girls}
+                                error={error?.assisted_num_of_girls_under_18}
                                 disabled={disabled}
                             />
                             <NumberInput
                                 label={strings.drefFormBoys}
-                                name="boys"
-                                value={value.boys}
+                                name="assisted_num_of_boys_under_18"
+                                value={value.assisted_num_of_boys_under_18}
                                 onChange={setFieldValue}
                                 error={error?.boys}
                                 disabled={disabled}
                             />
                         </>
                     )}
+                    <NumberInput
+                        label={(
+                            <>
+                                {strings.drefFormPeopleAssisted}
+                                <Link
+                                    title={strings.drefFormOperationClickEmergencyResponseFramework}
+                                    href={peopleTargetedLink}
+                                    external
+                                >
+                                    <WikiHelpSectionLineIcon />
+                                </Link>
+                            </>
+                        )}
+                        name="num_assisted"
+                        value={value?.num_assisted}
+                        onChange={setFieldValue}
+                        error={error?.num_assisted}
+                        hint={strings.drefFormPeopleAssistedDescription}
+                        disabled={disabled}
+                    />
+                    {/* NOTE: Empty div to preserve the layout */}
+                    <div />
                     <NumberInput
                         label={strings.drefFormTotal}
                         name="total_targeted_population"