{"id":11897,"date":"2022-08-16T09:42:41","date_gmt":"2022-08-16T14:42:41","guid":{"rendered":"https:\/\/www.mrc-productivity.com\/docs\/?post_type=ht_kb&p=11897"},"modified":"2023-11-28T12:29:20","modified_gmt":"2023-11-28T18:29:20","slug":"notification-badges","status":"publish","type":"ht_kb","link":"https:\/\/www.mrc-productivity.com\/docs\/knowledge-base\/notification-badges","title":{"rendered":"Notification Badges"},"content":{"rendered":"\n

Overview<\/h2>\n\n\n\n

A common UI component found in all types of software is some type of notifications badge that displays to user a number, indicative of the number of items that require their attention. A few examples include mobile applications, banking system, or customer portals, where one is frequently alerted to any outstanding messages or actions that are awaiting attention or action. <\/p>\n\n\n\n

This documentation will cover creating a similar type of functionality in m-Power. <\/p>\n\n\n\n

Implementation<\/h2>\n\n\n\n

The image below (Figure 1) contains a Multiple Row Data List retrieval that displays an end-user’s orders. The end goal will be to display a notification badge above the table output to notify the user how many un-read notifications they have. The notifications will pull from a different database table, which is also built over a retrieval template (Figure 2). <\/p>\n\n\n\n

\n
\"\"\/<\/a>
Orders Retrieval<\/mark><\/strong><\/figcaption><\/figure>\n\n\n\n
\"\"\/<\/a>
Notifications Retrieval<\/strong><\/mark><\/figcaption><\/figure>\n<\/figure>\n\n\n\n

In the Orders Retrieval, the m-Painter editor will be utilized to insert the notification badge. Place the cursor at the desired badge location and type the desired text.<\/p>\n\n\n\n

\"\"\/<\/a><\/figure>\n\n\n\n

Highlight the text and from the right-side Element Panel, select “Insert Smartlink”. Choose the “Notification Badge” link type. <\/p>\n\n\n\n

\"\"\/<\/a><\/figure>\n\n\n\n
\"\"\/<\/a><\/figure>\n\n\n\n

Next, select the application that contains the records you wish to serve as the notification count. Once the application has been selected, you have the option of mapping fields from the parent app to the notification app or any other additional parameters to filter the results. <\/p>\n\n\n\n

In my example, I only want to report the number of unread notifications. Therefore, I will pass the parameter val_READ_YN=N to the url.<\/p>\n\n\n\n

\"\"\/<\/a><\/figure>\n\n\n\n

Click “Next” to choose the Link Style and Target.<\/p>\n\n\n\n

\"\"\/<\/a><\/figure>\n\n\n\n

If looking to display the default notification badge, leave the Link Style set to the default ‘Link’ option. If a button style notification is desired instead, select ‘Button’.<\/p>\n\n\n\n

By default, the number of notifications will always display as the first piece of text in the badge.<\/p>\n\n\n\n

\"\"\/<\/a>
m-Painter on the left, runtime on the right<\/figcaption><\/figure>\n\n\n\n

If you would like to change the location of the notification count, place your cursor in the badge at the desired location and type {{number}}<\/code> in the badge directly. This logic will replace {{number}}<\/code> with the number of returned notifications at runtime instead of the default behavior, which is to append the number to the beginning. Additionally, you may add icons if desired.<\/p>\n\n\n\n

\"\"\/<\/a>
m-Painter on the left, runtime on the right<\/figcaption><\/figure>\n\n\n\n

At runtime, an AJAX call is automatically made to the configured link URL to return only a row count. This is what provides the number of notifications. Clicking on the badge\/button will link out to the notifications retrieval. <\/p>\n\n\n\n

The link on the notification badge\/button can be made into a hover popup, popup dialog, or any other supported link type within the “Target” tab of the Insert\/Edit Link window. <\/p>\n\n\n\n

Global Notifications<\/h2>\n\n\n\n

The above section will implement the notification badge into any one application of choice. However, for notifications that are global and not application-specific, it may be helpful to display this notification badge in the dictionary header, that way the notification is visible on every application page the user goes to within the data dictionary. <\/p>\n\n\n\n

To do this, copy the entire HTML code associated to the notification badge from the application it was inserted in. This code will be encompassed between two anchor (<a><\/code><\/a><\/code>) tags, as shown in the following example block:<\/p>\n\n\n\n

<a class=\"mrc-notifications badge badge-warning\" href=\"UPD2022Q2.I00401s?slnk=1&amp;READ_YN=N\"><i class=\"fa fa-bell-o\"><\/i>{{number}}<\/a><\/code><\/pre>\n\n\n\n
Open the dictionary Header\/Footer HTML section from the Admin menu of the m-Power interface. To neatly display the notification badge in the header, wrap the code above within a <li class=\"nav-item\"><\/li><\/code> tag, as shown here: <\/p>\n\n\n\n
\"\"
Fig 7. The dictionary header file, mrc_servlet_head.html<\/figcaption><\/figure>\n\n\n\n
Code from Figure 7:<\/p>\n\n\n\n
<li class=\"nav-item\">\n  <a class=\"mrc-notifications badge badge-warning\"\n href=\"UPD2022Q2.I00401s?slnk=1&amp;READ_YN=N\"><i class=\"fa fa-bell-o\"><\/i>{{number}}\n  <\/a>\n<\/li><\/code><\/pre>\n\n\n\n
At runtime, the notification badge will display next to the “Home” link.<\/p>\n\n\n\n
\"\"
Fig 8. The dictionary main menu at runtime<\/figcaption><\/figure>\n\n\n\n
Additional Notes<\/h2>\n\n\n\n
When inserting the notification badge, the default color of yellow is controlled by a CSS class badge-warning<\/code>.  To change the color of the notification badge, this class can be changed to a different value. See here <\/a>for more information.<\/p>\n","protected":false},"excerpt":{"rendered":"
Overview A common UI component found in all types of software is some type of notifications badge that displays to user a number, indicative of the number of items that require their attention. A few examples include mobile applications, banking system, or customer portals, where one is frequently alerted to…<\/p>\n","protected":false},"author":2,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[],"ht-kb-tag":[],"class_list":["post-11897","ht_kb","type-ht_kb","status-publish","format-standard","hentry"],"_links":{"self":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/11897","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/comments?post=11897"}],"version-history":[{"count":30,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/11897\/revisions"}],"predecessor-version":[{"id":13530,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb\/11897\/revisions\/13530"}],"wp:attachment":[{"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/media?parent=11897"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-category?post=11897"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.mrc-productivity.com\/docs\/wp-json\/wp\/v2\/ht-kb-tag?post=11897"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}