Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
...
Parameter | Required | Default | Notes | Ver | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
unnamed first parameter |
user parameter instead. | Deprecated v5.2 | ||||||||||||||
macro body | The message to display:
| |||||||||||||||
Replaces an existing message to the same audience; if the macro is empty, the message panel will be removed for that audience.
A message that included
| ||||||||||||||||
| How long should the message be displayed from the point at which it is set?
| |||||||||||||||
Default behavior depends on message audience:
In both cases, specifying a | ||||||||||||||||
| unfiltered | Only show to users in specific user group(s)?
The message for an individual user will expire once viewed by that user. It will not be displayed for subsequent views of the page or if a transition has occurred before viewing. The on-screen display of a message filtered to a specific group(s) can be removed from the screen for that member of the group using an X option displayed in the message panel. The option to remove the message is not displayed if a
| 5.2 | |||||||||||||
|
| Message style: o o o o if no
| 4.1 | |||||||||||||
tip and hint styles are no longer supported (since v4.1) – use success and info , respectively, instead. | ||||||||||||||||
| unfiltered | Only show to specific user(s)?
The message for an individual user will expire once viewed by that user. It will not be displayed for subsequent views of the page or if a transition has occurred before viewing. The on-screen display of a message filtered to a specific user(s) can be removed from the screen for that user by using an X option displayed in the message panel. The option to remove the message is not displayed if a
| ||||||||||||||
|
| Which types of content URL should the message be shown on? Default - no inclusion of the parameter or value. The undisplayed parameter default value is
When
| 5.2 | |||||||||||||
This parameter determine which URL the message will be shown on when using same-space publishing:
If you're not using same-space publishing, all users see the normal URL by default. | ||||||||||||||||
For example, If
But this message is not displayed when viewing the last approved version for a page with an applied workflow that includes a final state. The viewer will see this content URL with the
The filtered message | ||||||||||||||||
The
Unfiltered messages, those which do not specify user or group, are treated separately:
|
Removing a message
An empty set-message
macro body in a trigger can be used to remove a previously set message.
Code Block |
---|
{set-message} {set-message} |
You need to use the same parameters that are in the message you want to remove, for example, if the set-message
macro contained view=draft, then, your empty set-message macro must have the very same view=draft parameter.
For example, adding the following message on a state transition
Code Block |
---|
{trigger:statechanged|state=Test}
{set-message:style=success}
You transitioned to the "Test" state
{set-message}
{trigger} |
This can be removed in a subsequent transition
...
using an empty set-message
macro in the trigger.
Code Block |
---|
{trigger:statechanged|state=Ready}
{set-message |
...
}
{set-message}
{trigger} |
...
Although the set-message
macro included a parameter to define the style of the message, both this set-message
macro
...
and the empty set-message
macro
...
Removing a message
An empty set-message
macro body in a trigger can be used to remove a previously set message.
Code Block |
---|
{set-message} {set-message} |
You need to use the same parameters that are in the message you want to remove, for example, if the set-message
macro contained view=draft, then, your empty set-message macro must have the very same view=draft parameter.
For example, adding the following message on a state transition
Code Block |
---|
{trigger:statechanged|state=Test}
{set-message:style=success}
You transitioned to the "Test" state
{set-message}
{trigger} |
This can be removed in a subsequent transition using an empty set-message
macro in the trigger.
Code Block |
---|
{trigger:statechanged|state=Ready}
{set-message}
{set-message}
{trigger} |
Although the set-message
macro included a parameter to define the style of the message, both this set-message
macro and the empty set-message
macro are are unfiltered - they are displayed to the same audience - and the message is removed.
...
previous on-screen messages will be displayed on reapplying the workflow (if the state has not been initialized)
Examples
Table of Contents | ||||
---|---|---|---|---|
|
Adding a filtered set-message
macro and an unfiltered set-message
macro to the same trigger
...