Two different types of updates appear on the Administrative Portal Dashboard. The first is a BriteCore Status update controlled by IWS; the second is a customizable section that you can build. For the latter, see the Update the Administrative Portal Dashboard how-to.

Core Concepts

BriteCore Status

Overview

The BriteCore Status area on the Administrative Portal Dashboard displays important system notifications. A notification requiring attention will be red (critical) or orange (warning) with directions or important information. Once a notification requiring attention expires, the BriteCore Status area will return to green (all clear).

Usage

Only users with the role of Administrator will see the BriteCore Status area. These users will also see a Status Update badge next to the word BriteCore in the upper left of the screen, which indicates a new notification. To acknowledge the notification and remove the Status Update badge, click the Status Update badge.

How-Tos

Update the Administrative Portal Dashboard

Getting Started

1. Either open two browsers (e.g., Firefox and Chrome) or open an incognito window in the same browser
2. In one window (W1), navigate to Settings > System Wide > Login Information > Dashboard Text
3. In the other window (W2), login again
4. As you make changes to the dashboard text in W1, click Save
5. In W2, refresh the screen
6. This procedure allows you to immediately see the effects of your changes to this setting

Headers

Headers can be of any size and text:
<h4>New Procedures</h4>
<h3>TRAINING VIDEOS</h3>
<h3>Important updates</h3>

Section Divider

Use <hr/> to add a horizontal line between sections.

Text

• Use <ul></ul> (unordered list) or <ol></ol> (ordered list) with <li></li> (line item) to create a list

  <ul>
      <li>
           <b>Important messages:</b>The office will close at 3:00 PM today.
      </li>
      <li>
          Please shutdown your computer at the end of each day.
      </li>
    </ul>

• Use<p></p> (paragraph) and <b></b> (bold) tags to communicate your message

  <b>Update</b>
      <p>
        Our live date will be on January 1st!
      </p>

• Use style="color:red" to add color to text
  <h3 style="color:red">Quoting is suspended due to hurricane.</h3>

Links

• To open in the same window
  <a href="this is your link">This is what the user sees</a>
• To open in a new window
  <a href="this is your link" target="_blank">This is what the user sees</a>

FAQs

How do I update the Agent Portal Dashboard?
See the agent portal dashboard documentation.

How do I remove the Status Update badge that appears next to the word BriteCore in the upper left of the screen?
First, read the notification on the Dashboard. Then, click the Status Update badge.

More Information

BriteCore Status Section

• This section notifies users of general system issues
• Notifications are created by IWS staff
• Notifications are set in the notifications table and have a message, priority level, start time, and expiration time

• Either run the below script on a client site or use the Create Notification tool in Rundeck

  bin/create_notification.py --message "Another message" --level "critical" --start "2016-09-22 10:00" --expires "2016-09-23 18:00"

BriteCore Notifications Section

• This section notifies users of new features
• Notifications are created by IWS staff
• Notifications are set in the notifications table and have a message, priority level, start time, and expiration time
• Either run the below script on a client site or use the Create Notification tool in Rundeck

Script 1 - Default Message

This script creates the default message A new feature has been released. Please see our releases page for more information. that links to the Releases page of the BriteCore support site:

• Complete the fields on Rundeck using the following info:
  • Message: blank
  • Level: info
  • Start: roughly the current time (using military time)
  • End: 2-3 days from the start, allowing enough time for users to receive the notification

bin/create_notification.py --message "" --level "info" --start "2017-02-20 00:00" --expires "2017-02-23 18:00"

Script 2 - Custom Message

This scripts allows for a custom message using the --message argument:

• Complete the fields on RunDeck using the following info:
  • Message: insert your custom message here
  • Level: info
  • Start: roughly the current time (using military time)
  • End: 2-3 days from the start, allowing enough time for users to receive the notification

bin/create_notification.py --message "custom message" --level "info" --start "2017-02-20 00:00" --expires "2017-02-20 00:00" The --level argument of the script determines to which section the message is added: the BriteCore Status or BriteCore Notifications section.

Feedback

Report unclear or missing documentation.