Alarm handling by SMS in ALERT

Transcription

1 Micromedia International Alarm handling by SMS Author: Jens Eberle Pages : 9 Company: Micromedia International Date : 29/10/2013 Version : 1.1 Réf. : Alarm Handling by SMS.docx [Commentaires ] Alarm handling by SMS in ALERT Diffusion To CC Company Attached files: 29/10/2013 Alarm handling by SMS in ALERT 1/9

2 29/10/2013 Alarm handling by SMS in ALERT 2/9

3 Content Introduction... 4 Schema... 4 Alert Log and SMS... 4 Activation of the AckAlarmSMS script... 5 Configuration of the Script... 7 Script Versions and specifics /10/2013 Alarm handling by SMS in ALERT 3/9

4 Introduction This document will describe the installation of the SMS alarm handling in Alert. Before you start with the steps below, please make sure that a GSM modem with a valid SIM card is already installed and working on the ALERT server. Schema -Red Line: An Alarm has occurred, Alert will handle it and according to its Alarm condition it will send out a SMS to the available user - Blue Line: Optional, Call acknowledgement: according to the configuration the User can confirm that he has received the SMS - Green Line: Alarm Acknowledgement, the User can acknowledge the Alarm by sending back a predefined keyword plus the Alarm ID, he s got with the message It s also possible to acknowledge all ongoing alarms and to mask alarms. Please find the whole functionality description either in the Message Processor script or in the readme of the script. Alert Log and SMS 29/10/2013 Alarm handling by SMS in ALERT 4/9

5 Activation of the AckAlarmSMS script 1. Extract and copy the files ACKAlarmSMS.prg and.pro of the zip into the directory of ALERT (c:\mmi\alert by default) 2. In ALERT, activate the message processor (configuration -> options -> supervision check the option "message processor") 3. Then open the window message processor (Menu Configuration -> message processor) and right click on the arrow to select Import Choose the AckAlarmSMS.pro script and confirm with OK 4. Click Init to initialize the script and close the windows of the message processor by click OK 29/10/2013 Alarm handling by SMS in ALERT 5/9

6 5. Open the configuration of the COM Port (configuration -> communication -> COMx properties) 6. Follow the screenshot below to activate the SMS Ack script for the GSM Modem. Choose the AckAlarmSMS script from the drop down list Message processor. If you want have the call acknowledgement enabled for SMS, please define a keyword for call ack and call denied. Please modify the settings for the recipient as well. 29/10/2013 Alarm handling by SMS in ALERT 6/9

7 Configuration of the Script To acknowledge an alarm the user has to send back a SMS with the OID of the alarm he want to acknowledge. For this purpose it will be good to transmit the OID within the alarm message. You can either modify it for each alarm in the Tag Parameter, please modify the format of the alarm message by adding "&O" (which means OID) Or you can use the default alarm message format which would be better, then it s available for all new created alarms. Please go to Configuration -> Options ->Alarms Now, when you get an alarm of ALERT, then you will see the alarm message plus the OID on your mobile phone. You can answer to that SMS by sending back the OID with an optional keyword to acknowledge the alarm. The keywords can be defined in the scripts global parameter list, e.g. the variable gsack will be the keyword for the alarm acknowledgement ACK, gsackall the keyword to acknowledge all ongoing alarms, etc. (screenshot below). 29/10/2013 Alarm handling by SMS in ALERT 7/9

8 You can also define a Watch Dog variable to supervise the script (in the case there is an issue or it will be blocked in some way). For this, please change the value in the field "gntimeout" and put a value more than 0 (timeout in seconds, 10 are recommended) and give a name for "gswatchdogtagname", this will be the name of an alarm in ALERT that can be set if the script is having an issue. In the alarms condition, please use INFVAR" and put a value and time (1;60 this means if the value of the tag doesn't change from 1 in 60 sec. an alarm will be set). Explanation how the script will work: for each gntimeout, the script increase the value of the variable "gswatchdogtagname" until 1000 and then it set the value to 0. If after gntimeout the value of "gswatchdogtagname" hasn't changed, then the script is having an issue. 29/10/2013 Alarm handling by SMS in ALERT 8/9

9 Script Versions and specifics You will find the version of the script as comment in the.prg file -> Since version 3.0, it s possible to read or write value in a tag through SMS To write a value, you have to send an SMS with syntax: SetTag<Reference/OID of the alarm>:<value> The word "SetTag" can be defined in the keyword "gssettagkey", the character ":" can also be defined in "gssettagseparator". According to the option ""gbsetvaluebyref", you have to send the reference or the numeric id of the alarm. If the string ""gssettagkey" is empty no management will be done. To read a value of a tag, you have to send an SMS with the syntax: ValTag:<Reference/OID of the alarm> The word "ValTag:" can be defined in "gsgettagvaluekey". According to the option "gbgetvaluebyref", you have to send the reference or the numeric id of the alarm. If the string "gbgetvaluebyref" is empty no management is done. If the id isn't correct, a SMS with message in "gserrorgetvaluemsg" is sent. Please ask the technical support for further information and the latest script version 29/10/2013 Alarm handling by SMS in ALERT 9/9