Expiry dates use in macros

Overview

This article describes how Expiry Dates interact with specific macros

state

The expiry date for a workflow state is set via the duedate parameter.

The duedate parameter accepts both date and duration formats, as well as Value References.

The duedate for a state is set on the transition into the state. The time period to expiry is displayed in the workflow popup for the state.

Open

Upon expiry of the duedate fixed date or duration period

• the expiry indicator in the workflow popup turns red

Open

If the expiry date occurs whilst the page or blog post is in the state (not before, not after):

• the stateexpired event is sent

If the expiring state has an expired parameter, the workflow transitions to the state specified in the expired parameter.

On the expired parameter, the following workflow events are sent

• statechanged

• pagestatechanged if the event occurred for a workflow applied to a page

• newstatechanged if the event occurred for a workflow applied to a blog post

If the expiry date is set as a date that is before the occurrence of the transition to the state

• the state shows as expired but does not trigger any events or transition to another state

Examples

set-state-expiry

This macro can be used during an event (including expiry events) to set a new expiry date for a state.

It accepts both date and duration formats, as well as Value References.

Examples

task

The expiry date for a task is set via the duedate parameter, which accepts both date and duration formats, as well as Value References.

Upon expiry

• the expiry date and time is displayed in the tasks popup

• If the expiry date occurs whilst the state is active (not before, not after):

  • the taskexpired event is sent

The expiry of the task event is displayed in the document activity report for the page.

Open

If the state in which the expiring task has a taskcompleted parameter, the workflow transitions to the state the taskcompleted parameter specifies

On the taskcompleted parameter transition, the following events are sent

• statechanged

• pagestatechanged if the event occurred for a workflow applied to a page

• newstatechanged if the event occurred for a workflow applied to a blog post

Examples

set-message

When a set-message macro in a trigger has a duedate parameter value and this expires

• the message is removed

Examples

workflowparameter

This macro creates editable Value References which, depending on its edit parameter setting, can be edited by space admins or users:

• Parameters - Space Tools

• Workflow setup - Workflow Popup

Be sure to specify the type as duration.

Examples: