Author

Andrei Makaranka

JIRA task

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	UXPROD-2899

Business Requirements

Allow User to generate a preview of fiscal year rollover

Architects Review

Raman Auramau

Status


colour	YellowGreen
title	In ProgressDONE

PO review

Dennis Bridges

Status


colour	YellowGreen
title	In ProgressDONE

Table of Contents

maxLevel	5

...

Version	Date	Owner	Description	Reason
v1.0	06.14.2022	Andrei Makaranka	Initial version
v2.0	06.22.2022	Andrei Makaranka	Schema changed and WBS added
v2.1	06.30.2022	Andrei Makaranka	Status for preview added
v3.0	07.07.20202022	Andrei Makaranka	Redesign and rollover logs functionality added	Requirements changed

Overview

...


v4.0	08.03.2022	Andrei Makaranka	Rename "action" field tp "rolloverType"

Overview

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

...

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.

...

Property

Type

Read Only

Default

Required

Notes

actionrolloverType

enum ["Preview", "Commit", "Rollback"]

truefalse

Commit

Y

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

...

Code Block

language	groovy
theme	Midnight
title	ledger_fiscal_year_rollover_budget_collection
collapse	true

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Contains a list of budgets generated during the rollover. Also budgets include all calculated mounts",
  "type": "object",
  "properties": {
    "budgets": {
      "description": "The list of fiscal year rollover errors",
      "type": "array",
      "items": {
        "$ref": "ledger_fiscal_year_rollover_budget.json"
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "budgets",
    "totalRecords"
  ]
}

Create new DB Table "ledger_fiscal_year_rollover_

...

budget" → schema.json

In the database will be stored records with type of "ledger_fiscal_year_rollover_budget"

Create ledger fiscal year rollover Logs schemas

...

Code Block

theme	Midnight
title	ledger_fiscal_year_rollover_budget
collapse	true

    {
      "tableName": "ledger_fiscal_year_rollover_

...

ledgerRolloverId

UUID

...

Y

...

budget",
      "fromModuleVersion": "mod-finance-storage-8.1.7",
      "withMetadata": true,
      "index": [
        {
          "fieldName": "ledgerRolloverId",
          "tOps": "ADD",
          "caseSensitive": false,
          "removeAccents": true
        },
        {
          "fieldName": "fundId",
          "tOps": "ADD",
          "caseSensitive": false,
          "removeAccents": true
        },
        {
          "fieldName": "fiscalYearId"
        }
      ],
      "foreignKeys": [
        {
          "fieldName": "ledgerRolloverId",
          "targetTable": "ledger_fiscal_year_rollover",
          "tableAlias": "ledgerFYROBudget",
          "targetTableAlias": "ledgerFYRO",
          "tOps": "ADD"
        }
      ]
    }

Create ledger fiscal year rollover Logs schemas

Schema name : ledger_fiscal_year_rollover_log

Property	Type	Read Only	Default	Required	Notes
ledgerRolloverId	UUID	true	NA	Y
startDate	date-time	true	NA	Y	This is "creratedDate" from rollover metadata.
endDate	date-time	true	NA		This is "updatedDate" from rollover metadata. Should be provided only when "status" is "Success" or "Error".
rolloverStatus	ramls/acq-models/mod-finance/schemas/rollover_status.json	true	NA	Y
errorsLink	String or pattern	true	NA	N	If possible Link should included environment URL : https://okapi-bugfest-lotus.int.aws.folio.org/finance/ledger-rollovers-errors?query=ledgerRolloverId=={id}fff-e-errors
budgetsLink	String or pattern	true	NA	N	If possible Link should included environment URL : https://okapi-bugfest-lotus.int.aws.folio.org/finance/ledger-rollovers-budgets?

query=ledgerRolloverId=={id}fff-

query=ledgerRolloverId=={id}fff-
ledgerRolloverType	enum ["Preview", "Commit", "Rollback"]	true	NA	Y

Schema name : ledger_fiscal_year_rollover_log_collection

...

Ledger Rollover generated Budgets Business API

Method	Path	Request	Response	Description	Interface	Notes
GET	/finance/ledger-rollovers-budgets/{id}	NA	ledger_fiscal_year_rollover_budget	GET budgets of the ledger fiscal year rollover by id	finance.ledger-rollovers-budgets.item.get	Status : 200
GET	/finance/ledger-rollovers-budgets	NA	ledger_fiscal_year_rollover_budget_collection	GET budgets of the ledger fiscal year rollovers	finance.ledger-rollovers-budgets.collection.get	Status : 200

Ledger Rollover generated Budgets Storage API

Method	Path	Request	Response	Description	Interface	Notes
GET	/finance/ledger-rollovers-budgets/{id}	NA	ledger_fiscal_year_rollover_budget	GET budgets of the ledger fiscal year rollover by id	finance.ledger-rollovers-budgets.item.get	Status : 200
GET	/finance/ledger-rollovers-budgets	NA	ledger_fiscal_year_rollover_budget_collection	GET budgets of the ledger fiscal year rollovers	finance.ledger-rollovers-budgets.collection.get	Status : 200

Ledger Rollover Logs Business API

/{id} rollover by iditem

Method	Path	Request	Response	Description	Interface	Notes		Interface	Notes
GET	/finance/ledger-rollovers-logs/{id}	NA	ledger_fiscal_year_rollover_log	GET logs of the ledger fiscal year rollover by id	finance.ledger-rollovers-logs.item.get	Status : 200
GET	/finance/ledger-rollovers-logs		NA	ledger_fiscal_year_rollover_log_collection	GET logs of the ledger fiscal year	rollovers	finance.ledger-rollovers-logs.	collection.get	Status : 200
GET	/finance/ledger-rollovers-logs	NA	ledger_fiscal_year_rollover_log_collection	GET logs of the ledger fiscal year rollovers	finance.ledger-rollovers-logs.collection.get	Status : 200

Preview Ledger Rollover Storage API

Method	Path	Request	Response	Description	Interface	Notes
GET	/finance-storage/ledger-rollovers-logs/{id}	NA	ledger_fiscal_year_rollover_log	GET logs of the ledger fiscal year rollover by id	finance-storage.ledger-rollovers-logs.item.get	Status : 200
GET	/finance-storage/ledger-rollovers-logs	NA

Design

Work Breakdown Structure

Work

Comments

Story

~ Estimate

1

Update schema "ledger_fiscal_year_rollover" with new "action" field
Define schema and table for preview rollover results → Define new schemas and table

2.1. Create ledger fiscal year rollover Budget schemas
2.2. Create ledger fiscal year rollover Log schemas
2.3. Define new table for storing generated budgets in scope of Rollover

acq-models, mod-finance-storage, mod-finance

Jira Legacy

server	System JIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-319

1

2

Define Storage API : Preview Ledger Rollover → Storage API : Ledger Rollover Budgets
Implement API → Should be without any logic.

mod-finance-storage

Jira Legacy

server	System JIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-320

1

3

Work

Comments

Story

~ Estimate

1

Update schema "ledger_fiscal_year_rollover" with new "action" field
Create duplicate of the Budget schema where all amounts are "persistent"
Define schema and table for preview rollover results → Define schema and table for preview rollover results

acq-models, mod-finance-storage, mod-finance

Define and Implement Budgets API → Budgets Ledger Rollover Business API
Define and Implement Logs API → Logs view should be built accordingly with ledger_fiscal_year_rollover_log

_collectionGET logs of the ledger fiscal year rolloversfinance-storage.ledger-rollovers-logs.collection.getStatus : 200

Design

Work Breakdown Structure

Ledger Rollover Logs Business API

mod-finance

Jira Legacy

server	System JIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFIN-256

1

4

Spike : Implement POC with storing preview result in the temporary tables and after that upload results in the preview rollover table

mod-finance-storage

All all open technical questions should be resolved

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-319322

15

2

Define Storage API : Preview Ledger Rollover → Storage API : Preview Ledger Rollover
Implement API → Should be without any logic.
Business logic for POST will be implemented in scope of MODFISTO-318

mod5

Update ledger rollover SQL script with preview rollover logic and store results in the preview rollover table

mod-finance-storage

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-320323

1

3

Define API : Preview Ledger Rollover → Business API : Preview Ledger Rollover
Implement API → Should be Proxy to storage layer without any logic
Sending email will be added in scope of MODFIN-257

mod-finance

Jira Legacy

server	System Jira
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFIN-256

1

4

Spike : Implement POC with storing preview result in the temporary tables and after that upload results in the preview rollover table

mod-finance-storage

All all open technical questions should be resolved

Jira Legacy

server	System Jira
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-322

5

Update ledger rollover SQL script with preview rollover logic and store results in the preview rollover table6

Implement Preview rollover flow and update budgets with all calculated amounts

Steps should be run in scope of one DB transaction :

1.1 Rollover script run (field LedgerFiscalYearRollover."action" = "Preview")
1.2 Retrieve result of preview from table "ledger_fiscal_year_rollover_budget", where budgets amounts will be partially filled (MODFISTO-323)
1.3. Go through all budgets and calculate remaining amounts → org.folio.utils.CalculationUtils#calculateBudgetSummaryFields
1.4. Storing updated budgets in the rollover preview table → ledger_fiscal_year_rollover_budget

2. Update delete rollover logic : org.folio.service.rollover.LedgerRolloverService#deleteRollover. Rollover record deletion should happened together with rollover budgets in scope of one DB transaction

mod-finance-storage

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-323318

6

Implement Preview rollover flow and update budgets with all calculated amounts

Steps should be run in scope of one DB transaction :

1.1 Rollover script run (field LedgerFiscalYearRollover."action" = "Preview")
1.2 Retrieve result of preview from table "preview_7

Replace unique index in the table "ledger_fiscal_year_rollover" with uniqueness logic in the code

Remove index "ledgerId_fromFiscalYearId" from table "ledger_fiscal_year_rollover"
Implement validation logic in the separate validation service:

2.1 If incoming rollover is real with action ", where budgets amounts will be partially filled (MODFISTO-323)
1.3. Go through all budgets and calculate remaining amounts → org.folio.utils.CalculationUtils#calculateBudgetSummaryFields
1.4. Storing updated budgets in the rollover preview table → preview_ledger_fiscal_year_rolloverCommit", then rollover record should be unique for pair "ledgerId, fromFiscalYearId" (the same as in the index)

2.2 If incoming rollover is real with action "Preview", then rollover record should not be unique for pair "ledgerId, fromFiscalYearId" and it possible to have many previews for one ledger and same fiscal year.

mod-finance-storage

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFISTO-318327

78

Spike : To gain knowledge about mod-email and implement example with usage email sending

mod-finance

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFIN-258

89

Implement sending email and include it in the preview ledger rollover flow

mod-finance

Jira Legacy

server	System JiraJIRA
serverId	01505d01-b853-3c2e-90f1-ee9b165564fc
key	MODFIN-257

...

Versions Compared

Old Version 32

New Version Current

Key

Overview

Overview

Create new DB Table "ledger_fiscal_year_rollover_

budget" → schema.json

Create ledger fiscal year rollover Logs schemas

Create ledger fiscal year rollover Logs schemas

Schema name : ledger_fiscal_year_rollover_log

Schema name : ledger_fiscal_year_rollover_log_collection

Ledger Rollover generated Budgets Business API

Ledger Rollover generated Budgets Storage API

Ledger Rollover Logs Business API

ledger_fiscal_year_rollover_log_collection

Preview Ledger Rollover Storage API

ledger_fiscal_year_rollover_log

Design

Work Breakdown Structure

Design

Work Breakdown Structure

Page Comparison

Versions Compared

Old Version 32

New Version Current

Key

Overview

Overview

Create new DB Table "ledger_fiscal_year_rollover_

budget" → schema.json

Create ledger fiscal year rollover Logs schemas

Create ledger fiscal year rollover Logs schemas

Schema name : ledger_fiscal_year_rollover_log

Schema name : ledger_fiscal_year_rollover_log_collection

Ledger Rollover generated Budgets Business API

Ledger Rollover generated Budgets Storage API

Ledger Rollover Logs Business API

ledger_fiscal_year_rollover_log_collection

Preview Ledger Rollover Storage API

ledger_fiscal_year_rollover_log

Design

Work Breakdown Structure

Design

Work Breakdown Structure