feat(spp_farmer_registry_demo): USE_CASES.md + demo data, eligibility/compliance/approval (#915)

spp_farmer_registry/data/cel_variables.xml

@@ -7,7 +7,11 @@
     - Benefit calculations (farm_size_hectares * per_hectare_rate)
     - Program targeting (crop_count, livestock_count)
 -->
-<odoo noupdate="1">
+<!-- noupdate="0" so the activity-count CEL variable fix from OP#915 lands
+     on existing installs. Variables in this file are flagged is_system=True
+     and shouldn't be hand-edited; if an admin did override one, they'll get
+     the system definition back on the next upgrade. -->
+<odoo noupdate="0">
     <!-- ═══════════════════════════════════════════════════════════════════════
              FIELD VARIABLES - Direct field access from spp.farm.details
              ═══════════════════════════════════════════════════════════════════════ -->
@@ -78,6 +82,23 @@
              AGGREGATE VARIABLES - Activity Counts
              ═══════════════════════════════════════════════════════════════════════ -->
 
+    <!-- The five activity-count / livestock-sum variables below were
+         originally declared with `source_type="aggregate"` and an
+         `aggregate_target` pointing at non-existent inverse names like
+         `farm_aquaculture_activities` (the real o2m field is
+         `farm_aquaculture_act_ids`). On top of that, the CEL framework's
+         `aggregate_target` field is a Selection limited to
+         members/enrollments/entitlements, so even with the right name
+         the lookup wouldn't have worked. Net effect: every variable
+         resolved to 0 for every farm, so the demo programs' CELs (e.g.
+         `aquaculture_count > 0`) returned 0 matches even though seeded
+         enrollments existed. See OP#915.
+
+         The fix: each variable now reads from the corresponding stored
+         Integer compute on `spp.farm` (already maintained by
+         `_compute_activity_counts` / `_compute_total_livestock_heads`).
+         No new model fields, no aggregate framework needed. -->
+
     <record id="var_crop_count" model="spp.cel.variable">
         <field name="name">crop_count</field>
         <field name="label">Number of Crop Activities</field>
@@ -86,15 +107,13 @@
         >Count of crop cultivation activities on the farm</field>
         <field name="category_id" ref="variable_category_farm_activity" />
         <field name="value_type">number</field>
-        <field name="source_type">aggregate</field>
-        <field name="aggregate_type">count</field>
-        <field name="aggregate_target">farm_crop_activities</field>
-        <field name="aggregate_filter">true</field>
+        <field name="source_type">field</field>
+        <field name="source_model">res.partner</field>
+        <field name="source_field">crop_activity_count</field>
         <field name="cel_accessor">crop_count</field>
         <field name="applies_to">group</field>
         <field name="is_system">True</field>
-        <field name="cache_strategy">ttl</field>
-        <field name="cache_ttl_seconds">86400</field>
+        <field name="cache_strategy">none</field>
     </record>
 
     <record id="var_livestock_count" model="spp.cel.variable">
@@ -105,15 +124,13 @@
         >Count of livestock rearing activities on the farm</field>
         <field name="category_id" ref="variable_category_farm_activity" />
         <field name="value_type">number</field>
-        <field name="source_type">aggregate</field>
-        <field name="aggregate_type">count</field>
-        <field name="aggregate_target">farm_livestock_activities</field>
-        <field name="aggregate_filter">true</field>
+        <field name="source_type">field</field>
+        <field name="source_model">res.partner</field>
+        <field name="source_field">livestock_activity_count</field>
         <field name="cel_accessor">livestock_count</field>
         <field name="applies_to">group</field>
         <field name="is_system">True</field>
-        <field name="cache_strategy">ttl</field>
-        <field name="cache_ttl_seconds">86400</field>
+        <field name="cache_strategy">none</field>
     </record>
 
     <record id="var_aquaculture_count" model="spp.cel.variable">
@@ -122,15 +139,13 @@
         <field name="description">Count of aquaculture activities on the farm</field>
         <field name="category_id" ref="variable_category_farm_activity" />
         <field name="value_type">number</field>
-        <field name="source_type">aggregate</field>
-        <field name="aggregate_type">count</field>
-        <field name="aggregate_target">farm_aquaculture_activities</field>
-        <field name="aggregate_filter">true</field>
+        <field name="source_type">field</field>
+        <field name="source_model">res.partner</field>
+        <field name="source_field">aquaculture_activity_count</field>
         <field name="cel_accessor">aquaculture_count</field>
         <field name="applies_to">group</field>
         <field name="is_system">True</field>
-        <field name="cache_strategy">ttl</field>
-        <field name="cache_ttl_seconds">86400</field>
+        <field name="cache_strategy">none</field>
     </record>
 
     <record id="var_land_parcel_count" model="spp.cel.variable">
@@ -139,34 +154,31 @@
         <field name="description">Count of registered land parcels for the farm</field>
         <field name="category_id" ref="variable_category_farm" />
         <field name="value_type">number</field>
-        <field name="source_type">aggregate</field>
-        <field name="aggregate_type">count</field>
-        <field name="aggregate_target">land_parcels</field>
-        <field name="aggregate_filter">true</field>
+        <field name="source_type">field</field>
+        <field name="source_model">res.partner</field>
+        <field name="source_field">land_parcel_count</field>
         <field name="cel_accessor">land_parcel_count</field>
         <field name="applies_to">group</field>
         <field name="is_system">True</field>
-        <field name="cache_strategy">ttl</field>
-        <field name="cache_ttl_seconds">86400</field>
+        <field name="cache_strategy">none</field>
     </record>
 
-    <!-- Total livestock heads (sum of quantities) -->
+    <!-- Total livestock heads (sum of quantities) — backed by the stored
+         `total_livestock_heads` compute on spp.farm, which sums
+         farm_livestock_act_ids.quantity. -->
     <record id="var_total_livestock_heads" model="spp.cel.variable">
         <field name="name">total_livestock_heads</field>
         <field name="label">Total Livestock Heads</field>
         <field name="description">Sum of all livestock across all activities</field>
         <field name="category_id" ref="variable_category_farm_activity" />
         <field name="value_type">number</field>
-        <field name="source_type">aggregate</field>
-        <field name="aggregate_type">sum</field>
-        <field name="aggregate_target">farm_livestock_activities</field>
-        <field name="aggregate_field">quantity</field>
-        <field name="aggregate_filter">true</field>
+        <field name="source_type">field</field>
+        <field name="source_model">res.partner</field>
+        <field name="source_field">total_livestock_heads</field>
         <field name="cel_accessor">total_livestock_heads</field>
         <field name="applies_to">group</field>
         <field name="is_system">True</field>
-        <field name="cache_strategy">ttl</field>
-        <field name="cache_ttl_seconds">86400</field>
+        <field name="cache_strategy">none</field>
     </record>
 
     <!-- ═══════════════════════════════════════════════════════════════════════

spp_farmer_registry_cr/data/cr_types.xml

@@ -148,14 +148,17 @@
         <field name="source_module">spp_farmer_registry_cr</field>
     </record>
 
-    <!-- Manage Farm Assets (Add/Edit/Remove) — disabled until fully tested
+    <!-- Manage Farm Assets (Add/Edit/Remove) -->
     <record id="cr_type_manage_farm_asset" model="spp.change.request.type">
         <field name="name">Manage Farm Assets</field>
         <field name="code">manage_farm_asset</field>
         <field name="description">Add, edit, or remove farm assets and machinery</field>
         <field name="target_type">group</field>
         <field name="detail_model">spp.cr.detail.manage_farm_asset</field>
-        <field name="detail_form_view_id" ref="spp_farmer_registry_cr.spp_cr_detail_manage_farm_asset_form"/>
+        <field
+            name="detail_form_view_id"
+            ref="spp_farmer_registry_cr.spp_cr_detail_manage_farm_asset_form"
+        />
         <field name="apply_strategy">custom</field>
         <field name="apply_model">spp.cr.apply.manage_farm_asset</field>
         <field name="icon">fa-wrench</field>
