issue-483 add utilityCategory to assessment, form, report

src/app/indexed-db/update-db-entries.service.ts

@@ -270,7 +270,7 @@ export class UpdateDbEntriesService {
         // need recalculate uses and costs
         let facility: IdbFacility = facilities.find(_facility => { return _facility.guid == assessment.facilityId });
         let company: IdbCompany = companies.find(_company => { return _company.guid == facility.companyId });
-        // previously assessment is limited to one utility type
+        // legacy assessment is limited to one utility type
         // 1. update utility types
         assessment.utilityTypes = AssessmentOptions.find(_option =>
           { return _option.assessmentType == assessment.assessmentType })?.utilityTypes || [];
@@ -284,7 +284,27 @@ export class UpdateDbEntriesService {
           let utilityEnergyUse: UtilityEnergyUse = assessment.utilityEnergyUses.find(_energyUse =>
             { return _energyUse.utilityType == assessment.utilityType });
           utilityEnergyUse.utilitySaving = assessment.energySavings;
+          if (assessment.utilityType == 'Water' || assessment.utilityType == 'Waste Water') {
+            assessment.utilityCategory = 'water';
+          } else {
+            assessment.utilityCategory = 'energy';
+          }
           assessment.utilityType = undefined;
+        } else {
+          // update the utility category if none is set
+          if (assessment.utilityCategory == undefined) {
+            assessment.utilityCategory = 'energy';
+            for (const utilityType of assessment.utilityTypes) {
+              if (utilityType == 'Water' || utilityType == 'Waste Water') {
+                let use = assessment.utilityEnergyUses.find(_energyUse =>
+                  { return _energyUse.utilityType == utilityType });
+                if (use && use.include) {
+                  assessment.utilityCategory = 'water';
+                  break;
+                }
+              }
+            }
+          }
         }
         // update the use, cost, and savings
         assessment = updateAssessmentUtilityUseCostSavings(assessment, facility.unitSettings, company.companyEnergyUnit);

src/app/models/assessment.ts

@@ -30,6 +30,7 @@ export interface IdbAssessment extends IdbEntry {
     implementationCost: number,
     sidebarOpen: boolean,
     isUtilityCostUpdated: boolean,
+    utilityCategory?: 'energy' | 'water',
 }
 
 const defaultAssessmentType: AssessmentType = "Pump";
@@ -63,5 +64,6 @@ export function getNewIdbAssessment(userId: string, companyId: string, facilityI
         implementationCost: 0,
         sidebarOpen: false,
         isUtilityCostUpdated: true,
+        utilityCategory: 'energy',
     }
 }

src/app/shared/reports/calculations/assessmentReport.ts

@@ -125,6 +125,17 @@ export function getAssessmentReport(
         implementationCost += assessment.implementationCost;
     }
 
+    // update utilityCategory based on assessment and EEMs
+    let utilityCategory: string = assessment.utilityCategory;
+    if (utilityCategory == 'energy') {
+        for (const report of energyOpportunityReports) {
+            if (report.energyOpportunity.utilityCategory == 'water') {
+                utilityCategory = 'water';
+                break;
+            }
+        };
+    }
+
     let totalPaybackWithNebs: number = (implementationCost / totalFinancialImpact);
     if (totalPaybackWithNebs == Infinity) {
         totalPaybackWithNebs = 0;
@@ -169,7 +180,8 @@ export function getAssessmentReport(
         nonOpportunityPaybackWithoutNebs: nonOpportunityPaybackWithoutNebs,
         nonOpportunityPaybackWithNebs: nonOpportunityPaybackWithNebs,
         allNebReports: allNebReports,
-        keyPerformanceIndicatorReport: getKeyPerformanceIndicatorReport(allNebReports)
+        keyPerformanceIndicatorReport: getKeyPerformanceIndicatorReport(allNebReports),
+        utilityCategory: utilityCategory,
     }
 }
 
@@ -194,6 +206,7 @@ export interface AssessmentReport {
     nonOpportunityPaybackWithoutNebs: number,
     nonOpportunityPaybackWithNebs: number,
     keyPerformanceIndicatorReport: KeyPerformanceIndicatorReport,
+    utilityCategory?: string,
 }
 
 

src/app/shared/reports/calculations/executiveSummaryReport.ts

@@ -10,8 +10,7 @@ import { getKeyPerformanceIndicatorReport, KeyPerformanceIndicatorReport } from
 import { NebReport } from "./nebReport";
 import { IdbKeyPerformanceIndicator } from "src/app/models/keyPerformanceIndicator";
 
