ADC SWATCH (v3.0) Switch Monitoring Software) User Manual)

Transcription

1 ADC SWATCH (v3.0) Switch Monitoring Software) User Manual) Content Page INTRODUCTION... 1 Revision History... 1 Trademark Information OVERVIEW System Requirements INSTALLATION GRAPHICAL USER INTERFACE CONFIGURING THE PROGRAM Using the Preferences Command Unit Properties Screen Unit Status Screen Creating a New Database Adding a Site Adding a Unit to the Site Map Moving a Unit/Port to Another Site PROGRAM OPERATION SWATCH Global Preferences and Port Properties Scanning and Communication Errors Site Map/Unit List Event Log Capture Filter Display Filter SYSTEM MONITORING Port Status SWATCH GLOSSARY CUSTOMER INFORMATION AND ASSISTANCE INTRODUCTION Revision History This document covers the installation and use of the SWATCH Switch Monitoring Software for use with RF Worx RDS-1 hardware. ISSUE DATE REASON FOR CHANGE Issue 1 09/2000 Original Trademark Information ADC and ADC Telecommunications are registered trademarks of ADC Telecommunications, Inc. SWATCH is a trademark of ADC Telecommunications, Inc. RF Worx is a registered trademark of ADC Telecommunications, Inc Rev A Page 1

2 1. OVERVIEW This manual details the SWATCH software. This program monitors operating parameters for RDS-1 hardware (Dual A/B, Redundant Amplifier, Auto-Switchback, and Split-Linked A/B). This section assumes the user has basic knowledge of PC operation and some experience with the Windows interface. 1.1 System Requirements The SWATCH software is for use on any personal computer running Windows operating systems (95/98/NT/2000) with a 133 MHz Pentium processor (or faster) and at least 16 MB of RAM, 32 MB recommended. Note: Windows 2000 Professional requires at least 64 MB of RAM. 2 INSTALLATION Insert the SWATCH disk into your computer s CD-ROM drive. The installation program should begin automatically. If the installation program fails to start, perform the following procedure: 1. Click Start on the windows taskbar. 2. Select Run from the start menu. 3. Enter the following string in the Run dialog box: (X = your CD-ROM drive) X:\swatch\setup.exe Figure 1. Run Dialog Box 4. Follow the prompts in the installation program to install the SWATCH program on your PC. After the program has been successfully installed, you may run the program from the Windows program menu or from the desktop shortcut. Page 2

3 3 GRAPHICAL USER INTERFACE (GUI) All relevant terms for the user interface are called-out in Figure 2. These terms are used frequently throughout the manual; therefore this picture should serve as a reference for topics covered elsewhere. A brief description of each term follows Figure 2. MENU BAR TREE PANE UNIT PANE DISPLAY BAR STATUS BAR EVENT PANE Figure 2. SWATCH GUI Menu Bar Opens drop-down menus that house program options. Tables 1 through 4 on the next page contain a description of each menu. Tree Pane Displays either the Site Map or Unit List Status Bar If enabled, displays tips, mouse pointer references, and mail reporting results. Event Pane Displays the program s Event Log Unit Pane Displays information about the individual units within the database Page 3

4 Table 1. File Menu New Creates a new document Open Opens an existing document Save Saves an opened document using the same file name Save As Saves an opened document to a specified file name Preferences... Opens the global Preferences dialog box 1, 2, 3, 4 A list of the most recently opened files Exit Closes the program Table 2. View Menu Status Bar Displays or hides the Status Bar Unit List Displays the units by serial number in the Tree Pane Site Map Displays the Site Map tree in the Tree Pane (Default) Display Unit Status Displays the current unit/port power and failure status in the Unit Pane Unit Properties Displays the unit and port properties in the Unit Pane Page 4

5 Table 3. Logging Menu Status Scan Starts or stops periodic scan for status and power levels Capture Filter... Opens dialog to configure which events are saved to disk Display Filter... Opens dialog to configure which events appear in the Event Pane Discovery Scan Starts or stops periodic scan for new units (Applies to RDS2 units only) Table 4. Help Menu Swatch Help Opens the Swatch Help program. Help Topics Displays an index of help topics. What s This? Opens a pop-up Help program. Click on an item in the program and you will see a pop-up box with a brief description of that item. About Displays the version number of this application. Page 5