@@ -168,7 +171,6 @@
         <field name="is_system_type">True</field>
         <field name="source_module">spp_farmer_registry_cr</field>
     </record>
-    -->
 
     <!-- Manage Land Parcels (Add/Edit/Remove) — disabled until fully tested
     <record id="cr_type_manage_land_parcel" model="spp.change.request.type">

spp_farmer_registry_demo/README.rst

@@ -120,6 +120,24 @@ Dependencies
 Changelog
 =========
 
+19.0.2.1.0
+~~~~~~~~~~
+
+- feat(demo): add GIS + irrigation scenario (FM4) with reservoir + canal
+  network seed; FM4's idle hectare is now narratively explained as the
+  downstream consequence of reduced reservoir capacity
+- feat(demo): seed farm assets (hand tractor on FM1, water pump on FM8)
+  and a ``manage_farm_asset`` change request in the CR lifecycle
+- feat(demo): add a closed prior-year farm season alongside the active
+  one to demonstrate the ``draft → active → closed`` state machine
+- chore(deps): declare ``spp_gis``, ``spp_land_record``,
+  ``spp_irrigation``, ``spp_farmer_registry_vocabularies`` explicitly —
+  these were used at runtime but never listed
+- docs(demo): add Scenario 10 (GIS + irrigation walk for FM4); document
+  AGROVOC species selection (rice / tilapia) in Scenario 1; add
+  farm-season state-machine sub-step; refresh FM1/FM4/FM8 farm story
+  tables and the CR overview
+
 19.0.2.0.0
 ~~~~~~~~~~
 

spp_farmer_registry_demo/__manifest__.py

@@ -3,7 +3,7 @@
     "name": "OpenSPP Farmer Registry Demo",
     "summary": "Demo generator for Farmer Registry with fixed stories and volume generation",
     "category": "OpenSPP",
-    "version": "19.0.2.0.0",
+    "version": "19.0.2.1.0",
     "sequence": 1,
     "author": "OpenSPP.org",
     "website": "https://github.com/OpenSPP/OpenSPP2",
@@ -25,16 +25,29 @@
         "spp_area",
         # Programs (explicitly used for cycles, entitlements, payments)
         "spp_programs",
+        # GIS / land / irrigation — used by Scenario 10 (FM4 GIS+irrigation walk)
+        "spp_gis",
+        "spp_land_record",
+        "spp_irrigation",
+        # Registrant GIS — adds the Location/coordinates group on the Profile
+        # tab; our view inherits move it to the end of the tab.
+        "spp_registrant_gis",
+        # FAO vocabularies — surface AGROVOC species selection in scenarios
+        "spp_farmer_registry_vocabularies",
     ],
     "external_dependencies": {},
     "data": [
         "security/ir.model.access.csv",
         "data/demo_users.xml",
+        "data/approval_definitions.xml",
         "data/approval_links.xml",
         "data/demo_personas.xml",
         "data/demo_programs.xml",
         "data/logic_packs.xml",
+        "data/disable_group_types.xml",
+        "data/service_types.xml",
         "views/farmer_demo_wizard_view.xml",
+        "views/group_form_overrides.xml",
     ],
     "assets": {},
     "demo": [],

spp_farmer_registry_demo/data/approval_definitions.xml

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+    Farmer Registry Demo - Approval Definitions
+
+    Cycle and entitlement approval definitions consumed by the demo wizard.
+    `farmer_demo_generator.py` wires these onto each program's cycle manager
+    and entitlement manager so the demo programs actually enter the approval
+    workflow when cycles are created or entitlements are disbursed.
+
+    Mirrors `spp_mis_demo_v2/data/approval_definitions.xml` in shape; we add
+    them in farmer demo because MIS demo never assigns these to the program
+    managers (a gap to be fixed in MIS via a separate ticket).
+-->
+<odoo noupdate="1">
+    <!-- Cycle approval — Cycle Approver.
+         Cycle approval is gated on the Cycle Approver functional role, which is
+         the group the "Approve Cycle" button is shown to and the role purpose-
+         built for this in spp_programs. A Program Manager is intentionally NOT
+         a Cycle Approver in the program group hierarchy, so cycle approval must
+         route through this group for the dedicated approver to approve (OP#915).
+         The xmlid is kept stable because farmer_demo_generator wires it onto
+         each program's cycle manager by id. -->
+    <record
+        id="approval_definition_farmer_cycle_manager"
+        model="spp.approval.definition"
+    >
+        <field name="name">Farmer: Cycle Approval - Cycle Approver</field>
+        <field name="model_id" ref="spp_programs.model_spp_cycle" />
+        <field name="approval_type">group</field>
+        <field
+            name="approval_group_id"
+            ref="spp_programs.group_programs_cycle_approver"
+        />
+        <field name="is_require_comment">False</field>
+        <field name="notify_on_submit">True</field>
+        <field name="sla_days">3</field>
+        <field name="active">True</field>
+    </record>
+
+    <!-- Entitlement approval — Program Manager -->
+    <record
+        id="approval_definition_farmer_entitlement_manager"
+        model="spp.approval.definition"
+    >
+        <field name="name">Farmer: Entitlement Approval - Program Manager</field>
+        <field name="model_id" ref="spp_programs.model_spp_entitlement" />
+        <field name="approval_type">group</field>
+        <field name="approval_group_id" ref="spp_programs.group_programs_manager" />
+        <field name="is_require_comment">False</field>
+        <field name="notify_on_submit">True</field>
+        <field name="sla_days">3</field>
+        <field name="active">True</field>
+    </record>
+
+    <!-- Entitlement approval — Cycle Approver (alternate path used by some
+         programs that route through cycle approvers rather than managers). -->
+    <record
+        id="approval_definition_farmer_entitlement_cycle_approver"
+        model="spp.approval.definition"
+    >
+        <field name="name">Farmer: Entitlement Approval - Cycle Approver</field>
+        <field name="model_id" ref="spp_programs.model_spp_entitlement" />
+        <field name="approval_type">group</field>
+        <field
+            name="approval_group_id"
+            ref="spp_programs.group_programs_cycle_approver"
+        />
+        <field name="is_require_comment">False</field>
+        <field name="notify_on_submit">True</field>
+        <field name="sla_days">3</field>
+        <field name="active">True</field>
+    </record>
+
+    <!-- In-kind entitlement approval — Program Manager. Farmer demo's
+         entitlements are cash-only today; we still ship the in-kind
+         definition so admins enabling in-kind variants of the demo
+         programs get the same approval coverage out of the box. -->
+    <record
+        id="approval_definition_farmer_entitlement_inkind_manager"
+        model="spp.approval.definition"
+    >
+        <field
+            name="name"
+        >Farmer: In-Kind Entitlement Approval - Program Manager</field>
+        <field name="model_id" ref="spp_programs.model_spp_entitlement_inkind" />
+        <field name="approval_type">group</field>
+        <field name="approval_group_id" ref="spp_programs.group_programs_manager" />
+        <field name="is_require_comment">False</field>
+        <field name="notify_on_submit">True</field>
+        <field name="sla_days">3</field>
+        <field name="active">True</field>
+    </record>
+</odoo>

spp_farmer_registry_demo/data/approval_links.xml

@@ -67,9 +67,15 @@
     </record>
     -->
 
-    <!-- Manage Farm Assets — disabled until CR type is enabled
-    <record id="spp_farmer_registry_cr.cr_type_manage_farm_asset" model="spp.change.request.type">
-        <field name="approval_definition_id" ref="spp_farmer_registry_cr.approval_def_farmer_cr_local_to_hq" />
+    <!-- Manage Farm Assets — same local→HQ tiered approval as the other
+         farmer CR types (OP#915 round 6). -->
+    <record
+        id="spp_farmer_registry_cr.cr_type_manage_farm_asset"
+        model="spp.change.request.type"
+    >
+        <field
+            name="approval_definition_id"
+            ref="spp_farmer_registry_cr.approval_def_farmer_cr_local_to_hq"
+        />
     </record>
-    -->
 </odoo>