set-state-expiry macro

Overview

The {set-state-expiry} macro is used to add or replace the expiry date of the active workflow {state}.

Where to use it?

Optional.

One {set-state-expiry} can be put in a {trigger} macro.

Parameters

Events

The following Events are associated with state expiry:

• stateexpired

Value references

The following Event references are associated with state expiry:

• @duedate@
• @expirydate@

Example

In this example, when the workflow transitions in to the Start state, it's expiry date will be set to a Period of 1 Week (P1W). Upon expiry, the workflow will transition to the Stop state.

{workflow:Expiry}
   {state:Stop|submit=Start}
   {state}
   {state:Start|expired=Stop}
   {state}
   {trigger:statechanged|state=Start}
      {set-state-expiry:duedate=P1W}
   {trigger}
{workflow}

All examples

See also

Workflow Authoring Guide:

• Expiry Dates
• States
• Transitions
• Events
• Triggers
• Actions

User Guide:

• State expiry date