Está en la página 1de 92

Newpoint Compass Operator Guide

COPYRIGHTS AND DISCLAIMERS


Published Date: January 21st 2010
This publication contains information proprietary and confidential to Memotec Inc. Any reproduction,
disclosure or unauthorized use of this publication is expressly prohibited except as Memotec Inc. may
otherwise authorize in writing.
Memotec Inc. reserves the right to make changes without notice in product or component design as warranted
by evolution in user needs or progress in engineering or manufacturing technology. Changes which affect the
operation of the unit will be documented in the next revision of the manual.
We have made every effort to ensure the accuracy of the information presented in our documentation.
However, Memotec assumes no responsibility for the accuracy of the information published. Product
documentation is subject to change without notice. Changes, if any, will be incorporated in new editions of
these documents. Memotec may make improvements or changes in the products or programs described within
the documents at any time without notice. Mention of products or services not manufactured or sold by
Memotec is for informational purposes only and constitutes neither an endorsement nor a recommendation for
such products or services.
Memotec Inc. is a wholly owned subsidiary of Comtech EF Data Corp., and its parent company Comtech
Telecommunications Corp (NASDAQ: CMTL).
Compass and TrueNorth are registered trademarks or trademarks of Newpoint Technologies Inc.in Canada, the
United States of America, and in other countries.
Windows is a registered trademark of Microsoft Corporation in the United States and other countries.
Adobe and Adobe Acrobat Reader are registered trademarks of Adobe Corporation.
Crystal Reports is a trademark of Crystal Decisions/Business Objects.
Wireshark and the "fin" logo are registered trademarks of the Wireshark Foundation.
Any other trademarks are the property of their respective companies.
MySQL Server, its pre-built clients, and Newpoint's use of the MySQL API are covered by one of the
following licenses:
• GNU General Public License, version 2, June 1991
• GNU Library General Public License, version 2, June 1991

Copyright © 2010 Memotec Inc.


Memotec Inc.
7755 Henri Bourassa Blvd. West
Montreal, Quebec
Canada H4S 1P7
Tel.: (514) 738-4781
Fax: (514) 738-4436
www.memotec.com
Contents
Chapter 1: Using Newpoint Compass and TrueNorth . . . . . . . . . . . . . . . . . . . . . . .1-1

1. 1 About the Newpoint Compass Applications . . . . . . . . . . . . . . . . . . . . . . .1-2

1. 2 Typical Compass Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3


1.2.1 Starting/Stopping Compass Administrator and Server . . . . . . 1-4

1. 3 About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-5


1.3.1 The Intended Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
1.3.2 Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Chapter 2: Creating a System of Devices and Buses . . . . . . . . . . . . . . . . . . . . . . .2-1

2. 1 Adding your Devices to the Network Map . . . . . . . . . . . . . . . . . . . . . . . .2-2


2.1.1 About the Local Compass Node . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.1.2 Creating an SNMP Bus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.1.3 Adding an SNMP Bus to a Node. . . . . . . . . . . . . . . . . . . . . . . 2-6
2.1.4 Setting SNMP Bus Properties. . . . . . . . . . . . . . . . . . . . . . . . . 2-7
2.1.5 Checking the Current State of the SNMP Bus . . . . . . . . . . . . 2-8
2.1.6 Connecting to a Remote Server via a Remote Node . . . . . . . 2-9

2. 2 Adding a CXU Device to a Bus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-10

2. 3 Configuring Device Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-13


2.3.1 Modifying the System Device’s Properties . . . . . . . . . . . . . . 2-13
2.3.2 Defining the Device Configuration . . . . . . . . . . . . . . . . . . . . 2-15

Chapter 3: Monitoring the Network Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-1

3. 1 Monitoring the System Data with TrueNorth. . . . . . . . . . . . . . . . . . . . . . .3-2


3.1.1 The Layout of the TrueNorth Window . . . . . . . . . . . . . . . . . . . 3-3
3.1.2 Other Data Tracking Applications . . . . . . . . . . . . . . . . . . . . . . 3-5

3. 2 Working within a TrueNorth Session . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-6


3.2.1 Launching a TrueNorth session . . . . . . . . . . . . . . . . . . . . . . . 3-6
3.2.2 Viewing the System Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
3.2.3 Viewing Field and Point Data . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
3.2.4 Plotting a Live Graph of Performance Values. . . . . . . . . . . . 3-10

3. 3 Viewing Device Data Graphically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-11


3.3.1 Selecting the Points to Plot on a Historical Graph . . . . . . . . 3-13
3.3.2 Changing the Trend Graph Display . . . . . . . . . . . . . . . . . . . 3-15
3.3.3 About the Different Types of Graphs . . . . . . . . . . . . . . . . . . 3-16
3.3.4 Exporting the Trend Graph . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
3. 4 Editing a Node’s Data Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18

Chapter 4: Monitoring Events and Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

4. 1 Managing Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2


4.1.1 Viewing Alarms on a Host (System Tree) . . . . . . . . . . . . . . . 4-3
4.1.2 Alarms in the TrueNorth window . . . . . . . . . . . . . . . . . . . . . . 4-5
4.1.3 Acknowledge alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
4.1.4 Inhibit Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
4.1.5 Viewing Alarms for a Device . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
4.1.6 Configuring a Point to Trigger an Alarm . . . . . . . . . . . . . . . . . 4-8

4. 2 Managing Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11


4.2.1 Viewing Events for a Device. . . . . . . . . . . . . . . . . . . . . . . . . 4-11
4.2.2 Configuring a Point to Log an Event. . . . . . . . . . . . . . . . . . . 4-12

Chapter 5: Editing Screen Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

5. 1 About Editing the System Tree and Objects . . . . . . . . . . . . . . . . . . . . . . 5-2


5.1.1 What can and cannot be edited . . . . . . . . . . . . . . . . . . . . . . . 5-2

5. 2 Editing the System Tree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

5. 3 Editing a Detail Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4


5.3.1 Modifying an Object’s Detailed Layout . . . . . . . . . . . . . . . . . . 5-5
5.3.2 Changing the Background Color . . . . . . . . . . . . . . . . . . . . . 5-10
5.3.3 Displaying an Image in the Background . . . . . . . . . . . . . . . . 5-11

Appendix: Configuring Replication of Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1


Configuring the Compass NOC Server ................................................................A-2

Appendix: Configuring the SNMP Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1


About the SNMP Agent ........................................................................................B-2
Adding the SNMP Agent .........................................................................B-2
Configuring the SNMP Agent to Send SNMP Traps ...............................B-5
Sending the SNMP Trap to a Different Port ...........................................B-7
Verifying that SNMP Agent is Sending/Receiving Traps ........................B-8
Figures
Figure 1-1: Monitoring devices with Compass Administrator and TrueNorth . . . . . . .1-3

Figure 2-1: Devices are represented in the System Tree . . . . . . . . . . . . . . . . . . . . . .2-2

Figure 2-2: Compass Administrator window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-3

Figure 2-3: Driver Selection for Local Compass Node dialog box . . . . . . . . . . . . . . .2-4

Figure 2-4: The snmpmgr driver script running in the Restart Compass dialog box . .2-5

Figure 2-5: Compass Administrator with an SNMP and three devices . . . . . . . . . . . .2-6

Figure 2-6: Add Bus to Node dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-6

Figure 2-7: The Driver Parameters tab in the SNMP Configuration dialog box . . . . .2-7

Figure 2-8: The Polling Options tab in the SNMP Configuration dialog box . . . . . . . .2-7

Figure 2-9: Change SNMP Bus State dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-8

Figure 2-10: Compass Administrator with two Nodes . . . . . . . . . . . . . . . . . . . . . . . . .2-9

Figure 2-11: Devices are described by a collection of points . . . . . . . . . . . . . . . . . .2-10

Figure 2-12: Add Device to SNMP dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-11

Figure 2-13: Device Properties dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-13

Figure 2-14: General Device Info and Device Info tabs . . . . . . . . . . . . . . . . . . . . . .2-15

Figure 3-1: TrueNorth window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2

Figure 3-2: TrueNorth window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3

Figure 3-3: Examples of Trend plotting and Report generation . . . . . . . . . . . . . . . . .3-5

Figure 3-4: TrueNorth Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-6

Figure 3-5: System display in its own window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-7

Figure 3-6: System display in its own window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-9

Figure 3-7: Viewing a point on a live graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-10

Figure 3-8: A sample Trend graph . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-11

Figure 3-9: Selecting the points to include in the Trend graph . . . . . . . . . . . . . . . . .3-12

Figure 3-10: Defining the Points to be graphed . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-14

Figure 3-11: Editing (Trending Graphs) dialog box . . . . . . . . . . . . . . . . . . . . . . . . . .3-16

Figure 3-12: Displaying the point name in TrueNorth . . . . . . . . . . . . . . . . . . . . . . . .3-18

Figure 3-13: Selecting a model to edit in Compass Administrator . . . . . . . . . . . . . .3-18

Figure 3-14: Displaying points for a specific model. . . . . . . . . . . . . . . . . . . . . . . . . .3-19

Figure 3-15: Edit Point dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-20


Figure 4-1: Alarm Popup window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

Figure 4-2: Alarms in the System Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Figure 4-3: Alarm Popup window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Figure 4-4: List of Alarms in the TrueNorth window . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Figure 4-5: Devices with inhibited alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

Figure 4-6: System window displaying Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

Figure 4-7: Displaying the point name in TrueNorth . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Figure 4-8: Editing an point’s Alarm status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

Figure 4-9: Edit State dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10

Figure 4-10: Events list in the TrueNorth window . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11

Figure 4-11: Displaying the point name in TrueNorth . . . . . . . . . . . . . . . . . . . . . . . . 4-12

Figure 4-12: Editing an point’s Event status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13

Figure 4-13: Edit State dialog box for an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14

Figure 5-1: Editable and non-editable objects in the System Tree . . . . . . . . . . . . . . . 5-2

Figure 5-2: Editing the System Tree. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Figure 5-3: Viewing detail screens for multiple devices . . . . . . . . . . . . . . . . . . . . . . . 5-4

Figure 5-4: Component Properties dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Figure 5-5: Choose Color dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10

Figure 5-6: Using a map as a background image. . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11

Figure 5-7: Select an Image dialog box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12

Figure A-1: Data replication across two servers and connected devices . . . . . . . . .A-2
Figure B-1: Adding fepagent to the Startup process . . . . . . . . . . . . . . . . . . . . . . . . .B-2
Figure B-2: List of actively used ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-3
Figure B-3: Disabling the SNMP service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-4
Figure B-4: Opening the Configure SNMP Host Items dialog box . . . . . . . . . . . . . . .B-5
Figure B-5: Viewing the fepagent process in TrueNorth . . . . . . . . . . . . . . . . . . . . . .B-6
Figure B-6: Wireshark Capture Options dialog box . . . . . . . . . . . . . . . . . . . . . . . . . .B-8
Figure B-7: List of traffic for the selected host in Wireshark . . . . . . . . . . . . . . . . . . .B-9
Figure B-8: Wireshark Decode As dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-10
Tables
Table 1-1: Compass Mode icons and definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Table 3-1: TrueNorth toolbar buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Table 3-2: Toolbar buttons that change the graph display. . . . . . . . . . . . . . . . . . . . 3-15