6 4 CONFIGURING THE PROGRAM Upon initial launch (after installation), a setup wizard (Figure 3) will guide you in a step-bystep manner through the process of setting up global settings for the program. Note: You may bypass the startup wizard and access the same screens by running the Preferences command (See Section 4.1). Figure 3. Swatch Startup Wizard The following section provides a detailed description of the Preferences command, however, the same dialog descriptions apply to the setup wizard. 4.1 Using the Preferences Command This dialog sets up global preferences for the program. Open the preferences by using the drop-down menu as shown in Figure 4. Right-click the Tree Pane or the Event Pane to access the Preferences command. Page 6

7 Figure 4. Open Preferences File Tab This tab (Figure 5) provides options for the program s Site Map and Event Log. Site Map If checked, you may specify a particular site map file to open when the program is launched. The default setting is no site map. Event Log Specifies the file to which the events for a particular database (site map) are logged. The default setting is to save all events to the event log named Swatch.log. This box must be checked to save new events to the event log or to see recorded events displayed in the event pane. Figure 5. File Tab Page 7

8 4.1.2 Power Meters Tab (RDS2 Units Only) This tab (Figure 6) enables the user to establish global power values (minimum and maximum thresholds, minor threshold, and power units) for the system. Note: The global settings can be overridden in the Properties screen of any individual unit. Note: The Restore Defaults button will restore the system defaults to the page on which the button was pressed. Thresholds and Calibration (RDS2 Units Only) Enable Threshold Adjustment Check this box to enable threshold values to be entered in the threshold windows below. Enable Side A/B Max Threshold Check these boxes to enable the creation of maximum threshold values for side A and/or B. Max Threshold Enter the system s maximum threshold value (if threshold adjustment enabled) in this edit box. Min Threshold Enter the system s minimum threshold value (if threshold adjustment enabled) in this edit box. Enable Recalibration Check this box to enable system recalibration. Return Delay After a failure, the amount of time (in seconds) that the primary must be in a normal state before the unit will switch from the backup to the primary. Enter a number between 1 and 255 in the edit box. Enable Minor Threshold Check this box to enable minor threshold values to be entered in the minor threshold edit box below. Minor Threshold Enter the minor threshold value (if enabled) in this edit box. Page 8

9 Figure 6. Power Meters Tab Power Units (RDS2 Units Only) This section allows you to choose how the program displays the power units. Show Total Power (dbm) Click this radio button to display the total (combined) power of all channels in the system. Show Average Channel Level (dbmv) Click this radio button to display the average power level for each channel in the system. Enter the combined channel count in the edit box. Show Average Channel Level Between Split-Linked Ports Click this radio button to display the average power level of all channels in a split-linked system. Enter the channel count for Port 1 in the upper edit box and the channel count for Port 2 in the lower edit box. Page 9

10 4.1.3 COM Ports Tab This tab (Figure 7) is used to establish COM port settings. The SWATCH program is designed to communicate with any COM port (1 through 8) on any PC. COM Port Check Boxes If you know which COM ports are available on your PC, select them by left-clicking the check box next to the corresponding port. Open Selected Ports The program will try to open only those ports that are selected in the above section. Any selected port that is determined to be unavailable will be unselected by the program. Open All Ports The program will automatically detect any available COM ports on your PC. Those ports determined to be available will have a check placed next to them in the COM Port Check Boxes. Note: A dialog box will appear when the program has determined that a port is not available Scan Tab Figure 7. COM Ports Tab Select this tab (Figure 8) for the input and selection of scanning parameters. Status Scan The status scan determines if an event, (e.g. an alarm) has occurred in all defined online units. The top dialog box in this section displays the scan period (in milliseconds) for the selected unit. The bottom box displays the scan period (in milliseconds) for all other units in the system. Select the check box to start the status scan when the program is launched. If Status Scan is enabled on program start, a Site Map should be opened on program start (see File Tab section) or Discovery Scan (see below) should be enabled on program start. Page 10

