---
title: "Admin Guide - Cloud"
canonical: "https://support.appfire.com/space/ANNOUNCE/858423468/Admin%20Guide%20-%20Cloud"
format: markdown
---
> Macro (aura-html)

# Overview

This guide explains installation instructions and other administrative features available with *Announcer for Jira *and* Announcer for Confluence *on *c*loud.

> 📝 Currently, this app is not available to Bitbucket Cloud users.

# Install the Announcer app on Jira and Confluence  


> Macro (tabs)

# 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:**

1. From the top navigation bar, select **Apps** > **Manage Apps**.
2. In the left-hand menu, find the ANNOUNCER FOR JIRA/CONFLUENCE.

There, you will find the **[Announcement](#Announcements)** menu for creating and editing announcements and the **[Global Configuration](#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. 

![image](media://48d955ca-689b-4174-9424-937cf4c7937b)

In this page, you can click:

- **Preview** (> Macro (inline-media-image)

) to preview an existing announcement.
- **Reset **(> Macro (inline-media-image)

)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** (> Macro (inline-media-image)

) to edit an existing announcement.
- **Delete** (> Macro (inline-media-image)

) to delete an existing announcement.
- **Report** (> Macro (inline-media-image)

) 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:

![announcement_cloud.png](media://c6b91972-95a6-416a-947e-c09c1261acb4)


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. |
| <u>**Display**</u> |
| 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.<br>**Banner** - Displays the announcement as a banner on every page until the end user dismisses it. *(Confluence only)*<br>**Full Page** - Displays the notification as a "full page" announcement (see list of URLS below that are not affected).<br>**Dialog** - Displays the notification as a dialog.<br>**Flag** - Displays the notification as a popup that appears in the bottom left corner of the screen until the user dismisses it. |
| Notification Format | Select the format for the body of the announcement. Can be:<br>- HTML
- Markdown
- Plain Text<br>> ⚠️ **Flag **notifications support only **Plain Text** messages due to limitations in the Atlassian platform. |
| Contents | The body of the announcement.<br>> ✅ For HTML messages, If you want to include a link that opens in a new tab, add the `target=”_blank”` attribute to the `<a>` tag. |
| <u>**Scheduling Options**</u> |
| Enable date and time restrictions | Select to set a specific date and time range between which you want to display the announcement. Once this checkbox is selected, additional controls appear:<br>- *From *- Select the start date and time.
- *To* - Select the end date and time.
- *Run indefinitely* - Select this check box if you want to end the announcement manually.<br>> 📝 The date and time settings displayed here are in sync with server settings where Jira and Confluence are hosted. |
| Enable custom recurrence | Use this toggle to repeat displaying an announcement at regular intervals. To do so, select one of the following options:<br>- *Repeat announcement daily for *- Select a number for the number of days you want to repeat displaying the announcement. Also, select between daily, weekly, or monthly intervals.
- *Repeat announcement* - Select an option to repeat the announcement weekly, monthly or on the last day of the month. Also, mention the specific day in the week or the month on which the announcement is displayed.
- *Repeat announcement* weekly *on the following days - *Select the specific day of the week and the time when the announcement is displayed. |

### **Advanced edit options**

Click **Show advanced options** to display additional options.

- <u>Confluence</u>
- <u>Jira</u>

  
The table below describes each advanced option available for configuring an announcement:

| **Name** | **Description** |
| --- | --- |
| <u>**Access**</u> |
| Filter for specific space(s)<br>(*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)<br>(*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. |
| <u>**Acceptance Configuration**</u> |
| 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:<br>- *Enable the button after 5 seconds*: If enabled, the **Dismiss **button is initially disabled, and is enabled only after five seconds. This ensures that the user has the opportunity to read the announcement before dismissing it. When this option is disabled, the button is available for clicking with the announcement right away.
- *Should the accept button be shown*: If enabled, the **Acknowledge** button is displayed with the announcement. This allows administrators to make sure that users are not able to ignore or dismiss important information displayed through the announcement. If disabled, the button is not made available to the users with the announcement. |

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 (> Macro (inline-media-image)

) 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.

![image](media://f5f72b11-aa9c-4ff6-a893-fef6bbce74f9)

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 the*Global Configuration *page where you can configure all the global parameters of all the announcements.

![image](media://d6bb53f5-29e1-4359-80ad-212b3d8ac581)

The options that can be configured are:

| **Option** | **Description** | **Default value** |
| --- | --- | --- |
| <u>**General Settings**</u> |
| 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.<br>> ⚠️ Administrators must allow the HTML `script` tag in this parameter with caution. If this tag is whitelisted, the contents between the tag pairs are not removed and are processed as-is; thus, increasing possibilities of security vulnerabilities. | 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 |
| <u>**Remind Me Later Settings**</u> |
| 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.

# Statuspage.io Integrations

Click **ANNOUNCER FOR JIRA/CONFLUENCE**> **Statuspage.io integrations** from the sidebar to open the *Statupage.io Integration* page. The integration with Statuspage ensures that important information about critical systems and/or any incident updates is displayed across Confluence or Jira. A list of all announcements, enabled or disabled, is displayed in this page. Before you establish a connection with Statuspage, you see:

![image](media://c1b6328c-9ac3-4455-b29e-3820fd6d8423)

> 📝 First, establish a connection with your Statuspage instance. If not, actions associated with **Add a Statuspage Integration now** are ignored.

Click the *Cog* (:cog-icon: ) menu in the top-right corner to connect to a *Statuspage* instance. 

![statuspage_integration.png](media://032ac8cd-a468-460f-95d0-56c4a2ccd6e4)

All the options here are mandatory. The options that can be configured are:

| **Name** | **Description** |
| --- | --- |
| **Base URL** | Enter the Statuspage URL here. This URL is used to connect to your Statuspage instance. |
| [Statuspage.io](http://statuspage.io/)** API Token** | Enter the Statuspage API token. To get this token:<br>1. Login to [Statuspage.io](http://statuspage.io/) with your credentials.
2. Click your profile in the left sidebar.
3. Click **API info**.
4. Copy **Your API user key** (click the *Copy*  icon). Paste that value in this field. |
| **Polling Frequency** | The Announcer app checks Statuspage for updates every 5 minutes. This interval is fixed and cannot be changed. |
| **Statuspage Link Prefix** | Enter the text to be used to link the announcement with the Statuspage incident page. After this text, a link to the specific Statuspage incident is included. Clicking this link opens the Statuspage incident page in the browser. |

Click **Save** to save the announcement or **Cancel**, if you do not wish to proceed. 

After providing the connection details, click **Add a Statuspage Integration now **to create an announcement integrated with the configured Statuspage page.

![image](media://bfcee279-7edb-4bd5-acd5-c104e1d506b5)

The options that can be configured are:

| **Name** | **Description** | **Mandatory?** |
| --- | --- | --- |
| **Announcement Configuration** |
| **Enable** | Select to receive incident updates from the specified Statuspage instance. | No |
| **Name** | Enter a relevant name for the Statuspage announcement. Your Jira Administrator can refer to the integration with this name. | Yes |
| **Description** | Enter a descriptive text for the announcement that is not visible to users. | No |
| **Announcement Type** | Select one of the following:<br>- *Banner* - Displays the notification as a banner on every page until the end user dismisses it.
- *Full Page* - Displays the notification as a "full page" acknowledgment (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 top right hand corner of the screen until the user dismisses it.<br>> 📝 Full Page is not available for announcements created by Space (Confluence) or Project (Jira) administrators. | Yes |
| **Notification Icon** | Choose this if you'd like an icon displayed next to the announcement title. Available icons are:<br>- Error
- Information
- Success
- Warning<br>For *Banner* and *Flag* notification types, the border colors and icons change based on the icon selected from this list of options. | Yes |
| **Filter for specific project(s)**<br>*(Jira only)* | To target a specific project, select this checkbox and then select the project that should be used. To select multiple projects, hold down Shift and then click each project. For Jira: Only the projects that the current user has 'Browse' or 'Administer' permission for, are shown. | No |
| **Filter for specific groups(s)** | To target a specific group, select this checkbox and then select the group that should be used. To select multiple groups, hold down Shift and then click each group. | No |
| **[Statuspage.io](http://statuspage.io/)**** Configuration** |
| [Statuspage.io](http://statuspage.io/) **page** | Select a page from the drop-down list. This list is populated with the pages available on your Statuspage instance. | No |
| **Status(s)** | By default, all statuses available in Statuspage are displayed here. Click X to remove unwanted statuses from the box. | Yes |
| **Announcement EOL ** | Select the time till which the announcement is valid. This value is referred to as the End of Life (EOL) of the announcement. This specified time (in minutes, hours, or days) disables the announcements after the latest update from Statuspage is received. At the same time, the Acceptance Report counts for the announcement are also reset.<br>> ✅ Recommended *Announcement EOL* value is **15 mins**. | Yes |

Click **Create** to create the announcement or **Cancel**, if you do not want to proceed. Once a Statuspage announcement is created, you see it listed in the [http://Statuspage.io](http://Statuspage.io) * Integration* page. 

![image](media://9f6d60fc-a3b5-4c47-a25e-fdc47372bb46)

To create announcements for other Statuspage pages, click **Configure a Statuspage announcement**. You can integrate with multiple Statuspage pages, as required.

# Active Statuspage.io incidents

Click **ANNOUNCER FOR JIRA/CONFLUENCE **> **Active Statuspage.io incidents** from the sidebar to open the *Incidents* page. All active Statuspage announcements are displayed here.

If there are no active incidents, the *Incidents* page shows:

![image](media://6085c23d-6ac4-445a-bfc4-95abfdda744b)

After the configurations are made and the Announcer Series begins to receive incident updates, the *Incidents* page displays details such as, when the incident occurred, and, when the incident was last updated as shown:

![image](media://56e33246-d91d-4826-8804-9310c026f915)

Click the *Edit* :edit:  icon to view the incident history details. You can turn off notifications if you do not want to receive any more updates.

![image](media://03e4d066-9ea2-404a-a0c4-65d567a8b38a)

# 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:**

> Macro (tabs)