Types of Dashlets

The Dashboard displays two types of dashlets:

■Pie-chart dashlets display a ratio of device properties as a pie chart.

■Line-graph dashlets display graphs that show device counts over time.

Tip: Graphs set to intervals longer than one day may not display the data at the last datapoint exactly as shown in the matching field on the Device Info page. This is because data aggregation is occurring less frequently than polling to update the fields on the Device Info page. Set these graphs to the 6h or 1d intervals to update the data more frequently. Use intervals longer than one day to view data trends.

Dashboard Dashlets

The IoT FND Dashboard dashlets are described below.

Dashlet	Description
Router Inventory	This FAR status counts pie chart displays the status distribution and absolute count of FARs.
Router States Over Time	This line graph shows a count of the FARs and their states for the configured time interval.
Mesh Endpoint Inventory	This ME status counts pie chart displays the proportion (and count) of MEs. For example, the count of devices with an Unheard status relative to the other states: Up, Down, and Outage.
Mesh Endpoint States Over Time	This line graph shows a count of MEs and their states for the configured time interval.
Mesh Endpoint Config Group Template Mismatch Over Time	This line graph shows the number of MEs across all configuration groups and particular configuration groups that are out of sync for the configured time interval.
Mesh Endpoint Firmware Group Membership Mismatch Over Time	This line graph shows the number of MEs across all firmware groups and particular firmware groups that are out of sync for the configured time interval.
Config Group Template Mismatch	This pie chart shows the number of devices with matched and mismatched configuration group templates (applicable only to ME configuration groups).
Firmware Group Membership Mismatch	This pie chart shows the number of devices with mismatched firmware groups (applicable only to ME firmware groups).
Hop Count Distribution	This pie chart shows the hop count distribution for mesh devices.
Service Providers Data	This dashlet shows the service provider names, their associated cell IDs (if available), their associated total router count, and the count of down routers. This dashlet also displays the bandwidth usage and a sparkline showing the down routers over time. Tip: Click the triangle in any column heading, select Columns in the context menu, and check the Down Routers Over Time check box to hide this column.
Routers With Top Cellular Bandwidth Usage	This bandwidth chart displays the top n routers using the maximum cellular bandwidth, where n is the number of top routers to display. Click the Filter button and select the number of routers to display from the Show drop-down list.
	■Click the Last Billing Period button to display the bandwidth usage information for the top n routers that used the maximum bandwidth during last billing period. ■Click the Current Billing Period button to display the bandwidth usage information for the current billing period. The start days are defined on the Billing Period Settings tab (Admin > System Management > Server Settings).
Routers With Top Ethernet Bandwidth Usage	This dashlet is similar to the Routers With Top Cellular Bandwidth Usage dashlet, except that it displays the top n routers with the maximum Ethernet bandwidth usage.
Routers With Least Cellular RSSI	This dashlet displays a chart of routers with the lowest RSSI values at the last poll, which indicates the quality of the signal strength. Use this chart to gauge the cellular channel conditions for FARs.

Repositioning Dashlets

The Dashboard is configurable to display charts in your preferred arrangement. To configure the Dashboard:

■Click and drag the title bar of a chart to the desired position.

■Click the close box to remove the chart from the page.

■Click the interval button to do the following:

–Define an interval for line-graph chart displays.

–Define a custom interval for line-graph chart displays.

–Select the number of devices to chart for line-graph chart displays.

–Select a series to refine data in line-graph chart displays.

–Filter line-graph chart displays by group.

■Click the Settings button in the title bar to set the refresh interval for all charts and add dashlets back to the Dashboard.

To better view dashlets in the bottom of the Dashboard, collapse a dashlet to just its title bar by clicking the dashlet show/hide button ( ). In Dashboard with Collapsed Dashlets the Config Group Template Mismatch dashlet is expanded in the Dashboard with several other dashlets collapsed above it. To refresh the Dashboard, click the Refresh button ( ). To refresh a dashlet, click its Refresh button.

Figure 2 Dashboard with Collapsed Dashlets

Setting the Dashlet Refresh Interval

To set the refresh interval for dashlets:

1. Choose Devices > Dashboard.