-//IF no report is passed as a parameter
-//All data (assessments/opps/nebs) included
+// If no report is passed as a parameter, all data (assessments/EEMs/NEBs) included
 export function getExecutiveSummaryReport(visitDate: Date, assessmentIds: Array<string>, assessments: Array<IdbAssessment>,
     energyOpportunities: Array<IdbEnergyOpportunity>,
     nonEnergyBenefits: Array<IdbNonEnergyBenefit>,
@@ -86,6 +85,11 @@ export function getExecutiveSummaryReport(visitDate: Date, assessmentIds: Array<
         });
         return totalNebFinancialImpact;
     });
+    // update utility category
+    let utilityCategory: string = "energy"; // Default to "energy"
+    if (assessmentReports.some(report => report.assessment.utilityCategory === "water")) {
+        utilityCategory = "water";
+    }
     let totalPaybackWithoutNebs: number = (totalImplementationCost / totalNonNebCostSavings);
     if (totalPaybackWithoutNebs == Infinity || isNaN(totalPaybackWithoutNebs)) {
         totalPaybackWithoutNebs = 0;
@@ -109,7 +113,9 @@ export function getExecutiveSummaryReport(visitDate: Date, assessmentIds: Array<
         totalPaybackWithoutNebs: totalPaybackWithoutNebs,
         totalPaybackWithNebs: totalPaybackWithNebs,
         totalUtilityCosts: totalUtilityCosts,
-        totalUtilityCostSavings: totalUtilityCostSavings,};
+        totalUtilityCostSavings: totalUtilityCostSavings,
+        utilityCategory: utilityCategory
+    };
 }
 export interface ExecutiveSummaryReport {
     visitDate: Date;
@@ -126,4 +132,5 @@ export interface ExecutiveSummaryReport {
     totalPaybackWithNebs: number;
     totalUtilityCosts: number;
     totalUtilityCostSavings: number;
+    utilityCategory?: string;
 }

src/app/shared/reports/executive-summary-report/executive-summary-kpi-impacts/executive-summary-kpi-impacts.component.html

@@ -43,7 +43,7 @@ <h5 class="mt-2">Annual Key Performance Indicator Impacts</h5>
         </tr>
         <tr>
           <td class="ps-2">
-            Utilities
+            {{ executiveSummaryReport.utilityCategory == 'energy' ? 'Energy' : 'Utilities' }}
           </td>
           <td class="text-right">
             <app-single-cell-item [isCurrency]="true" [numValue]="executiveSummaryReport.totalUtilityCostSavings">

src/app/shared/reports/executive-summary-report/executive-summary-project-summary/executive-summary-project-summary.component.html

@@ -28,7 +28,9 @@ <h5 class="mt-2">Project Summary</h5>
         <tr>
           <th rowspan="2"></th>
           <th></th>
-          <th colspan="2">Utility Savings</th>
+          <th colspan="2">
+            {{ executiveSummaryReport.utilityCategory == 'energy'? 'Energy' : 'Utility' }} Savings
+          </th>
           <th></th>
           <th colspan="2">Including NEBs</th>
         </tr>

src/app/shared/shared-assessment-forms/assessment-details-form/assessment-details-form.component.ts

@@ -126,9 +126,24 @@ export class AssessmentDetailsFormComponent {
     let utilityTypes = AssessmentOptions.find(
       _assessmentOption => _assessmentOption.assessmentType == this.assessment.assessmentType)?.utilityTypes || [];
     this.assessment.utilityTypes = utilityTypes; // track all utility types
+    this.updateAssessmentUtilityCategory();
     await this.calculateUtilityUseCostSavings();
   }
 
+  updateAssessmentUtilityCategory() {
+    this.assessment.utilityCategory = 'energy';
+    for (let utilityType of this.assessment.utilityTypes) {
+      if (utilityType == 'Water' || utilityType == 'Waste Water') {
+        let use = this.assessment.utilityEnergyUses.find(
+          _energyUse => _energyUse.utilityType == utilityType);
+        if (use && use.include) {
+          this.assessment.utilityCategory = 'water';
+          break;
+        }
+      }
+    }
+  }
+
   updateEnergyOpportunities() {
     this.assessmentEnergyOpportunities = this.energyOpportunityIdbService.getByOtherGuid(
       this.assessment.guid, 'assessment');