Email Driver
TOPICITEMLIST List of the items supported under the DATASERVER topic CONVCOUNT Current number of DDE conversations established with the DATASERVER topic ADVISECOUNT Current number of advise transactions with items of the DATASERVER topic
DATASERVERCOUNT Number of defined data servers DATASERVERLIST List of data servers The DATASERVER topic also includes for each data server: A <SERVER>.STATUS item that indicates the current status of the data server designated by <SERVER>: 0 = Data server connected, no alarm, 1 = Active alarms on the data server, all acknowledged, 2 = All alarms inactive on the data server, but at least one to acknowledge, 3 = Active and unacknowledged alarms on the data server, 4 = Link failure with the data server, 8 = Data server polling stopped. This item is read only.
The TAGGROUP topic contains, in addition to the DDE protocol items, some items concerning the tag groups.
TOPICITEMLIST List of the items supported under the TAGGROUP topic CONVCOUNT Current number of DDE conversations established with the TAGGROUP topic ADVISECOUNT number of advise transactions with items of the TAGGROUP topic
GROUPCOUNT Number of defined tag groups GROUPLIST List of tag groups
The TAGGROUP topic also includes for each group:
A <GROUP>.STATUS item that indicates the current status of the group designated by <GROUP>:
Appendix
0 = No alarm in the group, 1 = Active alarms in the group, all acknowledged, 2 = All alarms inactive in the group, but at least one to acknowledge, 3 = Active and unacknowledged alarms in the group, 4 = Link failure with at least one tag of the group, 8 = Polling stopped for all tags of the group. This item is read only.
The ALARM topic contains, in addition to the DDE protocol items, some items concerning alarms.
TOPICITEMLIST List of items supported under the ALARM topic CONVCOUNT Current number of DDE conversations established with the ALARM topic ADVISECOUNT Current number of advise transactions with items of the ALARM topic
PORTFAIL Communication port failure (modem) 0 = all ports ok 1 = at least one port is failed 2 = all ports are failed REMOTEPORTFAIL Communication port failure (modem) on redundant station 0 = all ports ok 1 = at least one port is failed 2 = all ports are failed
DDEFAIL Not zero if the DDE conversation with the supervised application is broken or faulty REMOTEDDETFAIL Application link failure (DDE or OPC) on redundant station REDUNDANCYFAIL Redundancy failure 0 = redundant station ok 1 = link or port failure on redundant station 2 = link failure with redundant station ALARMLOCK 0 if no on-call group is in derogation state, 1 if at least one on-call group is in derogation state. In writing, the value 1 forces all groups in derogation state GROUPCOUNT Number of defined functional groups GROUPLIST List of functional groups
ALARMACK Command to acknowledge an alarm, under the form: "AlarmRef <Tab> User" AlarmRef is the identifier of the alarm to acknowledge. User is the name of the operator who acknowledge the alarm. The part "<Tab> User" can be omitted, in which case the alarm is acknowledgement anonymously. ALARMCOUNT Number of alarms in the alarm table ALARMLIST Alarm table (read only) This table is represented bar a list of lines having the format defined below for th e items ALARM.N. The ALARM topic also contains an item for each alarm of the alarm table . This item is identified by the name ALARM.N, the value N representing the index of the alarm in the table starting from 0, the maximum value being equal to the value of ALARMCOUNT item minus one. For read operations, an alarm item is represented by a line of 10 fields separated by tabulations and ended by carriage return (CR): Field 1 "-" if inactive alarm, "*" if active alarm Field 2 Date/Time of alarm (format "DD/MM HH:MM:SS") Field 3 Alarm identifier Field 4 Alarm message Field 5 Date/Time of acknowledgment ("DD/MM HH:MM") "-" if not acknowledged alarm Field 6 Name of acknowledging operator, "-" if not acknowledged alarm. Field 7 Alarm priority Field 8 Value of the variable associated with the alarm Field 9 Name of file containing the instructions Empty field if no instructions Field 10 Name of functional group of the alarm In writing, this item allows the acknowledgment of an alarm, by specifying in the da ta field the name of the operator who acknowledges the alarm.
Appendix
Some functions can be commanded by writing a command string in the COMMAND item of the SYSTEM topic or transmitting the same string through a n EXECUTE transaction or through the "ALERT" command line . The DDE commands can be sent from a remote station connected by network (NETDDE). The available commands are::
ALERT_SZCREATEALARM "CreateAlarm" Creation of an alarm ALERT_SZSETINSTRUCTIONS "SetInstructions" Attach an instruction file ALERT_SZSETPRIORITY "SetPriority" Modify the alarm priority ALERT_SZSETALARM "SetAlarm" Activate / deactivate an alarm ALERT_SZACKALARM "AckAlarm" Alarm acknowledgment ALERT_SZMASKALARM "MaskAlarm" Mask / unmask alarm ALERT_SZACKCALL "AckCall" Call acknowledgment ALERT_SZCALLGROUP "CallGroup" Group call ALERT_SZCALLUSER "CallUser" Call for service message ALERT_SZVALIDUSER "ValidUser" Validate / invalidate an operator ALERT_SZSENDCONSOLE "SendConsole" Send a message to the remote console ALERT_SZACKCONSOLE "AckConsole" Acknowledge a console message ALERT_SZRESTORELINKS "RestoreLinks" Reinitialize the DDE and OPC connections ALERT_SHOWWINDOW "ShowWindow" Selects the display of ALERT window ALERT_PLAYTEXT "PlayText" Synthesizes and plays a message on the local station
If the command is denied, the POKE or EXECUTE command returns an error. The error cause can be read in the REPORT item of the SYSTEM topic.
The REPORT item can be read by a simple request (REQUEST) or by a demand for advise (ADVISE). It returns the report value of the last executed command:
ALERT_ERR_NOERROR 00 Command accepted ALERT_ERR_INVALIDCOMMAND 02 Invalid function ALERT_ERR_SYNTAXERROR 03 Syntax error ALERT_ERR_LOWMEMORY 04 Memory overflow ALERT_ERR_INVALIDGROUP 05 Invalid group name ALERT_ERR_INVALIDALARM 06 Invalid alarm identifier ALERT_ERR_ACKNOWLEDGED 07 Alarm already acknowledged. ALERT_ERR_INVALIDUSER 08 Invalid user name ALERT_ERR_NOCONSOLE 09 No console defined The report for execution of a command that needs a delay to be completed (call command) should be interpreted by analysis of the events sent back in the TRACE item of the SYSTEM topic (see § 8.14.2). The commands are trans mitted under the form of character strings (upper or lower case) including a command label, followed by a parameter list, each parameter being separated from the previous by a tab character.
The commands are transmitted under the fo rm of character strings (upper or lower case) including the name of the ALERT application (with full path), a command label followed by a parameter list, each parameter being separated from the previous by a tab or a space character. If a parameter include s spaces or tabulations, it must be transformed in a quoted string (").
Object: Creation of an entry in the event list
Parameters:
1st parameter alarm identifier 2nd parameter attached on call group 3rd parameter associated alphanumeric alarm message 4th parameter associated numerical alarm message (optional) 5th parameter name of audio file containing the associated vocal message (optional)
Example:
DDE command:
CreateAlarm <Tab> Pressure <Tab> Technical <Tab> Boiler overpressure <Tab> 00835 <Tab> C:\Message\Pressure.wav
Command line:
Appendix
ALERT CreateAlarm Pressure Technical "Boiler overpressure" 00835 "C:\Message\Pressure.wav"
Object: Attach an instruction file to an alarm
Parameters:
1st parameter alarm identifier 2nd parameter Nom of text file containing the instructions 3rd parameter 1 = demand to delete the file upon deletion of alarm (by default: 0 = file never deleted)
Example:
DDE command:
SetInstructions <Tab> Pressure<Tab> c:\inst\pressure.txt
Command line:
ALERT SetInstructions Pressure "c:\inst\pressure.txt" (Attach the file "c:\inst\pressure.txt" to the alarm "Pressure")
Object: Modify the priority of an alarm
Parameters:
1st parameter alarm identifier 2nd parameter Priority level (0 to 99)
Example:
DDE command:
SetPriority <Tab> Pressure<Tab> 3
Command line:
ALERT SetPriority Pressure (set the priority level of alarm "Pressure" to 3)
Object: Activate/deactivate an alarm
Parameters:
1st parameter alarm identifier 2nd parameter "1" to activate, "0" to deactivate (optional, 1 by default) 3rd parameter alarm value (optional)
Example:
DDE command:
SetAlarm <Tab> Pressure<Tab> 1
Command line:
ALERT SetAlarm Pressure 1 (activate "Pressure" alarm, and start a call to the "Technical" group, f ollowing the configuration set by CreateAlarm)
Object: Acknowledgment of an alarm (suspend pending calls for this alarm)
Parameters:
1st parameter alarm identifier 2nd parameter name of user who acknowledges the alarm (optional)
Example:
DDE command:
AckAlarm <Tab> Pressure
Command line:
ALERT AckAlarm Pressure
Object: Masks or unmasks an alarm
Parameters:
1st parameter alarm identifier 2nd parameter "1" to mask, "0" to unmask (optional, 1 by default) 3rd parameter name of user who masks the alarm (optional)
Example:
DDE command:
MaskAlarm <Tab> Pressure
Command line:
ALERT MaskAlarm Pressure
Object: Acknowledgment of a call
Parameters:
1st parameter name of called user 2nd parameter name of user who acknowledges the call (optional) 3rd parameter "1" to require disconnection , "0" else (optional, 0 by default)
Example:
DDE command:
AckCall <Tab> Bob
Command line:
Appendix
ALERT AckCall Bob
Object: Creation of a temporary alarm, alarm activation and calling the associate d group. This alarm will be deleted after acknowledgment.
Parameters:
1st parameter destination of on-call group 2nd parameter alarm identifier 3rd parameter associated alphanumeric alarm message 4th parameter associated numerical alarm message(optional) 5th parameter name of audio file containing the associated vocal message (optional)
Example:
DDE command:
CallGroup <Tab> Technical <Tab> Pressure <Tab> Boiler overheating <Tab> 00835 <Tab> C:\Message\Pressure.wav
Command line:
ALERT CallGroup Technical Pressure "Boiler overheating" 00835 "C:\Message\Pressure.wav"
Object: Call a user for transmission of a message
Parameters:
1st parameter name of user 2nd parameter alphanumerical message to transmit 3rd parameter numerical message to transmit(optional) 4th parameter name of SOUND file containing the associated vocal message (optional) 5th parameter name of associated TEXT file (optional)
Example:
DDE command:
CallUser <Tab> Bob <Tab> Call Alert station
Command line:
ALERT CallUser Bob "Call Alert station"
Object: Set an user on-duty or off-duty
Parameters:
1st parameter name of user