11 Note: By default, the check box is initially left blank. It is recommended that the program launch status scan be enabled after system hardware has been entered into the program. Note: A Site Map must be present to launch the status scan at start-up. Discovery Scan Not applicable with RDS-1 units. Figure 8. Scan Tab Reporting Tab The SWATCH program is designed to alert the user (via ) when errors or warning conditions exist. Select this tab (Figure 9) for the input and selection of notification parameters. Note: systems must support Winsock 1.0 or better and have an operating IP network connection. Send on Failure Select this check box to be notified if a failure occurs. Send on Warning Select this check box to be notified if a warning occurs. Minimum Time Between Messages Enter the amount of time (0 to 240 minutes) between notifications. Page 11

12 Figure 9. Reporting Tab Mail Server Enter your server information in this box. To Enter the destination address in this box. From Enter the source address in this box. Subject Enter a default subject in this box. Message Enter the text of the message in this box. The message may contain tokens that will be converted based on the event being reported. Tokens consist of the percent character, followed by a zero or more decimal digits, followed by a character listed below. The digits determine the maximum width of the substituted result, taking the right most characters. A width of four will convert ABC123 to C123. With no digits, the result will have no truncated characters. %e Event Name %s Event severity, 0= normal, 1=warning, 2=fail %d Date of event %t Time of event %u Unit serial number, if applicable %p Port number, if applicable, 1 or 2 %n Port name, if applicable %% The percent character COM Port Trace If enabled, creates a trace file that collects a trace of COM port activity. The file would then be sent to ADC Customer Support for the diagnosing of any problems. The trace is normally off. Page 12

13 4.2 Unit Properties Screen The Unit Properties screen is accessed from the menu bar under the View command. This screen (Figure 10) displays information about a specific RDS unit. Select the unit in the Unit List/Site Map then Right-click the Tree Pane or the Event Pane to access the Unit Properties command. Add Add a unit with the serial number shown to the Site Map. The serial number must be unique. Each port name must also be unique. If the port name is blank, SWATCH will generate one from the serial number and the port number, P1 or P2. (See Section 4.6, Adding a Unit to the Site Map.) Update Changes the Site Map information for a unit with this serial number already present in the Site Map. Find Search the Site Map for a unit with the displayed serial number. First Unit Click this button to move to the first unit in the unit s sub-tree. This will change the Unit Properties screen to that of the first unit. Next Unit Click this button to move to the next unit in the unit s sub-tree. This will change the Unit Properties screen to that of the next unit. Use this to step through all units in the Site Map. Serial Number The serial number of the RDS unit is entered (either manually or automatically, see Section 4.6, Adding a Unit to the Site Map) in this edit box. Function The function (type) of the RDS unit is selected from this drop-down menu. Some values include the text (Preliminary). The SWATCH support for these units is not officially released. These units are shipped with an updated version of the software, which officially supports that unit. Install the new version if Discovery Scan adds such units to the Site Map. Edit/Cancel Button This button label displays Cancel whenever some property value has changed and has not yet been saved with Add or Update. These values are discarded if Cancel is clicked. Whenever there are no unsaved values, the button label is Edit. This state is useful when Status Scan is enabled and the selected unit is being scanned at frequent intervals. Click Edit to block the scan responses from changing the display. Once the values are saved or canceled, the block is removed. Page 13

14 Figure 10. Unit Properties Screen Locate Tab The Locate tab provides unit-specific COM port options. COM Port Displays the COM port to which the unit is connected. Status Displays the results of Ping, Find COM Port, or Find All Units actions. In the case of Ping, it shows the status byte(s) returned after a Get Status request is sent to the unit. Other messages state the progress of the action. Ping Verifies that the unit is attached to the selected COM port. Find COM Port The program will attempt to contact the unit using all available COM ports and will also determine the function type of the unit after finding the COM port. Find All Units The program will search all available COM ports for new units by forcing the Discovery Scan to take place. (RDS2 units only.) Communication Errors Clicking the Clear Errors button clears a counter maintained for each unit. When a unit does not respond to a request, even after several retries, this is one communication error. This results in a warning Event Log entry and the port icon turns yellow. If after several attempts the count increases to 10, the unit is presumed to have failed and no further communication is attempted. The port icon turns red, and a failure event is logged. This button clears the count. The operator should use it after attempting to correct the communication problem Port Tab(s) The Port Tab (Figure 11) contains information about a specific port within a particular unit. Name Displays the user-assigned name of the port. Page 14

