Revision History

Overview

Allow user to generate a rollover report that will tell the user what errors may occur if rolling over with current data.

Preview report should contain : finance rollover errors (budget errors) and clone of new generated budgets.

Constraints

• The current approach can cover rollover for the only one ledger though in real life there can be several ledgers - but this needs to be considered

Assumptions, dependencies

• Ledger Fiscal Year Rollover already implemented.
• It is likely that we will be creating upwards of 75000 - 100000 encumbrances during this process. (statistics from Library). 
• Prepare report with Unpaid invoices is UI responsibility.

Out of Scope

• Prepare report for orders rollover.
• Prepare report for encumbrances rollover.
• Support exchange rate.

Architecturally Significant Requirements

• The preview process should not make changes in real tables, but store the results in a temporary or separate tables.
• Finance rollover preview should be done by the same SQL script as used for Real rollover process.
• Must be compatible with PostgreSQL 10.x

Solution Design

• Current scheme for rollover records - add a column/flag to mark every rollover if it is a real or a preview one - this will also keep the history of completed previews
• mod-finance-storage-master\src\main\resources\templates\db_scripts\budget_encumbrances_rollover.sql - make this script parameterizable; pass a real/preview flag as the input parameter; use different tables depending on the flag value. This will allow not to duplicate the SQL script, but to use the same script for both the real rollover and the preview, and thereby get the correct results for the preview.
• Add another table to store preview data, including Export budget and errors that have occurred; data from this table can then be exported to any convenient format or displayed on the UI

Data Model

Update schema "ledger_fiscal_year_rollover" with new "action" field

Create duplicate of the Budget schema

New schema name : preview_rollover_budget

Schema should be copy of ramls/acq-models/mod-finance/schemas/budget.json where all amounts are "persistent"(remove readOnly flag from all amounts).

Create new table "preview_ledger_fiscal_year_rollover"

Schema for the table "preview_ledger_fiscal_year_rollover"

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Preview ledger fiscal year rollover",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique id of this category",
      "$ref": "../../common/schemas/uuid.json"
    },
     "ledgerFiscalYearRollover": {
      "description": "Fiscal year rollover",
      "type": "object",
      "$ref": "ledger_fiscal_year_rollover.json"
    },
    "previewResult": {
      "description": "Result of preview run",
      "type": "object",
      "$ref": "preview_ledger_fiscal_year_rollover_result.json"
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerFiscalYearRollover",
    "totalRecords"
  ]
}

Schema for the preview result "preview_ledger_fiscal_year_rollover_result"

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Preview ledger fiscal year rollover result",
  "type": "object",
  "properties": {
    "errors": {
      "description": "The list of fiscal year rollover errors",
      "type": "array",
      "items": {
        "$ref": "ledger_fiscal_year_rollover_error.json"
      }
    },
    "budgets": {
      "description": "The list of planned budgets",
      "type": "array",
      "items": {
        "$ref": "preview_rollover_budget.json"
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "totalRecords"
  ]
}

APIs

Preview Ledger Rollover Business API

Preview Ledger Rollover Storage API

Design

Work Breakdown Structure

Open Items