1. Getting Started
  2. About the Help
  3. Help organization

Help organization

There are five items on the main menu. For a more detailed explanation of each GUI Menu option, see Table 4-1.

The following sections are components of the help system:

Getting Started

The Getting Started section of the documentation provides an overview of the SDS application and documentation. In this section you can find information about the SDS including a product overview, the system architecture, and functionality. Additionally, this section familiarizes you with common SDS GUI features including user interface elements, main menu options, supported browsers, and common user interface widgets.

Communication Agent

The Communication Agent section of the documentation describes the plug-in included with SDS that includes infrastructure features and services for enabling inter-server communication. This includes:
  • Overview
  • Configuration
  • Maintenance
The Communication Agent GUI menu also lets you monitor the operational status of High-Availability (HA) Services Sub-Resources.

SDS Online Help

The SDS section of the documentation explains how to perform and manage configurations and maintain tasks using the SDS Menu options. These options include explanations for:

  • Subscribers
  • Blacklists
  • Logs
  • Imports and Exports
  • Audits
  • Queries
  • Destinations
  • Routing Entities
  • NAI Hosts

SDS Alarms, KPIs, and Measurements (AKMs)

The SDS AKM section provides information relevant to understanding alarms and events that may occur in the SDS application; recovery procedures for addressing alarms and events, as necessary; tasks for viewing alarms and events, generating alarms reports, and viewing and exporting alarms and events history; and information, including any relevant customer actions for addressing unusual measurement values.

OAM

The Operations, Administration, and Maintenance (OAM) section of the documentation describes:
  • Administration
  • Configuration
  • Alarms and Events
  • Security Log
  • Status and Manage
  • Measurements
The OAM section of the documentation explains how to use these GUI pages to view and manage the basic operation, administration, and maintenance for the SDS.