View source for Event Handler

''See also: [[Event Handler applications]]''
[[Image:Eventhandler.gif|right|thumb|Event Handler - Block Diagram]]
The AlphaCom exchange is an intercom exchange of which the main task is to enable uni- and bi-directional speech. In order to be able to meet as many customer requirements as possible when it comes to special features an '''Event Handler''' has been implemented. The underlying idea is that by customer-programming this event handler functionality can be implemented which is not part of the standard [[AlphaCom Feature List|feature list]]. The event handler is unique in the world of intercom. It is what gives the exchange its flexibility and makes it possible to meet most, if not all, customer requirements.<br /> The Event Handler is based on the software concept that when the intercom functions run, they report 'events' to a part of the software called the Event Handler. The event can be described as a trigger that sets off an action in the system depending on the information entered in [[AlphaPro]], the programming tool for the AlphaCom exchange. In this way, the Event Handler provides a powerful engineering tool for configuring system behaviour to meet requirements from customers. 

Actions can be simple, just to operate a relay under certain circumstances. Actions can also be programmed using a scripting language and can include conditional statements. An action can itself trigger a new event, making it possible to start a chain of actions. 

== The principle ==
=== Events ===
'''Events''' are generated inside the AlphaCom software when interesting things happen. Events follows a fixed format, with the following parameters:
* Owner
* Event type
* State change : ON/OFF
* Related-to 

The '''owner''' is source which triggers the event. The following possible owners are defined:

* A single '''station'''
* A '''group of stations''' ([[UDP group]]) with common behaviour 
* The '''scheduler''', the internal AlphaCom clock which generates a ‘tick’ every minute
* '''[[External Data Input]]''', a data port set up to receive ASCII text strings from external devices

The '''Event type''' is a number which tell what sort of event occurred. Event type is divided into a  '''Main event''' and [[Sub-Event (Event Handler)|Sub-Event]]. Main events are listed below. Only some of the Main events use the Sub-Event. In the case of the scheduler the event is the ‘minute tick’. 

'''State change''': Most of the events are modeled as a state which goes ON and OFF. But some events does not fit to that concept, then only a ON event is reported.

'''Related-to''' is specific for the feature which reports the event. It can be the other station in a conversation, or the sending station of a mail or CallRequest.

