Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
printablefalse
separatorpipe

Overview

This article describes how Expiry Dates interact with specific macros.

{state}

Expiry date

Table of Contents
maxLevel2
minLevel2
include
outlinefalse
indent
excludeOverview
typelist
printablefalse
class

state

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

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

Insert excerpt
Edit states using workflow builder
Edit states using workflow builder
namestate_duedate_wfbuilder
nopaneltrue

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.

...

Upon expiry :

...

of the duedate fixed date or duration period

  • the expiry indicator in the workflow popup

    will turn red – see

    turns red

...

Info

SeeState expiry date

If the expiry date occurs whilst the page or blog post is in the state

...

(not before, not after):

  • The 

    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

Info

Watchers and participants

...

receive a notification

If the expiry date is set as a date that is before the date on which occurrence of the transition to the state is entered,

  • the state

...

  • shows as expired but

...

  • does not trigger any events or transition to another state

Tip

This is good reason to use duration periods for duedate values rather than a fixed date.

Examples

...

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-state" and label = "example" and label in ( "parameter-expired" , "parameter-duedate" , "parameter-changeduedate" ) and label != "concept" and space = currentSpace ( )

...

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

...

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-workflowparameter" and label = "example" and label != "concept" and space = currentSpace ( )

...

task

...

Expiry 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 indicator

    the expiry date and time is displayed in the

    workflow popup will turn red – see: State expiry date

    tasks popup

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

    • The stateexpired

      the taskexpired event is sent

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

...

If the state in which the expiring

...

task has

...

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

Info

Watchers and participants

...

receive a notification

Examples

...

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-task" and label = "example" and label in ( "parameter-expired" , "parameter-duedate" , "parameter-changeduedate" ) and label != "concept" and space = currentSpace ( )

...

set-message

...

When a {set-message} expires:

  • The message will be removed
  • That is all.

Examples: macro in a trigger has a duedate parameter value and this expires

  • the message is removed

Examples

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-set-message" AND label != "concept" and label = "example" and label = "parameter-duration" and space = currentSpace ( )

...

workflowparameter

...

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

Be sure to specify the type as duration. Note that the  as duration.

The resulting editable field

...

usually

...

requires an exact date to be input.

Examples:

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-workflowparameter" and label = "example" and label = "type-duration" and label != "concept" and space = currentSpace ( )