feat(AMM-2491): low / out-of-stock report and re-upload of changed camp stock batches

pom.xml

@@ -5,7 +5,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.iemr.inventory</groupId>
 	<artifactId>inventory-api</artifactId>
-	<version>3.9.0</version>
+	<version>3.12.0</version>
 	<packaging>war</packaging>
 	<name>Inventory-API</name>
 	<description>Inventory Page</description>

src/main/java/com/iemr/inventory/controller/report/CRMReportController.java

@@ -86,6 +86,25 @@
 		return response.toString();
 	}
 
+	@ApiOperation(value = "Get low stock and out of stock report for a store", consumes = "application/json", produces = "application/json")
+	@RequestMapping(value = "/getLowStockReport", headers = "Authorization", method = {
+			RequestMethod.POST }, produces = { "application/json" })
+	public String getLowStockReport(@RequestBody String request) {
+		logger.info("getLowStockReport request " + request.toString());
+		OutputResponse response = new OutputResponse();
+		try {
+
+			ItemStockEntryReport report = InputMapper.gson().fromJson(request, ItemStockEntryReport.class);
+			String res = crmReportService.getLowStockReport(report);
+			response.setResponse(res);
+			logger.info("getLowStockReport response " + response.toString());
+		} catch (Exception e) {
+			logger.error(e.getMessage());
+			response.setError(e);
+		}
+		return response.toString();
+	}
+
 	@ApiOperation(value = "Get consumption report", consumes = "application/json", produces = "application/json")
 	@RequestMapping(value = "/getConsumptionReport", headers = "Authorization", method = {
 			RequestMethod.POST }, produces = { "application/json" })

src/main/java/com/iemr/inventory/model/report/LowStockReport.java

@@ -0,0 +1,76 @@
+/*
+* AMRIT – Accessible Medical Records via Integrated Technology
+* Integrated EHR (Electronic Health Records) Solution
+*
+* Copyright (C) "Piramal Swasthya Management and Research Institute"
+*
+* This file is part of AMRIT.
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program.  If not, see https://www.gnu.org/licenses/.
+*/
+package com.iemr.inventory.model.report;
+
+import com.google.gson.GsonBuilder;
+import com.google.gson.LongSerializationPolicy;
+
+import lombok.Data;
+
+@Data
+public class LowStockReport {
+
+	private Long slNo;
+
+	private String facilityName;
+
+	private Integer itemID;
+
+	private String itemName;
+
+	private String itemCategory;
+
+	private String strength;
+
+	private Integer minStock;
+
+	private Integer quantityInHand;
+
+	// "Out of stock" (nothing usable left) or "Low stock" (at or below the item's minimum stock)
+	private String stockStatus;
+
+	public LowStockReport() {
+
+	}
+
+	public LowStockReport(String facilityName, Integer itemID, String itemName, String itemCategory, String strength,
+			Integer minStock, Integer quantityInHand) {
+
+		this.facilityName = facilityName;
+		this.itemID = itemID;
+		this.itemName = itemName;
+		this.itemCategory = itemCategory;
+		this.strength = strength;
+		this.minStock = minStock;
+		this.quantityInHand = quantityInHand;
+		this.stockStatus = (quantityInHand == null || quantityInHand <= 0) ? "Out of stock" : "Low stock";
+	}
+
+	@Override
+	public String toString() {
+
+		return new GsonBuilder().setLongSerializationPolicy(LongSerializationPolicy.STRING).serializeNulls().create()
+				.toJson(this);
+
+	}
+
+}

src/main/java/com/iemr/inventory/repo/report/ItemStockReportRepo.java

