(Optional) Introduce affectedByBatch filter criteria for historic process instance query

[yanavasileva]

Acceptance Criteria (Required on creation)

• Extend the historic process instance query (HistoricProcessInstanceQuery) with #affectedByBatch(String batchId) filter criteria
  • filter historic process instances which are related to job log with the given batchId
  • check if an index can be added to improve the query
• Expose changes in REST API
  • document in OpenAPI
• Expose the filter in Cockpit and add a deep link button on the Batches page that leads to the process dashboard where filter will be preselect to display the impacted process instances
• Document the new deep link in https://docs.camunda.org/manual/develop/webapps/cockpit/batch/monitoring/

Hints

• query idea: SELECT from ACT_HI_PROCINST RES join ACT_HI_JOB_LOG JL where JL.batchId = param.batchId and RES.PROCESS_INSTANCE_ID_=JL.PROCESS_INSTANCE_ID_ - there will be more than one job log use the “exists” structure
• Code:
  • org.camunda.bpm.engine.history.HistoricProcessInstanceQuery
  • engine\src\main\resources\org\camunda\bpm\engine\impl\mapping\entity\HistoricProcessInstance.xml
  • org.camunda.bpm.engine.rest.dto.history.HistoricProcessInstanceQueryDto
• ❓ HPI supports OR queries, can/do we want the filter be supported for both AND and OR queries?
• Add to javadoc hint for: If there’s a performance issue, the user needs to clean up their history tables.

Links

• depends on Populate processInstanceId for execution jobs when invocationsPerBatchJob=1 #4205

Breakdown

Pull Requests

Beta Give feedback

No tasks being tracked yet.

Dev2QA handover

• Does this ticket need a QA test and the testing goals are not clear from the description? Add a Dev2QA handover comment