2. Click the Settings button ( ).

3. Click Set Refresh Interval.

Note: On line-graph dashlets, open the filter bar and click an interval button to display metrics for that time period.

4. From the drop-down menu, choose a refresh interval.

5. Close the Dashboard Settings dialog box when finished.

Adding Dashlets

To add dashlets to the Dashboard:

1. Choose Devices > Dashboard.

2. Click the Settings button ( ).

3. Click Add Dashlets.

Note: No dashlets display in this dialog box if all are displaying on the Dashboard.

4. Click the dashlet to add to the Dashboard.

5. Close the Dashboard Settings dialog box when finished.

Removing Dashlets

To delete dashlets from the Dashboard:

1. Choose Devices > Dashboard.

2. Click the dashlet Close button.

Using Pie Charts to Get More Information

Mouse over any segment of a pie chart to display a callout with information on that segment. Click any segment in the Router Inventory and Mesh Endpoint Inventory pie charts to display the devices in List View.

Setting Dashlet Time Properties

To specify the time interval for data collection for line-graph dashlets, click the interval icon ( ) in the title bar to display the 6h, 1d, 1w, 4w, or Custom buttons. The 6h button sets the data-collection time interval to the last six hours. The 1d button sets the time interval to the last 24 hours.

To specify a custom time interval for a line-graph dashlet:

1. Click Custom.

2. In the From fields, specify the beginning date and time.

3. In the To fields, specify the end date and time.

4. Click OK.

Collapsing Dashlets

Click the show/hide icon ( ) at the top-right of the dashlet to collapse it to its title bar.

Using the Series Selector

You use the Series Selector to refine line-graphs to display by device status. The device options are:

■Routers: Down, Outage, Unsupported, Unheard, and Up

■Mesh Endpoint Config Group: Config Out of Sync and Config In Sync

■Mesh Endpoint Firmware Group: Membership Out of Sync and Membership In Sync

■Mesh Endpoint States: Down, Outage, Unheard, and Up

To use the Series Selector:

1. Click Series Selector.

2. In the Series Selector dialog box, check the check boxes for the data series to show in the graph.

3. Click Close.

Using Filters

You use filters to refine the displayed line-graph data by groups. Applied filters display after the dashlet title.

To use the filters:

1. Click Add Filter in the line-graph dashlet pane.

2. From the first drop-down menu, choose a group type.

3. From the third drop-down menu, choose a group.

4. Click Apply.

The pencil icon is green and the filter displays next to the dashlet name to indicate that a filter is applied.

Note: Click the Remove Filter button to remove the filter and close the filter options.

Exporting Dashlet Data

You can export dashlet data to a CSV file.

To export dashlet data:

1. On the desired dashlet, click the export button ().

A browser download session begins.

2. Navigate to your default download directory to view the export file.

The filename begins with the word “export-” and includes the dashlet name (for example, export-Node_State_Over_Time_chart-1392746225010.csv).

Viewing Events

As shown in Events Page, the Events page (Operations > Events) lists all events for those devices that IoT FND tracks. All events are stored in the CG-NMS database server.

Figure 3 Events Page

By default, the Events page displays the Events chart, which is a visual view of events in a time line. However, depending on the number of devices the CG-NMS server manages, this page can sometimes time out, especially when the system is fully loaded. In that case, open the Preferences window by choosing username > Preferences (top right), clearing the check boxes for showing chart and summary counts on the Events page, and clicking Apply.

To limit the amount of event data displayed on this page, use the Filter drop-down menu (at the top of the left pane). For example, you can show the events for the last 24 hours relative to the last 30 days, or events for a specific day within the last seven days.

To enable automatic refresh of event data to refresh every 14 seconds, check the check box next to the Refresh button. To immediately refresh event data click the Refresh button or the refresh icon.

Note: The amount of event data displayed on the Events page is limited by the data retention setting for events (Admin > System Management > Data Retention).

All Events Pane Filters

Use the preset filters in the All Events pane to only view those event types.

Device Events

In the left pane, IoT FND tracks events for the following devices:

■Routers

■Endpoints

■Head-end Devices

■CG Mesh Devices

■NMS Servers

■Database Servers

