User Guide - 1.5

This guide refers to functionality in the 1.5 release of the Announcer add-on.

 

The Announcer for JIRA, Stash and Confluence add-ons are available to install through the Atlassian Marketplace & Atlassian Universal Plugin Manager (UPM).

 

If you're upgrading from a version prior to 1.5

If you're upgrading from a version from prior to 1.5, please note that all of your announcements will become disabled when you upgrade. Simply visit the Administration Overview page and click Enable all  (or select the announcements to enable).

 

To add a new announcement, click the Cog menu  and choose Add-ons. In the left sidebar, click Announcer.


 On This Page

Administration Overview page

On the administration Overview page, you can view the active notifications for users logging in.

From this page, you can:

  • Click Preview () to preview an existing notification.
  • Click Edit (  ) to edit an existing notification.
  • Click Delete () to delete an existing notification.
  • Click Add another announcement to add a new announcement.

 

Creating or editing an announcement

When you create or edit an announcement, the Notification editor window will appear.

 

Supply the following details:

NameDescription
TitleThis is both the title of the notification in the U/I and presented to the end user in the title bar of the browser window
DescriptionThis is an internal description of the announcement and is not displayed to the end user.
ContentsThis is the body of the announcement. Please use HTML tags to format the contents.
Anonymous AccessIndicates whether this item should be displayed to anonymous users.
Notification Type

Banner - this will make the notification be displayed as a banner on every page until the end user dismisses it.

Full Page - this will make the notification be displayed as a "full page" acknowledgment (see list of of URLS below that are not affected).

Dialog - this will make the notification be displayed as a dialog.

Button TextIf you want to override the text of the button, specify it here. If this field is left blank, the default text is used.
Filtered Projects/Spaces

If you want to target specific projects or spaces only, check this checkbox and select the project(s) or space(s) that should be used.

(info) This option is only available for Dialog and Banner notification types.

Active/InactiveWorking on a notification and not quite ready for it to be live? Simply click this checkbox.

JIRA handles the targeted projects differently than Bitbucket handles Bitbucket projects and Confluence handles a space. A project is considered active in JIRA if it's the last project the user visited.

About Anonymous Users

While we try to avoid showing the same item repeatedly, we're using the web browser session and thus an Anonymous user might see the same item repeatedly. However upon login, the notifications are applied to the logged-in user and thus they won't see the item again.

Reports

For any given report , select the report icon ()  and an Acceptance Report will be displayed that shows who has accepted the notification and who has not.

My Acknowledged notifications

At any time, a user can select Acknowledged notifications from the User menu to see the notifications they have acknowledged/accepted.


 

URLs that are not affected

The Announcer add-on will intercept all page requests with the exception of the below paths:

URLProductDescription
/rest/*AllREST URLs are not blocked
/plugins/servlet/upmAllThe Universal Plugin Manager (UPM) is not blocked

 

 

 

 

 

 


Need more help? Contact our support team.