Merge pull request #288 from NREL/issue-263

Help Text and Descriptions

src/app/setup-wizard/data-collection/on-site-assessment/neb-forms-accordion/neb-setup-form/neb-setup-form.component.html

@@ -76,10 +76,9 @@ <h6>
         </div>
     </h6>
     <p class="fw-light small">
-        Fill out the impacts on company performance metrics (<fa-icon [icon]="faScaleUnbalancedFlip"></fa-icon>) that
-        can be associated with this Non-energy Benefit. Click the "Search Performance Metrics" button and a modal will
-        appear to find and add
-        performance metrics that are typically associated with this NEB.
+        Fill out the impacts on company key performance metrics (<fa-icon [icon]="faScaleUnbalancedFlip"></fa-icon>) that
+        can be associated with this Non-energy Benefit. Click the "Search Key Performance Metrics" button and a modal will
+        appear to find and add key performance metrics that are typically associated with this NEB.
     </p>
     <div class="row">
         <div class="col">

src/app/setup-wizard/pre-visit/company-kpi-details/company-kpi-details.component.html

@@ -62,8 +62,7 @@ <h5>
                             </ng-template>
                             <ng-template #indicatorDescription>
                                 <p>
-                                    Lorem ipsum odor amet, consectetuer adipiscing elit. Ex consequat nulla vestibulum
-                                    dapibus lectus vestibulum. Ex nisi phasellus tempus himenaeos erat.
+                                    <span [innerHTML]="keyPerformanceIndicator.optionValue | kpiDescription"></span>
                                 </p>
                             </ng-template>
                         </div>
@@ -104,7 +103,8 @@ <h6>
                         </div>
                     </h6>
                     <p class="fw-light small">
-                        The below associated key performance metrics (<fa-icon [icon]="faScaleUnbalancedFlip"></fa-icon>)
+                        The below associated key performance metrics (<fa-icon
+                            [icon]="faScaleUnbalancedFlip"></fa-icon>)
                         will be used later on during an assessment to tie Non-Energy Benefits found back to company Key
                         Performance Indicators. This information can be added to and modified at a later time if not all
                         of the details are currently known.
@@ -156,8 +156,7 @@ <h6>
                                     </div>
                                 </ng-template>
                                 <app-kpm-details-form [keyPerformanceMetric]="keyPerformanceMetric"
-                                    (emitSave)="saveChanges()"
-                                    (emitCalculate)="calculateCost(keyPerformanceMetric)"
+                                    (emitSave)="saveChanges()" (emitCalculate)="calculateCost(keyPerformanceMetric)"
                                     [context]="'preVisit'"></app-kpm-details-form>
                                 <ng-template
                                     [ngIf]="(keyPerformanceMetricImpacts | keyPerformanceMetricImpactsList: keyPerformanceMetric.guid).length">

src/app/setup-wizard/pre-visit/company-kpi-details/kpi-description.pipe.spec.ts

@@ -0,0 +1,8 @@
+import { KpiDescriptionPipe } from './kpi-description.pipe';
+
+describe('KpiDescriptionPipe', () => {
+  it('create an instance', () => {
+    const pipe = new KpiDescriptionPipe();
+    expect(pipe).toBeTruthy();
+  });
+});

src/app/setup-wizard/pre-visit/company-kpi-details/kpi-description.pipe.ts

@@ -0,0 +1,30 @@
+import { Pipe, PipeTransform } from '@angular/core';
+import { KeyPerformanceIndicatorValue } from 'src/app/shared/constants/keyPerformanceIndicatorOptions';
+
+@Pipe({
+  name: 'kpiDescription'
+})
+export class KpiDescriptionPipe implements PipeTransform {
+
+  transform(kpiOptionValue: KeyPerformanceIndicatorValue): string {
+    switch (kpiOptionValue) {
+      case 'strategicRelationshipImpact':
+        return "Strategic Relationship Impact measures the success of a business's engagement with partners and the health of those relationships. Strategic relationship impact is an intangible measurement itself but can be partially quantified using KPMs to measure the success of a business's engagement with partners.  This can be done through measuring increased/losses in sales, customer and supplier satisfaction ratings, and customer churn for example."
+      case 'quality':
+        return "Quality metrics are quantifiable measurements used to evaluate performance, quality, or effectiveness for a product, process or system. They are used to measure success towards a goal and drive continuous improvement.";
+      case 'reduceExpenseCost':
+        return "Reduce Expense Cost is a strategic process that identifies and eliminates unnecessary operational expenses to increase profitability.  The goal is always to maximize value and efficiency without compromising quality or core operations.";
+      case 'safety':
+        return "Safety metrics are qualitative and quantitative measurements that help organizations to monitor and improve their safety performance. They help identify areas for improvement, ensure compliance with regulations, and prevent accidents and injuries.";
+      case 'waterConsumption':
+        return "Water Consumption is the amount of water used by an organization.  Measuring water consumption with respect to sustainability is for the purposes of reduced consumption.";
+      case 'productivity':
+        return "Productivity is a quantitative measurement that assesses how efficiently a company is producing their products. Productivity metrics can be used to track performance, identify areas for improvement, maximize efficiency, and make decisions that benefit operations.";
+      case 'chemicalEmissions': 
+        return "CO, CO<sub>2</sub>, NO<sub>x</sub>, SO<sub>x</sub> emissions emissions are a key sustainability metric. Emissions related to global warming and air quality are often reported to governmental agencies or other bodies to show improvements in sustainability and meet regulatory standards."
+      default:
+        return "Lorem ipsum odor amet, consectetuer adipiscing elit. Ex consequat nulla vestibulum dapibus lectus vestibulum. Ex nisi phasellus tempus himenaeos erat.";
+    }
+  }
+
+}