Table 3-3: Toolbar buttons that export the contents of the Trend graph . . . . . . . . . 3-17

Table 4-1: Alarm types and their configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Table 4-2: Alarm types and their configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10

Table 5-1: Detail Screen Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6


1
Using Newpoint Compass and TrueNorth

Memotec Inc. 1-1


Newpoint Compass Operator Guide

1.1 About the Newpoint Compass Applications


The NMS solution is a client/server system that stores its information in a database where
contents are accessible to other management systems through ODBC or APIs.
• Compass Server: queries the devices for data and makes that data available to
other Compass applications. The Compass Administrator application configures
the SNMP Buses and devices, generate trend reports, schedule maintenance, con-
figure emails and paging, etc.
For more information about the Compass Administrator, see “Creating a System
of Devices and Buses” on page 2-1.
• TrueNorth: the client application, monitors the dataflow on the server and its
devices. It displays the latest statistics, reviews the alarms, and performs
configuration changes.
Using a web browser, you can download the TrueNorth client located on the
server and because the client application is JAVA based, it can be run on most
operating systems.
For more information about TrueNorth, see “Monitoring the Network Data” on
page 3-1.
• Trend Plotting: you can create plotted charts from Active and/or stored Histori-
cal data from polled devices.
For more information about Trending, see “Viewing Device Data Graphically”
on page 3-11.
• Automatic Reporting Tool: allows you to generate and schedule reports on the
devices in your network.
Using dual databases meets the performance requirements of the specified system:
• one database handles the system real-time requirements
• the second handles historical information
The real time database contains an image of variables in each connected element and is
capable of performing 6,000 transactions per second. The historical database is a relational
non-proprietary ODBC compliant database and maintains records of all system events,
alarm, and trends.

1-2 Memotec Inc.


Using Newpoint Compass and TrueNorth

1.2 Typical Compass Workflow


Once you have your devices connected and ready to operate in your network, you are
ready to add them to Compass Administrator and monitor their operation in TrueNorth.

Figure 1-1: Monitoring devices with Compass Administrator and TrueNorth

The typical workflow in Compass is as follows:


1. In Compass Administrator, create the SNMP Bus and the Devices that represent the
equipment in your network.
For more information, see “Creating a System of Devices and Buses” on page 2-1.
2. Configure the devices and log the data that is to be tracked (polled).
For more information, see “Configuring Device Properties” on page 2-13.
3. Launch TrueNorth and monitor the devices for Events and Alarms.
For more information, see “Monitoring the Network Data” on page 3-1.
4. Generate reports on system activity.
For more information, see “Other Data Tracking Applications” on page 3-5.
5. View the system data on a graph.
For more information, see “Viewing Device Data Graphically” on page 3-11.

Memotec Inc. 1-3


Newpoint Compass Operator Guide

1.2.1 Starting/Stopping Compass Administrator and Server