Event Severity Level

In the left pane, select an event severity level to filter the list view to devices with that severity level:

■Critical

■Major

■Minor

■Info

Each event type has a preset severity level. For example, a Router Down event is a Major severity level event.

Preset Events By Device

IoT FND has a preset list of events it reports for each device it tracks. A list of those events is summarized under each device in the left pane on the Events page. For example, in the left pane click the show/hide icon ( ) next to Routers to expand the list of all events for routers.

Filtering by Severity Level

To filter by severity level:

1. Choose Operations > Events.

2. Click the SEVERITY show/hide arrow.

Note: Only severity levels that have occurred display.

3. Click a severity level (CRITICAL, MAJOR, MINOR, OR INFO).

All events of that severity level display in the Events pane.

Advanced Event Search

To use the filter to search for events:

1. Choose Operations > Events.

2. Under All Events (left pane), select an event category to narrow down your search.

3. Click the Show Filter link at the top of the main pane.

4. Use the filter drop-down menus and fields to specify your search criteria.

5. Click the plus button () to add the search strings to the Search field.

Repeat the process of adding search strings to the Search field as needed.

6. Click Search Events or press Enter.

The search results display in the Events pane.

You can also add search strings manually, as shown in the following examples:

■To filter events by Name (EID), enter the following string in the Search Events field, as shown in Search Events by Name Filter:

name: router eid string.

Search Events by Name Filter

Note: Note the use of the asterisk (*) wild card with this filter.

■To filter by event time period, enter the following string in the Search Events field, as shown in Search Events by Time Filter Example:

eventTime operator“YYYY-MM-DD HH:MM:SS:SSS”

Supported operators are: <, >, >=, <=, :

Note: Do not enter a space between eventTime and the operator. Figure 4 Search Events by Time Filter Example

Sorting Events

To sort events in ascending or descending order, mouse over any column and select the appropriate option from the heading drop-down menu.

Searching By Event Name

To search by event name (for example, Battery Low):

1. Choose Operations > Events.

2. Click the device type to search for in the left pane.

3. Click the Show Filter link at the top of the right pane.

The filter fields display under the Search Events field.

4. Choose Event Name from the left drop-down menu.

5. Choose the event name from the options in the right drop-down menu.

6. Click the plus button () at the right to add the filter to the Search Events field.

The filter syntax appears in the Search Events field.

7. Click the Search Events button.

The search results display in the Events pane.

Exporting Events

You can export events to a CSV file to examine as a log of event severity, time, name and event description by device.

To export events:

1. Choose Operations > Events.

2. Click the desired severity level or device type in the left pane.

3. Click the Export button ( ).

A browser download session begins.

4. Navigate to your default download directory to access the CSV file.

Viewing Issues

IoT FND offers different ways to monitor issues:

■The Operations > Issues page (Issues Page) provides a snapshot of the health of the network by highlighting only major and critical events that are active within the network.

■The Issues Status bar (Issues Status Bar) displays in the footer of the browser window and shows a count of all issues by severity for selected devices.

Figure 5 Issues Page

The Issues page provides an abbreviated subset of unresolved network events for quick review and resolution by the administrator. Issues remain open until either the associated event is resolved (and IoT FND generates a resolution event) or the administrator manually closes the event.

Only one issue is recorded when multiple entries for the same event are reported. Each issue has a counter associated with it. As an associated event is closed, the counter decrements by one. Every open or closed issue has an associated event.

Note: The amount of closed issues data that displays on the Issues page is limited by the Keep Closed Issues for data retention setting (Admin > System Management > Data Retention), which is based on the time the issue was closed. When the issue was closed displays as the Last Update Time for the issue.

Viewing Device Severity Status on the Issues Status Bar

A tally of issues listed by severity for the selected devices displays in the Issues status bar in the bottom-right of the browser window frame (Issues Status Bar). You can set the device types for issues that display in the Issues status bar in User Preferences (see Setting User Preferences).

Figure 6 Issues Status Bar

Click the Issues status bar to view the Issues Summary pane (Issues Summary Pane), which displays issues listed by the selected device category. Click count links in the Issues Summary pane to view complete issue criteria filtered by severity on the Operations > Issues page.