src/app/setup-wizard/setup-wizard-help-panel/company-kpi-detail-help/company-kpi-detail-help.component.html

@@ -1,5 +1,24 @@
 <p>
-    Provide baseline details about the selected KPI.
+    <span class="bold">Key Performance Indicators (KPI)</span> and <span class="bold">Key Performance Metrics
+        (KPMs)</span>
+</p>
+<p>
+    <span class="bold">Key Performance Indicators (KPI)</span> are the critical (key) quantifiable indicators of
+    progress toward an intended
+    result and are used to track progress towards business objectives.
+</p>
+<p>
+    <span class="bold">Key Performance Metrics
+        (KPMs)</span> refers to quantifiable measurements an organization uses to track performance.
+</p>
+<p>
+    Key Performance Indicators (KPIs) are the goals to be achieved, while Key Performance Measures (KPMs) are the data
+    that measures progress towards those goals. JUSTIFI uses this distinction to help organize KPMs so that non-energy
+    benefits are more easily found and aligned with business objectives.
+</p>
+<hr>
+<p>
+    Use this screen to provide baseline details about the selected KPI.
 </p>
 <hr>
 <p>

src/app/setup-wizard/setup-wizard-help-panel/company-kpi-select-help/company-kpi-select-help.component.html

@@ -1,5 +1,24 @@
 <p>
-    Select the Key Performance Indicators (KPI) that the company is tracking.
+    <span class="bold">Key Performance Indicators (KPI)</span> and <span class="bold">Key Performance Metrics
+        (KPMs)</span>
+</p>
+<p>
+    <span class="bold">Key Performance Indicators (KPI)</span> are the critical (key) quantifiable indicators of
+    progress toward an intended
+    result and are used to track progress towards business objectives.
+</p>
+<p>
+    <span class="bold">Key Performance Metrics
+        (KPMs)</span> refers to quantifiable measurements an organization uses to track performance.
+</p>
+<p>
+    Key Performance Indicators (KPIs) are the goals to be achieved, while Key Performance Measures (KPMs) are the data
+    that measures progress towards those goals. JUSTIFI uses this distinction to help organize KPMs so that non-energy
+    benefits are more easily found and aligned with business objectives.
+</p>
+<hr>
+<p>
+    Use this screen to select the Key Performance Indicators (KPI) that the company is tracking.
 </p>
 <hr>
 <p>

src/app/setup-wizard/setup-wizard.module.ts

@@ -61,6 +61,7 @@ import { EnergyOpportunityNebsListPipe } from './data-collection/on-site-assessm
 import { SetupWizardHelpPanelModule } from './setup-wizard-help-panel/setup-wizard-help-panel.module';
 import { LabelWithTooltipModule } from '../shared/label-with-tooltip/label-with-tooltip.module';
 import { KpmDetailsFormModule } from '../shared/kpm-details-form/kpm-details-form.module';
+import { KpiDescriptionPipe } from './pre-visit/company-kpi-details/kpi-description.pipe';
 
 @NgModule({
   declarations: [
@@ -112,7 +113,8 @@ import { KpmDetailsFormModule } from '../shared/kpm-details-form/kpm-details-for
     AssociatedMetricIndicatorPipe,
     KpmImpactsTableComponent,
     EnergyOpportunityNebsTableComponent,
-    EnergyOpportunityNebsListPipe
+    EnergyOpportunityNebsListPipe,
+    KpiDescriptionPipe
   ],
   imports: [
     CommonModule,

src/app/shared/constants/keyPerformanceIndicatorOptions.ts

@@ -25,7 +25,7 @@ export interface KeyPerformanceIndicatorOption {
     primaryKPI: PrimaryKPI,
     label: string,
     htmlLabel: string,
-    optionValue: KeyPerformanceIndicatorValue,
+    optionValue: KeyPerformanceIndicatorValue
 };
 
 export const KeyPerformanceIndicatorOptions: Array<KeyPerformanceIndicatorOption> = [