Page Comparison

Author

Andrei Makaranka

JIRA task

Jira Legacy

server	System Jira
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	Yellow
title	In Progress

PO review

Dennis Bridges

Status

colour	Yellow
title	In Progress

...

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.

...

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

...

Schema name : ledger_fiscal_year_rollover_log_collection

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 rollover runs",
  "type": "object",
  "properties": {
    "logs": {
      "description": "The list of  rollover runs",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": [
        {
          "typefieldName": "arrayledgerRolloverId",
        "items": {
        "$reftargetTable": "ledger_fiscal_year_rollover_log.json",
      }     }"tableAlias": "ledgerFYROBudget",
    "totalRecords": {
      "descriptiontargetTableAlias": "The number of records contained in this collection",
ledgerFYRO",
          "typetOps": "integerADD",
        "minimum":}
0     } ]
 },   "additionalProperties": false,
  "required": [
    "budgets",
    "totalRecords"
  ]
}

APIs

Ledger Rollover generated Budgets Business API

...

Method

...

Path

...

Request

...

Response

...

Description

...

Interface

...

Notes

...

ledger_fiscal_year_rollover_budget

...

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".
status	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-
ledgerRolloverType	enum ["Preview", "Commit", "Rollback"]	true	NA	Y

Schema name : ledger_fiscal_year_rollover_log_collection

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 rollover runs",
  "type": "object",
  "properties": {
    "logs": {
      "description": "The list of  rollover runs",
      "type": "array",
      "items": {
        "$ref": "ledger_fiscal_year_rollover_log.json"
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "budgets",
    "totalRecords"
  ]
}

APIs

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-

logs

budgets/{id}

NA

ledger_fiscal_year_rollover_

log

budget

GET

logs

budgets of the ledger fiscal year rollover by id

finance.ledger-rollovers-

logs

budgets.item.get	Status : 200
GET	/finance/ledger-rollovers-

logs

budgets

NA

ledger_fiscal_year_rollover_

log

budget_collection

GET

logs

budgets of the ledger fiscal year rollovers

finance.ledger-rollovers-

logs

budgets.collection.get

Status : 200

...

Ledger Rollover

...

Logs Business 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	ledger_fiscal_year_rollover_log_collection	GET logs of the ledger fiscal year rollovers	finance-storage.ledger-rollovers-logs.collection.get	Status : 200

...

Work

Comments

Story

~ Estimate

1

Update schema "ledger_fiscal_year_rollover" with new "action" fieldCreate duplicate of the Budget schema where all amounts are "persistent""action" field
Define schema and table for preview rollover results → Define schema and table for preview rollover resultsnew 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 : Preview Ledger Rollover Budgets and Logs
Implement API → Should be without any logic.
Update delete rollover logic : org.folio.service.rollover.LedgerRolloverService#deleteRollover
Business logic for POST will be implemented in scope of MODFISTO-318

mod-finance-storage

Jira Legacy

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

1

3

Define API : Preview Ledger Rollover → Business API : Preview Ledger Rollover Budgets and Logs
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 table

mod-finance-storage

Jira Legacy

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

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_ledger_fiscal_year_rollover", 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_rollover

mod-finance-storage

Jira Legacy

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

7

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

mod-finance

Jira Legacy

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

8

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

mod-finance

Jira Legacy

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

...

Versions Compared

Old Version 33

New Version 34

Key

Create new DB Table "ledger_fiscal_year_rollover_

budget" → schema.json

Create ledger fiscal year rollover Logs schemas

Schema name : ledger_fiscal_year_rollover_log_collection

Ledger Rollover generated Budgets Business API

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