Properties View Compensation Tab

Use the Properties view Compensation tab to define the execution modes that automation plug-in can process. This tab appears only for Automator and Sender plug-in types defined as an Internal Event Receiver.

Field Use

Execution Mode

Specify the execution modes that this plug-in can run when invoked. For more information about execution modes, see "About Task Compensation."

Select one of the following execution modes from the Normal column for execution modes that occur when the task is processing normally:

  • Select Do to indicate that the automation should run during normal order processing. Deselect this check box and select Redo or Undo to restrict the automation to compensation processing only.

    Note: If you select no check boxes on this tab, automation processing defaults to the Do execution mode.

  • Select Redo to indicate whether the automation should run again if the automation executed once but the order has changed since then.

  • Select Undo to indicate whether the action taken by an automation should be undone when the automation executed but the order has changed since then. You can also exclude certain data structure and elements from being undone on a task by setting the Ignore rollback during undo check box in the Order editor, Order Template, Properties View Order Data tab (see "Properties View Order Data Tab").

Select one of the following execution modes from the Fallout column for execution modes that occur when the task has failed:

  • Select Do so that if the task fails when running in the normal Do execution mode, the automation task can still run plug-ins configured with the Do in fallout mode. Deselect this check box and select Redo or Undo to restrict the automation to compensation processing only.

  • Select Redo so that if the task fails when running in the normal Redo execution mode, the automation task can still run plug-ins configured with the Redo in fallout mode.

  • Select Undo so that if the task fails when running in the normal Redo execution mode, the automation task can still run plug-ins configured with the Undo in fallout mode. You can also exclude certain data structure and elements from being undone on a task by setting the Ignore rollback during undo check box in the Order editor, Order Template, Properties View Order Data tab (see "Properties View Order Data Tab").

Note: Design Studio has validations in place that prevent you from defining more than one internal event receiver automation with the same execution mode per automated task or automated notification. For example, an automated task can not define two internal event receiver automations that both have Do selected for the execution mode. However, an automated task can define three internal event receiver automations if each defines a different execution mode (Do, Redo, and Undo).