Page and User references
- Robert Alexander Marshall
Overview
These references provide information related to the current page.
Where can they be used?
You can use user references in the following macros (including, where applicable, parameters, Conditions and macro body):
-
approval macro — Add content-focus reviews to states
-
get-metadata macro — Retrieve and display Value References
-
state macro — Define workflow states & basic transitions
-
state-selection macro — Specify direct state transitions
-
task macro — Add tasks to workflow states
-
trigger macro — Trigger actions when events are fired
-
workflowparameter macro — Define editable workflow Value References
They can also be used in Actions. See Event references for a full list of references that can be used in Actions.
Page References
| Reference | Type | Event(s) | Description |
| date | all events | The date that this content was last modified |
| link | all events | A link to this piece of content |
| link | all events | A link to the parent of the page (only for pages) |
| date | all events | The date that this piece of content was created |
| text | all events | Name of the space that this content belongs too |
| text | all events | The title of this piece of content |
| text | all events | The version number of this piece of content |
@id@ | text | all events | The id of this piece of content |
@labels@ | text | all events | List of comma-separated labels of this piece of content |
User References
| Reference | Type | Event(s) | Description |
|---|---|---|---|
@author@or @creator@ | username | all events | The username of the person who created the page or blog post. Specifically, it returns the username of the person who clicked the Publish button when the page or blog post was first created.
|
@modifier@ | username | all events | The username of the person who last changed this content. |
@user@ | username | all events | The username of the active user who triggered the event or state transition.
|
Using this reference can be unreliable outside of events, and also in cases where an event or transition is caused by state or task expiry. | |||
| all events | The usernames of everyone who is watching the content. |
Example
A common use would be to prevent page creators from taking part in content reviews:
{workflow:name=Review}
{state:In progress|submit=Review}
{state}
{state:Review|approved=Approved|rejected=In progress}
{approval:Review|assignable=true|exclude=@creator@}
{state}
{state:Approved|final=true|updated=In progress}
{state}
{workflow}