Figure 7 Issues Summary Pane

Adding Notes to Issues

On the Operations > Issues page, you can maintain notes on issues for the device. Click the Notes link inline with the issue to access any notes entered in the issue or add a note on the Notes for Issues Name page. You can and edit and delete notes from issues on this page. Issues can have multiple notes. The Notes for Issues Name page displays the time the note was created, the name of the user who wrote the note, and the text of the note. You can also add a note when closing a issue. Notes are purged from the database with the issue.

To add a note to an issue:

1. Click the Notes link inline with the desired issue or check the check box of the device and click Add Note.

The Notes for Issues Name pane displays. The issue in the following example has existing notes.

2. Click Add Note.

The Add Note dialog displays.

3. Insert your cursor in the Note field and type your note.

4. Click Add when finished.

The note text displays on the Notes for Issues Name pane in the Note column.

To add notes to issues with existing notes:

1. Click the Notes link inline with the issue or check the check box of the device and click Add Note.

The Notes for Issues Name pane displays.

2. To add a new note to the issue, click Add Note.

The Add Note dialog displays.

3. Insert your cursor in the Note field and type your note.

4. Click Add when finished.

To edit an existing note in an issue:

1. Click the Notes link inline with the issue.

The Notes for Issues Name pane displays.

2. To edit an existing note, click the pencil icon () at the right of the note that you want to edit.

3. Edit the note, and click Done when finished.

To delete a note from an issue:

1. Click the Notes link inline with the issue.

The Notes for Issues Name pane displays.

2. To delete a note, click the red X icon () at the right of the note.

3. Click Yes to confirm the deletion.

To add a note when closing an issue:

1. Check the check box of the issue to close.

2. Click Close Issue.

3. In the Confirm dialog box, insert your cursor in the Note field and type the note text.

4. To confirm that you want to close the issue and save the note, click Yes.

Searching Issues Using Predefined Filters

To search for open issues for a specific system or severity level:

1. Choose Operations > Issues.

To list only open issues, click All Open Issues (left pane).

Note: By default, IoT FND displays all issues that occurred within the specified data retention period (see Configuring Data Retention). To see Closed Issues associated with an event type or severity level, change issueStatus:OPEN to issueStatus:CLOSED in the Search Issues field, and then click Search Issues. To list all closed issues, in the left pane, click All Closed Issues.

2. Click a device category, event type, or severity level to filter the list.

The filter syntax appears in the Search Issues field, and the search results display in the main pane.

Search Issues Using Custom Filters

To search by creating custom filters:

1. Choose Operations > Issues.

2. Click Show Filter.

3. From the Filter drop-down menus, choose the appropriate options.

For example, to filter severity levels by EID:

You can also enter the search string in the Search Issues field. For example:

issueSeverity:CRITICAL issueStatus:OPEN eid:CG-NMS-DB+localhost

4. Click Search Issues.

The issues, if any, display in the Search Issues section (right pane).

5. Click the Events link to display events associated with an issue.

The Events for Issue Name pane displays all events for that device.

6. Click Search Issues or any link in the left pane to return to the Issues pane.

Closing an Issue

In most cases, when an event is resolved, the issue is closed automatically by the software. However, when the administrator has actively worked on resolving the issue, it might make sense to close the issue directly. When the issue is closed, IoT FND generates an event.

To close a resolved issue:

1. Choose Operations > Issues.

2. Locate the issue by following the steps in either the Searching Issues Using Predefined Filters or Search Issues Using Custom Filters section.

3. In the Search Issues section (right pane), check the check boxes of the issues to close.

4. Click Close Issue.

Note: You can also add a note to the issue at this time.

5. Click Yes.

Router Charts

IoT FND provides these charts in the Device Info pane on the Device Details page for any FAR:

FAR Device Charts shows the Mesh Link Traffic and Mesh Endpoint Count charts.

Figure 8 FAR Device Charts

Mesh Endpoint Charts

IoT FND provides the charts listed in Device Detail Charts in the Device Info pane on the Device Details page (Mesh Endpoint Device Charts) for any ME.

Figure 9 Mesh Endpoint Device Charts