Track affected process instances by batch (when invocationsPerBatchJob=1)

[yanavasileva]

User Story (Required on creation)

As an Operations Engineer, I want to know the activity id and process id of an incident resulting of an error in a batch job

Functional Requirements (Required before implementation)

Batch configuration is available on demand for every newly created batch on Batches page in Cockpit.
Process instance id is available for running batches that has failed jobs.

Technical Requirements (Required before implementation)

• Preserve the batch configuration in the byte array table
  • don't remove the process instance ids during batch execution job creation, but use an index (pointer) to iterate over them
  • don't delete the byte array, leave it for the History cleanup to pick it up
• Set removal time for those byte arrays according to HTTL of the batch type
• Expose a new private endpoint to fetch the batch configuration based on batchId
• Configuration is preserved only for newly create batches, instruct users to wait for all their batches to complete before doing an upgrade.
• In Cockpit, add a new button for the batch configuration
  • shows the complete configuration
  • add another button for downloading the configuration
  • add processInstanceId column in Failed jobs and Job log view for in progress batches

Limitations of Scope

• Tracking the process instance id in failed jobs is available only for in progress batches. For completed batches previously failed job information is not available/displayed.
• process instance id will not be populated for invocationsPerBatchJob!=1

Hints

Links

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

Breakdown

Tasks

Beta Give feedback

1. Expose batch configuration to the private API #4202
   type:subtask +1
2. In Cockpit, expose batch configuration to Batches page #4203
   scope:cockpit type:subtask +2
3. In Cockpit, add processInstanceId column to the Failed jobs and Job log view in Batches page #4216
   scope:cockpit type:subtask +2
4. Document trackability from a batch operation to a process instance #4224
   scope:documentation type:subtask +2
5. (Optional) Introduce affectedByBatch filter criteria for historic process instance query #4215
   type:task +1
6. Inform Support team for the made changes and how custom batches are impacted

Dev2QA handover

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