From 9d943a591984010e66b852dd8d9cd6705ee2ea07 Mon Sep 17 00:00:00 2001 From: Jonathan Niles Date: Wed, 27 Jan 2021 15:46:37 +0100 Subject: [PATCH] feat(stock): add option to view AMC calcs Adds the ability to view the AMC/CMM calculations in the Articles in Stock Registry. A summary of the information is presented for the user to examine and the explicit formula used to calculate the AMC is shown for the user to validate. Closes #5291. --- client/src/i18n/en/inventory.json | 1 + client/src/i18n/en/stock.json | 15 ++- client/src/i18n/fr/inventory.json | 1 + client/src/js/services/StockService.js | 5 + .../stock/inventories/modals/amc.modal.html | 115 ++++++++++++++++++ .../stock/inventories/modals/amc.modal.js | 31 +++++ .../src/modules/stock/inventories/registry.js | 7 ++ .../templates/inventory.action.html | 8 ++ .../modules/stock/lots/modals/edit.modal.html | 5 +- client/src/modules/stock/stock.service.js | 15 +++ server/controllers/inventory/depots/extra.js | 21 +++- 11 files changed, 221 insertions(+), 3 deletions(-) create mode 100644 client/src/modules/stock/inventories/modals/amc.modal.html create mode 100644 client/src/modules/stock/inventories/modals/amc.modal.js diff --git a/client/src/i18n/en/inventory.json b/client/src/i18n/en/inventory.json index eee33c21c5..55ac95a94a 100644 --- a/client/src/i18n/en/inventory.json +++ b/client/src/i18n/en/inventory.json @@ -1,6 +1,7 @@ { "INVENTORY": { "ADD_GROUP": "Add Inventory Group", + "OPEN_AMC_CALCULATION" : "View AMC Calculations", "ADD_METADATA": "Add Inventory Item", "ADD_TYPE": "Add Inventory Type", "ADD_UNIT": "Add Inventory unit form", diff --git a/client/src/i18n/en/stock.json b/client/src/i18n/en/stock.json index e70d22719b..3e3444eab7 100644 --- a/client/src/i18n/en/stock.json +++ b/client/src/i18n/en/stock.json @@ -114,6 +114,7 @@ "MONTH_OF_STOCK" : "Stock Months - Months until Stock Out", "MONTHLY_CONSUM" : "Average Monthly Consumption", "MONTHLY_CONSUMPTION" : { + "AVERAGE_MONTHLY_CONSUMPTION" : "Average Monthly Consumption", "ALGO_1" : "Algorithm 1", "ALGO_1_COMMENT" : "The average monthly consumption is obtained by dividing the quantity consumed during the period by the number of days with stock for the period, and by multiplying the result by 30.5.", "ALGO_2" : "Algorithm 2", @@ -121,7 +122,19 @@ "ALGO_3" : "Algorithm 3", "ALGO_3_COMMENT" : "The average consumption is obtained by dividing the quantity consumed during the period by the number of days in the period, and by multiplying the result obtained by 30.5.", "ALGO_4" : "Algorithm 4 (MSH)", - "ALGO_4_COMMENT" : "The average consumption is obtained by dividing the quantity consumed during the period by the difference of the number of months in the period minus the total number of days of stock out in the period. The MSH algorithm is recommended by the Management Sciences for Health organization (https://www.msh.org)." + "ALGO_4_COMMENT" : "The average consumption is obtained by dividing the quantity consumed during the period by the difference of the number of months in the period minus the total number of days of stock out in the period. The MSH algorithm is recommended by the Management Sciences for Health organization (https://www.msh.org).", + "FIRST_INVENTORY_MOVEMENT_DATE" : "First Recorded Movement", + "LAST_INVENTORY_MOVEMENT_DATE" : "Last Recorded Movement", + "DAYS_BEFORE_CONSUMPTION" : "Days before First Consumption", + "NUMBER_OF_MONTHS" : "Number of Months", + "SUM_CONSUMPTION_DAY" : "Stock Consumption", + "SUM_CONSUMED_QUANTITY" :"Quantity Consumed", + "SUM_DAYS" : "Total Days", + "SUM_STOCK_DAY" : "Stock Available in Depot", + "SUM_STOCK_OUT_DAYS" : "Stock Outs", + "TITLE" : "Average Monthly Consumption", + "DAYS" : "Days", + "MONTHS" : "Months" }, "MOTIF" : "Motive", "MOVEMENT" : "Movement", diff --git a/client/src/i18n/fr/inventory.json b/client/src/i18n/fr/inventory.json index 5038eafbc2..edac521540 100644 --- a/client/src/i18n/fr/inventory.json +++ b/client/src/i18n/fr/inventory.json @@ -1,6 +1,7 @@ { "INVENTORY": { "ADD_GROUP": "Ajouter un groupe d'inventaire", + "OPEN_AMC_CALCULATION" : "Voire CMM calcules", "ADD_METADATA": "Ajouter un inventaire", "ADD_TYPE": "Ajouter un type d'inventaire", "ADD_UNIT": "Ajouter une forme d'Inventaire", diff --git a/client/src/js/services/StockService.js b/client/src/js/services/StockService.js index 57b142df4f..df39a709ba 100644 --- a/client/src/js/services/StockService.js +++ b/client/src/js/services/StockService.js @@ -190,6 +190,11 @@ function StockService(Api, StockFilterer, HttpCache, util, Periods) { }); } + inventories.loadAMCForInventory = function loadAMCForInventory(inventoryUuid, depotUuid) { + return inventories.$http.get(`/depots/${depotUuid}/inventories/${inventoryUuid}/cmm`) + .then(util.unwrapHttpResponse); + }; + return { stocks, stockAssign, diff --git a/client/src/modules/stock/inventories/modals/amc.modal.html b/client/src/modules/stock/inventories/modals/amc.modal.html new file mode 100644 index 0000000000..da95bf85cf --- /dev/null +++ b/client/src/modules/stock/inventories/modals/amc.modal.html @@ -0,0 +1,115 @@ +
+
    +
  1. {{ModalCtrl.depot.text}}
    2. +
  2. {{ModalCtrl.inventory.groupName}}
    3. +
  3. {{ModalCtrl.inventory.code}} - {{ModalCtrl.inventory.label}}
    4. +