@@ -57,6 +57,21 @@ List<ItemStockEntryReport> getItemStockEntryReportByFacilityID(@Param("startDate
 	List<Object[]> getExpiryReportByFacilityID(@Param("startDate") Date startDate,
 			@Param("endDate") Date endDate, @Param("facilityID") Integer facilityID);
 
+	// Live stock (db_iemr, not the reporting copy): items mapped to the store whose usable (not expired) stock
+	// is 0 or at/below the item's Min_Stock.
+	@Query(value = "SELECT f.FacilityName, i.ItemID, i.ItemName, c.ItemCategoryName, i.Strength, i.Min_Stock, "
+			+ "COALESCE((SELECT SUM(e.QuantityInHand) FROM db_iemr.t_itemstockentry e WHERE e.FacilityID = f.FacilityID "
+			+ "  AND e.ItemID = i.ItemID AND e.Deleted = false AND (e.ExpiryDate IS NULL OR e.ExpiryDate >= CURDATE())), 0) AS inHand "
+			+ "FROM db_iemr.m_facility f "
+			+ "JOIN db_iemr.m_item i ON i.ItemID IN (SELECT m.ItemID FROM db_iemr.m_itemfacilitymapping m "
+			+ "  WHERE m.FacilityID = f.FacilityID AND m.Deleted = false) AND i.Deleted = false "
+			+ "  AND (i.Discontinued IS NULL OR i.Discontinued = false) "
+			+ "LEFT JOIN db_iemr.m_itemcategory c ON c.ItemCategoryID = i.ItemCategoryID "
+			+ "WHERE f.FacilityID = :facilityID "
+			+ "HAVING inHand <= 0 OR (i.Min_Stock > 0 AND inHand <= i.Min_Stock) "
+			+ "ORDER BY inHand ASC, i.ItemName ASC", nativeQuery = true)
+	List<Object[]> getLowStockReportByFacilityID(@Param("facilityID") Integer facilityID);
+
 	@Query(value="Select ISEx.*, db.BeneficiaryID, concat(IFNULL(db.Title,''),' ', IFNULL(db.FirstName,''),' ', " 
             + "IFNULL(db.MiddleName,''),' ', IFNULL(db.LastName,'')) Name from db_reporting.fact_itemstockexit ISEx left join db_iemr.t_patientissue PI "
             + "on ISEx.ExitTypeID = PI.VanSerialNo and ISEx.VanID = PI.VanID "

src/main/java/com/iemr/inventory/repo/stockEntry/ItemStockEntryRepo.java

@@ -94,6 +94,16 @@ List<Object[]> findByItemIDInQuantityInHandGreaterThanForFacilityID(@Param("item
 	@Query("UPDATE ItemStockEntry c SET c.quantityInHand = c.quantityInHand + :quant WHERE c.itemStockEntryID = :id")
 	Integer addStock(@Param("id") Long id, @Param("quant") Integer quant);
 
+	@Transactional
+	@Modifying
+	@Query("UPDATE ItemStockEntry c SET c.processed = 'N' WHERE c.itemStockEntryID = :id")
+	Integer markForUpload(@Param("id") Long id);
+
+	@Transactional
+	@Modifying
+	@Query("UPDATE ItemStockEntry c SET c.processed = 'N' WHERE c.vanSerialNo = :vanSerialNo and c.facilityID = :facilityID")
+	Integer markForUploadByVanSerialNo(@Param("vanSerialNo") Long vanSerialNo, @Param("facilityID") Integer facilityID);
+
 	@Transactional
 	@Modifying
 	@Query("UPDATE ItemStockEntry c SET c.quantityInHand = c.quantityInHand - :quant WHERE c.itemStockEntryID = :id")

src/main/java/com/iemr/inventory/service/indent/IndentServiceImpl.java

@@ -40,6 +40,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import com.iemr.inventory.service.stockEntry.StockUploadMarker;
 import org.springframework.stereotype.Service;
 
 import com.iemr.inventory.data.indent.Indent;
@@ -59,6 +60,9 @@
 @Service
 public class IndentServiceImpl implements IndentService{
 
+	@Autowired
+	private StockUploadMarker stockUploadMarker;
+
 	private static final Logger logger = LoggerFactory.getLogger(IndentServiceImpl.class);
 
 	@PersistenceContext
@@ -237,6 +241,7 @@
 			{
 				indentOrderRepo.updateQuantityInStock(indentIssue.getIssuedQty(), indentIssue.getItemStockEntryID(),
 						indentIssue.getFromFacilityID());
+				stockUploadMarker.batchChanged(indentIssue.getItemStockEntryID());
 
 				indentIssue.setCreatedDate(new Timestamp(System.currentTimeMillis()));
 				indentIssue.setIssueDate(new Timestamp(System.currentTimeMillis()));

src/main/java/com/iemr/inventory/service/patientreturn/PatientReturnServiceImpl.java

@@ -31,6 +31,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import com.iemr.inventory.service.stockEntry.StockUploadMarker;
 import org.springframework.stereotype.Service;
 
 import com.iemr.inventory.data.patientreturn.ItemDetailModel;
@@ -44,6 +45,9 @@
 @Service
 public class PatientReturnServiceImpl implements PatientReturnService{
 
+	@Autowired
+	private StockUploadMarker stockUploadMarker;
+
 	private static final Logger logger = LoggerFactory.getLogger(PatientReturnServiceImpl.class);
 
 	@Autowired(required=false)
@@ -113,6 +117,7 @@
 		for(ItemDetailModel itemDetail : list)
 		{
 			int result = patientReturnRepo.updateQuantityReturned(itemDetail.getReturnQuantity(), itemDetail.getItemStockEntryID());
+			stockUploadMarker.batchChanged(itemDetail.getItemStockEntryID());
 			patientReturnRepo.updateIssuedQuantity(itemDetail.getReturnQuantity(), itemDetail.getItemStockExitID());
 			ItemReturnEntry itemReturnEntry = new ItemReturnEntry();
 			itemReturnEntry.setCreatedBy(itemDetail.getCreatedBy());

src/main/java/com/iemr/inventory/service/report/CRMReportService.java

@@ -33,6 +33,8 @@
 
 	String getExpiryReport(ItemStockEntryReport entryReport);
 
+	String getLowStockReport(ItemStockEntryReport entryReport) throws Exception;
+
 	String getConsumptionReport(ItemStockExitReport exitReport);
 
 	String getBenDrugIssueReport(PatientIssueExitReport exitReport);

src/main/java/com/iemr/inventory/service/report/CRMReportServiceImpl.java

@@ -45,6 +45,7 @@
 import com.iemr.inventory.model.report.DailyStockSummary;
 import com.iemr.inventory.model.report.ExpiryReport;
 import com.iemr.inventory.model.report.InwardStockReport;
+import com.iemr.inventory.model.report.LowStockReport;
 import com.iemr.inventory.model.report.MonthlyReport;
 import com.iemr.inventory.model.report.TransitReport;
 import com.iemr.inventory.model.report.YearlyReport;
@@ -203,6 +204,29 @@
 		return reportList.toString();
 	}
 
+	@Override
+	public String getLowStockReport(ItemStockEntryReport entryReport) throws Exception {
+
+		if (entryReport == null || entryReport.getFacilityID() == null) {
+			throw new Exception("facilityID is required");
+		}
+		List<Object[]> list = itemStockReportRepo.getLowStockReportByFacilityID(entryReport.getFacilityID());
+		List<LowStockReport> reportList = new ArrayList<LowStockReport>();
+		Long slNo = 1L;
+		for (Object[] object : list) {
+			if (object != null) {
+				LowStockReport report = new LowStockReport(text(object[0]),
+						object[1] != null ? ((Number) object[1]).intValue() : null, text(object[2]), text(object[3]),
+						text(object[4]), object[5] != null ? ((Number) object[5]).intValue() : null,
+						object[6] != null ? ((Number) object[6]).intValue() : 0);
+				report.setSlNo(slNo++);
+				reportList.add(report);
+			}
+		}
+
+		return reportList.toString();
+	}
+
 	@Override
 	public String getConsumptionReport(ItemStockExitReport exitReport) {
 

src/main/java/com/iemr/inventory/service/stockEntry/StockEntryServiceImpl.java

@@ -55,7 +55,10 @@
 @Service
 public class StockEntryServiceImpl implements StockEntryService {
 
+	@Autowired
+	private StockUploadMarker stockUploadMarker;
+
 	@Autowired
 	private PhysicalStockEntryRepo physicalStockEntryRepo;
 
 	@Autowired(required=false)
@@ -129,6 +132,8 @@
 		for (ItemStockExit itemStockExit : itemissueListUpdated) {
 			cnt = cnt + itemStockEntryRepo.updateStock(itemStockExit.getFacilityID(),
 					itemStockExit.getItemStockEntryID(), itemStockExit.getQuantity());
+			stockUploadMarker.batchChangedByVanSerialNo(itemStockExit.getItemStockEntryID(),
+					itemStockExit.getFacilityID());
 		}
 
 		return cnt;

src/main/java/com/iemr/inventory/service/stockEntry/StockUploadMarker.java

@@ -0,0 +1,53 @@
+/*
+* AMRIT – Accessible Medical Records via Integrated Technology
+* Integrated EHR (Electronic Health Records) Solution
+*
+* Copyright (C) "Piramal Swasthya Management and Research Institute"
+*
+* This file is part of AMRIT.
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with this program.  If not, see https://www.gnu.org/licenses/.
+*/
+package com.iemr.inventory.service.stockEntry;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+
+import com.iemr.inventory.repo.stockEntry.ItemStockEntryRepo;
+
+/**
+ * StopTB camp laptops (stoptb.enforce.vanid=true): the camp's stock is reported on central from uploaded rows, so a
+ * batch whose QuantityInHand changes (adjustment, stock exit, patient return, indent issue) is marked
+ * Processed='N' and uploaded again; central updates its copy by VanSerialNo + store. Other deployments: no change.
+ */
+@Component
+public class StockUploadMarker {
+
+	@Value("${stoptb.enforce.vanid:false}")
+	private boolean stopTBLaptop;
+
+	@Autowired
+	private ItemStockEntryRepo itemStockEntryRepo;
+
+	public void batchChanged(Long itemStockEntryID) {
+		if (stopTBLaptop && itemStockEntryID != null)
+			itemStockEntryRepo.markForUpload(itemStockEntryID);
+	}
+
+	public void batchChangedByVanSerialNo(Long vanSerialNo, Integer facilityID) {
+		if (stopTBLaptop && vanSerialNo != null && facilityID != null)
+			itemStockEntryRepo.markForUploadByVanSerialNo(vanSerialNo, facilityID);
+	}
+}

src/main/java/com/iemr/inventory/service/stockadjustment/StockAdjustmentServiceImpl.java

@@ -29,6 +29,7 @@
 import java.util.stream.Collectors;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import com.iemr.inventory.service.stockEntry.StockUploadMarker;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
@@ -51,6 +52,9 @@
 @Service
 public class StockAdjustmentServiceImpl implements StockAdjustmentService {
 
+	@Autowired
+	private StockUploadMarker stockUploadMarker;
+
 	@Autowired(required=false)
 	StockAdjustmentDraftRepo stockAdjustmentDraftRepo;
 
@@ -184,6 +188,7 @@
 			} else {
 				itemStockEntryRepo.subtractStock(action.getItemStockEntryID(), action.getAdjustedQuantity());
 			}
+			stockUploadMarker.batchChanged(action.getItemStockEntryID());
 
 		});