1. Web GUI User's Guide
  2. Dashboard Tab Operations

4 Dashboard Tab Operations

The Oracle® Enterprise Session Border Controller (ESBC) provides a web-based Dashboard that can display application and system data in Widgets to help you monitor and manage the system. You can add and remove Widgets from the Dashboard, specify their data sampling settings, and export the data.

Topics:

Web GUI Tabs Displays and Operations

The Web GUI displays tabs that you click to display information and perform tasks, such as configuring, managing, and monitoring the system. Each tab displays a unique set of tools to control its operations. The following information describes the operations and tool sets for each tab.

This screen capture shows the Oracle header on the Web GUI. It displays the five tabs described in the following text.

Dashboard Tab

The Dashboard tab displays SIP statistics and other information about your Oracle® Enterprise Session Border Controller (ESBC) through Widgets that display graphs, charts, and tables. The ESBC provides dozens of Widgets to choose from and the Dashboard can display up to eighteen widgets at a time. You can add and remove the Widgets, as needed. The Dashboard is the default landing page.

See Dashboard Controls and Operations

Configuration Tab

The Configuration tab displays the Wizards and Commands controls along with lists of configuration objects, grouped in the same tree-like structure as found in the Acme Command Line Interface (ACLI).

See Configuration Tab Operations

Monitor and Trace Tab

The Monitor and Trace tab displays the call ladders and session details of SIP signaling calls and information about system activities by way of summary reports of filtered SIP data. You can export the ladder diagrams, session details, and summaries from the Monitor and Trace tab.

See Monitor and Trace Tab Operations

Widgets Tab

The Widgets tab displays graphical views of System, Media, and Signaling data about the Oracle® Enterprise Session Border Controller. Each Widget corresponds to an ACLI show command. On the Widgets tab, you can click links to the Widgets for viewing and you can add Widgets to the Dashboard and your Favorites list.

Widget Tab Operations

System Tab

The System tab displays system objects and controls for managing, booting, configuring, and upgrading the system.

See System Tab Operations.

Configuration Search Tool

The Configuration tab provides two levels of search operations. You can use the Search tool on the Configuration tab to search for configuration objects. Within a multi-instance configuration object, you can use Search to find a specific configuration instance on the list.

The Search tool, displayed as a magnifying glass, on the Configuration page header opens the Search text box where you enter the text to search for, such as a configuration object name, an attribute, or value. You can enter the full name of a configuration object to find a specific object or you can enter a phrase to see a list of all objects that contain that phrase. For example, you can enter enable-snmp-auth-traps to find that object or you can enter SNMP to see a list of all configuration objects with SNMP in their name.

The Search magnifying glass is located in the middle of the Configuration tab.

This screen capture shows the location of the Search button on the Configuration page header.

When you click the Search tool, the system displays the Configuration Search text box next to the Magnifying Glass, where you enter the configuration object name, attribute, or value that you want to find. When you search for a phrase, rather than a complete object name, the system displays a list of all objects that contain the phrase.

This screen capture shows the configuration search text box where you enter the name, attribute, or value that you want to search for.

Multi-instance configuration objects display a list of configurations and the table includes a text box for local search within the table. You can enter all or part of the configuration name.

This screen capture shows the search field on a multi-instance configuration object.

When you search for a particular configuration, the results display only that configuration and the system adds a clear entry icon, displayed as an 'x', to the Search field.

This screen capture shows the X button that the system adds to the search field when you search for a particular configuration.

When you click the button, the system resumes displaying all of the configurations on the list.

Dashboard Controls and Operations

The Oracle® Enterprise Session Border Controller (ESBC) can display dynamic data about the system through Widgets that you choose to place on the Dashboard. You can decide which Widgets to display by adding, deleting, and moving them at any time. The Dashboard can display up to 18 Widgets.

Note:

The (ESBC) collects only SIP data for the Dashboard Widgets, including the default CPU and Memory Widgets. For this reason, you must set up a valid SIP configuration before the ESBC can display any data on a Dashboard Widget.

The following screen capture shows an example of the Dashboard page and the controls you use to manage the Widgets:

This screen capture shows the OCSSC Dashboard, which displays Widgets and the controls you use to add, refresh, and reset them.

This screen capture shows the system identification that the Web GUI displays on the Dashboard banner.—Shows the device name, the device IP address, and the software build number. When you deploy your SBC in a High Availability (HA) pair, the system identification also states whether the device is the Active or Standby peer.

This screen capture shows the refresh icon.—Updates the data in all of the Widgets on the Dashboard.

This screen capture shows the Reset button.—Resets the Dashboard to display the default Widgets and removes all other Widgets from the Dashboard.

This screen capture shows the Add Widgets button.—Displays the list of Widgets that you can add to the Dashboard.

This screen capture shows the Add Widgets tile, which is just another way of adding a Widget.—Displays the list of Widgets that you can add to the Dashboard.

This screen capture shows an example of a message that a Widget can display to tell you that there is no data to display.—Tells you that the Widget is blank because there is no data to display.

A Widget can display a table, text, a pie graph, or a line graph depending on the type of data and the purpose of the display. For example, the SIP Realms All Widget displays an actionable table and the Recording Widget displays static text. You can access the list of Widgets from the Dashboard page by clicking Add Widget.

Most of the Widgets automatically display any available data when you click the name of the Widget, but some Widgets require further input. Such Widgets include a Settings button in their tool bar that launches a parameters dialog were you specify the data to display. For example, the Realm Specifics Widget requires you to set the name of the realm and the auto refresh interval.

Note:

The operation of Widgets, such as those that require the SIP Session module, may affect system performance. The system displays a warning when you add a Widget that may affect performance. Oracle recommends adding such Widgets at a time when the performance impact will not affect service.
The default display includes the following Widgets:
  • Highest CPU Usage
  • Current Memory Usage
  • Historical Memory Usage
  • Alarms

