BB - Allow multiple Portfolio Summary templates

[perryr16]

DB Schema

To accomodate the new templates, a new table DataReport will be introduced.

• DataReport 1-Many with Goal
• Moving from one Goal model to several Goals, each inheriting from the parent model Goal. The new goal types will be GoalStandard, GoalTransaction, GoalWaterTreatment, GoalStreetLights, GoalDataCenter.

Through these new Goal types, each template can be represented by nesting Goal types under a DataReport. Many of the templates introduce the concept of a "blended sumamry". A blended summary aggregates each of its child goal's summary values (total sqft across all goals). When a DataReport has multiple Goals, the DataReport endpoints will handle the "blended summary".

Template breakdown

There are 6 unique data report templates.

• Wendys Transactions
  • db: DataReport -> [GoalTransaction]
  • standard + transactions, eui (t) = kbtu/transactions, transactions %, eui(t) %
• AAPI Commercial (Commonwealth Partners)
  • db: DataReport -> [GoalStanard] (optional AAPI field = True)
  • The standard portfolio summary with an additional AAPI metrics (average annual percentage improvement)
    • Acquisition, Disposition, Years in Portfolio, AAPI
    • AAPI = ((Current EUI/Baseline EUI) ^(1/Years in Portfolio) -1) * (-1)
  • AAPI summary table
• Standard Multifamily (REACH)
  • db: DataReport -> [GoalStandard, GoalStandard]
  • A version of the standard template that summarizes 2 separate reports
    • WB (Whole Building) and OPR (Owner Paid Receipts), where OPR is a property state extra data field
  • Blended Summary
• AAPI Multifamily (LINC)
  • db: DataReport -> [GoalStandard, GoalStandard] (optional AAPI field = True)
  • Same as REACH + AAPI + AAPI Summary
• Waste Water Treatment and Streetlight Template (West Palm Beach)
  • db: DataReport -> [GoalStandard, GoalWaterTreatement, GoalStreetlight]
  • summary is standard, however sqft and EUI are "N/A"
  • BS - standard
  • WWTF - MGD (million gallons / day?), kBTU, EUI
  • SL - Pole Count, Energy / Pole, kBTU = Pole Count * Energy / Pole
• Data Center Template (Iron Mountain)
  • db table: DataReport -> [GoalDataCenter]
  • summary: DC(kBTU), IT(kBTU), PUE-1 = DC / IT - 1, IT %, PUE-1 %
  • data table: DC(kBTU), IT(kBTU), PUE = DC / IT, IT %, PUE-1 %

Concerns

• Not enough overlap to reuse tables and controllers, will likely need customization for each
• Do these need to incorporate Filter Groups? - no, will use a state field like OPR
• Excel issue: Where are the "Raw Data" tabs?
• What does the config look like? How can we make this "simple" to the user, when they are tailored to very specific needs

[perryr16]

Tasks:

• move goal logic to an imported service
• multi goal data reports should have a parent portfolio summary based on data report type
• modify goal editor for different types
• prevent users from changing report/goal types while editing
• if standard data report, hardcode new goals as standard type (same with transactions and data centers). MultiFamily will have OPR option. WWT will have wastewater and streetlights.
• data quality checks by data_report, not goal
• partial when no data reports

Comments

• Data reports are generic, but we should probably hard code around them
• Would a unique controller for each data_report type make sense?

[perryr16]

Being put on hold. A lot of work has already been completed on branch https://github.com/SEED-platform/seed/tree/data-report-goal-refactor