Admin Guide - Cloud
- Karina Zoin
- Rosen Marinkov
On this page:
Overview
This guide explains installation instructions and other administrative features available with Announcer for Jira and Announcer for Confluence on cloud.
Currently, this app is not available to Bitbucket cloud users.
Install the Announcer app on Jira and Confluence
Manage the Announcer app as a site or organization admin
As a site or Organization admin, you can configure the Announcer app at both the global and announcement levels for Confluence or Jira. The following sections explain how to manage these settings.
To access the Announcer app’s configuration pages:
From the top navigation bar, select Apps > Manage Apps.
In the left-hand menu, find the ANNOUNCER FOR JIRA/CONFLUENCE.
There, you will find the Announcement menu for creating and editing announcements and the Global Configuration menu for managing the app's global settings.
Announcements
Select ANNOUNCER FOR CONFLUENCE (Or ANNOUNCER FOR JIRA) > Announcements from the sidebar to view the Announcements page that displays all the existing announcements and allows you to create, edit, or delete an announcement.
In this page, you can click:
Preview () to preview an existing announcement.
Reset ()to reset the acknowledgement counts to 0 for the respective announcement. The acknowledgements are cleared and the announcement is displayed again to the targeted users as configured.
Edit () to edit an existing announcement.
Delete () to delete an existing announcement.
Report () to see an acceptance report for an existing announcement.
Add notification to add a new announcement.
Basic edit options
When you choose to create a new announcement or edit an existing one, the following dialog with basic options appears:
The table below describes each basic option available for configuring an announcement:
Name | Description |
|---|---|
Title | The title of the announcement in the UI that is presented to the end user in the title bar of the browser window. |
Description | An internal description of the announcement that is not displayed to the end user. |
Display | |
Show for Anonymous | Indicates whether this announcement should be displayed to anonymous users. |
Enable announcement | Indicates whether the announcement is active (enabled) or inactive (disabled). Only enabled announcements are displayed to the targeted users. |
Notification Type | Indicates the display method of the announcement. Banner - Displays the announcement as a banner on every page until the end user dismisses it. (Confluence only) Full Page - Displays the notification as a "full page" announcement (see list of URLS below that are not affected). Dialog - Displays the notification as a dialog. Flag - Displays the notification as a popup that appears in the bottom left corner of the screen until the user dismisses it. |
Contents | Use the dropdown to select the intended format (HTML, Markdown, Plain Text) from the Advanced options and then enter the body of the announcement. |
Advanced edit options
Click Show advanced options... to display additional options.
Confluence
Jira
Name | Description |
|---|---|
Access | |
Filter for specific space(s) (Confluence only) | If you want to target a specific space, select this checkbox and then select the space that should be used. To select multiple spaces, hold the Shift key and select each space. |
Filter for specific project(s) (Jira only) | If you want to target a specific project, select this checkbox and then select the project that should be used. To select multiple projects, hold the Shift key and select each space. |
Filter for specific groups(s) | If you want to target a specific group, select this checkbox and then select the group that should be used. To select multiple groups, hold the Shift key and then select each group. |
Acceptance Configuration | |
Button Text | If you want to change the text of the button, specify it here. If this field is left blank, the default text (Dismiss) is used. |
Button Behavior | If you want to manage the Acknowledge and/or Dismiss buttons displayed for users in announcements, select or deselect either of the following check boxes:
|
Notification Format | Select a format to display the announcement in. Available formats are:
Enter the body of the announcement in the Contents editor. Certain rich text features such as bulleted or numbered lists, font styles, and so on, can be applied to the text based on the specified format. |
Click:
Save to save the changes made to the announcement.
Cancel to discard your changes.
Reports
To view the notification report on who viewed the announcement, select the report icon () of the respective announcement to navigate to the Notification report page. This page displays who has accepted the announcement and who has not. Dwell time (i.e., how long an announcement was displayed before the user dismissed it), in seconds, is displayed as a summary across all users and on a per user basis. You can see the number of times the users used the Remind me later option.
You can click Export to CSV on the top right corner to export the report to a CSV file.
Global Configuration
Select ANNOUNCER FOR CONFLUENCE (Or ANNOUNCER FOR JIRA) > Global Configuration from the left sidebar to view theGlobal Configuration page where you can configure all the global parameters of all the announcements.
The options that can be configured are:
Option | Description | Default value |
|---|---|---|
General Settings | ||
Dialog Height | This allows you to change the default dialog height of Dialog announcements. | Medium |
Whitelist HTML tags | Allows administrators to specify which HTML tags and/or attributes can be used in the announcement body. This is applicable only for the HTML notification format. Administrators must allow the HTML
| a, b, i, u, h1, h2, h3, h4, h5, h6, div, font, strong, style |
Enable Delegation | Allows space administrators in Confluence or project administrators in Jira to create their own announcements. | false |
Remind Me Later Settings | ||
Enable Remind me later | Enable this option to give users the option to temporarily mute an announcement and have the announcement reappear after a pre-set period of time. Disabling this option displays the announcement until the user selects Dismiss. | false |
Remind me later text | Allows you to customize the text displayed on the the Mute button of the announcement. Add some helpful text for users to understand that they can be reminded of the announcement later and can mute it for a while when they click the link. | Remind me later |
Mute period | Specifies the amount of time (in minutes) for which you can mute the announcement. | 240 |
Explanation Text | Allows you to add the hover dialog text that helps the user understand the announcement in detail. | Refer to the image |
Data deletion policy
When users uninstall the app, it is essential to ensure that their data is handled responsibly and in compliance with privacy regulations. To achieve this, we follow a data deletion policy that guarantees the removal of the app data 90 days post the uninstallation of the app. This includes the configured notifications, acknowledgement reports and any configuration data.
Manage the Announcer app as a delegated admin
You can also set up announcements for a specific Jira project or Confluence space. Below are the steps to find and manage announcements if you are a Jira project admin or a Confluence space admin.
To access the Announcer app’s configuration page, follow the steps below:
Need more help? Contact our support team.