Console Banner
Console banners are notifications that appear at the top of the Console UI. They enable your users to be informed about important updates like scheduled maintenance or system outages. These banners are visible across relevant pages and are intended to ensure that users stay informed about critical events based on the selected date, time, tenant or solution.
Banners are created and managed by OS1 platform or product admins and can be enabled to be shown at different levels: for all tenants in a stack, specific tenant, or a specific solution level.
A typical banner includes:
- Title: A brief summary of the notification.
- Message: Detailed information about the notification.
- Active Period: The time frame during which the banner is relevant.
Banner Example: Title: Scheduled Maintenance Message: System maintenance from 2:00 PM to 6:00 PM EDT. The application will be unavailable during this period. Active: September 25, 2023, 2:00 PM to 6:00 PM EDT
Note: Only platform or product admins with the appropriate access can create and manage banners. To obtain admin access, reach out to us by visiting the OS1 portal and click the Contact Us button to request access.
- Scheduled Maintenance Notifications: Inform users about upcoming maintenance activities and expected downtimes.
- Service Outages: Notify users immediately about service disruptions or critical updates.
- Promotional Banners: Highlight important announcements, features, or updates relevant to users.
- Real-Time Communication: Display time-sensitive notifications to users.
- Priority Levels: Banners are categorized by priority (stack, tenant, and solution level), ensuring the most critical alerts are visible first.
- Customizable: Banners can be tailored for specific solutions and tenants.
- Time-Sensitive: Banners are displayed based on pre-configured date ranges.
As a product or platform admin, you can leverage the Banner API to create and manage banners using the Banner API. To get step-by-step instructions on how to do this, refer to our Banner Developer Guide.
A banner is displayed in the Console as per the date range, solution, and tenant configured by the product admin. The banner is visible to all user types (all roles) within the selected solution and will appear on all application pages of the selected tenant as a sticky banner at the top of your Console UI.
Your end users will be able to see banners created by administrators. Here’s what you need to know:
Banners are categorized into three types, each with a different level of importance:
- Stack-level Banners: It is typically used for critical system-wide notifications. This level is used for actions involving core or foundational services that impact all tenants within the system. For example, if a critical service needs to be updated, a stack-level banner notifies all users about the maintenance and its implications.
- Tenant-level Banners: This level is used for specific tenant actions that affect only a subset of users, such as issues impacting a single tenant's customer base. For example, if a tenant's payment is overdue, a targeted notification will alert only the relevant tenant users.
- Solution-level Banners: This level is used to inform users about changes or updates that are specific to a particular solution they are using. For example, the solutions team needs to perform maintenance on a specific solution., like DispatchOne or TMS solution, and users need to be informed about the scheduled downtime.
When multiple banners are active simultaneously, they are displayed according to a set priority and their active time range. The following rules apply:
- Priority by Banner Type: If multiple banners are active at the same time, they are displayed based on their type in the following order of priority:
- Stack: Highest priority
- Tenant: Medium priority
- Solution: Lowest priority
- Handling Overlapping Banners: If banners of different types overlap, (for example., a stack banner and a Tenant banner are both active at the same time), the banner with the longest active time range will be displayed first.
- Sticky Banners: Banners will remain visible at the top of the console interface as you navigate through different pages.
- Visibility Across All Pages: Banners are displayed when they are active based on the specified activeFromTime and activeUntilTime attributes. They will be visible to all user roles within the selected solution and will appear as sticky banners on all application pages of the tenant.
- Role-Based Visibility: Banner is visible to all user roles within the selected solution and tenant.
- Dismissal: When a user dismisses a banner, its ID is stored in session storage to prevent it from reappearing during the current session. The banner will not be shown again in the current tab until the user logs out, but it may appear in new tabs if it is still active.
Info: To dismiss a banner, click the 'X' or 'Close' button typically located in the top-right corner of the banner.
- Time Stamp: Dates and times displayed on banners are converted to the tenant's timezone based on the API response.The activeFromTime and activeUntilTime are compared against the server’s current time (UTC) to determine banner’s visibility. For example: If a banner is configured to be active from "2024-10-08T09:00:00Z" to "2024-10-08T011:00:00Z", it will appear.
- UTC Time: Active from 09:00 AM to 11:00 AM UTC.
- Local Time: For a user in EST (UTC-5), the banner is active from 04:00 AM to 06:00 AM EST. Additionally, the date and time within the banner message (in the content.data attribute) are converted accordingly.
- Customizable: Banners can be tailored for different solutions and tenants.
- Time-sensitive: Banner display is based on configured date ranges.
- No Caching: API responses are cached for 15 minutes to reduce network calls. The cache is refreshed when this period expires or when a page reload occurs.