set-message macro

Overview

Use the set-message macro to display an on-screen message. It's great for keeping the user informed during the content production process.

• messages are shown between the page title and body content whilst viewing content (it's hidden from the edit screen)
• if triggered by stateexpired or taskexpired events, the message won't be shown until the page is refreshed

Where to use it?

Optional.

One or more {set-message} macros can be added as action macros in a trigger macro.

Parameters

Parameter	Required	Default	Notes	Ver
unnamed first parameter			DEPRECATED Use the user parameter instead	Deprecated 5.2
macro body			The message to display: Plain text, or Confluence Wiki Markup Supports Value References
			Replaces existing message to the same audience; if empty, the message panel will be removed for that audience.
duration			How long should the message be displayed from the point at which it is set? ISO 8601 duration code – see: Expiry Dates Page: Advanced different-space publishing Page: Advanced remote-space publishing Page: Attachment events
			Default behavior depends on message audience: unfiltered messages are shown indefinitely if a group and/or user is specified, the message for an individual user will expire once viewed by that user In both cases, specifying a duration will override the default behavior.
group		unfiltered	Only show to users in specific user group(s)? Comma separated list of user groups Supports Value References Filter by label There are no items with the selected labels at this time.	5.2
style		info	Message style: info, error, warning, success o o o o if no style is added the default message display is info. Page: Advanced different-space publishing Page: Advanced remote-space publishing Page: Blog Post Events Page: Message notification styles	4.1
			OBSOLETE The tip and hint styles are no longer supported (since v4.1) – use success and info, respectively, instead.
user		unfiltered	Only show to specific user(s)? Comma-separated list of usernames Supports Value References Filter by label There are no items with the selected labels at this time.
view		both	Which types of content URL should the message be shown on? draft – the normal URL published – the /public URL both – both normal and public URLs Filter by label There are no items with the selected labels at this time.	5.2
			This parameter determine which URL the message will be shown on when using Same-space publishing: view-only users see the /public URL by default content producers will still see the normal URL by default, but can Switch between draft and published URLs If you're not using same-space publishing, all users see the normal URL by default.
The user and group parameters can be used together: groups are treated as if you listed their users via the user parameter there can be only one message for a given user per view type Unfiltered messages, those which do not specify user or group, are treated separately: they will be shown in addition to user or group messages Use the macro body empty to remove the previously set message.  You need to use the same parameters that are in the message you want to remove e.g., if the message contained view=draft, then, your empty set-message macro must have the very same view=draft parameter.

Example

{workflow:set-message test}
   {state:Ready}
   {state}
   {state:Test}
   {state}
   {trigger:statechanged|state=Test}
      {set-message}
         This message shown to everyone
      {set-message}
      {set-message:user=@user@}
         You transitioned to the {{Test}} state
      {set-message}
   {trigger}
   {trigger:statechanged|state=Ready}
      {set-message}{set-message}
   {trigger}
{workflow}

All examples

• Page:
  Advanced different-space publishing
• Page:
  Advanced remote-space publishing
• Page:
  Attachment events — Triggering events when attachments are created, updated or removed.
• Page:
  Blog Post Events — Workflow events associated with blog posts
• Page:
  Message notification styles — Test the style parameter of the {set-message} macro
• Page:
  Using set-message and metadata to display different information for the draft and published content — Using the view parameter of the {set-message} macro to display a different metadata when users view the draft or published versions

See also

Workflow Authoring Guide:

• Notifications
• Expiry Dates
• Events
• Triggers
• Actions