Package ch.ivyteam.ivy.workflow

Enum Class SystemTaskFailureBehaviour

java.lang.Object
java.lang.Enum<SystemTaskFailureBehaviour>
ch.ivyteam.ivy.workflow.SystemTaskFailureBehaviour
All Implemented Interfaces:
Serializable, Comparable<SystemTaskFailureBehaviour>, java.lang.constant.Constable
public enum SystemTaskFailureBehaviour extends Enum<SystemTaskFailureBehaviour>

Defines the behaviour in case a system task fails. A system task is a task that is executed by the system.

The behaviour that should be applied if a system task fails is not set on the task definition because process designers may like to change the behaviour depending on what kind of failure happens inside the system task. Therefore the behaviour can be configured either on the ivy.response object inside the system task process or with the engine wide system property 'SystemTask.Failure.Behaviour'

The following example shows how to set the behaviour:

ivy.response.setParameter("ch.ivyteam.ivy.workflow.SystemTaskFailureBehaviour", SystemTaskFailureBehaviour.FAIL_TASK_DO_NOT_RETRY);

If the behaviour is not set in the system task process the default behaviour is FAIL_TASK_DO_RETRY.

Since:
13.08.2008
API:
This is a public API.

  • Enum Constant Details

    • FAIL_TASK_DO_RETRY

      public static final SystemTaskFailureBehaviour FAIL_TASK_DO_RETRY
      In case the system task fails, put the task into state TaskState.FAILED. After a defined period the task state will be changed by the system back to state TaskState.SUSPENDED and the system retries to execute the task.
      API:
      This public API is available in Java.

    • FAIL_TASK_DO_NOT_RETRY

      public static final SystemTaskFailureBehaviour FAIL_TASK_DO_NOT_RETRY
      In case the system task fails, put the task into state TaskState.FAILED. The task state will not be changed back to state TaskState.SUSPENDED by the system. Therefore the system does not retry to execute the task. Note that the workflow administrator can manually set the task state back to TaskState.SUSPENDED in which case the system retries to execute the task.
      API:
      This public API is available in Java.

    • DESTROY_TASK

      public static final SystemTaskFailureBehaviour DESTROY_TASK
      In case the system task fails, the task will be destroyed.
      API:
      This public API is available in Java.

    • DESTROY_CASE

      public static final SystemTaskFailureBehaviour DESTROY_CASE
      In case the system task fails, the case will be destroyed.
      API:
      This public API is available in Java.