+
+ +
+ +

+ + + STOCK.MONTHLY_CONSUMPTION.ALGO_1 +
+ STOCK.MONTHLY_CONSUMPTION.ALGO_1_COMMENT + + + + STOCK.MONTHLY_CONSUMPTION.ALGO_2 +
+ STOCK.MONTHLY_CONSUMPTION.ALGO_2_COMMENT + + + + STOCK.MONTHLY_CONSUMPTION.ALGO_3 +
+ STOCK.MONTHLY_CONSUMPTION.ALGO_3_COMMENT + + + + STOCK.MONTHLY_CONSUMPTION.ALGO_4 +
+ STOCK.MONTHLY_CONSUMPTION.ALGO_4_COMMENT + +

+ +
+ +
+
+
STOCK.INVENTORY
+
{{ModalCtrl.inventory.code}} - {{ModalCtrl.inventory.label}}
+ +
STOCK.MONTHLY_CONSUMPTION.NUMBER_OF_MONTHS
+
+ {{ModalCtrl.data.start_date | date }} − {{ModalCtrl.data.end_date | date}} + ({{ModalCtrl.data.number_of_month}} STOCK.MONTHLY_CONSUMPTION.MONTHS) +
+ +
STOCK.MONTHLY_CONSUMPTION.FIRST_INVENTORY_MOVEMENT_DATE
+
{{ModalCtrl.data.first_inventory_movement_date | date }}
+ +
STOCK.MONTHLY_CONSUMPTION.LAST_INVENTORY_MOVEMENT_DATE
+
{{ModalCtrl.data.last_inventory_movement_date | date }}
+ +
STOCK.MONTHLY_CONSUMPTION.SUM_CONSUMED_QUANTITY
+
{{ModalCtrl.data.sum_consumed_quantity }} {{ModalCtrl.inventory.unit}}
+ +
STOCK.MONTHLY_CONSUMPTION.SUM_CONSUMPTION_DAY
+
{{ModalCtrl.data.sum_consumption_day}} STOCK.MONTHLY_CONSUMPTION.DAYS
+ +
STOCK.MONTHLY_CONSUMPTION.SUM_STOCK_DAY
+
{{ModalCtrl.data.sum_stock_day}} STOCK.MONTHLY_CONSUMPTION.DAYS
+ +
STOCK.MONTHLY_CONSUMPTION.SUM_STOCK_OUT_DAYS
+
{{ModalCtrl.data.sum_stock_out_days}} STOCK.MONTHLY_CONSUMPTION.DAYS
+
+
+ + +
+ + + + + + + + + + + + + + + + + +
STOCK.MONTHLY_CONSUMPTION.ALGO_1STOCK.MONTHLY_CONSUMPTION.ALGO_2STOCK.MONTHLY_CONSUMPTION.ALGO_3STOCK.MONTHLY_CONSUMPTION.ALGO_4
{{ModalCtrl.data.algo1}}{{ModalCtrl.data.algo2}}{{ModalCtrl.data.algo3}}{{ModalCtrl.data.algo_msh}}
+ +
+ +
+
STOCK.MONTHLY_CONSUMPTION.ALGO_1
+
30.5 × ({{ModalCtrl.data.sum_consumed_quantity}} / {{ModalCtrl.data.sum_stock_day}}) = {{ModalCtrl.data.avg_consumption}}
+ +
STOCK.MONTHLY_CONSUMPTION.ALGO_2
+
30.5 × ({{ModalCtrl.data.sum_consumed_quantity}} / {{ModalCtrl.data.sum_consumption_day}}) = {{ModalCtrl.data.avg_consumption}}
+ +
STOCK.MONTHLY_CONSUMPTION.ALGO_3
+
30.5 × ({{ModalCtrl.data.sum_consumed_quantity}} / {{ModalCtrl.data.sum_days}}) = {{ModalCtrl.data.avg_consumption}}
+ +
STOCK.MONTHLY_CONSUMPTION.ALGO_4
+
{{ModalCtrl.data.sum_consumed_quantity}} / ({{ModalCtrl.data.number_of_month}} − ({{ModalCtrl.data.sum_stock_out_days}} / 30.5)) = {{ModalCtrl.data.avg_consumption}}
+
+
+
+
+ +
+ +
diff --git a/client/src/modules/stock/inventories/modals/amc.modal.js b/client/src/modules/stock/inventories/modals/amc.modal.js new file mode 100644 index 0000000000..08c7c6794b --- /dev/null +++ b/client/src/modules/stock/inventories/modals/amc.modal.js @@ -0,0 +1,31 @@ +angular.module('bhima.controllers') + .controller('StockAMCModalController', StockAMCModalController); + +StockAMCModalController.$inject = [ + 'StockService', 'NotifyService', '$uibModalInstance', 'data', +]; + +function StockAMCModalController(Stock, Notify, Instance, data) { + const vm = this; + + vm.close = () => Instance.dismiss(); + + Stock.inventories.loadAMCForInventory(data.inventory_uuid, data.depot_uuid) + .then(items => { + vm.data = items; + + vm.settings = vm.data.settings; + vm.inventory = items.inventory; + vm.depot = items.depot; + + vm.data.avg_consumption = vm.data[vm.settings.average_consumption_algo]; + + // nicer aliases to use in the HTML + vm.isAlgo1 = vm.settings.average_consumption_algo === 'algo1'; + vm.isAlgo2 = vm.settings.average_consumption_algo === 'algo2'; + vm.isAlgo3 = vm.settings.average_consumption_algo === 'algo3'; + vm.isAlgo4 = vm.settings.average_consumption_algo === 'algo_msh'; + }) + .catch(Notify.handleError); + +} diff --git a/client/src/modules/stock/inventories/registry.js b/client/src/modules/stock/inventories/registry.js index 245a4c1de8..ec4572f523 100644 --- a/client/src/modules/stock/inventories/registry.js +++ b/client/src/modules/stock/inventories/registry.js @@ -299,6 +299,13 @@ function StockInventoriesController( vm.gridApi.core.notifyDataChange(uiGridConstants.dataChange.COLUMN); }; + vm.viewAMCCalculations = viewAMCCalculations; + + function viewAMCCalculations(item) { + return Modal.openAMCCalculationModal(item) + .catch(angular.noop); + } + /** * @function openBarcodeScanner * diff --git a/client/src/modules/stock/inventories/templates/inventory.action.html b/client/src/modules/stock/inventories/templates/inventory.action.html index 754186738f..14053cb78c 100644 --- a/client/src/modules/stock/inventories/templates/inventory.action.html +++ b/client/src/modules/stock/inventories/templates/inventory.action.html @@ -35,5 +35,13 @@ INVENTORY.VIEW_LOTS_IN_STOCK + +
  • + +
  • + + INVENTORY.OPEN_AMC_CALCULATION + +
    • diff --git a/client/src/modules/stock/lots/modals/edit.modal.html b/client/src/modules/stock/lots/modals/edit.modal.html index f5f72e66a0..8eade8b279 100644 --- a/client/src/modules/stock/lots/modals/edit.modal.html +++ b/client/src/modules/stock/lots/modals/edit.modal.html @@ -1,6 +1,9 @@
    - LOTS.DETAILS +
      +
    1. LOTS.DETAILS
      2. +
    2. {{$ctrl.model.text}}
      3. +
    diff --git a/client/src/modules/stock/stock.service.js b/client/src/modules/stock/stock.service.js index 6f5511e8f7..258ce81447 100644 --- a/client/src/modules/stock/stock.service.js +++ b/client/src/modules/stock/stock.service.js @@ -30,6 +30,7 @@ function StockModalService(Modal) { service.openSearchStockRequisition = openSearchStockRequisition; service.openAssignmentHistoric = openAssignmentHistoric; service.openDuplicateLotsModal = openDuplicateLotsModal; + service.openAMCCalculationModal = openAMCCalculationModal; /** create stock assign */ function openActionStockAssign(request) { @@ -241,6 +242,20 @@ function StockModalService(Modal) { return instance.result; } + function openAMCCalculationModal(request) { + const templateUrl = 'modules/stock/inventories/modals/amc.modal.html'; + const controller = 'StockAMCModalController as ModalCtrl'; + const params = angular.extend(modalParameters, { + templateUrl, + controller, + size : 'lg', + resolve : { data : () => request }, + }); + + const instance = Modal.open(params); + return instance.result; + } + function openDefineLots(request) { const params = angular.extend(modalParameters, { templateUrl : 'modules/stock/entry/modals/lots.modal.html', diff --git a/server/controllers/inventory/depots/extra.js b/server/controllers/inventory/depots/extra.js index 94e2e54e17..0431ce5ccc 100644 --- a/server/controllers/inventory/depots/extra.js +++ b/server/controllers/inventory/depots/extra.js @@ -9,6 +9,7 @@ const router = require('express').Router({ mergeParams : true }); const db = require('../../../lib/db'); const core = require('../../stock/core'); +const inv = require('../inventory/core'); exports.router = router; @@ -91,7 +92,25 @@ async function getInventoryAverageMonthlyConsumption(req, res, next) { [monthAvgConsumption, db.bid(inventoryUuid), db.bid(uuid)], ); - res.status(200).json(averageMonthlyConsumption); + const sql = `SELECT + BUID(d.uuid) as uuid, d.text, d.description, d.is_warehouse, + allow_entry_purchase, allow_entry_donation, allow_entry_integration, allow_entry_transfer, + allow_exit_debtor, allow_exit_service, allow_exit_transfer, allow_exit_loss, + BUID(parent_uuid) parent_uuid, dhis2_uid, + min_months_security_stock + FROM depot AS d + WHERE d.enterprise_id = ? AND d.uuid = ?;`; + + const [[inventory], [depot]] = await Promise.all([ + inv.getItemsMetadata({ uuid : inventoryUuid }), + db.exec(sql, [req.session.enterprise.id, db.bid(uuid)]), + ]); + + const settings = req.session.stock_settings; + + res.status(200).json({ + ...averageMonthlyConsumption, inventory, depot, settings, + }); } catch (err) { next(err); }