15 Note: You may change the name of the unit at any time from this field by entering the new name and clicking Update. Site Displays the site where the port is located. Edit Sites Allows the user to change or add sites to the database. (See Section 4.5, Adding a Site.) Description Displays information the user deems relevant regarding the port. Off-Line The unit is not connected. Click this box to prevent the program from attempting communication with the port. The unit/port will appear gray in the Unit List/Site Map. Global Preferences SWATCH will configure RDS2 units to settings defined in the Preferences-Power Meters tab. Local Preferences Allows RDS2 units to be individually configured. Note: Switching from global to local will restore the former local settings for that specific RDS2 unit. Enable Thresholds Enables the local threshold setting and enables/disables calibration for RDS2 units. Note: To adjust threshold settings, both the local and global settings must be enabled. Set Power Units Sets the local power units. This overrides the global power unit settings. Figure 11. Unit Properties Port Tab Page 15

16 4.3 Unit Status Screen As the name implies, the Unit Status Screen displays the current status of the unit. This screen is used to monitor the power information, set the unit s minimum and maximum thresholds (if enabled), calibrate/recalibrate the unit, and has text areas for a unit description and failure history. The Unit Status screen is accessed from the menu bar under the View command. Select the unit in the Unit List/Site Map then Right-click the Tree Pane or the Event Pane to access the Unit Status command. Serial Number Displays the unit s serial number. Description Displays user-input description of the unit. Failure History To be implemented in a future release. This screen is covered in greater detail in Section 6, System Monitoring. Figure 12. Dual A/B Unit Status Screen 4.4 Creating a New Database Create a new database by using the File New command from the menu bar. (Figure 13.) A blank database will appear. Page 16

17 Figure 13. Creating a New Database 4.5 Adding a Site Perform the following procedure to add a site to the Site Map: 1. Use the View Unit Properties menu command to switch the Unit Pane to the Unit Properties view (Figure 10). Right-click the Tree Pane or the Event Pane to access the Site Map Properties command. 2. Select a Port tab. 3. Select Edit Sites. The Manage Site Map dialog (Figure 14) will appear. Figure 14. Manage Site Map Dialog 4. In the Parent drop-down menu, select an existing site as the parent of the new site. If the parent is blank, the new site will be at the uppermost site position. 5. Select an existing site to change, or select the blank site name. Page 17

18 6. Enter a new site name in the Name edit box. 7. Click Add to add a new site to the parent, or click Update to change the name of an existing site. 8. To remove a site, highlight the site in the drop-down menu and click Delete. 4.6 Adding a Unit to the Site Map Perform the following procedure to add a RDS-1 unit to the program: 1. Use the View Unit Properties menu command to switch the Unit Pane to the Unit Properties view (Figure 10). 2. Enter the serial number and function of the unit. 3. Select the Locate tab and enter the COM port. 4. Click on the port tab(s) and select a site to which the unit/port will be assigned. 5. Select the Add button Figure 15. Entering a Unit Into the Database Note: You can also enter only the serial number, and then select Find COM Port to let the program determine the function and COM port. Note: The Dual A/B Switch (2 ports) will appear as two logical ports with corresponding tabs labeled Port 1 and Port 2 all other models will have one tab labeled Port. Page 18

19 4.7 Moving a Unit/Port to Another Site Perform the following procedure to move a unit or individual port to another site in the Site Map. 1. Select the unit or port you wish to move by left clicking on that item in the Unit List/Site Map. Use the View Unit Properties menu command to switch the Unit Pane to the Unit Properties view (Figure 10). 2. Select the Port tab (Figure 16). 3. Click on the Site drop-down menu and select the site to which you would like to move the unit/port. 4. Click the Update button. The item will appear in the Site Map under its new site. Figure 16. Moving a Unit/Port to Another Site 5 PROGRAM OPERATION 5.1 Swatch Global Preferences and Port Properties The power meter settings, calibration enabling, and return delay values for one port of a Dual A/B unit are controlled through two mechanisms: Global Preferences establish system wide settings. Some global preferences are used to force all ports to use global values for certain functions. Global preferences also provide the values for those ports that individually are configured to use global preferences even when they have the option to be locally configured. The Unit Properties determine the settings for the port(s) of a unit when not overridden by global enable preferences. These are controlled in the Unit Pane via either a Properties display or a Status display. The unit and port properties are saved in the Site Map file, even when not enabled for use. Page 19