Widget Controls

Each Widget contains the controls that you use to manage its operations, according to the purpose of the Widget. The controls display when you hover over the three ellipses in the upper right corner of the Widget.

The following screen capture shows an example of the tool bar that displays in a Widget. In the Widget, you can hover over the control for a description.

This screen capture shows the tool bar that displays when you hover over the three ellipses in the upper right corner of the Widget.

The following information describes the Widget controls.

This screen capture shows the Widgets toolbar. Each icon is numbered to correspond to the list that follows the screen capture.
  1. Refresh—Updates the data in the Widget.
  2. Settings—Displays the dialog where you set the data sampling parameters for the Widget. When you click the icon, the Widget displays the Settings dialog, where you can set the auto-refresh interval and other parameters that apply to the particular Widget. Widgets can display up to 100 data samples in intervals of 1 hour, 1 minute, or 1 second.
  3. Export—Downloads the data displayed in the Widget.
  4. Remove—Removes the Widget from the Dashboard. When you remove all Widgets from the Dashboard, the GUI displays the following message: " Your Dashboard is empty, please add a Widget or reset to restore the original Dashboard."
  5. Maximize—Displays the Widget in full-screen size.
  6. Show Information—Describes the data display. For example, in the Current Memory Usage Widget, the information icon says, "Pie graph displays current percentage of free and allocated memory."

About the Add Widgets Page

After you click either the +Widget button or the Add Widget card on the Dashboard, the Web GUI displays the Add Widget page. On the Add Widget page, you can search for Widgets to add to the Dashboard and you can see which Widgets exist on the Dashboard. You can also see descriptions of the Widgets and change the display from card view to list view.

The following screen capture shows the default view of the Add Widgets page, called card view.

This screen capture shows the add widget page in card view. It shows the page controls at the right end of the banner and it shows the search filters in the left corner just above the top row of cards. Each card contains the Add button.

In the top row of the preceding screen capture, the Alarms card and the Licenses card each display a green circle around a check mark. The check mark means that those Widgets currently display on the Dashboard.

The following screen capture shows the list view of the Add Widgets page.

This shows the list view of the Add Widgets page. t shows the page controls at the right end of the banner and it shows the search filters in the left corner just above the top row of the list. Each row contains the Add button at the end of the row.

In the preceding screen capture, the Alarms row and the Licenses row each display a green circle around a check mark in the column between the Widget and Description. The check mark means that those Widgets currently display on the Dashboard.

Action Controls on the Banner

Regardless of which view you choose, the banner displays the following controls.
  • This screen capture shows the Add Widgets search icon.Search—Click to display the Search field, where you enter the name of a Widget.
  • This screen capture shows the Add Widgets card view icon.Card view—Click to display the card view.
  • This screen capture shows the Add Widgets list view icon.List view—Click to display the list view.
  • This screen capture shows the Add Widgets Close icon.Close—Click to close the Add Widgets page.

Search Filters

Regardless of which view you choose, the Add widgets page displays the following search filters.
  • This screen capture shows the All Widgets button.All widgets—Click to see a list of all Widgets in alphabetical order.
  • This screen capture shows the System Widgets button.System—Click to see only a list of System-related Widgets.
  • This screen capture shows the Media Widgets button.Media—Click to see only a list of Media-related Widgets.
  • This screen capture shows the Signaling Widgets button.Signaling—Click to see only a list of Signaling-related Widgets.
  • This screen capture shows the In Use button.In Use—Click to see a list of Widgets currently displayed on the Dashboard.

Note:

All of the lists display a scroll bar when the list exceeds the page space.

Add a Dashboard Widget

You can add up to eighteen Widgets to the Web GUI Dashboard to display SIP and System statistics to help you monitor and manage the system.

The system does not require a re-boot after performing the following procedure. The system adds the Widget to the Dashboard right away.
  1. Access the Dashboard page and click either the + Widgets button or the +Add Widgets tile.
    The ESBC displays the Add Widget dialog in card view.
  2. On the Add Widget page, use the filters or scroll to the widget you want to add.
  3. Do one of the following:
    • In card view, click Add on the card.
    • In list view, click Add in the Command column.
The system displays the newly added Widget on the Dashboard right away.
Next Steps:
  • See "Configure Data Sampling Settings for a Dashboard Widget."

Configure the Data Sampling Settings for a Dashboard Widget

To display SIP and System statistics on a Dashboard Widget, the system requires a setting for how often to refresh the display. You can use the default interval or select one from the Auto-refresh interval drop-down list on the Widget.

Some Widgets also display the Table Name drop-down list, where you can set the data sampling frequency. For example, you might configure the Widget to refresh the display every 40 seconds and to display the data samples in one minute increments.
  1. Click the Dashboard tab.
  2. On the Widget, hover over the ellipses to display the toolbar, and click the Settings icon.
  3. Select a Widget display refresh frequency from the Auto-Refresh Interval (seconds) drop down list.
  4. If the Widget displays the Table Name drop-down list, select a data sampling increment for the Widget display. Valid values: Seconds | Minutes | Hours.
  5. Click OK.
  6. Click Close.

View A Widget That is Not on the Dashboard

The Dashboard is limited to displaying a maximum of eighteen widgets. If your Dashboard is fully populated with Widgets and you want to see a Widget that is not on the Dashboard, use the Widgets link on the Monitor and Trace page.

  1. Access Widgets: Widgets tab.
  2. In the navigation pane, click the name of the Widget that you want to see.
    The system displays the Widget.
  3. Optional—Add the widget to the Dashboard, if the Dashboard is not fully populated.