Expiry Dates - Macros

Overview

This article describes how Expiry Dates interact with specific macros.

{state}

Expiry date is set via the duedate parameter, which accepts both date and duration formats, as well as Value References.

Upon expiry:

• The expiry indicator in the workflow popup will turn red – see: State expiry date
• If the expiry date occurs whilst the state is active (not before, not after):
  
  • The stateexpired event is sent
  • If the expiring state has an expired parameter, the workflow will transition to the state it specifies
    • Events statechanged and, depending on content type, either the pagestatechanged or newstatechanged will be sent
  • Watchers and participants will receive a notification

If the expiry date is before the date on which the state is entered, the state will show as expired but won't trigger any events or transition to another state.

Examples:

• Page:
  Communardo Metadata for Confluence app — Using the Communardo metadata as value references in a workflow - including use in a custom condition for a trigger macro
• Page:
  State expiry dates — Using state expiry dates, defining them with metadata, and making them editable

{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:

• Page:
  Require Parameters on a state transition — Require workflow parameter values to be set before moving into a workflow state.
• Page:
  State expiry dates — Using state expiry dates, defining them with metadata, and making them editable
• Page:
  Using workflow parameters to create reviewer teams in a space — Using workflow parameters to create teams of users for use in approvals

{task}

Expiry date is set via the duedate parameter, which accepts both date and duration formats, as well as Value References.

Upon expiry:

• The expiry indicator in the workflow popup will turn red – see: State expiry date
• If the expiry date occurs whilst the state is active (not before, not after):
  
  • The stateexpired event is sent
  • If the expiring state has an expired parameter, the workflow will transition to the state it specifies
    • Events statechanged and, depending on content type, either the pagestatechanged or newstatechangedwill be sent
  • Watchers and participants will receive a notification

Examples:

{set-message}

When a {set-message} expires:

• The message will be removed
• That is all.

Examples:

• Page:
  Advanced different-space publishing
• Page:
  Advanced remote-space publishing
• Page:
  Attachment events — Triggering events when attachments are created, updated or removed.

{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. Note that the resulting editable field will usually require an exact date to be input.

Examples:

• Page:
  State expiry dates — Using state expiry dates, defining them with metadata, and making them editable