Projections: summarize changes needed to enact a plan

Open
#489 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active

Research direction

Start with the projection model in web/server.core/Domain/Projection.cs, creation and save flows in web/server/Controllers/ProjectionsController.cs, and the appointment, budget, setup, and workspace helpers named in the investigation references. Trace when setup edits occur and how content is saved or duplicated, then compare the retained funding data with the current-only appointment values. Done means a read-only report meets the acceptance checks; implementation is explicitly deferred, and the complete staffing comparison requires cross-stack snapshot and comparison work.

Written by the indexing model from the issue text.

Description

enhancement

Problem

After adjusting a projection, a faculty member or project manager can see the resulting forecast but cannot easily identify the changes needed to put that plan into practice. Those changes may include extending an appointment, changing a salary or funding allocation, moving budget between categories, or extending a funding period.

Add a read-only Plan changes report that compares the final plan with its original captured inputs. The direction is accepted for future work; implementation is deferred. This issue does not request changes to the current projections release.

Proposed experience

Place a Plan changes button beside Plan details, opening a wide dialog using the existing dialog pattern. Keep the four main workspace tabs unchanged. Show the comparison date and the number of affected appointments and funding sources, then group the report into staffing and funding.

  • Staffing: group by appointment, showing the person's name, job title and identifying position information. Show only changed assumptions, with original and planned values for salary, FTE, appointment dates, fringe/fee assumptions and funding allocations. Label salary as the full-time base salary assumption. Combine adjacent periods with identical allocation changes and allow allocation details to expand.
  • Funding: group by project/task. Show original available budget, net adjustment and revised available budget for each changed category, plus the source total. Show original and planned funding dates. Distinguish increased/decreased overall funding from redistribution among categories.
  • Additions: identify new appointments and planned funding sources, including their proposed terms.
  • Exclusions: if reported, describe items as removed from this plan or excluded from the forecast. Do not imply an employee is being terminated or a project closed.

The report shows the final difference, not an edit timeline. If a salary changes twice, show its original and final values. If an edit is reverted, remove that change from the report. Ordinary saves and duplication must preserve the original comparison. Include applied, unsaved workspace edits with a clear unsaved indication; exclude incomplete values still inside an editor.

Example: extending Alex's appointment from June 30 to September 30 and moving $14,000 out of supplies into salary and fringe should produce explicit staffing and rebudgeting entries, even if the total source funding is unchanged.

Mockup

Illustrative data only. The screenshot shows the proposed report and expandable funding-allocation detail. It is a design reference, not an implemented screen.

Plan changes mockup showing staffing, funding allocations, rebudgeting and funding dates

Feasibility and data requirements

Budget and funding-date comparisons are supported by the data already retained. Staffing comparisons require new baseline retention.

  • Imported funding sources retain captured start/end dates separately from editable dates, and retain original budgets alongside net category adjustments. Planned sources have no captured dates and should appear as additions.
  • Category adjustments retain net category changes, not transfer events. Show exact reductions and increases, but do not invent donor-to-recipient transfer paths when several categories changed. Preserve meaningful newly established zero-budget categories.
  • Appointments currently retain only their current values. The client's existing baseline means the last saved draft and resets after saving, so it cannot serve as the original staffing baseline.
  • Capture immutable original staffing before setup edits begin, with enough funding-source identity and selection provenance to explain allocation changes. Capturing only when the reviewed plan is first saved is too late.
  • Preserve that baseline through ordinary saves and duplication. Keep stable identities across removals and additions; current maximum-plus-one IDs can be reused after removal. Normalize allocation schedules before comparison.
  • Respect setup scope. People and sources never selected into the plan must not appear as removals. Baseline handling must also distinguish scope exclusions from explicit changes.
  • Existing saved plans cannot reliably reconstruct original staffing. Show their supported budget/date comparisons and state that staffing comparison is unavailable. Do not silently treat current values as originals or compare against today's live data.

A budget/date-only report is a small UI/helper change. The complete staffing version is a medium cross-stack feature covering snapshot capture, persistence and validation, identities, comparison logic and regression coverage. An optional addition to the existing JSON content may avoid a physical database schema change; confirm that during implementation.

Existing constraints and first-version boundaries
  • Imported employee identity fields, including title and job code, are currently protected from editing. Supporting title changes is a separate feature; this report should describe changes the planner actually supports.
  • Salary is currently a base assumption across the forecast. Do not invent an HR effective date.
  • Funding dates are task/source dates. Use labels such as Funding end date, without implying that an award extension has been approved.
  • Leave expense changes, historical edit logs, transfer-event history, approval/completion tracking and automatic payroll or finance updates out of the initial version.

Acceptance checks

  • An unchanged plan shows no changes; changing and reverting an assumption removes its entry.
  • Staffing edits made during setup remain visible after creation, save, reload and duplication.
  • New, excluded and removed appointments/sources are classified without false administrative implications or ID collisions.
  • Allocation comparisons are correct for multiple sources, outside-plan funding, partial periods and equivalent adjacent date ranges.
  • Rebudgeting shows exact signed category changes and correct source totals for both zero-sum moves and net funding changes.
  • Funding-date comparisons show original and proposed dates; planned sources are identified as additions.
  • Older plans show supported comparisons and an honest staffing limitation.
  • Only applied workspace edits appear, with unsaved changes identified. Incomplete editor inputs do not appear.
  • The dialog is keyboard accessible, handles long names and many changes, and returns focus to its opener.
  • Tests cover snapshot immutability, setup timing, save/duplicate preservation, reverted edits and the edge cases above. Database testing remains isolated.
Code investigation references

Findings reviewed at commit c75f7410803aa4ee5c79231f4baf2205290158ad:

Related projections work: #467 and #472.

Dominant language
TypeScript
Stars
0
Forks
1
Avg merge
19h 34m
Merged PRs (30d)
22

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ucdavis/Walter

All issues in ucdavis/Walter

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.