Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameters

Mandatory

Default

Description

unnamed first parameter
or name

Yes

 

Name of the state. Names must be unique withing a state macro and can use any character set supported by Confluence expect the special characters used by the workflow syntax and Confluence (e.g. {. |}, ,|, etc.).

approved

No

 

The state to change into if all the defined approvals are approved.

rejected

No

 

The state to change into if all the defined approvals are rejected.

updated

No

 

The state to change into if the page is updated (edited).

submit

No

 

The state to change into if the page is submitted (via the Accept button). Only applicable if there are no approvals in the state.

expired

No

 

The state to change into if the page expires based on duedate time range or the user set expiry date from changeduedate.  For more details, please see Expiry Date below.

completed

No

 

The state to change into if all the tasks in the state are completed

final

No

false

If set to true, when a page or blog post reaches this state, its version is marked as Published.  Used for same space publishing.  Refer to Understanding the Comala Workflow Engine for more information on different publishing options.

description

No

 

The description to be shown in the page's state box.

hideselection

No

false

By default, if rejected, approved, updated, submit, expired or completed parameters are not set, then the engine will allow changing the state to any other state. If this value is set to true then no state selections are allowed. See also state-selection.

taskable

No

false

Whether or not tasks can be manually defined in this state via the Tasks button.

duedate

No

 

Duration of time before the state expires following the ISO 8601 standard for duration or exact date the state should expire. For more details, please see Expiry Date below.

changeduedate
NofalseIf set to true, the due date of the state can be adjusted by users.  Can be used with or without duedate.  For more details, please see Expiry Date below.
hidefrompathNofalseIf set to true, this state will be hidden from the progress tracker for the workflow.
colourNo

Colour of the state in hexadecimal value (e.g., #ff0000)or simple colour names (e.g., red). Grey if the value is invalid. Default colors for states: Blue if there is not a final state in the workflow; Green if the state is set as final; Yellow if the workflow has a final state which is not the current state

macro's body

No

 

Can be empty, the state-selection macro, or a combination of task and/or approval macros.

...

To set the exact date use the following format: YYYY-MM-dd HH:mm 

The duedate value can also be specified using a value reference that is read when the state is created.

...