1. User's Guide
  2. Getting Started
  3. Dashboard Tab Operations

Dashboard Tab Operations

The Oracle Enterprise Communications Broker (ECB) provides a web-based Dashboard that can display SIP data statistics in Widgets to help you monitor and manage the system. The ECB 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 ECB can display any data on a Dashboard Widget.

The Dashboard can display up to eighteen Widgets. Each Widget can display up to 100 data samples in intervals of 1 hour, 1 minute, or 1 second. You can select a chart, graph, table, web form, or text for the display, depending on the Widget. You can customize the Dashboard by adding, deleting, and moving the Widgets. You can refresh the statistics displayed on the Dashboard and you can reset the Dashboard to its default display. The default display includes:
  • Highest CPU Usage
  • Current Memory Usage
  • Historical Memory Usage
  • Alarms

The Dashboard page provides the following controls:

Figure 4-22 Dashboard


This screen capture shows The Dashboard page and its controls.

  1. Refresh—Updates the data in all of the Widgets on the Dashboard.
  2. Reset—Resets the Dashboard to display the default Widgets and removes all other Widgets from the Dashboard.
  3. Widgets drop down —
    • Add a Widget - Displays a list of Widgets that you can add to the Dashboard.
    • Upload Widgets - Upon upload, the system backs up your existing widgets file to /code/dashboard and updates your Dashboard with the new file.
    • Download All Widgets - Downloads Widgets to settings-admin.xml.

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 either the navigation pane on the Monitor and Trace tab or 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 display 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.

Each Widget contains the controls that you need to manage the particular Widget, according to the purpose of the Widget. The controls display when you hover over the three elipses in the upper right corner of the Widget. The following screen capture shows an example of the tool bar that displays in a Widget.

Figure 4-23 Manage Widget

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

To learn what each control does, hover over the control.

This screen capture shows the Widgets toolbar. Each icon is numbered to correspond to the list that follows the screen capture.

The following list describes the Widget controls.
  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.
  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."

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 degrade service.

Add a Widget to the Dashboard

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. On the Dashboard page, scroll down and click Add Widget. icon.
    The ECB displays the Add Widget dialog in card layout. Note the following aspects of the Add Widget dialog:
    • Tabs across the top of the dialog allow you to filter to specific widget categories, including All Widgets, System, Media, Signaling, and In Use.
    • The In Use tab lists widgets already added to the dashboard.
    • The Search (Magnifying Glass) icon provide a dialog for you to type in widget names, which the system finds for you.
    • There are two widget layouts :
      • Card layout—Shows widgets that match the selected filter as text boxes.

        Figure 4-24 Card layout for Widgets


        This image shows the add widget card layout.

      • Table layout—Shows widgets that match the selected filter in lists.
    • Both layouts add a green marker to tell you that the widget is already on the Dashboard.
  2. On the Add Widget page, use your preferred dialog layout and filters to locate the widget you want to add.
    The Web GUI displays the Widget name in the center pane.
  3. In the center pane, under Command (See the far, right column header.), click Add.
    The system displays a success message.

    Note:

    If the system displays a warning that adding this Widget requires enabling the SIP.Message module, the system enables the module when you add the Widget.
  4. Click OK.
  5. Click Close.
    The system displays the newly added Widget on the Dashboard right away.
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.