| Author | Andrei Makaranka | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| JIRA task |
| ||||||||
| Business Requirements | |||||||||
| Architects Review |
| ||||||||
| PO review |
|
| Table of Contents | ||
|---|---|---|
|
...
| Version | Date | Owner | Description | Reason |
|---|---|---|---|---|
| v1.0 | 06.14.2022 | Andrei Makaranka | Initial version | |
| v2.0 | 06.22.2022 | Schema changed and WBS added | ||
| v2.1 | 06.30.2022 | 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 |
|
Create
...
ledger fiscal year rollover Budget schemas
Shema name : ledger_fiscal_year_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 "ledger_fiscal_year_rollover_budgets"
Schema for the table "Also link on Ledger Rollover ("ledgerRolloverId")
| Code Block | ||||||
|---|---|---|---|---|---|---|
|
...
| Code Block | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "ContainsA abudget",
list of budgets generated during the rollover. Also budgets include all calculated mounts","type": "object",
"javaName": "budget",
"extends" : {
"type$ref" : "object"../../common/schemas/entity.json"
},
"properties": {
"budgetsid": {
"description": "The listUUID of fiscal year rollover errorsthis budget",
"type$ref": "array",../../common/schemas/uuid.json"
},
"itemsledgerRolloverId": {
"$refdescription": "rollover_budget.json"Ledger fiscal year rollover UUID",
}"$ref": "../../common/schemas/uuid.json"
},
"totalRecordsname": {
"description": "The numbername of records contained in this collectionthe budget",
"type": "integer",string"
},
"budgetStatus": {
"minimumdescription": 0"The status of the budget",
} }, "additionalPropertiestype": false,"string",
"requiredenum": [
"budgetsActive",
"totalRecords" "Frozen",
"Inactive",
"Planned",
"Closed"
]
} |
APIs
Ledger Rollover Budgets snapshot Business API
...
},
"allowableEncumbrance": {
"description": "The encumbrance percentage limit for this budget",
"type": "number"
},
"allowableExpenditure": {
"description": "The expenditure percentage limit for this budget",
"type": "number"
},
"allocated": {
"description": "The amount currently allocated to this budget",
"type": "number"
},
"awaitingPayment": {
"default": 0,
"description": "The amount currently awaiting payment for this budget",
"type": "number"
},
"available": {
"description": "The amount currently available for this budge",
"type": "number"
},
"encumbered": {
"default": 0,
"description": "The amount currently encumbered for this budget",
"type": "number"
},
"expenditures": {
"default": 0,
"description": "The amount currently expended for this budget",
"type": "number"
},
"netTransfers": {
"default": 0,
"description": "Summing all the transfers on this budget",
"type": "number"
},
"unavailable" : {
"description": "Unavailable amount for this budget",
"type": "number"
},
"overEncumbrance": {
"description": "The amount currently over-encumbered for this budget",
"type": "number"
},
"overExpended": {
"description": "Amount the budget is over expended.",
"type": "number"
},
"fundId": {
"description": "UUID of fund",
"$ref": "../../common/schemas/uuid.json"
},
"fiscalYearId": {
"description": "UUID of fiscal year",
"$ref": "../../common/schemas/uuid.json"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this budget",
"type": "array",
"items": {
"$ref": "../../common/schemas/uuid.json"
}
},
"tags": {
"type": "object",
"description": "arbitrary tags associated with this budget",
"$ref": "../../../raml-util/schemas/tags.schema"
},
"metadata": {
"type": "object",
"$ref": "../../../raml-util/schemas/metadata.schema",
"readonly": true
},
"initialAllocation": {
"default": 0,
"description": "The amount of the first allocation made to this budget",
"type": "number"
},
"allocationTo": {
"default": 0,
"description": "The sum of all allocation transaction amounts made TO this budget not including the Initial allocation",
"type": "number"
},
"allocationFrom": {
"default": 0,
"description": "The sum of all allocation transaction amounts made FROM this budget not including the Initial allocation",
"type": "number"
},
"totalFunding": {
"description": "budget.allocated + budget.netTransfers",
"type": "number"
},
"cashBalance": {
"description": "Total Funding minus Expended",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"budgetStatus",
"name",
"fundId",
"fiscalYearId"
]
}
|
Schema name: ledger_fiscal_year_rollover_budget_collection
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"$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"
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"tableName": "ledger_fiscal_year_rollover_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- |
| ledgerRolloverType | enum ["Preview", "Commit", "Rollback"] | true | NA | Y |
Schema name : ledger_fiscal_year_rollover_log_collection
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"$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-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
Method | Path | Request | Response | Description | Interface | Notes | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | /finance/ledger-rollovers/-logs/{id} | NA | preview_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 | .itemNA | 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 | preview_ |
Design
Work Breakdown Structure
| Work | Comments | Story | ~ Estimate | |
|---|---|---|---|---|
| 1 |
|
Preview Ledger Rollover Storage API
...
Method
...
Path
...
Request
...
Response
...
Description
...
Interface
...
Notes
...
/finance-storage/ledger-rollovers/logs/{id}
...
Design
Work Breakdown Structure
| Work | Comments | Story | ~ Estimate | 1 |
| acq-models, mod-finance-storage, mod-finance | | Jira Legacy | server | System Jira
2.1. Create ledger fiscal year rollover Budget schemas | acq-models, mod-finance-storage, mod-finance |
| 1 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2 |
| mod-finance-storage |
| 1 | ||||||||||||||||
| 3 |
| mod-finance |
| 1 | ||||||||||||||||
| 24 |
| mod
| mod-finance-storage All all open technical questions should be resolved |
| 15 | |||||||||||||||
| 3 |
| mod-finance-storage | 5 | Update ledger rollover SQL script with preview rollover logic and store results in the preview rollover table
| 1 | |||||||||||||||
| 4 |
| mod-finance-storage All all open technical questions should be resolved |
| 5 | ||||||||||||||||
| ||||||||||||||||||||
| 6 | Implement Preview rollover flow and update budgets with all calculated amounts
1.1 Rollover script run (field LedgerFiscalYearRollover."action" = "Preview") 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 |
| 6 | Implement Preview rollover flow and update budgets with all calculated amounts
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
| |||||||||||||||
| 7 | Replace unique index in the table "ledger_fiscal_year_rollover" with uniqueness logic in the code
2.1 If incoming rollover is real with action "Commit", 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 |
| |||||||||||||||||
| 78 |
| mod-finance |
| |||||||||||||||||
| 89 |
| mod-finance |
|
...