stop:647 Nikshay Workflow: Job Mertic Handling.

src/main/java/com/iemr/admin/controller/nikshayjoblog/NikshayJobLogController.java

@@ -33,18 +33,21 @@
 import org.springframework.format.annotation.DateTimeFormat;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import com.iemr.admin.data.nikshay.NikshayJobHistoryLog;
+import com.iemr.admin.data.nikshay.NikshayJobRunDTO;
 import com.iemr.admin.service.nikshayjoblog.NikshayFailureReason;
 import com.iemr.admin.service.nikshayjoblog.NikshayJobHistoryLogService;
 import com.iemr.admin.service.nikshayjoblog.NikshayPhase;
+import com.iemr.admin.service.nikshayjoblog.NikshayTriggerType;
 
 import io.swagger.v3.oas.annotations.Operation;
 
-/** Read side of the Ni-kshay phase history: failed items and one beneficiary's history. */
+/** Read side of the Ni-kshay phase history: failed items, one beneficiary's history and the runs. */
 @RestController
 @RequestMapping(value = "/nikshay/log", headers = "Authorization")
 public class NikshayJobLogController {
@@ -84,6 +87,46 @@
 		}
 	}
 
+	@Operation(summary = "Ni-kshay runs (the whole job, cron or manual, and manual phase runs), newest first, "
+			+ "with their picked, succeeded, failed, notApplicable and waiting counts")
+	@GetMapping(value = "/runs")
+	public ResponseEntity<?> getRuns(@RequestParam(value = "triggerType", required = false) NikshayTriggerType triggerType,
+			@RequestParam(value = "fromDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate fromDate,
+			@RequestParam(value = "toDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate toDate,
+			@RequestParam(value = "page", defaultValue = "0") int page,
+			@RequestParam(value = "size", defaultValue = "50") int size) {
+		if (page < 0 || size < 1 || size > MAX_PAGE_SIZE) {
+			return ResponseEntity.badRequest().body("page must be >= 0 and size between 1 and " + MAX_PAGE_SIZE);
+		}
+		try {
+			// Dates are whole days: toDate is included, so the query bound is the next day's start.
+			Page<NikshayJobRunDTO> runs = logService.getRuns(triggerType,
+					fromDate != null ? Timestamp.valueOf(fromDate.atStartOfDay()) : null,
+					toDate != null ? Timestamp.valueOf(toDate.plusDays(1).atStartOfDay()) : null, page, size);
+			Map<String, Object> body = new HashMap<>();
+			body.put("runs", runs.getContent());
+			body.put("totalElements", runs.getTotalElements());
+			body.put("page", page);
+			body.put("size", size);
+			return ResponseEntity.ok(body);
+		} catch (Exception e) {
+			logger.error("Error reading Ni-kshay runs", e);
+			return ResponseEntity.status(500).body("Could not read the Ni-kshay runs");
+		}
+	}
+
+	@Operation(summary = "One Ni-kshay run by its jobRunId, with its counts per phase")
+	@GetMapping(value = "/runs/{jobRunId}")
+	public ResponseEntity<?> getRun(@PathVariable("jobRunId") String jobRunId) {
+		try {
+			NikshayJobRunDTO run = logService.getRun(jobRunId);
+			return run != null ? ResponseEntity.ok(run) : ResponseEntity.status(404).body("No Ni-kshay run " + jobRunId);
+		} catch (Exception e) {
+			logger.error("Error reading Ni-kshay run {}", jobRunId, e);
+			return ResponseEntity.status(500).body("Could not read the Ni-kshay run");
+		}
+	}
+
 	@Operation(summary = "Every Ni-kshay phase entry of one beneficiary (benRegId), newest first")
 	@GetMapping(value = "/history")
 	public ResponseEntity<?> getHistory(@RequestParam("benId") Long benId) {

src/main/java/com/iemr/admin/data/nikshay/NikshayJobRunDTO.java

@@ -0,0 +1,51 @@
+/*
+* AMRIT – Accessible Medical Records via Integrated Technologies
+* 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.admin.data.nikshay;
+
+import java.sql.Timestamp;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.iemr.admin.service.nikshayjoblog.NikshayLogStatus;
+import com.iemr.admin.service.nikshayjoblog.NikshayTriggerType;
+
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * One Ni-kshay run (the whole job, or one manual phase run), from its JOB row in
+ * nikshay_worker_job_history_log. summary is the counts saved as JSON in the row's message;
+ * rows written before the counts were added have plain text, given in message instead.
+ */
+@Getter
+@Setter
+public class NikshayJobRunDTO {
+	private String jobRunId;
+	private NikshayTriggerType triggerType;
+	private String triggeredBy;
+	private NikshayLogStatus status;
+	// From the summary. For rows written before the times were added, startedAt is null and
+	// finishedAt is the row's created_at.
+	private Timestamp startedAt;
+	private Timestamp finishedAt;
+	private JsonNode summary;
+	private String message;
+}

src/main/java/com/iemr/admin/repo/nikshayjoblog/NikshayJobHistoryLogRepo.java

@@ -35,6 +35,7 @@
 import com.iemr.admin.service.nikshayjoblog.NikshayFailureReason;
 import com.iemr.admin.service.nikshayjoblog.NikshayLogStatus;
 import com.iemr.admin.service.nikshayjoblog.NikshayPhase;
+import com.iemr.admin.service.nikshayjoblog.NikshayTriggerType;
 
 @Repository
 public interface NikshayJobHistoryLogRepo extends CrudRepository<NikshayJobHistoryLog, Long> {
@@ -69,6 +70,21 @@ Page<NikshayJobHistoryLog> findLatestFailed(@Param("failed") NikshayLogStatus fa
 
 	List<NikshayJobHistoryLog> findByBenIdOrderByIdDesc(Long benId);
 
+	// JOB summary rows (one per run), newest first. Every filter is optional (null = no
+	// filter); toDate is exclusive.
+	String RUNS_WHERE = " WHERE l.phase = :job "
+			+ " AND (:triggerType IS NULL OR l.triggerType = :triggerType) "
+			+ " AND (:fromDate IS NULL OR l.createdAt >= :fromDate) "
+			+ " AND (:toDate IS NULL OR l.createdAt < :toDate) ";
+
+	@Query(value = " SELECT l FROM NikshayJobHistoryLog l " + RUNS_WHERE + " ORDER BY l.id DESC ",
+			countQuery = " SELECT COUNT(l) FROM NikshayJobHistoryLog l " + RUNS_WHERE)
+	Page<NikshayJobHistoryLog> findRuns(@Param("job") NikshayPhase job,
+			@Param("triggerType") NikshayTriggerType triggerType, @Param("fromDate") Timestamp fromDate,
+			@Param("toDate") Timestamp toDate, Pageable pageable);
+
+	NikshayJobHistoryLog findFirstByJobRunIdAndPhaseOrderByIdDesc(String jobRunId, NikshayPhase phase);
+
 	// Which of the given references already have a successful upload in this phase
 	@Query(" SELECT DISTINCT l.referenceId FROM NikshayJobHistoryLog l WHERE l.phase = :phase "
 			+ " AND l.status = :success AND l.referenceId IN :referenceIds ")

src/main/java/com/iemr/admin/service/nikshayidgenerate/NikshayIdGenerateService.java

@@ -113,13 +113,23 @@ public void runEnrolment(List<Long> benRegIds, int limit, NikshayPhaseRun run) {
 		logger.info("Found {} beneficiaries eligible for Ni-kshay ID generation", eligible.size());
 		List<NikshayIdGenerateBeneficiaryDTO> positive = toRun(filterDiagnosisComplete(
 				filterHouseholdScreened(keepRequested(eligible, benRegIds)), benRegIds, run), benRegIds, limit);
+		pick(run, positive);
 		processBeneficiaries(positive, NikshayFlowScenario.POSITIVE, run);
 
 		// The query already requires the whole household to be screened
 		List<NikshayIdGenerateBeneficiaryDTO> allNegative = nikshayIdGenerateRepository.findAllNegativeBeneficiaries();
 		logger.info("Found {} members of all-negative households for Ni-kshay ID generation", allNegative.size());
-		processBeneficiaries(toRun(keepRequested(allNegative, benRegIds), benRegIds, limit - positive.size()),
-				NikshayFlowScenario.ALL_NEGATIVE, run);
+		List<NikshayIdGenerateBeneficiaryDTO> allNegativeToRun = toRun(keepRequested(allNegative, benRegIds), benRegIds,
+				limit - positive.size());
+		pick(run, allNegativeToRun);
+		processBeneficiaries(allNegativeToRun, NikshayFlowScenario.ALL_NEGATIVE, run);
+	}
+
+	// Counted in the run summary as picked by ENROLMENT
+	private static void pick(NikshayPhaseRun run, List<NikshayIdGenerateBeneficiaryDTO> beneficiaries) {
+		for (NikshayIdGenerateBeneficiaryDTO beneficiary : beneficiaries) {
+			run.getPickedBenRegIds().add(beneficiary.getBeneficiaryId());
+		}
 	}
 
 	// The beneficiaries asked for (all of them when benRegIds is null)
@@ -295,6 +305,7 @@ public void runContacts(List<Long> benRegIds, int limit, NikshayPhaseRun run) {
 				}
 			}
 		}
+		run.getPickedBenRegIds().addAll(ids);
 		logger.info("Adding the contacts of {} index patient(s)", ids.size());
 		if (ids.isEmpty()) {
 			return;

src/main/java/com/iemr/admin/service/nikshayjoblog/NikshayFailureReason.java

@@ -44,5 +44,7 @@ public enum NikshayFailureReason {
 	// More than one Ni-kshay record matches
 	MULTIPLE_DUPLICATE_MATCHES,
 	// The test result is an error / invalid run (e.g. NAAT "Error-2"): not uploaded, waits for a retest
-	TEST_RESULT_INVALID
+	TEST_RESULT_INVALID,
+	// JOB summary row only: a phase pass threw an error; each such pass has its "error" in the message JSON
+	PHASE_COULD_NOT_RUN
 }

src/main/java/com/iemr/admin/service/nikshayjoblog/NikshayJobHistoryLogService.java

@@ -35,7 +35,9 @@
 import org.springframework.transaction.annotation.Propagation;
 import org.springframework.transaction.annotation.Transactional;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.iemr.admin.data.nikshay.NikshayJobHistoryLog;
+import com.iemr.admin.data.nikshay.NikshayJobRunDTO;
 import com.iemr.admin.repo.nikshayjoblog.NikshayJobHistoryLogRepo;
 import com.iemr.admin.service.nikshayclient.NikshayApiException;
 
@@ -49,6 +51,9 @@ public class NikshayJobHistoryLogService {
 	private static final Logger logger = LoggerFactory.getLogger(NikshayJobHistoryLogService.class);
 
 	private static final int MESSAGE_MAX_LENGTH = 1000;
+	// A JOB row's message is the run summary JSON (message is TEXT since AMRIT-DB V141)
+	public static final int SUMMARY_MAX_LENGTH = 10000;
+	private static final ObjectMapper MAPPER = new ObjectMapper();
 
 	@Autowired
 	private NikshayJobHistoryLogRepo logRepo;
@@ -113,16 +118,56 @@ public List<NikshayJobHistoryLog> getHistory(Long benId) {
 		return logRepo.findByBenIdOrderByIdDesc(benId);
 	}
 
+	/** The runs (their JOB rows), newest first. Null filters are ignored. */
+	public Page<NikshayJobRunDTO> getRuns(NikshayTriggerType triggerType, Timestamp fromDate, Timestamp toDate,
+			int page, int size) {
+		return logRepo.findRuns(NikshayPhase.JOB, triggerType, fromDate, toDate, PageRequest.of(page, size))
+				.map(this::toRun);
+	}
+
+	/** One run by its jobRunId, or null when it has no JOB row. */
+	public NikshayJobRunDTO getRun(String jobRunId) {
+		NikshayJobHistoryLog row = logRepo.findFirstByJobRunIdAndPhaseOrderByIdDesc(jobRunId, NikshayPhase.JOB);
+		return row == null ? null : toRun(row);
+	}
+
+	private NikshayJobRunDTO toRun(NikshayJobHistoryLog row) {
+		NikshayJobRunDTO run = new NikshayJobRunDTO();
+		run.setJobRunId(row.getJobRunId());
+		run.setTriggerType(row.getTriggerType());
+		run.setTriggeredBy(row.getTriggeredBy());
+		run.setStatus(row.getStatus());
+		run.setFinishedAt(row.getCreatedAt());
+		String message = row.getMessage();
+		if (message != null && message.trim().startsWith("{")) {
+			try {
+				run.setSummary(MAPPER.readTree(message));
+				if (run.getSummary().path("startedAt").asLong() > 0) {
+					run.setStartedAt(new Timestamp(run.getSummary().path("startedAt").asLong()));
+				}
+				if (run.getSummary().path("finishedAt").asLong() > 0) {
+					run.setFinishedAt(new Timestamp(run.getSummary().path("finishedAt").asLong()));
+				}
+			} catch (Exception e) {
+				logger.warn("Run {}: summary is not valid JSON", row.getJobRunId());
+			}
+		}
+		if (run.getSummary() == null) {
+			// Older row: plain text
+			run.setMessage(message);
+		}
+		return run;
+	}
+
 	private NikshayJobHistoryLog entry(NikshayJobRunContext ctx, NikshayPhase phase, Long benId,
 			String referenceId, NikshayLogStatus status, String message) {
 		NikshayJobHistoryLog entry = new NikshayJobHistoryLog();
 		entry.setBenId(benId);
 		entry.setPhase(phase);
 		entry.setReferenceId(referenceId);
 		entry.setStatus(status);
-		entry.setMessage(message != null && message.length() > MESSAGE_MAX_LENGTH
-				? message.substring(0, MESSAGE_MAX_LENGTH)
-				: message);
+		int maxLength = phase == NikshayPhase.JOB ? SUMMARY_MAX_LENGTH : MESSAGE_MAX_LENGTH;
+		entry.setMessage(message != null && message.length() > maxLength ? message.substring(0, maxLength) : message);
 		entry.setJobRunId(ctx.getJobRunId());
 		entry.setTriggerType(ctx.getTriggerType());
 		entry.setTriggeredBy(ctx.getTriggeredBy());