state macro
- Robert Alexander Marshall
Overview
The state macro is used to define a state in a workflow macro. State macros are used to automatically set tasks and approvals on a page.
Where to use it?
Required – at least one.
One or more state macros can be put in a workflow macro.
Parameters
Parameter | Required | Default | Notes | Ver |
|---|---|---|---|---|
unnamed first parameter | Name of the workflow state
In addition to being used for transitions, event triggers, etc., the state name is also shown in many aspects of the user interface and reporting. The current workflow state name parameter can be retrieved a report or third party metadata app/macro by using the | |||
macro body | Can be empty, or one or more of the following macros:
| |||
TransitionsDefine the name of target state for common transitions. If required, custom transitions can be implemented by using Events to trigger a set-state transition. | ||||
| see notes | If a content review is Approved, which state should the workflow transition to? | ||
| see notes | If a content review is Rejected, which state should the workflow transition to? | ||
| Define a single state to transition to from the current state. This causes a drop-down menu to appear in the workflow popup to allow direct transition to that state. See also: | |||
| If the associated content is edited (updated), which state should the workflow transition to?
| |||
If used on a state that is | ||||
| Require a given list of workflow parameters to be set before transitioning into this state.
| |||
ExpiryStates can be set to expire on either an explicit date, or, more commonly, a time period from the occurrence of the transition to the state. If a state expires while it is active, the state specified by the Events: | ||||
|
| Can users set and/or change the
Can be used with or without the | 4.5+ | |
| If defined, the state will be given an expiry date.
See Expiry Dates for more information. The due date will be logged in the Activity Report - Content when the state is entered (v4.5.1+). | 3.2+ | ||
| The state to change into if the page expires after its | 3.2+ | ||
If you're viewing the page when expiry occurs, you won't see the state update until you refresh the page. Also, if the expiry date has already passed when entering the state, the transition won't occur. For best results always use an ISO 8601 duration rather than a specific date. | ||||
TasksWant to add tasks automatically when a state is transitioned to? See: task macro. When all tasks are completed, the state specified by the Events: | ||||
| The state to change into if all the tasks in the state are completed. | |||
|
| Whether or not tasks can be manually defined in this state via the Tasks button. | ||
PublishingSpecify which state in your workflow is a final, published state. See also: Same-space publishing and State Status Indicator Circles. | ||||
|
| Should content in this state be considered "Published"?
Setting as | ||
If the | ||||
|
| When using this parameter, the | ||
This parameter is exclusively used for integration with the K15t Scroll Versions app, and is must be used for workflows in spaces where the Scroll Versions app is being used. | ||||
User InterfaceThe following parameters can be used to customise the user interface associated with workflow states. | ||||
| By default, states are coloured as described in State Status Indicator Circles, namely:
If desired, you can override the colour of individual states by specifying a colour in one of the following formats:
Invalid colour specifications will default to Grey. See also: Confused States - Grey Circle. Triadic colour schemes yield good visual colour segregation. | 5.1+ | ||
| Adds a plain text description to the workflow popup when this state is active. | |||
|
| Should the state be hidden from the Progress Tracker bar on the workflow popup?
Note: The state will still appear in the tracker bar when the workflow is in that state. See also: | ||
|
| By default, direct state transition buttons (to every other state in the workflow) will be added to the workflow popup, unless you specify any of the following parameters: If none of those parameters are specified, should the default buttons be hidden?
Alternatively, you can use a state-selection macro to specify which direct state transition buttons should be shown. | 3.0+ | |
Deprecated ParametersThese parameters are either deprecated or obsolete and should no longer be used. | ||||
|
| Obsolete Use | 3.2.2 | |
| Obsolete Use | 3.0 | ||
Editing duedate
The duedate and changeduedate parameters can be used on their own or together. The following table describes what will happen with each possible combination:
|
| Description |
|---|---|---|
not set |
| State will not have an expiry date nor can users add an expiry date. |
set |
| State will have an expiry date based on the duedate parameter that the user cannot change. |
not set |
| State will not initially have an expiry date, but the user can add an expiry date. |
set |
| State will initially have an expiry date based on the |
Events
The following Events are applicable to transitions between states:
statechangedpagestatechangednewsstatechanged
Example
{workflow:name=States}
{state:Start|submit=Stop}
{state}
{state:Stop|submit=Start}
{state}
{workflow}