Status

Indicates whether the announcement is active (enabled) or inactive (disabled).

Title

The title of the notification is displayed to the end user in the browser window's title bar.

Description

An internal description of the announcement that is not displayed to the end user.

Announcement Type

Select one of the following announcement types:

• 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 the 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.

Announcement Icon

Select one of the following to display the respective icon next to the announcement title:

• Error

• Information

• Success

• Warning

Accept Button Text

Enter the text for the accept button. If this field is left blank, the default text Dismiss is used.

Enable the button after 5 seconds

Select this checkbox, and the Dismiss button activates after 5 seconds. This ensures the user has the opportunity to read the announcement before dismissing it.

Should the accept button be shown

This applies to Banner and Flag announcement types only and indicates whether the Accept button should appear.

Use the dropdown to select the desired format: HTML, Markdown, or Plain Text. Then enter the body of the announcement.

Show for anonymous users

Select to display the announcement to anonymous users.

Show announcement upon every login 

Select to display the announcement to the user upon every login.

Show announcements for new users only

(Confluence and Jira only)

Select to display the announcement to newly added Jira or Confluence users.

Filter for specific space(s)

(Confluence only) 

To target a specific space, select this checkbox and then select the space to be used. To select multiple spaces, hold down Shift and then click each space.

Filter for specific space category(s)

(Confluence only) 

To target a specific space category, select this checkbox and then select the space category to be used. To select multiple space categories, hold down Shift and then click each space category.

Filter for specific project category(s)

(Jira only)

To target a specific project category, select this checkbox and then select the project category to be used. To select multiple project categories, hold down Shift and then click each space category.

Filter for specific project(s)

(Jira and Bitbucket only)

To target a specific project, select this checkbox and then select the project to be used. To select multiple projects, hold down Shift and then click each project.

Filter for specific Project Role

(Jira only)

To target a specific project role, select this checkbox and then select the project role that should be used. To select multiple roles, hold down Shift and then click each role. Only the project roles for the selected project are displayed. 

This option is displayed only after selecting a project in the Filter for specific project(s) option.

Filter for specific group(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. 

Filter for specific user(s)

To target a specific user, check this box and select the user receiving the announcement. You can choose any user on your instance, with no limit on the number of users you can add.

If a user is deleted or deactivated, they will be automatically removed from this filter. If all users are removed, the Filter for specific user(s) box will be unchecked in the Announcement Editor.

Enable date and time restrictions on announcement

Select to set a specific date and time range between which you want to display the announcement. Once this checkbox is selected, additional controls From and To are displayed where you can select the start date and end date with respective timings.

Enable custom recurrence

Use this toggle to repeat displaying an announcement at regular intervals. To do so, select one of the following options:

• 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 a week on which the announcement is displayed.

Usage Analytics Settings

Help Us Improve the Product

When enabled, it allows us to collect some usage data that will help us improve the product. To learn more about what is being sent, refer to Analytics Information. This configuration can also be turned off if you do not wish to share the information.

Enabled

Dialog Height

This allows you to change the default dialog height of Dialog announcements.

500

Allow project administrators to create announcements

Allows Space Administrators and Project Administrators to create their own announcements.

Disabled

Bypass Full Page Announcements

Enter the following in the respective text fields:

• A regular expression which, when applied, will 'skip' the verification of interstitial announcements. To maintain normal behavior, leave this field blank.
  When this field is blank, the regular expression used is ^Jakarta Commons-HttpClient.+ (this allows the Application Links to pass through).

   

• One or more URIs where a full page announcement is not displayed. Use the '|' symbol to separate multiple URIs.

Blank

Add/Remove tags and attributes for styling the announcements

Allows you to configure global HTML tags and attributes. 

Usage details:
If you would like to whitelist the following html h1 tag and its attributes ('style' in this case)

Add the following to HTML Settings

1. add h1 to tags (comma separated if there are other tags already added)

2. define "h1.attributes" key and value would be "style"
   example:

Refer to the image

Enable Remind Me Later

Enable this option to remind the user of the announcement after a pre-set period of time. Disabling this option displays the announcement until the user selects Dismiss.

Disabled.

Remind Me Later Text

Allows you to add the reminder link text that informs the purpose to the user.

blank

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

Base URL

Enter the Statuspage URL here. This URL is used to connect to your Statuspage instance.

Statuspage.io API Token

Enter the Statuspage API token. To get this token:

1. Login to 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

Specify the time in minutes. This value specifies how frequently the application must communicate with Statuspage to get the latest updates.

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.

Enable

Select to receive incident updates from the specified Statuspage instance.

Name

Enter a relevant name for the Statuspage announcement. Your Jira Administrator can refer to the integration with this name.

Description

Enter a descriptive text for the announcement that is not visible to users.

Announcement Type

Select one of the following:

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

Notification Icon

Choose this if you'd like an icon displayed next to the announcement title. Available icons are:

• Error

• Information

• Success

• Warning

For Banner and Flag notification types, the border colors and icons change based on the icon selected from this list of options.

Filter for specific project(s)

(Jira and Bitbucket 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.

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.

Statuspage.io page

Select a page from the drop-down list. This list is populated with the pages available on your Statuspage instance.

Status(s)

By default, all statuses available in Statuspage are displayed here. Click X to remove unwanted statuses from the box.

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.

/rest/*

REST URLs are not blocked

/plugins/servlet/upm

The Universal Plugin Manager (UPM) is not blocked