How to use Handy Status

Check out our tips for working with Handy Status

Insert Handy Status

Once you have one or more status sets created in your Confluence instance, you can insert a Handy Status macro and interactively switch between statuses of the selected status set.

1. Insert the Handy Status macro on a page by typing /handy status or with the help of the Insert menu .
2. Select a set and a status.
3. Insert the macro and update or publish the page.

Change the status in the page view mode

1. Click the status.
2. Select a new status.

Check out our article with tips for Confluence status management.

Known issues

1. The Handy Status macro can't be displayed in Confluence Cloud template previews. It results in an error message. This issue is caused by Confluence Cloud bug. However, this preview issue doesn't affect the macro behavior once the page is created from the Confluence Cloud template. You can use our app as expected.
   

Link the status to the page label

Each Handy Status can be linked to the page label. This label will be updated every time you switch the status. It can be configured when you insert Handy Status or edit the Handy Status settings. 

To see the label changes after the status change, please, refresh the page. You can also use prefixes for labels for better traceability.

If you need several statuses with labels on your Confluence page, insert them one by one with the required settings. 

Don't copy the status with the label for the correct page labeling.

Link the new status to the page label

1. Go to the edit mode.
2. Insert the Handy Status macro on a page by typing /handy status or with the help of the Insert menu .
3. Select a set and a status.
4. Check Synchronize the page label with status.
5. Add Label prefix if needed.
6. Click Save.

Check out our article with tips for creating external documentation in Confluence.

Link the existing status to the page label

1. Go to the edit mode.
2. Click the status which you want to link to the page label.
3. Click Edit.
4. Enable the toggle Synchronize the page label with status.
5. Add Label prefix if needed.
6. Click Save.

Known issues

If you use Handy Status with the page label connection in a Confluence template, you need to change the value of Handy Status for the corresponding page label to appear.

Enable Handy Status Descriptions

You can select to show the Handy Status descriptions to a particular macro on a Confluence page.

1. Go to the edit mode.
2. Start editing an existing Handy Status macro or insert a new Handy Status macro.
3. Enable the Status description toggle.
4. Click Save.

You can enable or disable the Handy Status description at any moment. If the status description is not visible after being enabled, enter it in the Handy Status admin page first.

View Handy Status History

For the correct Status History behavior, please, don't copy Handy Status but create it on a page from the Insert menu or by typing /handy status.

1. Click Handy Status in the page view mode.
2. Open the Status History tab.
3. See the date, time, author, and status value changes including the creation of Handy Status.

Handy Status History shows the last 15 operations of status changes.

You will see no status history in certain cases:

• for Handy Status created from a Confluence template
• for Handy Status migrated from Server/Data Center

Known issues

1. Handy Status History is not migrated from Server or Data Center. If you migrate the macro, you'll see the No status history available message in the Status History tab. All the new operations of Handy Status changes will be recorded as expected after migration. 
2. If you copy Handy Status with history, your copied Handy Status gets the original Handy Status history as well. The Handy Status History is copied on macro copying. To avoid this behavior, insert Handy Status on a page by typing /handy status or with the help of the Insert menu .

Delete a status set

Before deleting statuses or sets, please, make sure they are not used on Confluence pages because this will make these statuses or sets shown as read-only.

You can delete any status set if it's not necessary anymore.

1. Navigate to Apps>Handy Macros.
2. Locate the status set that you want to delete.
3. Select and click Delete to delete a status set.
4. Submit this action by clicking Delete set.

Delete a status from a status set

You can delete any status set if it's not necessary anymore.

1. Navigate to Apps>Handy Macros.
2. Locate the status that you want to delete.
3. Click Delete.
4. Submit this action by clicking Delete status.

Set restrictions to Handy Status set configuration

By default, no restrictions apply, and all users can manage Handy Status sets. Once restrictions apply, only selected users or groups can manage all status sets. Other users will only be able to view the existing status sets.

Grant access restrictions

To grant access restrictions to users or groups, you need to:

1. Navigate to Global Settings > Handy Macros for Confluence> Aссess Restrictions.
2. Locate the Set access restrictions button or the Select field above the table.
   

   

   
   

   

   
   
3. Start typing the user or user group to grant them access restrictions.
4. Choose one or more entries in the select field. 
5. Click Confirm to grant them access to status set management, or click Cancel to undo the operation.

• Once you have at least one user or group with access permissions, all other users or groups will only be able to view the existing sets.
  

  

• You can add up to 100 users and 100 user groups. If you reach the limit, adding new ones will be impossible. You will see the following message.

  

Remove access restrictions

You can remove the access restrictions from any user or user group. To do so:

1. Navigate to Global Settings > Handy Macros for Confluence> Aссess Restrictions.
2. Locate the user or user group with access restrictions in a table from which you need to remove access.
3. Click the Remove icon.
4. Confirm the action in the modal dialog.

Delete all Handy Status data

You can delete all Handy Status data if it's not necessary anymore.

1. Navigate to Global Settings > Handy Macros for Confluence> App Configuration.
2. Locate the Handy Status menu. 
3. Click Delete statuses to delete all data related to the Handy Status macro.
4. Submit the action by typing DELETE in the modal dialog.

Please note that once deleted, the Handy Status data can't be restored.