20 5.2 Scanning and Communication Errors The SWATCH program scans the system at an interval established in the Preferences dialog. During the scanning process the program ensures that each unit is connected to its respective COM port. If up to ten communication errors are encountered, a yellow icon will appear in the Site Map/Unit List. If, after ten system scans, a unit does not respond it is determined to be off-line and will appear in red in the Site Map/Unit List. An entry will also be added to the Event Log. 5.3 Site Map/Unit List The Site Map and Unit List are a graphical representation of the units in the system. The Site Map displays units in a tree format whereby individual units or ports are sub-units of larger branches or nodes. (Figure 17.) Figure 17. Site Map The Unit List displays all units in the system in numerical order (Figure 18). Note: Dual A/B and Split-Signal switches will display unit status for only port 1. The site map must be used to access port 2. Page 20

21 Figure 18. Unit List The unit status is displayed using a coloring scheme detailed in Table 5. By looking at the Site Map or Unit List, it is easy to find any units that are not functioning normally. Table 5. Color Code Indications COLOR CODES Green Yellow Red Blue Gray CONDITION Normal operating condition no errors. A warning condition 1-9 communication errors. A failure state 10 communication errors, not calibrated, or unit has failed. Loss of input signal (Redundant Amplifier only). The unit is off-line or not connected. The Site Map reports any errors up through the tree, with each subsequent (superior) node appearing in the color that represents the most serious condition found in the (inferior) nodes. The Unit List displays errors on a unit-by-unit basis. 5.4 Event Log The Event Log (Figure 19) is a list of system events displayed in the Event Pane. The event log can capture and display any combination of normal events, warnings, or failures. Settings for this function are covered in Sections 5.5 and 5.6. Clicking on an event in the date column of the event log related to a particular unit will open the Site Map/Unit List and highlight the port (if port specific) or unit in question. The fields can be sorted by date, time, name, or event in either ascending or descending order. Click on the desired field on the Display Bar and the log will be rearranged. The Event Log will display the last 1000 events that pass through the Display Filter; however, the Event Log file may contain more events. Change the filter to become more selective, or change the time range to exclude the newer events. Page 21

22 Figure 19. Event Log 5.5 Capture Filter This dialog (Figure 20) allows the user to choose which events are written to the Event Log file. The dialog provides the option of logging normal events, warnings, and/or failures. Note: This filter does not control what is viewed in the Event Log. (See Section 5.6, Display Filter) Figure 20. Capture Filter Page 22

23 5.6 Display Filter This dialog (Figure 21) allows the user to choose which events are displayed in the Event Log Pane. The dialog provides the option of displaying normal events, warnings, and/or failures, as well as date-specific logging. Figure 21. Display Filter Select the Follow Site Map check box to display events for only those units in the selected Site Map sub-tree. For example, if a particular unit appears in yellow (Figure 22) in the Site Map and you would like to view the events for that unit only, select Follow Site Map, then click on the unit in question and the information for that unit will be displayed in the Event Log Pane. Figure 22. Follow Site Map Example Page 23

24 6 SYSTEM MONITORING System monitoring is done from the Unit Status Screen. The colored bars display the status of the primary/backup sides of the unit based on the coloring convention detailed in Table 5 on Page 21. Select the unit in the Unit List/Site Map then right-click the Tree Pane or the Event Pane to access the Unit Status command. Serial Number Displays the unit s serial number. Description Displays user-input description of the unit. Failure History Displays a list of unit failures. Figures 24 through 27 shows the Unit Status Screens for the RDS-1 units. Figure 24. Dual A/B Switch Unit Status Screen Figure 25. Auto Switchback Unit Status Screen Page 24

25 Figure 26. Redundant Amplifier Unit Status Screen Figure 27. Split-Linked A/B Switch Unit Status Screen 6.1 Port Status The Port Status is determined by the unit and reported to the SWATCH program. The Port Status icon lies within the Unit Status screen. The icon will be color-coded using the same convention as detailed in Table 5, Page 21. Clicking on the icon brings up the Port Status dialog (Figure 28). Page 25

26 Figure 28. Port Status The Port Status dialog provides a graphic overview of the problems reported (if any). 7 SWATCH TM GLOSSARY Calibration Determines the ideal power level for the system. The unit is fed a known nominal signal and it records that signal as the optimal signal strength for normal operation. Capture Filter Dialog that allows the user to choose which events are written to the Event Log file. COM Port Serial RS-232 Input/Output port on a PC. Linked to an RDS unit s RS-485 communications port via serial cables and an RS-232 to RS-485 converter. Discovery Scan Scans all defined COM ports and will detect any new or missing RDS2 units. Display Filter Dialog that allows the user to choose which events are displayed in the Event Pane. Event Log A list of events written to a file and displayed in the Event Pane. Clicking on an event in the event log related to a particular unit will open the Site Map/Unit List and highlight the unit in question. Event Pane Pane at the lower right of the program window, displays the program s Event Log. Maximum Threshold The acceptable deviation above the optimal (calibrated) signal strength that will keep the unit running at an acceptable level. Exceeding this level is interpreted as a failure and will cause the unit to switch to the backup side. Menu Bar A menu list at the top-left of the program window from which various program settings can be created or changed. Opens drop-down menus that house program options. Page 26

27 Minimum Threshold The acceptable deviation below the optimal (calibrated) signal strength that will keep the unit running at an acceptable level. Exceeding this level is interpreted as a failure and will cause the unit to switch to the backup side. Minor Threshold This number is used to establish a warning level. If the power input is within the minor threshold figure (above or below) of the established maximum or minimum threshold. The Power Meter appears in yellow (warning condition). Port Status A port s internal assessment and reporting of its status to the program, displayed in the Port Status dialog. Port Status Dialog Contains the Port Status report. Power Meters The display of the programs interpretation of what is occurring in the system. This is a graphical rendering that allows the user to monitor how each unit (port) is performing. It should be noted that the decision to switch to a backup side is made by the unit itself the software is only used for monitoring purposes. Preferences A series of screens used to establish global program settings. Return Delay After a failure, the amount of time (in seconds) that the primary side must be in a normal state before the unit will switch from the backup to the primary. Site Map Nested tree structure contained in the Tree Pane that shows units grouped by location. Status Bar Bar at the bottom of the program window that, if enabled, displays tips and mouse pointer references. Status Scan A periodic scan of the system units for status and power levels. Tree Pane The pane that spans the left side of the program window. Displays either the Site Map or Unit List. Unit List Contained in the Tree Pane, shows a list of all the units in the system, in numerical order. Unit Pane The pane at the upper-right of the program window that displays information about the individual units within the database. Unit Properties Screen Screen that appears in the Unit Pane, displays information about an individual unit. Unit Status Screen Screen that appears in the Unit Pane that displays a unit s status. Page 27

28 8 CUSTOMER INFORMATION AND ASSISTANCE EUROPE SALES ADMINISTRATION: TECHNICAL ASSISTANCE: U.S.A. OR CANADA SALES: EXTENSION 3000 TECHNICAL ASSISTANCE: EXTENSION 3475 (24 HOURS A DAY, 7 DAYS A WEEK) ELSEWHERE SALES ADMINISTRATION: TECHNICAL ASSISTANCE: (24 HOURS A DAY, 7 DAYS A WEEK)? B To obtain product information using the Internet, visit the ADC web site at Technical assistance may also be obtained via at technical@adc.com. ADC also offers assistance in system integration, available through the ADC Integrated Solutions Group and its international offices. The central phone number in the United States is Contents herein are current as of the date of publication. ADC reserves the right to change the contents without prior notice. In no event shall ADC be liable for any damages resulting from loss of data, loss of use, or loss of profits and ADC further disclaims any and all liability for indirect, incidental, special, consequential or other similar damages. This disclaimer of liability applies to all products, publications and services during and after the warranty period. This publication may be verified at any time by contacting ADC s Technical Assistance Center at , extension 3475 (in U.S.A. or Canada) or (outside U.S.A. and Canada), or by writing to ADC Telecommunications, Inc., Attn: Technical Assistance Center, Mail Station #71, P.O. Box 1101, Minneapolis, MN , U.S.A. All Rights Reserved Printed in U.S.A. Page 28