NovaStar 4X Pager Alarm Software 5073NS4X-AD DCN-M409

Transcription

1 NovaStar 4X Pager Alarm Software 5073NS4X-AD DCN-M409

2 Receiving and Unpacking Carefully unpack all components and compare to packing list. Notify HydroLynx Systems immediately with any discrepancy. Inspect for damage that may have occurred during shipment. In the event of damage, claims for loss must be filed immediately with carrier by the consignee. This does not apply to shipments via Parcel Post or UPS, in which case you should contact HydroLynx Systems for instructions. Returns If you need to return unit to the factory for any reason call HydroLynx Systems between 8:00 A.M. and 4:00 P.M. Pacific Time and request a Return Authorization Number (RA#). Carefully pack the unit so that it will not be damaged in shipment. Write the RA# on the outside of the box. Include with the unit a description of the problem. Warranty HydroLynx Systems warrants that its products are free from defects in material and workmanship under normal use and service for a period of one year from the date of shipment from the factory. HydroLynx Systems' obligations under this warranty are limited to, at HydroLynx Systems' option: (i) replacing; or (ii) repairing; any product determined to be defective. In no case shall HydroLynx Systems' liability exceed product's original purchase price. This warranty does not apply to any equipment that has been repaired or altered, except by HydroLynx Systems, or which has been subjected to misuse, negligence, or accident. It is expressly agreed that this warranty will be in lieu of all warranties of fitness and in lieu of the warranty of merchantability. 950 Riverside Pkwy., Suite 10 West Sacramento, CA (916) FAX (916) hydro@hydrolynx.com Copyright 8, 2006 by

3 1. Software description The NovaStar 4X Pager Alarm software dials an alarm pager service through a dial-out modem, dials a remote printer, or sends an alarm message on the Internet. The software supports analog, digital, and TAPS (Telocator Alphanumeric Protocol) dial-out pager services, The analog pager program sends the alarming device ID number to a pager as you would send a phone number. The digital and TAPS pager programs log into a pager service, select a pager ID group and send the alarm messages to the pager service to be transmitted to the pager group. The alarm message includes the device ID, alarm type, alarm data value, and time of alarm. The printer pager program dials remote printer(s) and sends the alarm notice. The alarm message includes the device ID, alarm type, alarm data value, and time of alarm. The pager program sends alarm messages to address through the Internet connection. The alarm message includes the device ID, alarm type, alarm data value, and time of alarm. A list of phone numbers to be dialed or addresses is set up ahead of time. Unique pager lists can be assigned to different alarm actions. 2. Installation Insert the CD in CD-Rom drive 1. From the NovaStar 4X xmenu Other pull-down menu, select Install software and then From CD-Rom. To install the software from the command prompt, type the command: cd / sh /cd0/install Press keys when prompted by the installation program. The installation program will add a Pager Setup entry to your xmenu Setup pull-down and a View pager log entry to your Test pull-down. Logout then login again to start the updated xmenu. 3. Pager Alarm Setup A menu entry has been added to the NovaStar 4X xmenu Setup pull-down by the installation program. This entry is labeled APager Setup@ and will start the program xpagersetup when selected. It is not necessary to reboot your computer after installing this software. DCN-M NS4X-AD Page 1 of 9

4 3.1 Pager Alarm Selection The xpagersetup program lets you edit existing pager alarms or create new ones. Under Select alarm action click the arrow button to the right of the alarm action field to select an existing pager alarm. Click the New alarm button to add a new pager alarm. Click the New multi alarm button to combine several alarm actions into one alarm action. 3.2 Pager Alarm Type Select the type of pager alarm under Pager service type: Analog, Digital, TAPS, , or Printer. Click the Link action button to create the alarm action files used by NovaStar for this pager alarm type. 3.3 Pager List Entry Pager telephone numbers or addresses and names are show in the Pager List. Click on a pager entry to edit it. The pager number and name are shown in the edit fields below the pager list. Make changes and click Replace to update the list. Click Add above or Add below to add a new pager entries. Click Remove to delete the selected entry(s) from the pager list. Use the Up and Down arrow buttons to the right of the edit buttons to reposition an entry in the pager list. Page 2 of NS4X-AD DCN-M409

5 3.4 Pager Configuration Parameters The pager configuration is shown in a separate window to the right of the pager setup: Parameter Modem port Service number From address From host subject server Description Enter the dial-out modem port name, for example: /dev/mdm1. To launch a pager dial-out on a remote node prefix the modem port name with the remote node number, for example: //2/dev/mdm1 For digital and TAPS pagers, enter the service telephone number pager service sender address pager service sender computer host name pager service subject message SMTP or Exchange server name Baud rate Dial baud rate: 300, 1200, 2400, 4800, 9600 Data bits Dial data bits: 5, 6, 7, 8 Parity Stop bits Dial timeout Dial attempts Login attempts Login attempts Page delay Page wait Login prompt Login name Pager prompt Message prompt Message received Log file Dial parity: none, odd, even, mark, space Dial stop bits: 1 or w Dial timeout in seconds Number of dial retries for connecting to a digital or TAPS service Number of login retries for a digital or TAPS service Number of page retries for a digital or TAPS service Delay after dialing analog pager number before sending alarm data Delay between analog pager dials in seconds Digital and TAPS pager service login prompt Digital pager service login name Digital pager service prompt for pager number Digital pager service prompt for page message Digital pager service message received acknowledgment Pager log file DCN-M NS4X-AD Page 3 of 9

6 Lock timeout Length of time to wait for a previous page to finish (seconds) 3.5 Pager Configuration Dialogue Boxes Page 4 of NS4X-AD DCN-M409

7 4. Pager Alarm Action Setup The Pager Setup program adds pager alarms to the NovaStar alarm action configuration file: ed /usr/ns/cfg/alarmact.cfg The alarm action configuration file has one line for each alarm action. Each line has 3 fields. The fields are separated by at least one space. The third field can include spaces. The field information is: Alarm action number I/O port alias to start alarm on Alarm action description (may include spaces) The alarm action numbers are chosen automatically by the pager setup program. The I/O port alias should be /dev/con1. Do not use the modem port name. The description is a string describing the pager alarm action. For example: /usr/ns/cfg/alarmact.cfg: 0 /dev/con1 Main console - beep 1 /dev/con1 Main console - silent 2 /dev/con1 Pager alarm Note that you must restart NovaStar if you modify the alarm action configuration file. 4.1 Pager Alarm Program Setup The pager setup program Link action button links the NovaStar alarm program, warning_sh, to the alarm action execution file with the commands: cd /usr/ns/bin ln -fs warning_sh warning# where # is the alarm action number. For example to link alarm action 2 execute the commands: cd /usr/ns/bin ln -fs warning_sh warning2 Then the pager service script is then linked to the alarm action script file. The pager service script files are stored in the directory /usr/ns/par. They are named: warning_analog warning_digital warning_taps warning_ warning_printer - Analog pager service - Digital pager service - TAPS pager service - pager service - Printer pager service The pager service script is linked to the alarm action script by copying the script with the DCN-M NS4X-AD Page 5 of 9

8 command: cd /usr/ns/par cp -pv pagerscriptfilename warning#.par where # is the alarm action number. For example to link the alarm action 2 script to the TAPS pager service script, execute the commands: cd /usr/ns/par cp -pv warning_taps warning2.par 4.2 Pager Alarm Configuration File Pager alarm configuration files are stored in the directory /usr/ns/pager and are named pager#.cfg, where # is the alarm action number. The configuration file contains the following fields. A listing of the fields, their default assignments and description follows: Analog pager service: TYPE="ANALOG" Pager service type MODEM="/dev/mdm1" Modem port for dial-out BAUD="2400" Modem port baud rate PARITY="even" Modem port parity BITS="7" Modem port data bits STOP="1" Modem port stop bits DIALTIMEOUT="20" Dial-out timeout PAGEDELAY="10" Delay before dialing alarm ID number PAGEWAIT="10" Delay before next pager is dialed LOGFILE="/usr/ns/log/pager.log" Pager log file LOCKTIMEOUT= 60 Wait time for previous page to finish Digital pager service: TYPE="DIGITAL" MODEM="/dev/mdm1" SERVICE="T " BAUD="2400" PARITY="even" BITS="7" STOP="1" DIALTIMEOUT="20" DIALATTEMPTS="3" LOGINATTEMPTS="3" PAGEATTEMPTS="3" LOGINPROMPT="ID=" LOGINNAME="" PAGERPROMPT="Pager ID" MESSAGEPROMPT="Message:" Pager service type Modem port for dial-out Pager service telephone number Modem port baud rate Modem port parity Modem port data bits Modem port stop bits Dial-out timeout Dial-out attempts to connect to pager service Login attempts for pager service Page message send attempts Login prompt from pager service Login name sent to pager service Prompt to enter pager ID number Prompt to enter message to send Page 6 of NS4X-AD DCN-M409

9 MESSAGERECEIVED="Page accepted." Page message accepted response LOGFILE="/usr/ns/log/pager.log" Pager log file LOCKTIMEOUT= 60 Wait time for previous page to finish TAPS pager service: TYPE="TAPS" Pager service type MODEM="/dev/mdm1" Modem port for dial-out SERVICE="T " Pager service telephone number BAUD="2400" Modem port baud rate PARITY="even" Modem port parity BITS="7" Modem port data bits STOP="1" Modem port stop bits DIALTIMEOUT="20" Dial-out timeout DIALATTEMPTS="3" Dial-out attempts to connect to pager service LOGINATTEMPTS="3" Login attempts for pager service PAGEATTEMPTS="3" Page message send attempts LOGINPROMPT="ID=" Login prompt from pager service LOGFILE="/usr/ns/log/pager.log" Pager log file LOCKTIMEOUT= 60 Wait time for previous page to finish pager service: TYPE=" " Pager service type sender address FROMHOST="novastar.HL" sender computer name SUBJECT="Alarm on ALERT1" message subject SERVER="mail.hydrolynx.com" SMTP or Exchange server LOGFILE="/usr/ns/log/pager.log" Pager log file LOCKTIMEOUT= 60 Wait time for previous page to finish Printer pager service: TYPE="PRINTER" Pager service type MODEM="/dev/mdm1" Modem port for dial-out BAUD="9600" Modem port baud rate PARITY="none" Modem port parity BITS="8" Modem port data bits STOP="1" Modem port stop bits DIALTIMEOUT="30" Dial-out timeout PAGEDELAY="2" Delay pager before printing alarm message PAGEWAIT="5" Delay before next printer is dialed LOGFILE="/usr/ns/log/pager.log" Pager log file LOCKTIMEOUT= 60 Wait time for previous page to finish DCN-M NS4X-AD Page 7 of 9

10 4.3 Pager Alarm Number List The pager alarm list of pager numbers is stored in the directory /usr/ns/pager and is named pagernumber#.lst, where # is the alarm action number. The pager number list file contains the pager numbers for this alarm action. Each line contains the pager number, one or more spaces and a description of the pager owner. The pager number cannot contain spaces. For example the pager alarm list for alarm action 2 is named /usr/ns/par/pagernumber2.lst and contains: Dave=s pager Joe=s pager 4.4 Pager Alarm Notification The pager alarm actions list for notification is stored in the directory /usr/ns/pager and is named pageraction#.lst, where # is the alarm action number. The pager alarm action list file contains the alarm actions used to extract pager alarm information from the NovaStar system. One or more alarm actions can be used for the pager notification. All unacknowledged alarms from these actions are sent to the pager. Typically the alarm action number used to start the page is the alarm action for notification. Put each alarm actions for notification on an new line. For example, the alarm notification file for alarm action 2 is named /usr/ns/par/pageraction2.lst and contains: 2 5. Alarm testing The pager alarm program can be tested with the NovaStar alarm test program. From the NovaStar 4X xmenu Test pull-down select Alarms. Select the alarm type from the list of alarm actions. Click Test to start the alarm test after selecting an alarm action. Acknowledge the test alarm as you would a standard alarm. Click Exit to quit the program. Note that acknowledging a pager alarm terminates the pager dial-out. 5.1 Alarm Acknowledgment The pager alarm dial-out is terminated when the alarm is acknowledged on the NovaStar system. It is not possible to acknowledge the alarm from a pager that receives the alarm page. Page 8 of NS4X-AD DCN-M409