Introduction

Modules have the capability to register navigation entries (views),which will be displayed in the left-side navigation. Clicking on these entries will display the corresponding view of the module in the content area.

The navigation menu supports only two levels of navigation. If further breakdown of the navigation is required, modules must provide a third-level in a tab bar (tab control) that spans the entire content area. Presently, the tab bar must be managed by the module’s UI.

Module views have the capability to trigger notification toasts at the bottom of the page. These notifications will automatically disappear after a few seconds but can be accessed again in the message center, which is represented by a bell icon in the header.

These notifications offer feedback on the results of fundamental system operations, such as saving confirmations. They are designed to be minimally disruptive and do not necessitate user action. These notifications are specific to the logged-in user and are stored in the browser cache for a duration of three days.

Banners are displayed at the top of the page and remain visible until the user dismisses them. Unlike dialogs, banners do not impede the user from utilizing the system. However, they are mildly disruptive and should only be utilized for matters that necessitate user action or when the entire module is impacted.

Web Portal includes a central user profile management page. User settings from this page are accessible via the UI APIto the module views, enabling them to apply the corresponding configuration to the affected UI elements.

Modules can register widgets which will be shown in the widget catalog on the Web Portal dashboard.

Context links facilitate linking between views of different modules based on a shared context. For instance, a view displaying device data may present the user with a context menu, enabling them to navigate to other views (of different modules) containing additional information about that device.

Modules have the capability to offer portions of their user interface as embedded views (e.g., a view with ticket details), which can be embedded by another module’s view. This functionality enables modules to enrich their views with valuable information to address cross-module use cases, eliminating the need for users to switch between modules to access related information.

Similar to embedded views, modules can provide dialog views that are opened by Web Portal in a dialog at runtime. This feature is beneficial for scenarios where a task needs to be performed in another module. After closing the dialog, the user will remain in the previous context without the need to switch back and forth between different views.

Users have the ability to utilize the search functionality to locate views. Presently, this functionality is restricted to the views in the navigation menu. Modules can enhance search accuracy by providing search tags (keywords) in the views API.

Modules can provide third-party open source software disclosure documents which will be displayed by Web Portal on the Open-Source Documents page linked in the header.

Modules can register their public API documentation (as OpenAPI 3.0 specification) which will be rendered and provided to users by Web Portal. It’s important to note that the public API documentation is accessible without any authentication.