When you launch Compass Administrator, you can create or modify your network of
devices. Once you create your network of devices, you can use TrueNorth to monitor the
data traffic. For information on how to start TrueNorth, see “Launching a TrueNorth
session” on page 3-6.
When you installed the Newpoint Compass system on your PC, it installed the Compass
Server application that resides in your system tray when you start your PC (it appears as
the Compass icon). The Compass icon allows you to stop, pause (Idle), or run the
Compass server.
The state of the Compass Mode determines how you can modify the local host (the PC on
which you have launched Compass Administrator. For example, when the Compass Mode
is in Stop Mode, you are limited in what you can modify on the local node.
To change the mode type, right-click the Compass Mode icon in the system tray and
select the server’s mode. You have the following choices:
Mode Type Icon Description

Stop Mode The local host is not online and not available to the
network. All Compass processes are stopped.

Idle Mode The local host is online and accessible across the net-
work, and although all Compass processes are run-
ning, no data is being acquired.

Run Mode The local host is online and accessible across the net-
work, all the processes are running, and data requisi-
tions are being performed normally.

Table 1-1: Compass Mode icons and definitions

NOTE: The Compass Mode icon is not supported on Windows Server 2008; you must
use the Change State dialog box to change the mode.

To launch Compass Administrator, follow these steps:


1. Select Start > Programs > Newpoint Compass > Compass Administrator.The
Compass Administrator window appears.
2. To change the Compass Mode in Compass Administrator, use the Change State
dialog box (for more information, see “Checking the Current State of the SNMP Bus”
on page 2-8).

1-4 Memotec Inc.


Using Newpoint Compass and TrueNorth

1.3 About this Guide


This Operator Guide is designed to teach you the basics of using the Compass system to
monitor and control the devices in your network. The Newpoint Compass Quickstart
Guide provides you with just enough information to get started quickly with the Newpoint
Compass system.

1.3.1 The Intended Audience


This guide is designed for system operators and integrators who maintain and customize
device-based monitor and control systems. This guide will provide you with a solid
understanding of the devices and technologies that are configured in the system.

1.3.2 Contact Information

Support and Licensing Keys


If you need technical support on the Newpoint Compass system or to obtain a software
licensing key, contact Memotec Inc. as follows:
• Telephone: +1 514-738-4781 (emergencies: dial #1)
• Fax: +1 514-738-4436
• Email: cx.support@memotec.com
• Web: http://www.memotec.com/

Documentation Feedback
If you have any feedback on this Guide, please send an email to docs@memotec.com.
When providing us with feedback on the documentation, please be as specific as possible
(including the document name, the chapter number, and the page number).

Memotec Inc. 1-5


Newpoint Compass Operator Guide

1-6 Memotec Inc.


2
Creating a System of Devices and Buses

Memotec Inc. 2-1


Newpoint Compass Operator Guide

2.1 Adding your Devices to the Network Map


The physical equipment monitored and controlled in the Compass software suite are
represented by models or templates know as devices.
These devices are best represented in the form of device drivers which are software
modules that reside on the Compass nodes. They communicate with specific pieces of
equipment and form the foundation upon which a typical Compass system is built.

Figure 2-1: Devices are represented in the System Tree

Typically, the equipment that Compass monitors and controls interfaces with the system
via asynchronous serial communications ports. For SNMP-enabled devices accessible
over IP, the communication between Compass and the devices is done through the SNMP
Bus.
To this end, Compass uses the concept of the Bus. A Bus is an instance of a driver
executable that communicates with one or more devices of the same protocol type through
a single serial port. Buses form the basic unit of structure for communicating with the
equipment in your network. The combination of driver executable and serial port may also
be referred to as a driver instance, or a communications instance.

NOTE: With Memotec devices, you will use an SNMP Bus.

2-2 Memotec Inc.


Creating a System of Devices and Buses

2.1.1 About the Local Compass Node


Before you can add an SNMP Bus and it devices, you need to associate it with a Node
which identifies the Host via an IP address. A Node is an instance of a Compass server.
Compass Administrator comes pre-installed with a Local Compass Node that is
configured to use the local PC as its host (Address: localhost).

The Local Compass


Node lists the devices
directly connected to
this PC.

Figure 2-2: Compass Administrator window

This document assumes that you will be configuring Compass on the server itself, making
the server the local host. However, if you configure a server remotely, you must create a
new node and provide that PC’s IP address.
• If you are installing Compass on a PC, which is the local server, then you can use
the pre-existing Local Compass Node to create the SNMP Bus (see “Creating an
SNMP Bus” on page 2-4).
• For information on creating a Node for a remote server, see “Connecting to a
Remote Server via a Remote Node” on page 2-9.

Memotec Inc. 2-3


Newpoint Compass Operator Guide

2.1.2 Creating an SNMP Bus


By using the Driver Select command, you can create an SNMP Bus by simply activating
the snmpmgr driver. This driver contains a set of commands that automatically creates the
SNMP Bus and any devices associated with it.
To create an SNMP Bus, follow these steps:
1. Right-click the Local Compass Node and select Driver Select from the pop-up menu.
The Driver Selection for Local Compass Node dialog box appears.

Figure 2-3: Driver Selection for Local Compass Node dialog box

2. Select the snmpmgr driver and click Add Driver. The snmpmgr driver should appear
in the Active drivers panel.
If the snmpmgr driver is already in the Active drivers panel, you can skip this step.
3. Click OK. The Restart Compass dialog box appears.

2-4 Memotec Inc.


Creating a System of Devices and Buses

4. Click Restart. A script will display the process launched by the snmpmgr driver.
When the Current state reads as Run Mode, click Close.

Figure 2-4: The snmpmgr driver script running in the Restart Compass dialog box

NOTE: When you start or restart a Compass driver, look through the result panel to
see if there are any of the commands or processes fail. If there are any failed
processes, it may cause Compass to malfunction.

When the Compass Administrator window reappears, you’ll see that the SNMP Bus now
appears as a child of the Local Compass Node. You only need to create the SNMP Bus
once.
For information on how to add devices to the SNMP Bus, see “Adding a CXU Device to a
Bus” on page 2-10.

Memotec Inc. 2-5


Newpoint Compass Operator Guide

2.1.3 Adding an SNMP Bus to a Node


The Driver Select command (see “Creating an SNMP Bus” on page 2-4) automatically
adds a pre-configured SNMP Bus to the local Compass Node, which should be robust
enough for most users. However, you can also add an SNMP Bus to a Node and configure
it manually, provided that the SNMP driver is installed.
Once you add an SNMP Bus to a Node, you can start adding devices to it right away.
However, you can also change its default configuration, which will then affect any devices
associated with it. For more information on modifying the Bus, see “Configuring Device
Properties” on page 2-13.

Each device you


add to the SNMP
Bus will appear
instantly in
TrueNorth and you
will be able to track
its status.

Figure 2-5: Compass Administrator with an SNMP and three devices

You may also need to add other SNMP Buses when monitoring SNMP devices that
require unique SNMP Bus configurations.
To add an SNMP Bus to your system, follow these steps:
1. Log into Compass Administrator.
2. Right-click one of the Compass nodes in the left panel and select Add Bus.

Figure 2-6: Add Bus to Node dialog box

3. Type the name of the new Bus in the Bus name field.
4. Enable the Stand-alone executable driver checkbox and the Driver field displays
snmpmgr automatically.
5. Click OK.
You can now start adding devices to this node. For more information, see “Adding a CXU
Device to a Bus” on page 2-10.

2-6 Memotec Inc.


Creating a System of Devices and Buses

2.1.4 Setting SNMP Bus Properties


You must configure some of the SNMP Bus settings to be able to effectively monitor the
CXU devices.
To configure an SNMP Bus, follow these steps:
1. Right-click the SNMP Bus and select Configuration from the pop-up menu. The
Configuration dialog box appears.
2. Select the Driver Parameters tab and enter the following configuration information:

Figure 2-7: The Driver Parameters tab in the SNMP Configuration dialog box

• Poll Delay: set to 25 milliseconds


The Poll Delay allows you create an interval of time between queries of values
from the CXU devices. Increasing the poll delay will reduce the bandwidth
required for monitoring.
• Disable point auto-creation: enable this checkbox
3. Select the Polling Options tab and enter the following configuration information:

Figure 2-8: The Polling Options tab in the SNMP Configuration dialog box
• Maximum OIDs per Request: set to 8
• Maximum Open Request: set to 8
• Write Traplog File: enable this checkbox

Memotec Inc. 2-7


Newpoint Compass Operator Guide

NOTE: Reduce these values to limit the bandwidth of the Compass Data Request.

2.1.5 Checking the Current State of the SNMP Bus


Once you add an SNMP Bus to a Node, you can check its current state to ensure that
everything is running smoothly. Possible errors include ports that may be down or a
configuration file may be incorrectly defined.
If any errors appear when you check the SNMP Bus you should contact Memotec
Technical Support (see “Contact Information” on page 1-5).
To check the state of an SNMP Bus, follow these steps:
1. Right-click the SNMP Bus you wish to check and select Current State. The Change
State dialog box appears.
2. If the SNMP Bus is not currently running (the Current state should read as Stopped),
click the Start button.

Figure 2-9: Change SNMP Bus State dialog box


3. If the Bus is running properly, the message window will display “initialization
complete” and the Current state will read as Running.
4. You can click Stop or Restart to change the Bus’ current state.
5. Click Close when done.

2-8 Memotec Inc.


Creating a System of Devices and Buses

2.1.6 Connecting to a Remote Server via a Remote Node


Compass Administrator comes pre-installed with a Local Compass Node that is
configured to use the local PC as its host (Address: localhost). But if you want to
configure a server that is on another PC than the current one, you need to create a new
Node and provide that PC’s unique IP address.

The default Local


Compass Node
refers to the current
PC, but the Remote
Compass Node
refers to an external
PC.

Figure 2-10: Compass Administrator with two Nodes

To create a node, follow these steps:


6. Right-click Compass System and select Add Node. The Add Administrator Node
dialog box appears.
7. Type the name of your Node in the Description field. Make sure it’s something
distinct enough that you will easily recognize it.
8. Type the IP address in the Address field. This field only accepts numbers, so do not
include the http:// in the address. The address uses the standard IP format.
If you are creating a node for the server from which Compass Administrator was
launched, you can type “localhost” in the Address field.
Click OK. The new Node you appears in the left panel. If any Buses or devices exist
on this Compass node, they will also appear.
You can now change the state and the configuration of this remote Compass node, as well
as add Buses and Devices to it.
• For information on adding a Bus to this Node, see “Adding an SNMP Bus to a
Node” on page 2-6.
• For information on adding a Device to a Bus, see “Adding a CXU Device to a
Bus” on page 2-10.

NOTE: Anything you add to a Node (buses, devices) becomes part of that Node
(based on its IP address). If you add a Remote Node to Compass
Administrator, all of its associated Buses and Devices will automatically
appear.

Memotec Inc. 2-9


Newpoint Compass Operator Guide

2.2 Adding a CXU Device to a Bus


The basis of a device driver is a Point model which defines the characteristics of the data
available from the device, such as the device name or the status of the user ports. The
collection of points in a point model collectively define a physical piece of equipment.
All devices represented by point models within the same driver module can be controlled
by the same device driver software, which is typical when a manufacturer produces
several similar devices that use a common communications protocol.

Figure 2-11: Devices are described by a collection of points

Device drivers query the equipment types that they support for status information and
assign values to respective data points in the local Compass database; the information
stored in the database is then used to populate detail screens and other fields in various
Compass client applications.
Device drivers also accept operator input to make configuration changes on pieces of
equipment supported by the driver. The Compass Driver Pack provides many device
drivers that support a wide array of devices produced by various manufacturers’ right out
of the box. Drivers are organized in the Compass directory structure by manufacturer and
equipment type.
To add a device to an SNMP Bus, follow these steps:
1. Log into Compass Administrator.
2. Open the Node you wish to modify, right-click the SNMP Bus, and select Add
Device.

2-10 Memotec Inc.


Creating a System of Devices and Buses

Figure 2-12: Add Device to SNMP dialog box


3. Type a descriptive name for the device in the Description field. For example, you
could describe where the device is located (“Main office”).
4. Type the name of the device in the Device Name field. For example, you could
indicate the device by its model number (“CXU1280”).
When typing the name and description of the device, you must assign a unique name
to the device and you can only use numbers and letters. Special characters are not
allowed in the name of the device.
5. Select the MEMOTEC_CXU device driver from the Device model drop-down list.

NOTE: If bandwidth is limited, select MEMOTEC_CXU_lite device driver, which


polls fewer fields and reports mainly on the device information and status.

However, MEMOTEC_CXU_lite device driver does not poll the


Performance Monitor fields needed by the Automatic Reporting Tool.

6. Select the MEMOTEC_CXU subsystems associated with this model from the
Subsystem drop-down list.
Subsystems allow you to group devices together (by location, device type, function,
etc.).
7. Enable the options that apply to this device.
• Active: this device is actively polled. If you disable this checkbox, the device
will have no signal; it becomes a place-holder that you can activate at a later date.
• Do not replicate: prevents data related to this device from being replicated to
another Compass server.
8. Click OK. The device is added to the selected SNMP Bus.

NOTE: Although the device may be present, it hasn’t been configured yet. Therefore,
you cannot begin monitoring the device until it has been configured (see

Memotec Inc. 2-11


Newpoint Compass Operator Guide

“Configuring Device Properties” on page 2-13).

2-12 Memotec Inc.


Creating a System of Devices and Buses

2.3 Configuring Device Properties


In addition to modifying a device’s properties and configuration, Compass Administrator
also allows you to modify the device’s points. Points define the criteria within a device
that issues alarms or other events when the device is running.

WARNING: You should not modify this device information or the device may not
behave properly.

2.3.1 Modifying the System Device’s Properties


If you need to modify a device’s basic properties (the ones you defined when you added it
to the SNMP Bus, you can do so using the Properties dialog box.
To configure a device, follow these steps:
1. Open the SNMP Bus, right-click the device you want to modify and select Properties
from the pop-up menu. The Properties dialog box appears.

Figure 2-13: Device Properties dialog box

2. Modify any of the basic definitions that you set when you created the device. For
more information on these fields, see “Adding a CXU Device to a Bus” on page 2-10.
3. You can also define the more advanced configuration settings for the device using the
following buttons:
• Config: allows you to configure the settings for a device. For more information,
see “Defining the Device Configuration” on page 2-15.
• Points: defines the criteria within a device that issues alarms or other events
when the device is running.

Memotec Inc. 2-13


Newpoint Compass Operator Guide

WARNING: You should not modify the configuration and point information or the
device may not behave properly. Changing the device name resets the
device configuration (hostname, polling period, etc.). It also affects the
data trending tools (Compass Trending Tool, Automatic Reporting Tool).

4. Click OK when done.

2-14 Memotec Inc.


Creating a System of Devices and Buses

2.3.2 Defining the Device Configuration


When you add a device to an SNMP Bus, or devices are included automatically within the
SNMP Bus (see “Creating an SNMP Bus” on page 2-4), they appear pre-configured with a
set of default values. You can customize the specifications for each device using the
Configuration dialog box.

NOTE: The procedure below explains how to define a device according to the
Memotec configuration.

To define a device’s configuration, follow these steps:


1. Open the Node, the Bus, right-click the device you want to modify and select
Configuration from the pop-up menu.
You can also click the Config button in the Properties dialog box (see “Modifying
the System Device’s Properties” on page 2-13).
The Configuration dialog box appears. In Figure 2-14, you can see the two tabs you
will need to use to configure this device.

Figure 2-14: General Device Info and Device Info tabs

2. In the General Device Info tab, set the properties as follows:


• Initial Polling: enable this checkbox so that Compass will poll the device at
startup.

Memotec Inc. 2-15


Newpoint Compass Operator Guide

If you have many devices, the initial polling may balloon bandwidth usage. You
may want to disable this feature to prevent this.
• Retries: number of attempts to perform if polling is enabled (between 1 and 3).
3. In the Device Info tab, set the properties as follows:
• Agent Hostname: enter the IP address for the CXU device.
• Community Name: type public in this field.
This is the default community name for Memotec devices. If you change this
value, make sure it matches the Memotec device configuration.
• Set Community: type private in this field.
This is the default set community name for Memotec devices. If you change this
value, make sure it matches the Memotec device configuration.
• Timeout (sec): set to 5.
• SNMP Version: select Version 1 from this drop-down list.
• Poll Rate (sec): set to 900 (15 minutes) or less.
• SNMP Port: set to 161.
• SNMP Trap Port: set to 162.
• Trap Protocol: select UDP.
4. Enable the Nonstandard GETNEXT (v1 only) checkbox.
5. Click OK when done.

2-16 Memotec Inc.


3
Monitoring the Network Data

Memotec Inc. 3-1


Newpoint Compass Operator Guide

3.1 Monitoring the System Data with TrueNorth


The Compass TrueNorth application monitors devices and manages information for
satellite earth stations. It provides a concise, easy-to-use, and integrated view of the
equipment, comprising their monitor and control (M&C) networks.
Using the intuitive, user-friendly interface, you can easily manage hundreds of network
devices, receive instantaneous alarm and event notifications, and seamlessly connect to
remote Compass nodes, all from within a single application.

Figure 3-1: TrueNorth window

TrueNorth integrates the following into a single application:


• device screens
• multiple levels of system screens
• alarm and event viewing
• a screen editor
The TrueNorth application resides on the Compass server so that all users can share and
have the same view of the system without needing to copy and maintain separate files and
settings. TrueNorth’s powerful configuration management and integrated screen editor
allows you to easily map out animated, color-coded views of their device networks, create
customized device detail screens, and even create new graphical template objects that are
added to the standard TrueNorth palette.

3-2 Memotec Inc.


Monitoring the Network Data

Device drivers
The device driver reads the data from a monitored device when it polls the device for
information. A device driver can query (poll) the device for new information or status
changes when other processes are not active.
If the data is an input change, this information is passed on to the Compass for processing
and it will redistribute that information to the clients. Once the data has been received
from a query, it can be displayed in a variety of ways in TrueNorth.

3.1.1 The Layout of the TrueNorth Window

Tree

Toolbar

System display

List display of
events and
alarms

Figure 3-2: TrueNorth window


The TrueNorth window is divided into four main sections:
• Tree: this panel displays all the devices in your Compass system. Any devices
you add in Compass Administrator will appear immediately in the System Tree.
The Tree window contains the following objects by default:
- All Devices: displays the devices and objects that track the system state.
> System: displays the current Compass state and health.
> Master Process Monitor List: lists the amount of time that the Compass
server has been online (the Uptime), allows you to set the Compass server
to Idle or Run modes, and lists the process started by Compass.
> PIDMONITOR: displays the current status for each active process.
- System: allows you to configure the drivers, the Compass system properties,
and the User settings (also definable in Compass Administrator). Not all users
have access to this section.

Memotec Inc. 3-3


Newpoint Compass Operator Guide

• Toolbar: functions that affect what appears in the System display panel
including:
Button Description

Navigation (Up, Back, and Forward): select objects in the


System Tree based on their position (Up) or the sequence of
objects you selected (Back and Forward).

Home: clears the System panel.

Save as Image: takes a snapshot of the System panel and


saves it as a image file (JPG format).

Print: takes a snapshot of the System panel and sends it to a


printer connected to your PC.

Zoom: increases, decreases, or resets the size of the System


panel.

Refresh: updates the System panel with the latest data.

Table 3-1: TrueNorth toolbar buttons

• System display: displays information associated to the object you select in the
System Tree.
• List display: displays events and alarms being tracked by TrueNorth.

3-4 Memotec Inc.


Monitoring the Network Data

3.1.2 Other Data Tracking Applications


In addition to the TrueNorth application, there are other applications that allow you to
monitor or analyze the data flowing over your network of devices.

You can create a graph that tracks up


to eight points and export it as an
images or generate a report that
presents the data in a variety of ways.

Figure 3-3: Examples of Trend plotting and Report generation

These applications are as follows:


• Trend Plotting: As performance data is logged to an SQL relational database, a
variety of options are available for reviewing and reporting. Memotec solution
includes a graphical application for creating visual trends of collected
performance data.
The Trend Historian graphical user interface supports both active trending as new
data is collected as well as historical trending of previously logged data. The
application supports creating of various graphical charts including line graphs,
bar graphs and pie charts. For more information, see “Viewing Device Data
Graphically” on page 3-11.
• Automatic Reporting Tool: Visual data can also be exported to a comma
separated spreadsheet for use in other applications. Additional reports can be
created with third party packages like Crystal Reports. Memotec also offer an
automatic reporting tool with predefined template reports.
For more information on the Automatic Reporting Tool, see the Automatic
Reporting Tool.pdf document on the installation CD.

Memotec Inc. 3-5


Newpoint Compass Operator Guide

3.2 Working within a TrueNorth Session


Once you have an SNMP Bus with CXU devices loaded and running in the Compass
Administrator, you’re ready to monitor them in TrueNorth (see “Creating an SNMP Bus”
on page 2-4).
When you launch TrueNorth, once you log onto the host, the devices that have been added
to the SNMP bus appear in the System Tree. As the devices are polled, the Events and
Alarms are logged and the icons will reflect what’s going on.
You can also display the polling results on a graph using the Trend Plotting application
(see “Viewing Device Data Graphically” on page 3-11).

3.2.1 Launching a TrueNorth session


To launch the TrueNorth application, follow these steps:
1. Launch TrueNorth using one of the following ways:
• From a Compass server: select
Start > Programs > Newpoint Compass > Compass TrueNorth
• From a remote PC: launch a web browser and type the following in the address
field: http://[Compass Server IP address]:5099
After you log into TrueNorth for the first time using that address, you can use the
TrueNorth icon that appears in your Start menu (Start > Programs > Newpoint
Compass > TrueNorth WebLaunch) and on your Desktop.

NOTE: When you launch the TrueNorth WebLaunch the first time, you may receive a
security warning. You can add the TrueNorth WebLaunch as an exception
and add it to your list of trusted websites.

The Login window appears.

Figure 3-4: TrueNorth Login

3-6 Memotec Inc.


Monitoring the Network Data

2. Log into TrueNorth by supplying your identity information.


• Hostname: the IP address for the server to which you wish to connect. If you
launched this window from a web browser, the IP address will already be in this
field.
• User Name: the username defined for the server to which you are connecting
(default: tnadmin).
• Password: the password for the username you selected (default password for
tnadmin is newpoint)
If your credentials are valid, the TrueNorth window appears.

3.2.2 Viewing the System Data


When you double-click a Memotec device from the System Tree, its system information
appears in the System panel on the right. You can use this information to track the
performance quality of the device, view tracked events, as well as flag any errors that
occur on the device.
The information that appears in the System panel is live, although you can refresh it using
the Refresh button in the toolbar (top right).

Basic stats

Current state

System tabs

Figure 3-5: System display in its own window

The System window is divided into three sections:


• Basic stats: displays the name of the device, its compression rates, the amount
of time it has been running, and status of each port
• Current state: indicates if the device is running and being tracked by Compass.
- Green: system is active and has no errors
- Red: system is active, but has major alarms

Memotec Inc. 3-7


Newpoint Compass Operator Guide

- Orange: system is active, but has minor alarms


- Cyan: alarms on this device have been inhibited
- White: no polling active
- Grey: system is not actively running
• System tabs: These six tabs display data flow information about the currently
selected device.
- Information: general information about the device
- Monitor Status: status of ports, clocking, and redundancy
- Configuration: puts port in or out of service, switch to Backup Unit
- Congestion: status of the congestion over the WAN
- Performance: detailed performance statistics for Ethernet, WAN, T1/E1 port
mapping
- Traps Status: list of current alarms

NOTE: For more information on these tabs, see the CXU driver reference help on the
installation CD in /newpoint/drivers/.

You can either view the System information within TrueNorth or you can view it in its
own window (as show in Figure 3-5).
To view the system information as its own window, right-click the Memotec device from
the System Tree and select Open in New Window from the pop-up menu. The system
information appears in its own System window.

3-8 Memotec Inc.


Monitoring the Network Data

3.2.3 Viewing Field and Point Data


When you display the system data for a device, a list of fields and port LEDs appear to
display the status of the device or item. Each field and object in this window represents a
variable or point with data that is being tracked.

Each field and many


of the graphic
objects are points
that contain data
that can be edited,
affected, and
plotted.

Figure 3-6: System display in its own window

You can view the data for this field, variable, or point in a variety of ways. If you right-
click the item in the window, you can choose from the following tasks. You can:
• Plot the data in the field or point graphically (for more information on the Plot
command, see “Plotting a Live Graph of Performance Values” on page 3-10)
• Acknowledge or Inhibit the events on the point (Ack and Inhibit commands, for
more information on these commands, see “Acknowledge alarms” on page 4-5)
• Add notes for this field/point (Notes command). A text editor appears and allows
you to add textual notes to the field/point.
• Edit the configuration for the point being graphed (for more information on the
Edit Point command, see “Editing a Node’s Data Points” on page 3-18)

Memotec Inc. 3-9


Newpoint Compass Operator Guide

3.2.4 Plotting a Live Graph of Performance Values


When you double-click a device in the System Tree, the details for that device appears in
the System display panel. This panel contains many tabs and fields that track different
types of data that flow through the device.
While the Trend Plotting tool allows you to track multiple points graphically, you can
generate a simple graph for a single point of data for a device.
To create this graph, right-click a field in the System display panel and select Plot > Live.
The Live Plot window appears and begins to display the data in the field as a simple
graph.

NOTE: If you have registered a field to be tracked using the Trend Plotting tool, you
can also view the data to the past hour, 24 hours, or 30 days (these options
appear in the Plot > Live pop-up menu for the registered point).

You can
generate a live
graph for any of
the fields or
points in the
System display.

Figure 3-7: Viewing a point on a live graph

If you right-click on the Live Plot window itself, you can perform the following tasks:
• Pause or Play the live process of the graph (Pause/Play)
• Send a snapshot of the current graph to a printer (Print)
• Save the a snapshot of the current graph as a CSV file or as a graphic (Save)
To view the data for an entire device or network, you need to use the Trend Plotting tool
(see “Viewing Device Data Graphically” on page 3-11).

3-10 Memotec Inc.


Monitoring the Network Data

3.3 Viewing Device Data Graphically


Using the Trend Plotting tool, you can create plotted charts from Active or stored
Historical data from the devices and the points that are being polled.

Figure 3-8: A sample Trend graph

Once you select the points you wish to display graphically, you can change how the graph
appears, modify the graph settings, and export the graph data as an image or send it to a
printer.
To plot the device values on a graph, follow these steps:
1. Select Start > Programs > Newpoint Compass > Trend Plotting. The Compass
Trending window appears.
2. Select the type of graph you wish to create from the File > New menu:
• Current Plot: plots the current set of values that begin when you launch the
graph. These values will continue to change as long as the graph is active.
• Historical Plot: uses a set of values stored in the historical database for a specific
amount of time. These values are static: they will not change while the graph is
active.

NOTE: Before you can plot historical data, you need to select File > Configure Log-
ging and select the points you want to plot. You may need to wait up to one

Memotec Inc. 3-11


Newpoint Compass Operator Guide

hour before the data becomes available to the Trending tool.

The Choose Points dialog box appears.


3. Select the host address you wish to track from the Logged Points on drop-down
listbox.
If the IP address does not appear in this field, you can add it and click Select. The
points for the current host appears in the Choose Points dialog box.
4. Select each point you wish to appear in the graph and click >>. The points you will
be tracking appear in the Points to Trend list box.

You can enter up


to eight points in
the Points to
Trend list box.

Figure 3-9: Selecting the points to include in the Trend graph

To remove a point from the Points to Trend list box, select the point and click <<.
5. Define the range of time that the values need to be tracked in the Query Range panel.
• Query Range: select the amount of time to perform the query (Today, Yesterday,
a specific month, etc.)
• Start Time and End Time: select when the query should begin and end. You can
only select these times if you select Exact Range from the Query Range drop-
down listbox.

NOTE: The Query Range only appears if you select New > Historical Plot. It does
not appear for the Current Plot graph.

6. Define the X and Y span for the graph:

3-12 Memotec Inc.


Monitoring the Network Data

• X Span: define the length of time to cover in the graph (seconds, minutes, hours,
or full span).
• Y Span: defines the range of values to track in this graph.
- If you enable the Auto checkbox, the range of values on the Y axis will
change as the values change.
- If you deselect the Auto checkbox, then you can use the define the Minimum
and Maximum values for the Y axis.
7. Select the type of graph to generate:
• Graph Type: defines how the lines will appear in the graph
• Round Values To: allows you to adjust the numbers by the nearest multiple. For
example, if you enter 100 in this field, a value of 1258 will be adjusted to 1300.
8. Click OK when done. The Trend graph now appears in the Compass Trending
window.

3.3.1 Selecting the Points to Plot on a Historical Graph


To plot the data from a specific CXU device in a historical graph, you need to select the
points that you need to be graphed in the report. This needs to be set only once for each
device and will apply every time you generate a report for that device.
To define the points to log, follow these steps:
1. Launch the Trend Plotting tool (Start > Program > Newpoint Compass > Trend
Plotting).

2. Select File > Configure logging. The Choose Points for Logging dialog box appears.
3. Select a new host from the Points on Host drop-down list.
By default, localhost represents the server running on the PC. If you are using a
remote Compass server, you can specify the IP address.
4. For each device, select the following points and click >> to move them to the right
column:

Memotec Inc. 3-13


Newpoint Compass Operator Guide

Figure 3-10: Defining the Points to be graphed

NOTE: Select the first point that you want (ex: Current E Ss 01) and repeatedly press
>> until you reach the last point.

5. When you are done selecting the points for the various CXU devices, press OK.

3-14 Memotec Inc.


Monitoring the Network Data

3.3.2 Changing the Trend Graph Display


You can use the following toolbar buttons in the Compass Trending window to change
how the graph appears. You can make these changes as the graph is running: you do not
need to stop and restart the graph to change how it appears.
Button Description

Normal: you can change the what the graph displays by dragging the
mouse.
• Left-dragging changes the zoom level of the X axis
• Right-dragging changes the level of the Y axis

Rotate: changes the rotation angle of the Trend Graph.

Note: If the graph is not in 3D mode, it will automatically shift to 3D mode


when you click this button.

Move: changes the horizontal and vertical position of the graph within the
Compass Trending window. When you click this button, you can drag the
graph to a new position in the window.

Zoom: changes the magnification level of the graph.


• If you drag the cursor upwards, the magnification increases.
• If you drag the cursor downwards, the magnification decreases.

Depth: changes the depth of the graph in 3D mode.

Note: If the graph is not in 3D mode, it will automatically shift to 3D mode


when you click this button.

3D: toggles the 2D or 3D view of the Trend Graph.

Edit: opens the Editing dialog box which allows you to fine-tune the display
of the graph to a very detailed level.
You can select different types of graphs, change the display of the lines, the
size of the X and Y axis, and edit many more graphical features.
See “About the Different Types of Graphs” on page 3-16.

Table 3-2: Toolbar buttons that change the graph display

Memotec Inc. 3-15


Newpoint Compass Operator Guide

3.3.3 About the Different Types of Graphs


The Trend Plotting tool supports a variety of graphs that you can display within the
Trending window. The Edit button allows you to select from 56 different types of
graphs and allows you to display as many as you need in the Trending window.

If you click the Edit button, the Editing dialog box appears and displays a set of tabs
that allow you to customize what these graphs display.

Figure 3-11: Editing (Trending Graphs) dialog box

These tabs include the following:


• Chart: allows you to add the graphs you need, select their type, and allows you to
customize how it displays the data.
• Series: allows you to select a specific graph and modify its individual
configuration.
• Data: allows you to customize the X and Y axis values, as well as label the items
being tracked on the graph.
• Tools: allows you to add static graphics to the graph (ex: lines, arrows, images,
etc.)
• Export: allows to save a snapshot of the graphs in the Trending window as an
image file.
• Print: allows you to print a snapshot of the graphs in the Trending window.

3-16 Memotec Inc.


Monitoring the Network Data

3.3.4 Exporting the Trend Graph


You can use the following toolbar buttons in the Compass Trending window to export
the Trend graph as file, to copy it to the clipboard, or to send it to a printer.
Button Description

Print: sends a snapshot of the current Trend graph to a printer that is


connected to your PC.

Copy: takes a snapshot of the current Trend graph and copies it to the
clipboard. You can paste this graphic from the clipboard to most third-party
applications.

Save: takes a snapshot of the current Trend graph and saves it as a graphic
file.

Table 3-3: Toolbar buttons that export the contents of the Trend graph

You can also export the data in the Trend graph as HTML, a CSV file, or as a text file. To
export this data, select File > Export Data and select the path and format of the data you
wish to export.
The following is an example of how the data appears when exported:
Date Time cxu20.dsx1TrapLineStatus Date Time cxu20.dsx1TrapLineStatus

07/16/2009 25.000000 07/16/2009 24.000000


11:39:53 11:39:53

07/16/2009 45.000000 07/16/2009 44.000000


11:40:54 11:40:54
07/16/2009 42.000000 07/16/2009 45.000000
11:41:55 11:41:55

07/16/2009 41.000000 07/16/2009 40.000000


11:42:56 11:42:56

07/16/2009 62.000000 07/16/2009 64.000000


11:43:57 11:43:57

07/16/2009 51.000000 07/16/2009 51.000000


11:44:58 11:44:58

07/16/2009 52.000000 07/16/2009 52.000000


11:45:59 11:45:59

07/16/2009 37.000000 07/16/2009 40.000000


11:47:00 11:47:00

07/16/2009 42.000000 07/16/2009 41.000000


11:48:01 11:48:01

Memotec Inc. 3-17


Newpoint Compass Operator Guide

3.4 Editing a Node’s Data Points


As indicated in previous sections, a device contains a number of points that send and
receive data that can be tracked and plotted on a graph. These points are defined by the
driver model for the type of device. You can also use these points to trigger alarms and
events, allowing to manage the traffic of data flowing through a device
These points come from the device with a default set of values and configurations, but you
can edit these points using the Compass Administrator. You may need to edit a device’s
points to change its alarm priority or customize how an alarm should be reported.
In TrueNorth, you can display the name of the point for a specific field by placing your
cursor over that field. The name of the point appears in bold at the top of the balloon in the
following format: device.pointname.

Figure 3-12: Displaying the point name in TrueNorth

NOTE: Although you can edit points in TrueNorth, we recommend that you use Com-
pass Administrator instead.

To edit the points on a device, follow these steps:


1. In Compass Administrator, select View > Driver Editing.
This changes what the Node displays in the System Tree (View > System Setup
displays the Bus and Drivers on the Node).
2. Open the Node for the server you wish to edit as follows:
A. Open the snmpmgr object.
B. Right-click the model you wish to edit.

C. Select Points from the pop-up menu.

In this example, we
have selected the
MEMOTEC_CXU
model for the Local
Compass Node.

Figure 3-13: Selecting a model to edit in Compass Administrator

3-18 Memotec Inc.


Monitoring the Network Data

The Points dialog box for the model you selected appears.

Figure 3-14: Displaying points for a specific model

You can filter the list of points using the checkboxes at the top of the dialog box.
You can also search for a specific point or set of points using the Find next field and
button.

WARNING: Although you can add and delete points using this dialog box, we do not
recommend that you do this.

4. Select the point you wish to change and click Edit. The Edit dialog box appears.

Memotec Inc. 3-19


Newpoint Compass Operator Guide

Figure 3-15: Edit Point dialog box


Although you have the ability to modify anything in this dialog box, you will
typically only change the configuration of the States/Events/Alarms.

WARNING: You should NOT change any of the following fields:


Group
Tag Name
Class
Offset
Changing any of these fields can cause the driver to fail.

5. Once you make your changes, click OK.


6. Once you finishing editing the points for the model, click Close in the Points dialog
box.

NOTE: If you install a new version of the driver, it may overwrite your changes to the
current driver model. For this reason, you should keep a log of all your
changes so that you can re-apply them later, if necessary.

3-20 Memotec Inc.


4
Monitoring Events and Alarms

Memotec Inc. 4-1


Newpoint Compass Operator Guide

4.1 Managing Alarms


An alarm occurs automatically when a data value from controlled equipment meets the
specified threshold criteria identified as an alarm condition (defined in the device driver).
When an alarm occurs in the system, a pop-up window appears accompanied with an
audible alarm.

Figure 4-1: Alarm Popup window

The graphics associated with the alarmed data point (e.g., device detail, circuit string,
system summary) would turn the appropriate color, launches any scripts designed to
automatically respond to the alarm, and adds a new entry to the Event logs.
From the popup window, the user can confirm the alarm (see “Acknowledge alarms” on
page 4-5). The user can also inhibit an alarm, so it stops being reported (see “Inhibit
Alarms” on page 4-6).
The alarm pop-up by default displays the host, device and data point that has created the
alarm. The display format is user configurable and can include other fields such as current
threshold, priority, unack status, device description, and point description.
From Compass Administrator, you can configure a point to launch an alarm under specific
conditions, as well as the severity of that alarm. For more information, see “Configuring a
Point to Trigger an Alarm” on page 4-8.

4-2 Memotec Inc.


Monitoring Events and Alarms

4.1.1 Viewing Alarms on a Host (System Tree)


When the devices trigger an alarm, there are many ways you can be made aware.
TrueNorth plays warning sounds to alert you that there is an alarm, the Device panel
displays information about the alarm (see “Viewing Alarms for a Device” on page 4-7),
the Alarm pop-up window lists the current alarms (see “Alarm Popup window” on page 4-
4), and the Alarm Event list displays the alarms (see “Alarms in the TrueNorth window”
on page 4-5).
The System Tree also displays which of the monitored devices and which features in
TrueNorth have registered alarms.

Device icons that appear in


red or that are flashing red
have registered alarms.
Device icons that appear in
green do not have Alarms.
Device icons that appear in
flashing green have
resolved Alarms that were
NOT acknowledged.

Figure 4-2: Alarms in the System Tree

Any items in the System Tree that appear in red or in flashing-red have registered alarms
on them. These icons will remain red until you resolve or reset the alarms for that device.
The parent icon will display the highest ranking alarm among its children. For example, if
you have two devices with one major alarm and one minor alarm, it’s parent folder will
display the major alarm.
You can open the parent icons in the System Tree to see a list of the alarms for that item.
You can then select that device or alarm view more information about the alarm in the
TrueNorth.

Memotec Inc. 4-3


Newpoint Compass Operator Guide

Alarm Popup window


The Alarm Popup window displays all the current alarms for the current Host. This
window will appear automatically when an alarm is flagged, displaying the new alarm and
all the other current alarms. If the Alarm Popup window is not open, you can open it by
selecting Alarms > Show Popup.

Figure 4-3: Alarm Popup window


This window displays a simple summary of the current alarms for the system. Devices that
have alarms listed in this window will also be flashing in the System Tree. For more
detailed information about each of these alarms, consult the Alarms list as the bottom of
the TrueNorth window.

Mute Alarm Sound


There may also be a sound being played when an alarm appears. If you wish to mute the
sound, you have the following choices:
• To toggle the alarm sound for all the alarms, click Mute/Un-Mute in the Alarm
Popup window or select Alarms > Mute.
• To silence a single alarm, select the alarm in the Alarm Popup window and click
Silence. Although this alarm will remain unacknowledged, it will no longer play
its alarm sound.

4-4 Memotec Inc.


Monitoring Events and Alarms

4.1.2 Alarms in the TrueNorth window


You can also view the list of current alarms in the bottom of the TrueNorth window. These
are the same alarms listed in the Alarm Popup window, but they have more detailed
information about the nature of each alarm.
You and display or hide this part of the TrueNorth window by selecting View > Show
Alarm/Event Viewer.

To display the list of alarms in the TrueNorth window, click the Alarms button in the
bottom left of the window.

Figure 4-4: List of Alarms in the TrueNorth window

You can expand each device to view the alarms that are logged for it, as well as see where
the alarm originates, its priority, subsystem, and the time it was logged. With this detailed
information, you can take precise action.

4.1.3 Acknowledge alarms


New alarms will flash red until they are acknowledged or inhibited (see “Inhibit Alarms”
on page 4-6). When you acknowledge an alarm, it will remain flagged, but TrueNorth will
no longer try to get your attention about it.
To acknowledge an alarm in the Alarm Popup window, you have two choices:
• To acknowledge a single alarm, select the alarm and click Ack.
• To acknowledge all the active alarms, click Ack All.
You can acknowledge an alarm in the Alarms list in the TrueNorth window in one of the
following ways:
• To acknowledge a single alarm, right-click the specific alarm and select Ack
from the pop-up menu.
• To acknowledge all the active alarms for a device, right-click the parent device
and select Ack from the pop-up menu.
• To acknowledge multiple alarms, select them while pressing the Ctrl key, right-
click the selected alarms, and select Ack from the pop-up menu.

NOTE: If an alarm is resolved without being acknowledged in Compass, its device


icon will flash green in the System Tree.

Memotec Inc. 4-5


Newpoint Compass Operator Guide

4.1.4 Inhibit Alarms


New alarms will flash red until they are acknowledged or inhibited (see “Acknowledge
alarms” on page 4-5). When you inhibit an alarm, the alarm is ignored, allowing
subsequent actions to take place.
The inhibited alarm remains flagged, but TrueNorth will no longer try to get your attention
about it. Once you inhibit an alarm, it will remain ignored until you uninhibit it.
When you inhibit an alarm on a device, the device’s icon in the System Tree changes and
displays an inhibit flag.

In this example, the devices in the New York


folder have alarms, but they have all been
inhibited (marked with the (i) flag).
In the London folder, both devices have alarms,
but only the CXU21 device has inhibited alarms.
The parent folders for both sets of devices are
also flagged as containing inhibited alarms.

Figure 4-5: Devices with inhibited alarms

To inhibit status of an alarm, use one of the following ways:


• To acknowledge a single alarm, right-click the specific alarm and select Inhibit
from the pop-up menu.
• To acknowledge all the active alarms for a device, right-click the parent device
and select Inhibit from the pop-up menu.
• To acknowledge multiple alarms, select them while pressing the Ctrl key, right-
click the selected alarms, and select Inhibit from the pop-up menu.
To uninhibit an alarm, right-click the inhibited alarm and select Un-Inhibit from the pop-
up menu. An uninhibited alarm reverts to it’s current status (alarm or resolved).

4-6 Memotec Inc.


Monitoring Events and Alarms

4.1.5 Viewing Alarms for a Device


An alarm occurs automatically when a data value from a device meets the threshold
criteria identified as an alarming condition.

Basic Stats

Current State

Trap Status

Figure 4-6: System window displaying Alarms

When an alarm occurs in the system, the following occurs:


• An audible sound is generated
• The Alarm Popup window appears
• The devices listed in the System Tree flash Red (major) or Orange (minor)
• The alarm is recorded in the Alarms list at the bottom of the TrueNorth window
• The System panel records the alarm in the Basic Stats panel, the Current State
panel, and the Traps Status tab.
• System tree overview will display the same alarms at the parent levels of the tree
(see Figure 4-2).
If a device registers any type of error, it appears as an alarm within TrueNorth. Alarms
appear in a variety of ways, ensuring that you have all the information you need to correct
the error, but also make sure you are fully aware of any conflicts on the device.

Memotec Inc. 4-7


Newpoint Compass Operator Guide

4.1.6 Configuring a Point to Trigger an Alarm


By default, certain points in the driver model are configured to trigger alarms under
specific conditions, although you can configure almost any point to launch an alarm or an
event as needed.
To configure the alarms in your system, you need to modify the point that triggers that
alarm. In Compass Administrator, you can define what value should trigger an alarm and
how severe an alarm it is.
There are two types of alarms in the Compass system:
Alarm Priority Range Color

Minor Alarm 100 - 149 Orange

Major Alarm 150 - 255 Red

Table 4-1: Alarm types and their configurations

To find the points that contain alarm settings, you can display the name of the point for an
alarm field in TrueNorth by placing your cursor over that field. The name of the point
appears in bold at the top of the balloon in the following format: device.pointname.

Figure 4-7: Displaying the point name in TrueNorth

You can then search for the point in Compass Administrator using the pointname.
To edit the alarm status of a point, follow these steps:
1. Select View > Driver Editing.
2. Select Node > snmpmgr and select the model that contains the point you wish to edit.
For more information on how to edit points in a model, see “Editing a Node’s Data
Points” on page 3-18.
3. Right-click the model name and select Points from the pop-up menu. The Points
dialog box appears.
4. Use the Find next field to find the pointname you wish to edit. Make sure all the
checkboxes are enabled.
5. Select the point you wish to edit and click Edit. The Edit dialog box appears and
displays the configuration for that point.

4-8 Memotec Inc.


Monitoring Events and Alarms

Figure 4-8: Editing an point’s Alarm status


In this point (rmpStatus), there are a number of states, events, and alarms listed in
the States/Events/Alarms panel. The first four lines contain States, which are not
recorded as alarms or events. These states can be used by other points to launch
scripts or other tasks in the system.
The last three lines contain one minor and two major alarms.
6. Decide if you want to add or edit an alarm:
• To add an alarm, click Add. The Add State dialog box appears.
• To edit an alarm, select the alarm from the States/Events/Alarms panel and
click Edit. The Edit State dialog box appears.
In this example, we will be editing the Failed alarm, but the Add State dialog box is
identical to the Edit State dialog box (see Figure 4-9).

Memotec Inc. 4-9


Newpoint Compass Operator Guide

Figure 4-9: Edit State dialog box


7. Configure the alarm as follows:
• Enter a name for the alarm in the State name field. Make sure you enter an accu-
rate name because it maybe referenced by other points.
• Define when the alarm is triggered in the Condition fields. Select the mathemat-
ical state from the drop-down list box and the value that needs to be met in the
field.
For example, in Figure 4-9, the Failed alarm will be active when the value of the
rmpStatus point is equal to 1.
• Select Alarm from the Severity drop-down listbox and define its priority in the
field. You have the following choices:
Alarm Priority Range Color

Minor Alarm 100 - 149 Orange

Major Alarm 150 - 255 Red

Table 4-2: Alarm types and their configurations

The two other kinds of Severity options are:


- State: no action is taken
- Event: the point is flagged, logged as an event, and is listed in the Events log
(see “Configuring a Point to Log an Event” on page 4-12)
8. Click OK when done.

4-10 Memotec Inc.


Monitoring Events and Alarms

4.2 Managing Events


The event database logs all system events with date & time stamp, user, node, event type,
description, and current value. Events include:
• User login/logout
• Alarms
• Alarm acknowledgement
• Variable or status changes
• Executed commands (by the user or system)

4.2.1 Viewing Events for a Device


Any operations that take place on a device are logged as Events (not including Alarms --
see “Viewing Alarms on a Host (System Tree)” on page 4-3). These Events are logged in
the Events list which you can view at the bottom of the TrueNorth window.

To display the list of events in the TrueNorth window, click the Events button in the
bottom left of the window.

Figure 4-10: Events list in the TrueNorth window

The events list provides details about previous alarms and events, providing you with a
detailed overview of what is happening in the network of devices.

NOTE: Only the last 100 events appear in this list. To view more events, select View
> Event Queries in TrueNorth.

Memotec Inc. 4-11


Newpoint Compass Operator Guide

4.2.2 Configuring a Point to Log an Event


To find the points that contain event settings, you can display the name of the point for an
event field in TrueNorth by placing your cursor over that field. The name of the point
appears in bold at the top of the balloon in the following format: device.pointname.

Figure 4-11: Displaying the point name in TrueNorth

You can then search for the point in Compass Administrator using the pointname.
To edit the event status of a point, follow these steps:
1. Select View > Driver Editing.
2. Select Node > snmpmgr and select the model that contains the point you wish to edit.
For more information on how to edit points in a model, see “Editing a Node’s Data
Points” on page 3-18.
3. Right-click the model name and select Points from the pop-up menu. The Points
dialog box appears.
4. Use the Find next field to find the pointname you wish to edit. Make sure all the
checkboxes are enabled.
5. Select the point you wish to edit and click Edit. The Edit dialog box (see Figure 4-12)
appears and displays the configuration for that point.

4-12 Memotec Inc.


Monitoring Events and Alarms

Figure 4-12: Editing an point’s Event status


In this point (dsx1ExtClkLockStatus), there are a two of states listed in the
States/Events/Alarms panel.
6. Decide if you want to add or edit an event:
• To add an event, click Add. The Add State dialog box appears.
• To edit an event, select it from the States/Events/Alarms panel and click Edit.
The Edit State dialog box appears.
In this example, we will be editing the Nce_Locked state, but the Add State dialog
box is identical to the Edit State dialog box (see Figure 4-13).

Memotec Inc. 4-13


Newpoint Compass Operator Guide

Figure 4-13: Edit State dialog box for an Event


7. Configure the event as follows:
• Enter a name for the event in the State name field. Make sure you enter an accu-
rate name because it maybe referenced by other points.
• Define when the event is triggered in the Condition fields. Select the mathemati-
cal state from the drop-down list box and the value that needs to be met in the
field.
In Figure 4-13, the Nce_locked event will be logged when the value of the
dsx1ExtClkLockStatus point is equal to 2.
• Select Event from the Severity drop-down listbox and define its priority in the
field. The two other kinds of Severity options are:
- State: no action is taken
- Alarm: the point is flagged, logged as an alarm, and is listed in the Alarm and
Events log (see “Configuring a Point to Trigger an Alarm” on page 4-8)
8. Click OK when done.

4-14 Memotec Inc.


5
Editing Screen Layouts

Memotec Inc. 5-1


Compass Operator Guide

5.1 About Editing the System Tree and Objects


Once you have defined the devices in your network, they appear in the TrueNorth System
Tree in a default position in the structure and contain a standard detail layout. However,
you can change where they appear in the System Tree and modify what information
appears in the Detail Screen layout.
There are two parts of the TrueNorth layout that you can modify:
• System Tree: you can create folders to group the objects as you wish and add
other devices directly to the hierarchy.
For more information, see “Editing the System Tree” on page 5-3.
• Detail Screen: when you click an object in the System Tree, its details appear in
a panel in TrueNorth. You can modify what appears in this panel for each object
in the System Tree.
For more information, see “Editing a Detail Screen” on page 5-4.

5.1.1 What can and cannot be edited


Although TrueNorth is highly customizable, there are elements which cannot be modified.
The elements you can modify are as follows:
• Overview: displays a high-level overview of the objects in your system.
• All Devices: contains all the devices and monitoring tools in your system.

Editable
overview, All Devices
and its contents.
Not editable:
System and its contents.

Figure 5-1: Editable and non-editable objects in the System Tree

However, you cannot edit the System folder or any of its contents. These items can only be
edited using the Compass Administrator.

5-2 Memotec Inc.


Editing Screen Layouts

5.2 Editing the System Tree


The System Tree contains a hierarchy of your devices and monitoring tools. You can edit
this layout and add new layers or modify the current structure.

In this example, we created two new


folders (Remote Devices and
Redundant Devices) and added the
devices to them.

The statuses of the devices are still


displayed in the new folders.

Figure 5-2: Editing the System Tree.

You can also create unattached items that you can configure and link to devices or other
tools (see “Editing a Detail Screen” on page 5-4).
To edit the System Tree, select Tree > Tree Editable to activate it. Once the System Tree
is in Edit mode, you can perform any of the following tasks:
• Create folders: right-click the overview folder and select New > New Folder.
• Drag existing objects into existing folders.
• Create objects: right-click the overview folder and select New > New Unat-
tached Item. You then would attach a device or tool to that item by modifying its
detail screen (see “Editing a Detail Screen” on page 5-4)
When done with editing the System Tree, reselect Tree > Tree Editable to deactivate it.

Memotec Inc. 5-3


Compass Operator Guide

5.3 Editing a Detail Screen


Each object in the System Tree has its own detail screen that you can customize in terms
of appearance, objects, and layout. You can add graphic links to devices, flowcharts,
fields, buttons, device status LEDs, etc. All of these objects appear when you double-click
the object in the System Tree.

Figure 5-3: Viewing detail screens for multiple devices

To edit a screen layout, follow these steps:


1. Double-click the object you wish to edit. The current layout of the selected object
appears in the detail panel.
2. Select File > Edit Screen. The detail panel becomes editable and displays a set of grid
points behind the current layout.
Also, the System Tree displays two tabs:
• System Tree: displays the current hierarchy of your devices. You can select the
element to edit in the detail panel. However, you cannot edit this tree in this mode
(see “Editing the System Tree” on page 5-3).
• Components: displays the objects and tools you can add to the current details
screen.
3. Edit the detailed layout of the element. There are three aspects of the layout you can
change:
• Object layout: add or modify elements within the object that display or contain
information about that object (see “Modifying an Object’s Detailed Layout” on
page 5-5).

5-4 Memotec Inc.


Editing Screen Layouts

• Background color: (see “Changing the Background Color” on page 5-10)


• Background wallpaper: (see “Displaying an Image in the Background” on
page 5-11)
4. When done, select File > View Screen. You will be prompted to save your changes:
• To save your changes, click Yes.
• To cancel your changes and revert to the last saved setting, click No.

5.3.1 Modifying an Object’s Detailed Layout


Once you activate the Edit mode, you can modify the Detail Screen by adding components
from the Components tab.
To add components to the detail layout area, follow these steps:
1. Select the Components tab.
2. Click the component you want to use (see Table 5-1 for more information about each
component) and click where you want to put them in the detail layout area.
3. Depending on the object, use the drag points to resize the component.
4. To configure the component, right-click the component and select Properties from
the pop-up menu.

Figure 5-4: Component Properties dialog box

5. Modify the component and click OK.


6. Once you are done editing this layout, select File > View Screen. To save the detailed
layout without exiting the Edit mode, select File > Save Screen.

Memotec Inc. 5-5


Compass Operator Guide

Component Definitions

Component Object Name and Description

The BBS Switch (Baseball Switch) object switches dynamically based


on the status of an associated Compass database point.

The MatrixSwitch object works matrix switch devices which use a


standardized matrix switch point naming.
For each output on the matrix switch there must be a status point with
the tagname OUTPUT_#, where # is the output number on the switch.
The OUTPUT_# point should be set to -1 to indicate that the output is
unconnected, otherwise the OUTPUT_# point should be set to the
number of the connected input.
You can associate this object with a system device in a similar fashion to
the auto-generated subsystem and device buttons that appear in various
detail screens.

The ColoredIcon object displays an image icon on a detail screen. The


color of the icon changes dynamically depending on the state of linked
objects/subsystems.

The Load object represents a ground or load in a communications


system.

The Jump object indicates that one path does not actually intersect with
another. This object is useful in detail screens with lots of connecting
lines that cannot be presented in a planar fashion easily.

The Label object displays text information on the screen.


When linked to a Compass database point, the label will update itself as
needed to reflect the most current point status.

The LED object displays an LED indicator on the screen that updates
itself dynamically based on the status of the Compass database point to
which it is linked.

The Alarmlist object defines a window in which all current system


alarms and inhibited alarms will display their status dynamically.

The AEM object displays an alarm viewer, an event viewer, or both on a


screen.

Table 5-1: Detail Screen Components

5-6 Memotec Inc.


Editing Screen Layouts

Component Object Name and Description

The LEDlist object defines a window that displays all points of a given
class (i.e. DI, FI, etc.) that are equal to a specified target value. The
LEDlist object is intended to be used on device screens only and will not
display data.

The DescLabel object is an object which identifies a label displaying


variable text information on the screen. These objects are typically used
to display the values of device status points that do not constitute
alarms.

The DescButton object allowS system operators to view the status of


and to set the values of corresponding status and control points in device
detail screens.

The RadioButton object is a simple control that can be associated with


a Compass database point which will determine its selected state; it can
also be simultaneously used to set output points.

The Checkbox object is a simple control that can be associated with a


Compass database point which will determine its selected state; it can
also be simultaneously used to set output points

The Slider object displays a point value with a minimum and maximum
value, allowing you to change the value by sliding the marker left or right.

The Spinner object displays a point value with a minimum and maximum
value, allowing you to change the value by clicking the Up or Down
arrows.

The Border object defines a titled line border that surrounds a group of
objects. You would use this object with the TabbedPane object to further
group related points.

The DevPointTable object can display dozens of Compass database


points for a particular device in a tabular format. The table can specify
just status points, just control points, or a combination thereof.

The Table object displays a comprehensive table on the screen.

The Rectangle object displays a rectangle on the screen that you can
size, rotate, color, and in which you can display text.

Table 5-1: Detail Screen Components

Memotec Inc. 5-7


Compass Operator Guide

Component Object Name and Description

The Ellipse object displays a rectangle on the screen that you can size,
rotate, color, and in which you can display text.

The TabbedPane object appears very commonly in device detail


screens and allows you to separate groups of points into pockets with
like functionality to un-clutter the device interface and make it more user-
friendly.

The Meter object behaves like an analog measurement device, such as


a voltmeter or ohmmeter. It displays the scaled value of a point;
however, it is limited to displaying a value between the ranges of 0-100.
In many cases, data must be scaled in order to use the Meter object
effectively.

The Meter2 object behaves like the Meter object, except that you can
customize the range.

The PolyLine object allows you to draw polygons and/or lines that are
not necessarily connected to another screen object.

The SubPanel object acts as a scrollable, dynamic display window that


can be used on device detail screens or system overview screens.

The BarGraph object allows you to plot point data values in a standard
vertical-bar graph format for visual comparison. The values are plotted in
real-time.

The Chart object displays a historical or live trend chart for up to 12


points.

The ScriptComponent object allows you to launch a coded script that


can analyze or manipulate data. You would link this component to a
script file.

Note: This object is fully functional, but it is designed for advanced


users who understand TrueNorth source code

The Globe object displays an interactive global view of Earth.

Table 5-1: Detail Screen Components

5-8 Memotec Inc.


Editing Screen Layouts

Component Object Name and Description

InputOutputR object
The InputOutput object is a right arrow shape which indicates the inputs
and outputs on a screen.

InputOutput object
The InputOutput object is a left arrow shape which indicates the inputs
and outputs on a screen.

Table 5-1: Detail Screen Components

Memotec Inc. 5-9


Compass Operator Guide

5.3.2 Changing the Background Color


By default, the background color of the detail screen is a gray, but you can change this
color to suit or contrast with the graphics you have selected to appear in the panel. For
example, if many of your buttons appear in gray, they may appear washed out with a gray
background. Therefore, you may want to select a darker or more colorful background
color to make them more distinct.

NOTE: The background color only applies to the currently selected object in the Sys-
tem Tree. By default, the background color for each object is gray.

To change the background, follow these steps:


1. Select File > Edit Screen. The Background menu becomes active.
2. Select Background > Background Color. The Choose Color dialog box appears.

Figure 5-5: Choose Color dialog box

3. Select a color for the background. You can select this color from one of the four tabs:
• Swatches: a collection of standard colors
• HSB: select colors according to Hue, Saturation, and Brightness
• RGB: select colors according to a mixture of Red, Green, and Blue
• State Colors: select colors according to the TrueNorth color legend for Status
and User States.
You can preview how a color appears in the application in the Preview panel. To
reset the color to last applied color, click Reset.
4. Click OK to apply your selection to the window panel. If you have an image currently
in the background, the color appears behind it (see “Displaying an Image in the
Background” on page 5-11).

5-10 Memotec Inc.


Editing Screen Layouts

5.3.3 Displaying an Image in the Background


You can select an image that will appear behind your components in the detail screen.
This can be useful to the layout of your objects if they need to correspond to specific
locations.
For example, if you had a number of devices in multiple locations in a city, you could
place a map of the city in the background and place the components according to their
locations on that map.

By placing a map
as the
background
image, you can
place the device
buttons where
they physically
reside in a city.

Figure 5-6: Using a map as a background image

NOTE: The background image you select only applies to the currently selected object.
By default, there is no background image for each object in the System Tree.

To make an image available to TrueNorth, you have two choices:


• Use the File > Add New Image command: copies the image file to the server PC.
• Copy the image files to the \Compass\fepxml\images directory. The files
that appear in this directory will be available for selection in TrueNorth.
However, you can only do this when you are working with the local host; if you
are working with a remote server, use the Add New Image command.

NOTE: If the image is larger than the TrueNorth window, it will not be resized, nor
will scrollbars appear. To make it fit the window, you must resize the image
file itself before loading it into TrueNorth.

Memotec Inc. 5-11


Compass Operator Guide

To change the background, follow these steps:


1. Select File > Edit Screen. The Background menu becomes active.
2. Select Background > Load Background Image. The Select an Image dialog box
appears.

All these files appear in the


\Compass\fepxml\images
directory on the server PC
running TrueNorth.

Figure 5-7: Select an Image dialog box.

3. Select an image from the dialog box and click OK. The selected image appears behind
the object in the panel.
4. To hide or remove the image, select one of the following commands:
• Hide/Show: select Background > Load Background Image. The image will
still be associated with the background, but it will be hidden. To display it again,
select Background > Show Background Image.
• Remove: select Background > Remove Background Image. The image disap-
pears and is no longer associated TrueNorth. The current background color
appears (see “Changing the Background Color” on page 5-10).

5-12 Memotec Inc.


A
Configuring Replication of Data

Memotec Inc. A-1


Newpoint Compass Operator Guide

A.1 Configuring the Compass NOC Server


This section explains how to configure replication data from one remote server directly
connected to CXU units to a NOC server at a different location. Most of the configuration
changes are done on the NOC server, which receives the data collected from all the remote
servers.

Data Replication

NOC Remote
Server Server
(London) (New York)

Figure A-1: Data replication across two servers and connected devices

Replication allows you to keep synchronous data on multiple servers, while keeping it
accessible to your users or to third-party users (providing either full or partial access).

NOTE: When editing the text files, you should use Wordpad. Using Notepad for edit-
ing files may add undesired spaces.

To replicate data on the NOC server, follow these steps:


1. Edit the file called host on the NOC and add a line for the remote node. You can edit
the file using a text editor.
You can find this file at the following path:
\windows\system32\drivers\etc\hosts
Example host file:
127.0.0.1 localhost
64.80.228.8 ny_node
2. In the host file, rename the remote_node to something meaningful; you should name
the server in way that describes its location or purpose.
In the above example, the remote node is called ny_node because the server is co-
located with the CXU in the New York (ny) region. Replace ny_node with the name
of your own remote node.

A-2 Memotec Inc.


NOTE: In this example, the remote node is the server that polls all the data from the
local CXU devices.

3. Also on the NOC server, edit the feprpl.cfg file and add the reference to the
remote node (in our example, this would be the ny_node). The feprpl.cfg file is
located in the \Compass\etc folder.
What you need to add to the feprpl.cfg file should look similar to this (you can
add it to the top of the list, right after the Field-Number Description items):
:ny_node:HOSTPFX:ny_node=MC_:
:ny_node:RX:1:0:.*/*I/ALL:
:ny_node:TX:0:0:MC_.*/*O/ALL:
:ny_node:TX:0:1:MC_.*/*I/ALL:
:ny_node:STATBIT:rplblok/DI/1:
:ny_node:TXEVT:rplblok/DI/2:
:ny_node:RXEVT:rplblok/DI/3:
:ny_node:RXLOG:1000:10000:
The feprpl.cfg file already contains a sample configuration, so you should
modify it to point to your own system as follows:
- Replace ny_node with the name of your own remote node.
- Replace MC_ to the prefix you use with your replicated buses.
4. Save the feprpl.cfg file.

Create Point Blocks


1. Launch Compass Administrator, right-click the Local Compass Node and select
Points from the pop-up menu.
2. Select the Local Compass Node and select System > Add Block to create a new
model. The Add Point Block dialog box appears.
3. Create a new model called rplblok and click OK.
4. Right-click rplblok and select Points from the pop-up menu.
5. Create the following three points: STATBIT, TXEVT, and RXEVT. Give them a
threshold of 0 as normal and 1 as fault. This will give Compass a few system points
that show the current status of the replication.
For more information on how to create points, see “Editing a Node’s Data Points” on
page 3-18.
6. Type the following command in a Command Line window:
rpldb -gcpb target_node
The gcpb command performs the following tasks:

Memotec Inc. A-3


Newpoint Compass Operator Guide

• g: gets the configuration from the remote node


• c: transfers device configurations
• p: transfers point models
• b: transfers miscellaneous point block data

Creating a new Supplemental Startup Command


1. Open Compass Administrator again, right-click the Local Compass Node and select
Configuration > Compass.
2. Click Add to create the following supplemental startup command:
• Startup Condition: Start in Run
• Startup Mode: Spawn and Continue
• Launch command: feprpl ny_node
• Process Monitor Device Tag: FEPRPL_NY_NODE
This startup command spawns a replicator pointed towards your target node
when Compass goes into run. Click OK when done.
3. Select the Local Compass Node and select Driver Select. The Driver Selection
dialog box displays the point files in the \remote directory (they were just pulled in
by the rpldb command).
4. Select the point files and click Add Driver.
5. Access the remote node server (NY), launch Compass Administrator, right-click the
Local Compass Node, and select Configuration > Compass.
6. Click Add to create the following supplemental startup command:
• Startup Condition: Start in Idle
• Startup Mode: Spawn and Continue
• Launch command: fepsync
• Process Monitor Device Tag: FEPSYNC
Click OK when done
7. While still in the Configuration dialog box (the System Parameters tab), type the
NOC IP address in the Time Sync Master Nodename field.
This will launch fepsync in Idle mode and have it sync the system clock with the
NOC so that your event log times match up. Alternatively, you can define the NOC
in the host file and use the host name instead of the IP.
8. Restart both Compass nodes and start them. All the data should now be replicated.

A-4 Memotec Inc.


B
Configuring the SNMP Agent

Memotec Inc. B-1


Newpoint Compass Operator Guide

B.1 About the SNMP Agent


This section explains how to configure the SNMP Agent (optional) in Compass. You can
use the SNMP Agent as a northbound interface, providing you with access to the Compass
data from an external application (using SNMP requests (get, getnext, getbulk, etc.).
You can also use the SNMP Agent to send SNMP traps to an external application when
Compass reports alarms.

B.1.1 Adding the SNMP Agent


To add the SNMP Agent to the startup routine, you must add fepagent to the Compass
startup. The fepagent controls the SNMP agent features.
To add fepagent to the Compass startup, follow these steps:
1. In the Compass Administrator window, right-click the Local Compass node and
select Configuration > Compass.
2. Select the System Parameters tab and click Add. The Configure Supplemental
Startup Commands window appears.

Figure B-1: Adding fepagent to the Startup process

3. Type fepagent in the Launch Command and Process Monitor Device Tag fields.

B-2 Memotec Inc.


4. Click OK. The fepagent command should now appear in the Supplemental Startup
Commands panel.

Other Applications on UDP Port 161


Make sure that no other applications are using UDP port 161, since it can cause conflicts
when the SNMP agent starts. To check if any other applications are already using the UDP
port 161, type the following command in a command line window:
netstat -n -a -b
If the port is used by an application, it will be listed with the application using it (see
Figure B-2).

Microsoft SNMP
agent (snmp.exe)
application is
running.

Figure B-2: List of actively used ports

NOTE: It can take a few seconds for the command to list all the ports in use. You need
sufficient permissions for this command to work.

The Microsoft SNMP agent (snmp.exe) application can cause a conflict with the SNMP
agent. To fix this, you should remove the Microsoft SNMP agent.
To remove the Microsoft SNMP agent, follow these steps:
1. Select Start > Control Panel > Add or Remove Programs > Add/Remove
Windows Components.
2. Disable the Management and Monitoring tools feature.
To permanently solve this problem, you can also stop the SNMP service using the
Services window as follows:

NOTE: You need administrative permissions for this to work.

1. Select Control Panel > Administrative tools > Services.


2. Right-click SNMP Service and select Properties. The SNMP Service Properties
dialog box appears.

Memotec Inc. B-3


Newpoint Compass Operator Guide

Disable the SNMP


service from this field.

Figure B-3: Disabling the SNMP service


3. From the Startup type drop-down listbox, select Disabled.
4. Click OK.

B-4 Memotec Inc.


B.1.2 Configuring the SNMP Agent to Send SNMP Traps
You now need to configure the SNMP Agent to poll values from the Compass server. It
can also be configured to send an SNMP trap to a third party application whenever an
alarm is detected in Compass.
To configure the SNMP Agent to send SNMP traps, follow these steps:
1. In the Compass Administrator window, right-click the Local Compass Node and
select Configuration > SNMP Agent. The Local Compass Node Configuration
dialog box appears.
2. Click Add to add an entry to the external application that wishes to receive the SNMP
traps. The Configure SNMP Host Items dialog box appears.

Fill in these two


fields.

The remaining
fields are
optional at this
time.

Figure B-4: Opening the Configure SNMP Host Items dialog box
3. Type the server’s IP address of the server with the external application in the
Hostname field and enable the Register Alarms feature.
4. Type the minimum alarm priority that should cause an SNMP trap to be sent in the
Min Alarm Priority field (range is between 100 and 255). This option is useful when
minor alarms should not send any SNMP traps.
If you need to send the SNMP traps to more than one destination, you can create
multiple SNMP agent hosts entries from the Configure SNMP Host Items dialog
box.
5. Click OK in the Configure SNMP Host Items dialog box and the Local Compass
Node Configuration dialog box.
6. Restart the Compass server, making sure the fepagent is starting normally.
You can check its status in the Change Compass State dialog box (it should appear

Memotec Inc. B-5


Newpoint Compass Operator Guide

as Starting process ‘fepagent’ ... initialization complete.)


7. Open a Command Line window, access the \compass\bin folder, and type the
following two commands:
• makemib -g
• makemib
The first command creates a configuration file in the \USR folder and the second
command generates various mib files in the \compass\etc\mibs folder.
8. Restart Compass and use the Compass Administrator tool to ensure that the startup
process is completed with no issues or conflicts.
9. Launch TrueNorth and verify that the fepagent process is running correctly.

You can see if there are any conflicts in by looking at these


devices in the TrueNorth tree and the Process Data panel.
If you have a conflict with UDP port 161, you will see that the
process is stopped (the icon will be red).

Figure B-5: Viewing the fepagent process in TrueNorth

B-6 Memotec Inc.


B.1.3 Sending the SNMP Trap to a Different Port
You can want to send an SNMP trap to a different port for security reasons (ex: firewall)
where specific ports can be blocked, or if port 162 is already in use on the remote third-
party server where the SNMP traps are being sent (see “Configuring the SNMP Agent to
Send SNMP Traps” on page B-5).
To send SNMP traps to a different UDP than the usual port of 162, you must edit the
snmpd.conf configuration file.
To edit this configuration file, follow these steps:
1. On the drive where Compass is installed, go to the \usr folder and edit the
snmpd.conf file. (you can use a text editor).
2. In the snmpd.conf file, locate the trap2sink command and add a community
string (usually private) and a new destination UDP port at the end of that line.
In the example below, we want to send the traps to UDP port 169.
It should look similar to the following:
########################################################
# Trap info
trapcommunity private
trap2sink 10.11.12.113 private 169
3. Save the file and restart Compass using the Compass Administrator tool.

WARNING: From now on, you should not enter the makemig -g command or it will
overwrite this change. You should make a backup of the updated
snmpd.conf file.

Memotec Inc. B-7


Newpoint Compass Operator Guide

B.1.4 Verifying that SNMP Agent is Sending/Receiving Traps


To verify that the SNMP agent is sending the SNMP traps, you need to use the Wireshark
application (visit http://www.wiresshark.org for more information and to download a
copy).
Once you have a copy of Wireshark, install it on the Compass server (Local) and on the
Remote server (Remote).
To verify that the SNMP agent is sending and receiving the SNMP traps, follow these
steps:
1. Decide if you wish to view the traps being sent or received:
• To verify the traps being sent, access the local Compass server.
• To verify the traps being received, access the remote server.
2. On the Compass server, launch Wireshark and select Capture > Options. The
Capture Options dialog box appears.

Select the type


of host from the
Interface drop-
down listbox.

Type the host


and remote
PC’s IP address
here.

Figure B-6: Wireshark Capture Options dialog box

3. Type host and the IP address of the remote PC in the Capture Filter field.
For example: host 10.11.11.114
4. Make sure the correct interface is selected in the Interface drop-down listbox and
click Start.
• To view the traps being sent, select Local from the Interface drop-down listbox.
• To view the traps being received, select Remote from the Interface drop-down
listbox.

B-8 Memotec Inc.


The traffic on the selected host appears in the Capturing Wireshark window.

Figure B-7: List of traffic for the selected host in Wireshark

If there is too much displayed traffic, type the following command in the Filter field
in the traffic window.
snmp.trap || snmp.sNMPv2_Trap
5. To generate traps, restart the Compass server using the Compass Administrator tool.
The traps should now appear in the traffic list if the SNMP Agent is running and if
no alarms are present.
• If you are on the Local host, this window displays the traps being sent.
• If you are on the Remote host, this window displays the traps being received.

NOTE: You may need to stop the capture if you want to see the packets captured.

If you changed the UDP destination port for the SNMP traps, the display filter indicated
above won't work. You should instead use the following display filter (replace 169 with
the port you need to use):
udp.dstport == 169

Memotec Inc. B-9


Newpoint Compass Operator Guide

Decoding the SNMP Traps


To decode the SNMP traps received on port 169 (or the port you are using), you need to
tell Wireshark that the traffic on this UDP port is SNMP. This is because UPD port 169 is
not normally used for SNMP traffic and Wireshark cannot automatically decode it as
SNMP (like when SNMP is sent to UDP port 162).
To force Wireshark to decode these traps (either being sent or received), follow these
steps:
1. Right-click one of the lines in the traffic list and select Decode as from the pop-up
menu. The Decode As dialog box appears.
2. Select the Transport tab, select the destination UDP port 169 (or any other ports used
for sending SNMP traps) and select SNMP from the list on the right of the dialog box
(see Figure B-8).

Figure B-8: Wireshark Decode As dialog box

3. Click OK.
All the frames with a destination set to the UDP port set above should now be shown as
SNMP instead of just UDP frames.

B-10 Memotec Inc.


Memotec Inc. B-11
REACH FURTHER. OFFER MORE.
Contact Memotec:

tel.: +1-514-738-4781
e-mail: COE@memotec.com

7755 Henri Bourassa Blvd. West


Montreal, Quebec | Canada H4S 1P7 www.memotec.com

También podría gustarte