ULP EMS Operator Guide On-Ramp Wireless Confidential and Proprietary. This document is not to be used, disclosed, or distributed to anyone without express written consent from On-Ramp Wireless. The recipient of this document shall respect the security of this document and maintain the confidentiality of the information it contains. The master copy of this document is stored in electronic format, therefore any hard or soft copy used for distribution purposes must be considered as uncontrolled.
On-Ramp Wireless Incorporated 10920 Via Frontera, Suite 200 San Diego, CA 92127 U.S.A. Copyright © 2011 On-Ramp Wireless Incorporated. All Rights Reserved. The information disclosed in this document is proprietary to On-Ramp Wireless Inc., and is not to be used or disclosed to unauthorized persons without the written consent of On-Ramp Wireless. The recipient of this document shall respect the security of this document and maintain the confidentiality of the information it contains.
Contents 1 Introduction ........................................................................................................... 1 2 ULP Network Overview ......................................................................................... 3 3 Maintaining and Operating the ULP Network ..................................................... 5 3.1 Logging in to the EMS ................................................................................................................ 5 3.2 Types of Accounts.
ULP EMS Operator Guide Contents Figures Figure 1. EMS UI Terminology ......................................................................................................... 2 Figure 2. Functional Overview of the ULP Network ......................................................................... 3 Figure 3. NODE FREQUENT REJOIN Alarm Email ...................................................................... 54 Figure 4. Reminder for the Alarm ..........................................................
Revision History Revision Release Date Change Description 01 December 10, 2010 Initial release of operator guide complete to system release 1.2.4.7. 02 December 13, 2010 Updated to be consistent with system release 1.2.5.2. Changes include: Screenshots for active directory Minor changes to procedure for adding and starting up APs 03 May 3, 2010 Updated to be consistent with system release 1.2.5.13.
1 Introduction This document provides Element Management System (EMS) administrators and/or operators with the following information: EMS account configuration and maintenance. Ultra-Link Processing™ (ULP) network commissioning and configuration. ULP end device commissioning and configuration. Day to day network operation, including network alarm monitoring and network alarm acknowledgment.
ULP EMS Operator Guide Introduction The following figure displays the EMS User Interface (UI) terminology. Screen Device Listing Pane Device Selection Pane Tab Alarm Pane Note: You may need to use the slider to see the entire Alarm Pane. Button Figure 1. EMS UI Terminology NOTE: The previous figure shows the EMS UI which contains panes and tabs with a drop-down list (Auto Refresh: OFF). Use this drop-down list to control the refresh rate of the screen.
2 ULP Network Overview The On-Ramp Wireless ULP technology network monitors critical infrastructure devices in a wide-area territory. A network deployment contains many Access Points (APs) that are geographically distributed in a specific territory. The APs create a wireless network which monitors end devices.
ULP EMS Operator Guide ULP Network Overview NOTE: Operators can use the On-Ramp Wireless CIMA and dashboard for application-level data collection and application alarms.
3 Maintaining and Operating the ULP Network The following sections describe how to maintain and operate the ULP network through the OnRamp Wireless EMS. 3.1 Logging in to the EMS To log in to the EMS, complete the following steps: 1. Open a web browser, and type: http://:8080/nms 2. From the Source drop-down list, select company Domain or Local Account. Typically, it is expected that installations use the Active Directory.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 4. In the Password field, type the password for this account. NOTE: Use the Active Directory account password when logging in to the EMS through the company Domain. If the company Domain is not active, use an account that was created in Maintaining a Local Account. 5. Click Login. 3.
ULP EMS Operator Guide Maintaining and Operating the ULP Network The following sections describe each type of account in the EMS. Administrator Account In new EMS installations that are not using Active Directory controlled logins, the administrator (admin) account is the only default account available. The admin account only manages accounts created in Local Accounts. If using Active Directory, the internal company's IT group maintains the account.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.3.1 Adding a User Account To add a local EMS user account, log in with an administrator account, and complete the following steps: 1. On the login screen, click the Admin tab. 2. Click Add User.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3. In the User ID field, type the user ID for this account. This is the same user ID that is entered when logging in to the EMS with this new account. 4. In the First Name field, type the first name of the user for this account. 5. In the Last Name field, type the last name of the user for this account. 6. In the Password field, type the password for this account. 7. In the Confirm Password field, confirm the password entered above. 8.
ULP EMS Operator Guide Maintaining and Operating the ULP Network The method in which operators use to initialize a network depends on the following items: Complexity of the operator's network Availability of site-specific information at the time of initialization 3.4.1 Configuring the Network with the Ingest File - Initialization Steps To configure the ULP network with the ingest file method, the operator must first have a valid ingest file.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 4. Click Browse, and navigate to the location of the ingest file. 5. Click Upload. 6. Click Save. The pop-up window asks the operator to confirm the configuration of the Gateway. 7. Click Yes. 3.4.3 Restarting the Gateway After uploading the ingest batch file, restart the Gateway. To restart the Gateway, complete the following steps: 1. In the Devices pane, click Gateway. 2. Select the Gateway to restart, and click Restart Gateway.
ULP EMS Operator Guide On-Ramp Wireless Confidential and Proprietary Maintaining and Operating the ULP Network 12 010-0045-00
ULP EMS Operator Guide Maintaining and Operating the ULP Network 6. After the AP adjusts the GPS time sync and RF Metrics, the AP transitions from a yellow state to a green state as shown below. 3.5 Configuring the Network Manually The following sections describe how to perform a manual network configuration. 3.5.1 Adding the Gateway The ULP Gateway is the point of entry for configuring the ULP network.
ULP EMS Operator Guide Maintaining and Operating the ULP Network To add and/or configure the Gateway, complete the following steps: 1. After logging in to the EMS, click the Devices tab, and select Gateway from the Device Selection pane. NOTE: For a new network, preconfigured Gateways, access points, and/or nodes will not be displayed. 2. Click Add Gateway.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3. In the Add New Gateway window, complete the information for the following fields. a. In the Host Address field, type the IP address (or DNS resolvable name) for the machine running the ULP Gateway. b. In the Control Port field, the default value is 4021. Do not change this value. c. Optional: In the Description field, type a description for the Gateway.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 2. In the Device selection pane, click on the GW ID of the Gateway that was added. The Gateway Configuration window is displayed. 3. Optional: In the Description field, type a description for the Gateway. The description can be any user-specific information, such as physical location or internal name for the Gateway. 4. Click the Basic Config tab.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 5. In the Gateway Configuration window, complete the information for the following fields. a. In the Name field, type a descriptive name for this Gateway. b. In the Gateway Device Type field, type gw. c. In the Upstream Control Socket Port (Numeric: 1024-65535) field, the default value is 4021. If the network does not use the default value, update the port value. d.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 10. Click the ULP Config tab. 11. In the Gateway Configuration window, complete the information for the following fields. a. In the System ID (Numeric 0-255) field, type the operator-specific System ID that matches the operator's network system ID. b. In the Bandwidth field, the default value (1MHz) is selected from the drop-down list. Do not change this value. c. In the Broadcast Spreading Factor field, select 2048 from the drop-down list.
ULP EMS Operator Guide Maintaining and Operating the ULP Network g. In the Keep Alive Message Interval (Seconds 5-60) field, type 5. NOTE: This parameter affects the generation of the GW Health alarm that the EMS generates. If the GW has not generated a keep alive signal within 3* in this field, the GW Health alarm will be triggered. 12. Click Save. NOTE: A pop-up window asks the operator to confirm the restart.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 18. Click Rediscover. NOTE: A pop-up window asks the operator to confirm the discovery of the Gateway. Additionally, there is a place to enter an optional note about this configuration change. All EMS configuration changes are logged to an audit report. The information here is logged in this report with the configuration change. 19. Click Yes. 20. Click Close. 3.5.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 5. In the Device selection pane, select Access Point. NOTE: If this is the first time adding an AP, this page will be blank. If adding multiple APs, the APs that were added are displayed in this list. 6. Click New AP. 7. In the IP Address field, type the IP address for the AP to be added.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 8. In the Control Socket Port (Numeric: 1024-65535) field, type 2021. NOTE: If the operator has different port information from the site survey, the operator must type a different control socket port number. 9. In the Control Socket Port Mode field, Server is selected from the drop-down list. Do not change this value. 10. Click Get Basic Config. NOTE: This step forces the EMS to obtain the default settings for this AP from the AP itself.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 12. Click Save Basic Config. NOTE: If changes were not made, the screen displays no changes made. If changes were made, a pop-up window allows the operator to enter a description of this event. This description will be entered into the system's audit report for future tracking of when changes were made to the system. 13. In the Update Notification pop-up window, click Yes. NOTE: If changes were made to the configuration, the AP will reboot.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 17. Click Next. 18. In the new Access Point window, complete the following field entries using the company specific site template. If the company template overrides defaults listed below, enter them when updating these fields. a. In the AP Channel (Numeric 1-38) field, type the channel of this AP from the site-specific template. b. In the UL Margin (Numeric 0-15) field, type 2. c.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 19. Click Save ULP Config. In the pop-up window, type Yes. NOTE: A pop-up window allows the operator to enter a description of this event. This description will be entered into the system's audit report for future tracking of when changes were made to the system. 20. Click Next. 21. In the AP Target State window, select Online from the AP Target State drop-down list. 22. Click Save AP Target State. In the pop-up window, click Yes.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 23. Click Next. 24. In the Counter Reporting Interval (Numeric 0-65535) field, type 12. 25. Click Save Counter Reporting Interval. 26. In the Update Notification pop-up window, click Yes. NOTE: A pop-up window allows the operator to enter a description of this event. This description will be entered into the system's audit report for future tracking of when changes were made to the system.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 27. Click Next. 28. Click Register AP. A pop-up window asks the operator to confirm the addition. NOTE: A pop-up window allows the operator to enter a description of this event. This description will be entered into the system's audit report for future tracking of when changes were made to the system. 29. Click Yes. NOTE: The EMS AP status does not update immediately.
ULP EMS Operator Guide Maintaining and Operating the ULP Network After the AP adjusts the GPS time sync and RF Metrics, the AP transitions from a yellow state to a green state as shown below.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.5.5 Configuring an End Device End devices are application specific, and operators may need to configure devices in multiple ULP network elements. Operators must perform a network configuration to each device from the EMS. This is called control configuration. Operators must also configure an end device in CIMA and/or another application-level tool. This is called data configuration.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 5. Physical device installation is completed. The devices will connect at this time, and they are visible in the EMS system. 6. Post installation delivers the completed work order that validates the Node ID (MAC address), application, and installation location to the CIMA operator for post installation application data configuration. 3.5.6 Adding an End Device To add a device, complete the following steps: 1.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 7. Click Add Nodes. 8. Complete the information for the following fields. a. In the Gateway field, select the Gateway. b. In the App Type, select the application type for this node from the drop-down list. c. Optional: Enter a description for the node. d. In the Add Node ID (In HEX: 0x0000) field, type the ID of the radio node. 9. Click Move to Node ID List. The node displays in the Node ID List field. 10. Click Add. 11. Click Add.
ULP EMS Operator Guide Maintaining and Operating the ULP Network To configure a specific device Update Interval (UI) or Listen Interval (LI), complete the following steps: 1. In the Device Selection Pane, click on Node. From the Node Device Listing Pane, select the Node ID of the node to configure. For example, in the following screen, there is one node in the list of nodes. This node has a Node ID of 0x10faf. 2. Click the Node.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3. Click the UI/LI Config tab. This release of the ULP EMS Operator Guide includes the following supported types of end devices (nodes): Sysmon: System monitor node that provides network-specific information to the EMS operator. This helps the EMS operator to understand the health of the ULP network. Configure the UI and LI with the values from the following table. Table 1.
ULP EMS Operator Guide Maintaining and Operating the ULP Network Table 3. RMU UI and LI Values Interval (UI and LI) Value UI 60 per day (24 minutes) LI Every update interval 4. After entering the UI and LI for a device, click Save, and click Yes. The device that was just added displays on the list as Not Joined with an asterisk in the Pending Value field. This denotes that the device has been configured in the EMS, but it has not yet joined the network.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.6 Day to Day Operations An EMS operator performs several tasks during the initial deployment of the network and adding end devices to the ULP network. For day to day operations of the ULP network, the EMS operator does not need to use the EMS console directly. In a typical ULP network deployment, the system can operate for months without ever generating an EMS alarm event.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.6.1 Summary of Alarms This section summarizes EMS generated alarms. The following table contains a short summary for each alarm, including: 1. Network element affected by the alarm 2. Severity of the alarm 3. Short description of the alarm 4. Alarm clearing condition The sub-sections, after the table, provide details for each alarm, such as descriptions for each alarm and how to proceed when receiving each type of alarm. Table 4.
ULP EMS Operator Guide Maintaining and Operating the ULP Network Node Join Failure Major An alarm generated when an end device is not allowed to join the network by the GW. Automatically cleared when the underlying cause is fixed and the device is allowed to join the network. This is cleared if the device is deleted from the EMS, because it was not supposed to be allowed onto the network. TX Suppression Critical AP Proximity Fault Warning An AP lid has been opened.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 2. A system administrator can control additional default parameters for the following alarms through editing the /opt/onramp_apps/nms_config.properties file on the EMS server. If editing the nms_config.properties file after starting the EMS, restart the EMS backhaul to show the changes. Some alarms can be permanently disabled by setting parameters in the nms_config.properties file.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.6.1.2 AP Process Health This type of alarm indicates that the AP and GW cannot communicate. This is due to the following reasons: 1. The AP died. To diagnose the AP, complete these steps: a. Log in to the AP web page: https:// b. From the AP web page, note the status of the AP. c. From the EMS and/or AP web page, reboot Access Point. 2. The network connectivity between the AP and GW is broken.
ULP EMS Operator Guide Maintaining and Operating the ULP Network The operator can attempt to clear the alarm by rebooting the AP generating this alarm. If this clears the alarm, call On-Ramp Wireless. If rebooting the AP does not clear the alarm, move the AP to an offline state in the EMS, and call On-Ramp Wireless. 3.6.1.5 Overload Adjustment The overload adjustment alarm is not likely to be cleared without a service call to On-Ramp Wireless. If this alarm is detected, call On-Ramp Wireless.
ULP EMS Operator Guide Maintaining and Operating the ULP Network Four missed intervals trigger a major alarm. Five missed intervals trigger a critical alarm. NOTE: To guarantee that EMS operators receive RMU network alarms before CIMA operator alarms, modify the alarms to be 1, 2, and 3 instead of 3, 4, and 5. Using these settings will enforce that EMS operators must clear network issues before they propagate to CIMA operators.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.6.1.10 Frame Squishing The frame squishing alarm is not likely to be cleared without a service call to On-Ramp Wireless. If this alarm is detected, call On-Ramp Wireless. 3.6.1.11 EMS DB Backlog This alarm is set when the time difference between the EMS last queued raw message and the last inserted messages grow larger than some configured value (default 5 minutes).
ULP EMS Operator Guide Maintaining and Operating the ULP Network as an AP cannot operate without a GPS fix. The operator may need to roll a service truck to establish whether there is any issue with the antenna connectivity of the GPS antenna to the AP. 3.6.1.17 AP VC-TCXO High Temperature This alarm is the result of the AP operating in a temperature extreme that is above its intended design target.
ULP EMS Operator Guide Maintaining and Operating the ULP Network To configure email based alarms, complete the following steps: 1. Log in to the EMS console, and click the Settings tab. If this is the first time creating email based alarms, the screen will be blank as shown in the following figure. 2. In the left pane, click Notification. 3. Click Add Notification Group.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 4. In the new Add New Notification Group window, complete the information for the following fields. a. In the Severity Threshold field, select the alarm severity for this email notification group from the drop-down list. NOTE: Depending on the threshold for a chosen alarm severity, an email is generated for alarms at that level or above that level in importance.
ULP EMS Operator Guide Maintaining and Operating the ULP Network NOTE: Several email alert notification groups can be created as necessary for work flow. In this field, the operator can segment alarm types and create email groups that are alerted for issues that are of concern. For example, node side alarms should automatically facilitate the EMS operator to contact the CIMA operator to clarify the operation of the end device.
ULP EMS Operator Guide Maintaining and Operating the ULP Network In the following example, there is a single warning in the system. The single warning is an AP proximity alarm meaning that the lid of AP ID #1 has been opened. If the email alarm system is in use, this alarm contains an email alert message. For more information, see Appendix A.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.6.4 Acknowledging Alarms Alarms only need to be acknowledged if the operator previously enabled the EMS to continue to send email alerts for non-acknowledged alarms. If the operator configured the EMS email system to send reminder emails, the system will continue to send email reminders for nonacknowledged alarms at the interval rate specified.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 4. Click Yes. Depending on the settings for the email system notification group, the operator may receive emails for combinations of acknowledgement, clearing, and/or lack of acknowledgement. After the cause of the alarm is cleared, the alarm will be cleared. There are not any active alarms displayed in the window.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.6.5 EMS Alarm History The EMS keeps the history of alarms for each element in the network. To see the alarm history for a device in the network, select a device from the device listing, and navigate to the Alarm History for that device. The following process is the same sequence of steps for Gateways, Access Points, or Nodes. In the following example, look at the alarm history of an Access Point. 1.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3. From the devices list, select the Access Point. 4. Click the Alarm History tab. In the following example, the original alarm is listed and is followed by the Cleared event after the cause for the alarm was fixed.
ULP EMS Operator Guide Maintaining and Operating the ULP Network 3.7 Audit Reporting The EMS includes a System Audit Reporting feature. This feature captures a log item each time devices are added, devices are removed, or a ULP system configuration parameter is set and/or changed. This reporting feature is useful when there are multiple system operators who need to verify when system changes may have been made that they are not aware of.
ULP EMS Operator Guide Maintaining and Operating the ULP Network To facilitate practical searching, each Activity Description entry contains two parts to the text captured in the field. For each type of system change, there is a fixed description as well as an optional description that is appended to this field. The optional description is the information that the operator enters in the pop-up window that accompanies a system change.
Appendix A Typical Email Alert Alarm Email The EMS alarm system will generate a specific email for each type of alarm that the system can generate. Depending on the configuration of the email system, the operator may receive reminder emails, acknowledgement emails, and cleared emails from the system.
ULP EMS Operator Guide Typical Email Alert Alarm Email Figure 4. Reminder for the Alarm Figure 5.
ULP EMS Operator Guide Typical Email Alert Alarm Email Figure 6.
Appendix B New Application Types The initial release of the EMS supports the following application types in this documented release: 1. App Type ID: 2 – FCI 2. App Type ID: 7 – FAA 3. App Type ID: 8 – Smart Meter 4. App Type ID: 9 – Transformer IQ 5. App Type ID: 255 – Sysmon 6. App Type ID: 2 – FCI Over time, new applications will be identified to be added to the ULP system. The EMS facilitates a way to add device types to the system. NOTE: New devices can be added to the EMS and CIMA.
ULP EMS Operator Guide New Application Types 3. Select Add App Type, and complete the field entries.
Appendix C Abbreviations and Terms Abbreviation/Term Definition AP Access Point. The ULP network component geographically deployed over a territory. CIMA Critical Infrastructure Monitoring Application. The network component that passes data from the Gateway to the associated upstream databases. CSV Comma Separated Value Dashboard Web page view of the aggregated end-device monitoring data. DBA Database Administrator FCI Fault Circuit Indicator.
