Configuration
Table of Contents
- 1 Table of Contents
- 2 Settings
- 2.1 Date and Time Format
- 2.2 Background and Text
- 2.3 Enabling Sound in Browser
- 2.4 Project Settings
- 2.5 Save
- 2.6 Cancel
- 2.7 Project
- 2.7.1 Edit
- 3 Languages
After installation, In-App Customer Portal Notifications administration is available in the "Apps" administration menu:
After clicking In-App Customer Portal Notifications, the user will be navigated to the configuration page:
Settings
The landing page (Settings tab) shows date, time, color, and sound settings and the list of the Jira Projects for which the notifications are enabled.
Date and Time Format
You can show the date and time in the notification bar in your desired format. You can use the following syntax to fill in the field across Date and time format:
Format | Sample output |
---|---|
YYYY | 2022 |
YY | 22 |
MMMM | January |
MMM | Jan |
MM | 01 |
M | 1 |
DD | 02 |
D | 2 |
dddd | Tuesday |
ddd | Tue |
HH | 03 |
H | 3 |
hh | 04 |
h | 4 |
mm | 09 |
m | 9 |
ss | 05 |
s | 5 |
a | pm |
A | PM |
Z | -07:00 |
[timezone] | UTC |
You can find the format examples in the table below:
Sample format | Output |
---|---|
DD/MM/YY HH:mm | 02/01/2022 23:09 |
ddd, DD MMM YYYY HH:mm:ss Z | Tue, 02 Jan 2022 23:09:05 -07:00 |
ddd, DD MMM YYYY h:mm:ss a | Tue, 02 Jan 2022 11:09:05 pm |
YYYY-MM-DDTHH:mm:ss.SSS | 2022-01-02T23:09:05.345 |
YYYY-MM-DDTHH:mm:ssZ | 2022-01-02T23:09:05-07:00 |
MM/DD/YY h:mm a | 01/02/2022 23:09 |
dddd, MMMM D, YYYY h:mm A | Tuesday, January 2, 2022 11:09 PM |
ddd, MMM D, YYYY h:mm A | Tue, Jan 2, 2022 11:09 PM |
MMM Do YY, h:mm:ss a | Jan 2nd 22, 11:09:05 pm |
dddd, Do MMMM YYYY, h:mm:ss a | Tuesday, 2nd January 2022, 11:09:05 pm |
After rendering the desired format in the field, click Save button.
Background and Text
By clicking Background and/or Text color, it is possible to define the colors for a notification bar:
To turn the notifications sound on/off, toggle “Play Sound” button.
After defining color and/or sound settings, Save and Cancel button will appear to Save or discard the selected configuration:
Click “Reset to Default” button to revert to the default color and sound Settings.
Default format is set to “DD.MM.yyyy HH:mm“ which corresponds to the following example output: “11.01.2023 15:56”.
Enabling Sound in Browser
In Google Chrome and Microsoft Edge browsers, additional settings should be configured to receive a sound alert when a notification arrives.
Mozzila Firefox does not need additional configuration and sound is enabled by default.
Google Chrome
Navigate to your Atlassian instance page, click on the lock button on the left side of the URL, and navigate to the site settings:
On the Permissions section, navigate to the “Sound” and select Allow from the dropdown list:
Microsoft Edge
Go to the browser settings through 3 dots button in the top right corner of the Edge browser:
Go to the “Cookies and site permissions“ from the left menu and scroll down to the “All permissions“ section:
Scroll down to the “Media autoplay” section and click on it:
On the Media autoplay configuration page, click Add under “Allow“ section, enter your Jira instance URL and click Add:
Project Settings
The projects grid shows all the JSM projects for which notifications are configured:
The following information and actions are available for the projects:
Add Project button
#: ordering number
Name: project name
Status: “Active” (green) or “Inactive” (red)
Edit: configure setting for the project (see below)
Copy: enables copying project configuration to the new project
Click the button to see the popup windows, where you can select available JSM projects, to which the existing configuration will be copied.
Delete: deleting the project from the list will delete the configuration setting for the deleted project.
To add a new Project, click “+ Add Project” button and configure the setting for the certain project:
Save
By clicking “Save” button, all the settings will be saved and the user will be navigated to the list of the projects in the Configuration (landing page).
Cancel
By clicking “Cancel” button, all the changes will be discarded and the user will be navigated to the list of the projects in the Configuration (landing page).
Project
For the dropdown select the project for which the notification should be enabled.
After selecting the project, you can select certain request types from the project, where you would like the notification bar to appear. You can select several Request Types. If the field is left empty, the notification bar will be visible for all the Request Types of the selected project.
After selecting the project, enable or disable certain actions for which the notification should be triggered. You can do this by clicking the “Is Enabled“ toggle:
The following actions can be enabled:
Request Created
Public Comment Added
Public Comment Edited
Request resolved
Request reopened
Participant added
Organization added
Approval required
Status changed
Edit
To define the user or the group, who should receive the notification, click “Edit“ and select the options in the pop-up window:
Customers involved - all the request participants will receive the notification
Reporter - Request reporter will receive the notification
Added Organizations - all the users for the organization, which is added to the request will receive the notifications
Check the “Exclude person who caused the action“ if you want the user, who triggered the action, not to receive the notification.
After selecting the options, click “Save” button to save the settings or “Cancel“ button to close the pop-up window, without saving the settings.
Languages
From the Languages tab, you can translate your customer portal notifications into multiple languages for the customers.
The following information and actions are available for the Language tab:
“Add Languages” button
#: ordering number
Name: Language name (as indicated in Jira instance)
“Available to customers” toggle: changing this toggle will enable or disable the language on the customer portal.
Edit: clicking “Edit” button will navigate the user to the translation page for the selected Language (see details below)
Delete: clicking “Delete” button will delete the selected Language
To add a new language, click “Add Languages” button, check the desired language from the popup button and click “Save“:
After clicking “Save” button, the selected language will be added to the languages grid.
Translate Language (Edit)
Click “Edit” button for the added language to translate certain terms into the selected language:
After all the terms are translated, click “Save” to go back to the Languages list.
Changing Language in Customer Portal
To show the content of the notification bar in the desired language, the customers should set the Portal preferred language.
Notifications bar will be displayed in the selected language only if the language is already added to the translations list of the plugin settings (see Languages for more details). If the selected language is not yet added to the plugin configurations, default language (English(US)) will be used.
After changing the profile language to the desired one, content of the notifications bar will be displayed in the selected language: