Filter Processes with exception and retries left

[PHWaechtler]

User Story (Required on creation)

Context

• If a job can not be executed successfully, it is retried according to the configured retry configuration
• If all retries are not successful, an incident is created
• See also this support ticket for more context

Problem

• Get informed early about failing jobs to avoid wasting too much time before all retries are used up and an incident is created.
• Currently, there is not an easy option to find all jobs "retrying"
• Manual retry is requested over automatic retry mechanism because:
  • Jobs are used to connect to external systems. The availability of these systems may vary, so long retry cycles (longer than 48 hours) can avoid incidents if the system becomes available again during the long retry cycles.
  • To get an early warning indication and proactively address system availability, transparency for retries is needed.
  • Restarting processes in an incident state takes more effort than managing to make an external system available again during the retry state

User Journey

• Access process instance search in cockpit
• Select "Process Instance: with jobs retrying"
• Receive result including all instances which are associated with jobs which have exceptions and retries left
• As detailed here, the operator may then decide to drill down to these jobs and manually retry them
• When the search criteria is not selected, the exception and retry state of jobs has no influence on the search result

Functional Requirements (Required before implementation)

Users can search for process instances which have jobs that have run into exceptions and have retries left

Technical Requirements (Required before implementation)

• New search criteria with UI name "Process Instance: with jobs retrying" for EN and "Prozessinstanz: Jobs werden aktuell erneut ausgeführt" for DE
• search criteria translates to combined SQL query in BE: jobs with exceptions and retries left
• search criteria either exists on the query (true) or is not added to the query (null). It is not possible to apply this criteria as a "not" (ie no option for "instances without jobs with exceptions and retries left)
• criteria exists in queries used for API used from cockpit instance search and java API
• query field is documented in openAPI

Limitations of Scope

• Users have to proactively search for instances with exceptions/retries left
• Manual retry of instances as requested in SUPPORT-18985 out of scope
  • Workaround suggested here

Hints

Links

• Product hub ticket
• Kickoff document

Breakdown

Pull Requests

Preview 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

Dev2QA handover
Functionality is to be tested as discussed in kickoff, ensuring new query search criteria returns correct result.