===Event Rules===
Event handler Rules are what you program in the [[Exchange_%26_System_%28AlphaPro%29#Events|Event Handler window]] in AlphaPro. An Eventhandler Rule has two main parts:
* A '''condition''', which matches specific Events
* An '''action''', which specifies what should happen when a Event matches a Condition. 

Stations can trigger many different types of event.<br /> Many events can trigger an action when the event is activated and when the event is de-activated, for instance event type 07: Conversation – Incoming. The On/Off action can be differentiated by the ‘When Change To’ flag.<br /> Events can be, but don't have to be, related to a specific directory number or a group of stations, for instance:

* Owner: Station 1
* Event: Conversation - Outgoing
* Related to: Directory number 102
* When change to: ON
* Action: RCO 2 ON

In this case the relay connected to RCO 2 will only be activated if 'Station 1' is in conversation with a station with directory nr 102, AND if Station 1 was the station which made the call. If 'Related to' was not specified, that same relay would be activated on any call which Station 1 would make.

== Events Types ==
The list shows the available '''event types''', grouped by function.<br><br>

{| border="1"
! style="background:#ffdead;" width="180" |Event Type
! style="background:#ffdead;" width="70" |No.
! style="background:#ffdead;" width="500" |When triggered
|-
|colspan="3"|'''''Single Station Events'''''
|-
| align=center |[[Audio (Event Type)|Audio]] || align=center | 01 || When audio is played in the speaker
|-
| align=center | [[Door Opening - Automatick Lock (Event Type)|Door Open - Automatick Lock]] || align=center | 03 || When the Code Lock [[AlphaCom Feature List|feature]] is dialed
|-
| align=center | [[Station in Use (Event Type)|Station in Use]] || align=center | 04 || When a station becomes busy or free
|-
| align=center | [[Microphone Open (Event Type)|Microphone Open]] || align=center | 05 || When the microphone is alive
|-
| align=center | [[Faulty Station Line (Event Type)|Faulty Station Line]] || align=center | 13 || When a station is reported faulty or OK
|-
| align=center | [[M-key (Event Type)|M-key]] || align=center | 31 || When the M-key is pressed or released
|-
| align=center | [[Off-hook (Event Type)|Off-hook]] || align=center | 32 || When the handset is lifted or replaced
|-
|colspan="3"|'''''Conversation Events'''''
|-
| align=center |[[Conversation Incoming (Event Type)|Conversation Incoming]] || align=center | 07 || When a call is received
|-
| align=center | [[Conversation Outgoing (Event Type)|Conversation Outgoing]] || align=center | 08 || When a call is made
|-
| align=center | [[Private Ringing mode (Event Type)|Private Ringing mode]] || align=center | 09 || During private ringing for ''incoming'' call
|-
| align=center | [[Private Ringing Outgoing(Event Type)|Private Ringing Outgoing]] || align=center | 33 || During private ringing for ''outgoing'' call
|-
| align=center | [[Door Opening - During Conversation (Event Type)|Door Opening - During Conv.]] || align=center | 02 || When door opening feature (digit 6) is activated during conversation
|-
|colspan="3"|'''''Mail (Call Queue) Events'''''
|-
| align=center |[[Received Mail (Event Type)|Received Mail]] || align=center | 10 || When a [[mail]] or a [[call request]] is received
|-
| align=center | [[Call Requester Mode (Event Type)|Call Requester Mode]] || align=center | 11 || When a station sends a [[Call Request]]
|-
| align=center | [[Priority Mail Present (Event Type)|Priority Mail Present]] || align=center | 06 || When a mail with priority level 100 (programmable) is present in the mail queue
|-
| align=center | [[Priority Mail in Idle (Event Type)|Priority Mail in Idle]] || align=center | 12 || When a priority mail is present, and the station is not in conversation
|-
| align=center | [[Mail Timeout (Event Type)|Mail Timeout]] || align=center | 20 || When a mail times out
|-
| align=center | [[New Current Mail (Event Type)|New Current Mail]] || align=center | 23 || When the current mail in the queue is changed
|-
| align=center | [[New First Mail (Event Type)|New First Mail]] || align=center | 24 || When a new mail arrives first in the queue
|-
|colspan="3"|'''''Conference Events'''''
|-
| align=center |[[Simplex Conference Audio (Event Type)|Simplex Conference Audio]] || align=center | 16 || When listening to [[simplex conference]], and the [[AUDIO_DETECT|$VOX]] command is activated
|-
| align=center | [[Simplex Conference Member (Event Type)|Simplex Conference Member]] || align=center | 17 || When a station joins a [[simplex conference]]
|-
| align=center | [[Open Duplex Conference Ringing (Event Type)|Open Duplex Conf. Ringing]] || align=center | 18 || During ringing to an [[open duplex conference]]
|-
| align=center | [[Open Duplex Conference Connect (Event Type)|Open Duplex Conf. Connect]] || align=center | 19 || When a station connects to an [[open duplex conference]]
|-
|colspan="3"|'''''Event Triggers'''''
|-
| align=center |[[Event Trigger (Event Type)|Event Trigger]] || align=center | 15 || When dialing a [[directory number]] with [[AlphaCom Feature List|feature number]] 52, 85, 95 or 105
|-
| align=center | [[Event Trigger with parameter (Event Type)|Event Trigger with parameter]] || align=center | 25 || When dialing Event Trigger [[AlphaCom Feature List|feature]] 95 or 105, preceeded by a directory number or digit
|-
| align=center | [[Start: Event Trigger with parameter (Event Type)|Start: Event Trigger with param.]] || align=center | 26 || When dialing a [[directory number]] with [[AlphaCom Feature List|feature number]] 95
|-
| align=center | [[Event Timeout (Event Type)|Event Timeout]] || align=center | 21 || When a timer started by the [[SET_TIMER|$ST]] command expires
|-
| align=center | [[Station DAK key as RCI (Event Type)|Station DAK key as RCI]] || align=center | 30 || When a [[DAK]] key is pressed
|-
|colspan="3"|'''''Scheduling'''''
|-
| align=center |[[Scheduler (Event Type)|Scheduler (Minute Tick)]] || align=center | 22 || When matching the specified date (or weekdays) and time
|-
|colspan="3"|'''''EDI - External Data Input'''''
|-
| align=center |[[External Data Input]] || align=center | 28 || When receiving ASCII data on EDI port
|-
|colspan="3"|'''''System Events'''''
|-
| align=center |[[System Status (Event Type)|System Status]] || align=center | 27 || When a [[device]] is reported up or down
|-
| align=center | [[AlphaNet Link (Event Type)|AlphaNet Link]] || align=center | 29 || When an AlphaNet link is reported up or down
|-
|}
<br>
<br>

== Action Commands ==
There are two types of '''Action Commands''' which can be used by the Event Handler, [[#Built-In Action Commands|Built-In Action Commands]] and [[#Data Protocol Commands|Data Protocol Commands]].

Both types of commands can include parameters and macros (e.g. %1.dir and %clk(8)) 
=== Built-In Action Commands ===
'''Built-in Action Commands''' are three- or four-letter commands. The commands are case-insensitive as from AMC 08.20. Most of the Built-In commands also have a Data Protocol implementation. 

{| border="1"
! style="background:#ffdead;" width="100" |Command
! style="background:#ffdead;" width="400" |Description
! style="background:#ffdead;" width="100" |From AMC ver.
|-
| align=center |[[PRS - Program to Station|PRS]] || Audio Program to Station || &nbsp;
|-
| align=center |[[PRG - Program to Group|PRG]] || Audio Program to Group || &nbsp; 
|-
| align=center | [[CNG - Simplex Conference to Group|CNG]] || Simplex Conference to Group || &nbsp;
|-
| align=center | [[MST - Mail to Station|MST]] || Mail to Station || &nbsp;
|-
| align=center | [[MGR - Mail to Group|MGR]] || Mail to Group || &nbsp;
|-
| align=center | [[MPP - Mail to Pocket Pager|MPP]] || Mail to Pocket Pager || &nbsp; 
|-
| align=center | [[AMS - Alarm Message to Station|AMS]] || Alarm Message to Station || &nbsp; 
|-
| align=center | [[AMG - Alarm Message to Group|AMG]] || Alarm Message to Group || &nbsp; 
|-
| align=center | [[RCO - Set Remote Control Output|RCO]] || Set Remote Control Output || &nbsp; 
|-
| align=center | [[EDO]] || Send text to serial port External Data Output EDO 1 - 4 || &nbsp;
|-
| align=center | [[LOG - Send text to exchange’s log port (including date/time) |LOG]] || Send text to exchange’s log port (including date/time) || &nbsp;
|-
| align=center | [[IND - Indicator control for CRMIV LEDs, buzzer etc. |IND]] || Indicator control for CRMIV LEDs, buzzer etc. || AMC 07.20
|-
| align=center | [[OWN - Modify Event Owner (%1) and/or Related_To (%2) values |OWN]] || Modify Event Owner (%1) and/or Related_To (%2) values || AMC 07.60
|-
| align=center | [[wudd|WUDD]] || Write a value to an User Defined Data UDD || &nbsp;
|-
| align=center | [[Tmp_statement|TMP]] || Write a string to a temporary variable || &nbsp;
|-
| align=center |[[PAUSE]] || Pauses the event handler command interpreter for 100 ms || AMC 08.20
|-
| align=center |[[IF/ENDIF]] || Conditional statement ||AMC 08.20
|-
| align=center | [[STOP]] || Stops the execution of the rest of the action string || AMC 08.20
|}
<br>
<br>

=== Data Protocol Commands ===

'''Data Protocol Commands''' are using ASCII commands in the [[Stentofon Simple Link Layer|Simple Link Layer]] format. The commands begin with $ or @.

The most relevant data protocol commands for the Event Handler and for [[RCI]]s are listed in the table below. Follow this link for a complete list of [[AlphaNet_Data_Protocol#Message_Formats_-_Grouped_by_Function|all Data Protocol Commands]]


{| border="1"
! style="background:#ffdead;" width="170" |Message 
! style="background:#ffdead;" width="70" |Short name
! style="background:#ffdead;" width="70" |Message no, Hex
! style="background:#ffdead;" width="600" |Description
|-
| colspan=4|'''''Station Connect Operations'''''
|-
| [[CALL_SETUP]] ||align=center|CALL||align=center|0x0008||Sets up a conversation between two users
|-
| [[DISCON_ST]] || align=center| &nbsp; ||align=center|0x008E||Disconnect station from ongoing feature  
|-
| [[PAR_RING]] ||align=center| &nbsp;||align=center|0x0098|| Add a Parallel Ringer station to a call in ringing state
|-
| colspan=4|'''''Station Keyboard & Display emulation'''''
|-
| [[DIAL_DIGITS]] ||align=center|DD||align=center|0x0050|| Simulate digit dialing from a station
|-
| [[DIAL_DAK]] || align=center|&nbsp;||align=center|0x0094||Dial DAK on a station
|-
| [[PLAY_DAK]] || align=center|PD||align=center|0x009C||"Dial sequence" for playback.
|-
| [[M_KEY]] ||align=center|M||align=center|0x0054|| Order station to press M-key
|-
| [[M_KEY_RELEASE]] ||align=center|MREL||align=center|0x0055|| Order station to release M-key
|-
| [[C_KEY]] ||align=center| C || align=center|0x0058||Order station to press C-key
|-
| [[DISPLAY_TEXT]] ||align=center| DSPL || align=center|0x005A|| Send text and control characters to a station 
|-
| colspan=4|'''''Station Features and Status'''''
|-
| [[PROGRAM]] ||align=center|PROG||align=center|0x0001|| Set audio program for single station or a predefined group of stations
|-
| [[PROG_CONF]] ||align=center|CONF||align=center|0x0004|| Set Simplex conference for predefined group of stations or a single station
|-
| [[CONF_TALK]] ||align=center|&nbsp;||align=center|0x008B|| Set Simplex conference speaker
|-
| [[CONF_TALK_STOP]] ||align=center|&nbsp;||align=center|0x008C|| Stop station form feeding Simplex conference
|-
| [[O_DUPL_CONF]] ||align=center| ODC||align=center|0x006F||Include/exclude a station or a group into/from an Open Duplex Conference
|-
| [[ALARM_MSG]] ||align=center|ALRM||align=center|0x0007|| Set up (or disconnect) an ASVP Alarm message to a single station or a predefined group of stations
|-
| [[CALL_TRANSFER]] ||align=center|TRF||align=center|0x0044|| Set or remove call transfer for a station
|-
| [[SET_REQ_TRANSF]] ||align=center|SCRT||align=center|0x002B|| Set transfer of Call Request for an intercom station
|-
| [[SET_ABSENCE]] ||align=center| SABS||align=center|0x0028|| Set absence status for an intercom station
|-
| [[WAKE_UP]] ||align=center|&nbsp;||align=center|0x0047|| Register or remove wakeup request
|-
| [[SET_GRP_FILT]] ||align=center|GFLT||align=center|0x007D|| Set group call filter for a station
|-
| [[GROUP_MEMBERSHIP]] || align=center|GRM||align=center|0x0081||Set group membership in NVRAM for a station
|-
| [[SET_STATION_COS]] ||align=center|SSC||align=center|0x0090|| Set COS membership in NVRAM for a station
|-
| [[MODIFY_COS_CONTENTS]] ||align=center|MCC||align=center|0x0091|| Modify feature membership in COS in NVRAM
|-
| [[TEMP_PROG]] ||align=center|TPROG||align=center|0x0096|| Temporarily "mute" program distribution to a station
|-
|[[VOL]]|| align=center | &nbsp;|| align=center | 0x009B || Set station volume
|-
| colspan=4|'''''Station Mail Operations'''''
|-
| [[SEND_MAIL]] || align=center|SM ||align=center|0x0031||Send a mail message to an intercom station
|-
| [[SEND_TXT_MAIL]] ||align=center|STM||align=center|0x0032|| Send a mail message with free text to an intercom station
|-
| [[CANCEL_MAIL]] ||align=center|CANM||align=center|0x0065|| Delete one or more mail/call request/alarm messages queued at a station
|-
| [[SET_MAIL_TIMEOUT]] ||align=center|SMT||align=center|0x0082|| Set the timer of a mail queue entry
|-
| [[COPY_MAIL]] || align=center|CPYM||align=center|0x0083||Send a copy of a mail in own queue to a new destination (station or group)
|-
| [[MAILQ_NAVIG]] ||&nbsp;||align=center|0x008D|| Do operation on mail queue, or step current mail in mail queue
|-
| [[DELETE_MAIL]] ||align=center|DELM||align=center|0x0034|| Delete a mail entry in the queue for an intercom station
|-
| colspan=4|'''''General Exchange Control'''''
|-
| [[SET_SYSTEM_TIME]] ||align=center|SST||align=center|0x0027|| Set the internal clock to the given date and time
|-
| [[PUT_STRING]] ||align=center|PUT||align=center|0x0073||Output String to Exchange serial port after adding appropriate framing depending on selected port
|-
| [[LOG_STRING]] || align=center|LOG||align=center|0x0075||Output String to System Log
|-
| [[EXECUTE_COMMAND]] ||align=center|X||align=center|0x004F|| Send a command string to the exchange to be executed there
|-
| [[EVENT_REPORT]] || align=center|ER||align=center|0x0067||Report an event to the event/action system
|-
| [[SET_TIMER]] ||align=center|ST||align=center|0x008F|| Start or stop a timer
|-
| [[WRITE_USER_DEF_DATA]] ||align=center|WUDD||align=center|0x008A|| Write User Defined Data (UDD)
|-
| [[SET_DIRNO_TXT]] ||align=center|SDT||align=center|0x0077|| Change the display text of a directory number (station or feature)
|-
|}

<br>
<br>

== Context Parameters and macros ==

[[#Action Commands|Action commands]] used in the Event Handler can contain '''context parameters''' and '''macros'''. They both return a value. 

'''Context Parameters''' are related to the actual event, and refer to the involved station(s) or functions. A parameter always starts with the character "%". Context parameters are useful for defining the action of a rule where the condition is a [[UDP_group]].

*'''%1''': the parameter is associated with the ''Owner'' field
*'''%2''': the parameter is associated with the ''Related to'' field 
*'''%3''': the parameter is associated with the ''When change to'' field

A '''macro''' is unrelated to the event itself. It reads information from the memory (nvram) or performs a calculation. Also a macro always starts with the character "%". 

Macros and parameters can be nested freely, and makes it possible to build complicated expressions.

=== List of context parameters ===

{| border="1"
! style="background:#ffdead;" width="80" |Parameter
! style="background:#ffdead;" width="80" |Short name (owner)
! style="background:#ffdead;" width="300" |Returned value
! style="background:#ffdead;" width="100" |From version
|-
| align=center | %1.phy || align=center | %1p || The [[physical number]] || AMC 07.20
|-
| align=center | %1.dir || align=center | %1d || The [[directory number]] || &nbsp;
|-
| align=center | %1.nam || align=center | %1n || The name (display text) || AMC 08.00
|-
| align=center | [[%1.exp]] || align=center | %1e || The [[User defined parameter]] || &nbsp;
|-
| align=center | [[%1.udp]] || align=center | %1e || The [[UDP group]] memberships for station|| &nbsp;
|-
| align=center | [[%1.dak]] || align=center | %1k ||  The number of the DAK key containing a specified string || AMC 08.00
|-
| align=center | %1.nod || align=center | &nbsp; || The [[node]] number || AMC 08.03
|-
| align=center | %1.ref || align=center | &nbsp; || The [[node]] and [[directory number]] as a complete [[NET_OBJ_REF]].<br>%1.ref is equivalent to "L(%1.nod) %1.dir" || AMC 08.20
|-
| align=center | %1.mpri || align=center | &nbsp; || Priority of the [[mail]]. Available in mail related events only || AMC 08.20
|-
| align=center | %1.mfre || align=center | &nbsp; || Free-text of station mail if available, else ”-”. Available in mail related events only
 || &nbsp;
|-
| align=center | %1.tag || align=center | &nbsp; || Mail tag. Unique mail identification. Available in mail related events only || AMC 08.10
|-
| align=center | %1.dev || align=center | &nbsp; || The [[Device]] number || AMC 09.03
|-
| align=center | %1.brd || align=center | &nbsp; || The board number (1 - 25)|| AMC 09.03
|-
| align=center | %1.port || align=center | &nbsp; || The port (1 - 32) within board|| AMC 09.03
|-
| align=center | %3.chg<br>%chg|| align=center | %3c || ON_txt when the event goes ON<br>
OFF_txt when the event goes OFF<br>Example: LOG “Door %1.dir is %chg(OPEN ,CLOSED)“
<br>Result, event ON:  - “Door 123 is OPEN  ”
<br>Result, event OFF: - “Door 123 is CLOSED”
|| AMC 07.20
|-
| align=center | %3.rft<br>%rft  || align=center | %3r || Action command parameter which substitutes the parameter with a text describing the on/off transition of the event. Some events can be reported many times (e.g. line errors), and it's possible to have different actions depending on if this is the first time, or a Refresh. || &nbsp;
|-
| align=center | [[%sev]] || &nbsp; ||Read sub-event number || AMC 09.03
|-
| align=center | [[Edi (macro)|%edi]] || &nbsp; ||Read EDI text input || AMC 10.00
|-
| align=center | %1.pag || align=center | &nbsp; || Return pager number related to station 1 / 2 || AMC 10.30
|-
|}
<br>

'''Note''': %2 can be used instead of %1. %2 will refer to the 'Related To' field instead of the 'Owner' field.

=== List of macros ===

{| border="1"
! style="background:#ffdead;" width="200" |Macro
! style="background:#ffdead;" width="400" |Description
! style="background:#ffdead;" width="100" |From version
|-
| align=center | [[%op]] || Macro for numeric calculations || AMC 08.20
|-
| align=center | [[%udd]] || Read [[User Defined Data - UDD|a UDD (User Defined Data variable)]] || AMC 08.20
|-
| align=center | [[%tmp]] || Read Temporary variable || AMC 10.00
|-
| align=center | [[%sng]] || Next group which station is member of  || AMC 08.20
|-
| align=center | [[%gns]] || Next member station of group  || AMC 08.20
|-
| align=center | [[%sgm]] || Is station member of group  || AMC 08.20
|-
| align=center | %clk || Read current date and time on format yyyy-mm-dd hh:mm:ss || AMC 08.20
|-
| align=center | %clkyear || Read current year || AMC 08.20
|-
| align=center | %clkmon || Read current month || AMC 08.20
|-
| align=center | %clkday || Read current day || AMC 08.20
|-
| align=center | %clkhour || Read current hour || AMC 08.20
|-
| align=center | %clkmin || Read current minute || AMC 08.20
|-
| align=center | %clksec || Read current second || AMC 08.20
|-
| align=center | %clkwday || Read current day of week (1 = Monday, 7 = Sunday) || AMC 08.20
|-
| align=center | %1.clk, %1.clkyear etc || Read the sceduling tick time || AMC 08.20
|-
| align=center | [[%gnv]] || The value of the NVRAM-parameter || AMC 09.05
|-
| align=center | [[%scutc]] || String extraction by character position  || AMC 10.00
|-
| align=center | [[%scutf]] || String extraction by field number || AMC 10.00
|-
| align=center | [[%sscan]] || String extraction by text scan || AMC 10.00
|-
| align=center | [[%scmp]] || String compare || AMC 10.00
|-
|}
<br>
<br>

=== Formating ===
Text adjustment parameters can be added to all %xxx macros
;%xxx(width,filler)
:'''width''': Length of field
::If ‘<’ is put immediately after the width, it means left-adjustment. Default is right adjustment
:'''filler''': If width is wider than the returned value, the specified filler character is filled in
::Typical fillers are
:::”  ” (space)
:::”0” (leading zero)
:::”F” (MPC protocol)
::The filler can be omitted: %xxx(width). Then ”  ” (space) will be used as filler if required. It is not allowed with space between the formatting parameters


'''Examples:'''

'''%1.dir'''
 Minimum:         %1.dir        - Example result:  “123”
 MPC format:      %1.dir(4,F)   - Example result:  “F123”
 Two last digits: %1.dir(2)     - Example result:  “23”

'''%1.nam'''
 Minimum:           %1.nam      - “Mr. Smith”
 5 last characters: %1.nam(5)   - “Smith”
 12 char, right :   %1.nam(12)  - “   Mr. Smith”
 12 char, left :    %1.nam(12<) - “Mr. Smith   ”

[[%udd]] (assuming decimal value 65 is stored in UDD 12)
 %udd(12)         - “65”
 %udd(12,4)       - “  65”
 %udd(12,4<)      - “65  ”  
 %udd(12,4,f)     - “ff65”  
 %udd(12,4<,f)    - “65ff”



[[Category:Event Handler]]