Add transactions template to portfolio summary (#4891)

* move functionality to backend

move functionality to backend

dev - meeds pagination

dev - meeds pagination

added pagination

labels functional

naming

logging

* sorting on related functional

clean up

* cleanup

* precommit

* lint

* add type and trasnaction to goal model

* transactions summary endpoint functional

* transaction data dev

* return if not none

* rename transactions_column

* add transaction data to endpoint

* move goal fxns to util

* transaction data functional

* format summary in backend

* translations

* precommit

* filters on trasnaction cols

* set transactions to none if standard

* translations

* early return

* update tests w new ps format

* catch incorrect datatype

* precommit

* missing url

* add goal type desc, rename migration, and fix typo

* lint

---------

Co-authored-by: Ross Perry <[email protected]>
Co-authored-by: Katherine Fleming <[email protected]>

seed/migrations/0234_transaction_goals.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.2.25 on 2024-12-02 22:02
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("seed", "0233_alter_goal_options"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="goal",
+            name="transactions_column",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="goal_transactions_columns",
+                to="seed.column",
+            ),
+        ),
+        migrations.AddField(
+            model_name="goal",
+            name="type",
+            field=models.CharField(choices=[("standard", "standard"), ("transaction", "transaction")], default="standard", max_length=255),
+        ),
+    ]

seed/models/goals.py

@@ -11,6 +11,11 @@
 
 from seed.models import AccessLevelInstance, Column, Cycle, Organization, Property
 
+GOAL_TYPE_CHOICES = (
+    ("standard", "standard"),
+    ("transaction", "transaction"),
+)
+
 
 class Goal(models.Model):
     organization = models.ForeignKey(Organization, on_delete=models.CASCADE)
@@ -25,10 +30,19 @@ class Goal(models.Model):
     target_percentage = models.IntegerField(validators=[MinValueValidator(0), MaxValueValidator(100)])
     commitment_sqft = models.IntegerField(blank=True, null=True, validators=[MinValueValidator(0)])
     name = models.CharField(max_length=255, unique=True)
+    type = models.CharField(max_length=255, choices=GOAL_TYPE_CHOICES, default="standard")
+    transactions_column = models.ForeignKey(
+        Column, on_delete=models.CASCADE, related_name="goal_transactions_columns", blank=True, null=True
+    )
 
     class Meta:
         ordering = ["name"]
 
+    def save(self, *args, **kwargs):
+        if self.type == "standard":
+            self.transactions_column = None
+        super().save(*args, **kwargs)
+
     def __str__(self):
         return f"Goal - {self.name}"
 

seed/serializers/goals.py

@@ -23,11 +23,13 @@ def to_representation(self, obj):
             "level_name": obj.organization.access_level_names[level_index],
             "baseline_cycle_name": obj.baseline_cycle.name,
             "current_cycle_name": obj.current_cycle.name,
-            "eui_column1_name": obj.eui_column1.display_name,
-            "eui_column2_name": obj.eui_column2.display_name if obj.eui_column2 else None,
-            "eui_column3_name": obj.eui_column3.display_name if obj.eui_column3 else None,
-            "area_column_name": obj.area_column.display_name,
+            "eui_column1_name": self.get_column_name(obj.eui_column1),
+            "eui_column2_name": self.get_column_name(obj.eui_column2),
+            "eui_column3_name": self.get_column_name(obj.eui_column3),
+            "area_column_name": self.get_column_name(obj.area_column),
         }
+        if obj.type == "transaction":
+            details["transactions_column_name"] = self.get_column_name(obj.transactions_column)
         result.update(details)
 
         return result
@@ -61,3 +63,11 @@ def validate(self, data):
             raise ValidationError("Columns must be unique.")
 
         return data
+
+    def get_column_name(self, column):
+        if not column:
+            return None
+        elif column.display_name:
+            return column.display_name
+        else:
+            return column.column_name

seed/static/seed/js/controllers/goal_editor_modal_controller.js

@@ -14,6 +14,7 @@ angular.module('SEED.controller.goal_editor_modal', [])
     'access_level_tree',
     'area_columns',
     'auth_payload',
+    'columns',
     'cycles',
     'eui_columns',
     'goal',
@@ -31,6 +32,7 @@ angular.module('SEED.controller.goal_editor_modal', [])
       access_level_tree,
       area_columns,
       auth_payload,
+      columns,
       cycles,
       eui_columns,
       goal,
@@ -40,20 +42,23 @@ angular.module('SEED.controller.goal_editor_modal', [])
       $scope.auth = auth_payload.auth;
       $scope.organization = organization;
       $scope.write_permission = write_permission;
-      $scope.goal = goal || {};
       $scope.access_level_tree = access_level_tree.access_level_tree;
       $scope.level_names = access_level_tree.access_level_names.map((level, i) => ({
         index: i,
         name: level
       }));
       $scope.cycles = cycles;
+      $scope.columns = columns.sort((a, b) => (a.displayName.toLowerCase() < b.displayName.toLowerCase() ? -1 : 1));
       $scope.area_columns = area_columns;
       $scope.eui_columns = eui_columns;
       // allow "none" as an option
       if (!eui_columns.find((col) => col.id === null && col.displayName === '')) {
         $scope.eui_columns.unshift({ id: null, displayName: '' });
       }
+
+      $scope.goal = goal || {};
       $scope.valid = false;
+      $scope.goal_types = ['standard', 'transaction'];
 
       const sort_goals = (goals) => goals.sort((a, b) => (a.name.toLowerCase() < b.name.toLowerCase() ? -1 : 1));
       const get_goals = () => {