Stiltsoft Handy Status Macro for Confluence
- Jorge Merino
- Robert Alexander Marshall
Overview
The Stiltsoft Handy Status macro adds and removes the labels on the page.
When you use the Stiltsoft Handy Status Macro for Confluence app along with a Comala Document Management workflow, configured with a trigger to monitor label addition and page update events, the value of the Stiltsoft Handy Status macro and the workflow status can “synchronize”.
You need the Stiltsoft Handy Status macro v3.8.0 or above.
The scenario
A user changes the Stiltsoft Handy Status macro value for a page and this automatically changes the Comala Document Management applied workflow state.
The Stiltsoft Handy Status macro must be linked to the page label in the macro configuration.
When the Stiltsoft Handy Status macro Synchronize the page label with status option is checked
the page label is updated every time you switch the status
This is configured when you insert the Stiltsoft Handy Status macro or edit the macro settings.
For further information refer to the Stiltsoft Handy Status Macro product documentation - How to use Stiltsoft Handy Status macro.
The solution
In a simple example
the Stiltsoft Handy Status macro is synchronized to change the label for the content
the Stiltsoft Handy Status macro is either no or yes
A Comala Document Management workflow is applied (with two states, In Progress and Approved). The applied workflow includes three workflow triggers
two separate triggers change the workflow state when the page label is changed in sync with the Stiltsoft Handy Status macro
a third trigger is used to change the page label when the page is edited in the Approved state
Workflow trigger one - Stiltsoft Handy Status macro changed to “no”
This trigger manages the response to a labeladded event.
Stiltsoft Handy Status macro is changed to no
the label no is added to the page
a workflow trigger listening for the addition of label no sets the state to the In Progress state
{trigger:labeladded|label=no}
{set-state:In Progress}
{trigger}Workflow trigger two - Stiltsoft Handy Status macro changed to “yes”
This trigger manages the response to a labeladded event.
Stiltsoft Handy status macro is changed to yes
the label yes is added to the page
a workflow trigger listening for the addition of the label yes sets the state to the Approved state
Workflow trigger three - page update in the Approved state changes page label
This trigger manages the response to a pageupdated event in the Approved state.
An updated state transition is not added to the Approved state. The transition is managed by this workflow trigger.
The workflow trigger listens for the pageupdated event when the workflow is in the Approved state.
On this pageupdated event, the trigger
changes the state to the In Progress state
sets the page label to no
removes the page label yes
The Stiltsoft Handy Status macro is synchronized with the page label so the macro status changes to no - the new page label value updated by the workflow trigger.
To prevent large numbers of notifications to page watchers, the Stiltsoft Handy macro app marks its content updates as "Minor change" (the same as if you clear the "Notify Watchers" checkbox while editing a page). With triggers and conditions, we can filter out "Minor Change" events and then use an action macro in the trigger to transition the state.
Workflow triggers
{trigger:labeladded|label=no}
{set-state:In Progress}
{trigger}
{trigger:labeladded|label=yes}
{set-state:Approved}
{trigger}
{trigger:pageupdated|state=Approved|isminorchange=true}
{set-state:In Progress}
{set-label:no}
{remove-label:yes}
{trigger}
The isminorchange parameter is a workflow condition that can be used in a pageupdated or newsupdated workflow trigger with the Stiltsoft Handy Status macro app.
App configuration
There is also a Document Management app setting which may be affected by the Stiltsoft Handy Status macro updating content...
Setting | Where | Notes |
|---|---|---|
Page Update Reset Approval | If enabled, content updates will reset any approvals in an active content review. |