Message Control Manual v8.20 Guide
Message Control Manual v8.20 Guide
Message Control
v. 8.20
Table of Contents
Message Control ...................................................................................................................... 1
Compatibility with version [Link] .............................................................................................. 2
Compatibility with version 5.50 .......................................................................................... 5
Requirements ........................................................................................................................ 6
Limitations ............................................................................................................................. 8
Supported AT commands ..................................................................................................... 9
Configure Message Control .................................................................................................. 11
General settings for sending .............................................................................................. 14
E-mail message via Outlook ........................................................................................... 15
E-mail message via SMTP .............................................................................................. 17
SMS message via GSM modem ..................................................................................... 19
SMS message via SMS gateway .................................................................................... 22
Voice messages .............................................................................................................. 24
Voice message audiofile via modem ............................................................................ 26
Voice message text-to-speech via modem .................................................................. 28
Voice over IP as audio file ........................................................................................... 30
Voice over IP as text-to-speech .................................................................................... 32
[Link] entries ............................................................................................................ 34
Project-specific settings ..................................................................................................... 46
Create a screen of type Message Control ......................................................................... 49
User Administration ............................................................................................................ 53
Functions ........................................................................................................................... 57
Screen switching to a screen of type Message Control .................................................. 58
Column settings ........................................................................................................... 59
Column selection ...................................................................................................... 60
Column format .......................................................................................................... 62
Save current queue ......................................................................................................... 65
Group/class/area/equipment suppressed ....................................................................... 66
General ........................................................................................................................ 67
Equipment Modeling .................................................................................................... 69
Send a Message ............................................................................................................. 72
Sending mode .............................................................................................................. 74
Send message to user group with shift filter ............................................................. 77
Message ...................................................................................................................... 80
E-mail via Outlook and SMS via GSM or SMS gateway ........................................... 81
E-mail message via SMTP ........................................................................................ 85
Voice message by audio file ...................................................................................... 89
Voice message via text to speech ............................................................................. 91
Acknowledgment of receipt .......................................................................................... 93
Send Message: activate .................................................................................................. 96
Send Message: deactivate .............................................................................................. 97
Parameters for messages .................................................................................................. 98
Text from limit value and free text .................................................................................... 100
Message Control in the Runtime ........................................................................................... 105
Connect screen of the type Message Control .................................................................... 107
Acknowledgment of messages .......................................................................................... 110
Voice messages in Runtime ............................................................................................... 114
Network .............................................................................................................................. 116
Voice message process ..................................................................................................... 118
Messages and error handling ............................................................................................... 122
Check list ........................................................................................................................... 124
LOG entries ........................................................................................................................ 127
Miscellaneous messages ................................................................................................ 128
Debug .......................................................................................................................... 140
Deepdebug .................................................................................................................. 132
MSG ............................................................................................................................. 136
Warnings ...................................................................................................................... 137
E-mail via SMTP/POP ..................................................................................................... 139
Error ............................................................................................................................. 143
Email via SMTP/POP - warning ................................................................................... 145
Voice over IP ................................................................................................................... 146
SMS ................................................................................................................................ 147
LOG entries - OpenSSL library ....................................................................................... 152
Message Control
The optional module Message Control allows for an automatic sending and acknowledgement of
messages. The sending is triggered via a function which can be linked with an event. Available media for
sending include the following:
• Voice message with audio file via modem or via voice over IP to telephone
The status of this transmission is logged in the Chronologic Event List (CEL).
• General settings for sending: in the properties of the Message Control group of the workspace1.
• Project-specific settings: in the properties of the Message Control node in the respective project.
1 project manager: Window in the Editor in which the Project tree, the Network topology and the engineering
environment for Smart Object templates are displayed.
As of version zenon 7.00 SP0 module Message Control differs basically from earlier versions in terms of
technology and configuration.
• the configuration is carried out in property Message Control of the workspace1 (sending) and
properties Project-specific settings for module Message Control in the project (project-specific)
• the shift model and the calendar functionality has been removed
• Sending e-mails is possible via Outlook or a SMTP Server whereas SMTP allows the sending of
attachments
• the configuration of the sending type is no longer saved in file [Link] but in file [Link]
• Evaluating the limit value texts: Up to now the evaluation of compound texts in module Message
Control differed from the evaluation of standard limit value texts. From version 7.00 on both are
evaluated in the same way. @StringTabelle+%var1
You can find details about the configuration in chapter Configure Message Control.
Conversion
Due to the profound changes a 100% compatibility cannot be guaranteed for the conversion. This is also
true for compiling Runtime files for older versions. At converting especially take care for:
• User:
• Users with the same name (first name, last name) existing: User is used and information is
added.
• No according user available: A new user is created. The link to the replacement and to the
user group is resolved. The user is added to the existing or at the conversion to the created
group.
• User groups:
• User group with same name exists: User group is used and information is added.
Message Control 2 / 154
• No according user group available: A new user group is created.
• Functions:
• Paging:
Paging is no longer available as sending type. Existing functions with sending type Paging are
changed to sending type GSM at the conversion. A message in the output window indicates this.
After the conversion you must check the settings of the function.
• SMS-Gateway:
As the simple interface does not offer a technical possibility to assign messages distinctly, from
version 7 on only the enhanced interface is supported. At conversion you must make sure that the
SMS Server from company Dialogs is configured correspondingly. Otherwise the sending fails.
Previous versions of message control and versions from zenon 7.00 SP0 on save their settings in
different files:
Import settings
If a previous version of zenon is opened in version 7 or higher the settings from the previous
[Link] are taken over and adapted as far as possible. The configuration always has to be
checked manually since not all settings can be converted 100% correctly. For instance, shift schedules
are assigend to groups which have to be further configured.
Export settings
The configuration can be written from version 7 to the [Link] for previous versions. To do so,
click on the global working area property Message Control /Export settings to [Link] ([Link])
and confirm the security query.
Attention: By executing the property Export settings to [Link] ([Link]) all corresponding entries
in [Link] are overwritten. For this reason the INI file might contain entries which cannot be
carried out in the present module message control or which disable configurations.
2. Then convert the project conversion from version 6.51 to the current zenon version.
3. In the current version, check the settings for the user and user groups.
Carry out all necessary corrections in the current version if required.
Note the compatibility notices in the Compatibility with version [Link] chapter.
Medium Requirement
E-mail The Runtime server executing the sending must be connected to a network.
message
via SMTP : An e-mail account must be available. The servers with access to the account must be
available.
SMS via A GSM modem must be connected to the computer and must be approachable via a
GSM : serial port (COM port1). usually USB modems create a virtual COM port1 during the
installation through which they can be approached.
• Support of DTMF signals (for receiving the PIN code when acknowledging a
message)
• The VoIP provider must support the SIP and RTP protocols.
The ports for the Voice over IP dispatch method can be freely configured using the properties of the
Voice over IP group.
Ranges:
• SIP: 0 - 65535
• RTP: 0 - 65534
Default values:
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
2 port: Is part of an IP address and can take on a value between 0 and 65535. The number identifies a
communication channel distinctly. For the communication with TCP/IP the IP address and the port number are
always necessary in order to address a recipient distinctly. Protocols UDP and SCTP also use port numbers.
DTMF signals from some cellphones can be interpreted with misunderstandings by some VoIP providers.
Reason: Some cellphones only send very long DTMF signals. These can be sporadically interpreted as
two short button presses by Voice over IP from the provider.
Detecting signals
DTMF signals from some cellphones can be interpreted with misunderstandings by some VoIP providers.
Windows CE
Set the telephone number of the SMS message AT+CSCA= \r\nOK\r\n at the end
center: “[SMSC
Telephone
Note: With a SMSC number, set the country code number]" \r
too (00xy or +xy; xy stands for the corresponding
figures).
Check to see if the modem has switched to AT+CMGF?\r \r\nOK\r\n at the end
SMS-PDU mode:
Check to see if the modem has set the given AT+CSCA?\r \r\nOK\r\n at the end
SMS message center:
PDU for the SMS to be sent to the number [SMS-PDU][0x1A] \r\nOK\r\n at the end
specified previously with completion flag:
List SMSs from the memory with status set by AT+CMGL= \r\nOK\r\n at the end
flag: [Flag]\r
Delete all SMSs with status set by flag from the AT+CMGD=0, \r\nOK\r\n at the end
memory (regardless of index): [Flag]\r
Note: For AT+CMGD commands, it is sufficient if one of the two versions is supported.
Arguments:
Error search
Error messages contain the notice ERROR in the response. You can find details on troubleshooting and
testing the connection in the Messages and error handling chapter.
• Functions which are executed in the Runtime for sending and management of messages
• E‑email
• SMS
• Voice message
1. Select the medium for dispatch in the properties group in Message Control .
Note: You can find this properties group if you click on the current Workspace in the zenon Editor.
2. To do this, activate the Sending mode active property in the area of the properties group that
represents the desired dispatch type.
Note: The Sending mode active property can be activated for several types of dispatch.
5. Configure the users or user groups that are to be reached via the medium.
1. with a button or
2. with the property Execute function instantly in case of limit values which are supposed to
send this message in case of violations
For linking with a limit value, content that is dynamically generated in the Runtime can be sent.
In order to use several Send a Message functions for a limit value, use a script that contains
these functions and is linked to the limit value.
• Dynamic part of the subject property in the project-specific settings for e-‑mail via SMTP
or Outlook
or
• Message text: defined for e-mails, SMS and voice messages in:
By doing so in the Runtime, the status of messages can be checked and the message queue can be
monitored.
• Active during Runtime start property: Once this property is activated Message Control
will automatically start in Runtime.
• Function Send Message: activate: If this function is carried out Message Control is started.
Messages are only processed from this point of time on.
When the Runtime is closed normally, an image of the current message queue is saved. This image can
also be created anytime in Runtime using the Save current queue function. Message Control can be
closed with the function Send Message: deactivate in the Runtime.
Suppress message
Message Control has a list of deactivated elements. Deactivated means that their alarms do not trigger a
message.
If during a violation of limit values the function Send Message is linked the messages are only created
and sent if neither variable1 nor alarm are suppressed.
• The variable1 is suppressed if its area or a linked equipment group is contained in the list of
suppressed elements.
This list can be modified with the function Suppress groups/classes/areas/equipment in the Runtime.
Alarms and equipment can be activated or deactivated. Suppressed entries are logged in the CEL if the
property Log in CEL is configured with all confirmations or only negative confirmations.
Activating or deactivating entries is carried out remanently in the network. If for instance for
maintentance purposes the alarms of an equipment section are switched off this setting will remain
active even after closing Runtime and will be re-applied during a restart.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
These properties of the Message Control group in the workspace1 are not project-specific.
Changes to this area are only effective in the Runtime after it has been restarted.
1 workspace: An administrative unit in the Editor in which projects can be grouped. Only projects which are
added to a workspace can be edited in the Editor.
• the sending mode was activated via the property Sending mode active
• on the executing computer a running Microsoft Outlook instance with a valid account and a
connection to the network/internet is available
If messages must be acknowledged it has to be taken care that the mailbox is retrieved within the
timeframe availablefor acknowledgement. This period of time is defined with the function Send message
(tab1 acknowledgement).
For Outlook, the following applies for use with message control:
Configuration
1. Activate the sending mode via the property Sending mode active .
Note: You can find this property in the Mail message (Outlook) area of the Message Control
property group.
2. Define the name of the Outlook profile to be used via the property Profile .
Behavior in Runtime
2. Messages are composed according to the settings and are sent as soon as a corresponding function
is carried out.
3. If a user responds to a message their response is read when the messages are retrieved and is then
passed on to Message Control.
• the sending mode was activated via the property Sending mode active
If messages must be acknowledged it has to be taken care that the mailbox is retrieved within the
timeframe availablefor acknowledgement. This period of time is defined with the function Send message
(tab1 acknowledgement).
Configuration
1. Activate the sending mode via the property Sending mode active .
Note: You can find this property in the Mail message (SMTP) area of the Message Control
property group.
2. Messages are composed according to the settings and are sent as soon as a corresponding function
is carried out.
3. If a user responds to a message their response is read when the messages are retrieved and is then
passed on to Message Control.
Only one thread at a time can open connections. A connection is always opened for the thread that needs
it and then closed again after the data exchange is complete. Whilst a message is sent, another thread
can query the received post or also send a message. If the incoming messages are retrieved it is also not
possible for another thread to start a retrieval or send messages.
The correct settings for the configuration are available from the provider of the employed e-mail account.
Procedure
1. Establishing a connection with the parameterized incoming mail server and the corresponding port.
If the connection is or is not secure depends on the settings of property Encryption .
2. All mails in the mail inbox are retrieved by the commands STAT and RETR. It is decided on the basis
of the subject whether an e-‑mail is relevant. Not relevant messages are skipped. Relevant messages
are forwarded to Message Control and - as long as the Keep read mail on server property is
deactivated - deleted from the server with the DELE command.
Note for HTML emails: All HTML control characters are removed on receipt.
3. The connection is closed by sending the QUIT command and subsequent closing of the connection.
Sending of an e-mail
1. According to the setting a secure or unsecured connection to the SMTP server is established.
2. If configured the SMTP authentication is carried out with the AUTH command.
3. The message to be sent is transferred in MIME format with the SMTP commands MAIL, RCPT and
DATA.
4. The SMTP connection is closed by sending the QUIT command and subsequent closing of the
connection.
1 port: Is part of an IP address and can take on a value between 0 and 65535. The number identifies a
communication channel distinctly. For the communication with TCP/IP the IP address and the port number are
always necessary in order to address a recipient distinctly. Protocols UDP and SCTP also use port numbers.
2 HTML: Is a text-based markup language for structuring content such as texts, graphics and hyperlinks in a
document. The screen of type HTML displays HTML content.
• the sending mode was activated via the property Sending mode active
• a GSM modem must be connected to the sending computer and must be approachable via a serial
port1 (COM port)
Note: usually USB modems create a virtual COM port during the installation through which they can
be approached.
• The GSM modem probably has to be initialized with a manufacturer software in order to be able to
connect to the GSM network.
Configuration
1. Activate the sending mode via the property Sending mode active .
Note: You can find this property in the SMS message (GSM modem) area of the Message Control
property group.
2. Select the COM port of the modem from the drop-down menu via the propertyModem connection
(serial) .
The correct port1 is displayed in the system properties of the modem.
Note: After a reconnection of the modem or a reboot of the computer the modem probably will have
to be re-initialized with the manufacturer software before it can be used with Message Control. The
COM port may change with a reconnection of the modem or a reboot of the computer.
3. In the property PIN code enter the PIN for the modem, if required.
5. Enter the telephone number for the short message center in the property field Number of SMS center
.
Behavior in Runtime
1. As soon as the Runtime is started the connection to the modem is being established and configured.
3. Messages are composed according to the settings and are sent as soon as a corresponding function
is carried out.
4. If a user responds to a message their response is read when the messages are retrieved and is then
passed on to message control.
Information
• execute the configuration software delivered by the GSM operator so that the modem is
initialized and connects with the network.
• check in the system control if the modem uses the same COM port again after reconnecting.
Timeout for 10000 ms The modem has 10 seconds to respond to the transmission
AT of an AT command.
commands
SMS polling 20000 ms Every 20 seconds it is checked if new SMS have arrived and
interval they are being read. If no incomplete multi-part SMS are
present anymore all messages which were read are deleted.
COM Write: 5 seconds 5 seconds are available for writing the bytes on the COM port
timeouts (max. 400 in case of SMS-PDU with maximum size).
read: immediate return
During the reading of the COM port the current content of the
receive buffer is read and immediately returned.
• Parity check:
Inactive
• Clear-to-Send and
Data-Set-Ready:
not controlled
• Data-Terminal-
Ready and
Request-To-Send
Flow Control:
activated
• Parity: None
• Stop Bit: 1
Buffer
Size of send buffer and 4096 The individual PDUs have a maximum size of 400 byte. During
size of receive buffer the sending of a SMS the individual PDUs are sent one after
for the serial port1 in another.
byte
During receiving all SMS arrived since the last polling interval
are retrieved at once as block. Thus the modem can move at
least 10 PDUs at once into the receive buffer of the serial port1.
Size of the total buffer 12288 Since a SMS-PDU occupies a maximum of 400 bytes in the
for conversion and receive buffer within one polling interval of 20 seconds, a
incoming SMS in byte maximum of 30 SMS parts with maximum size can be received
with this buffer.
• the sending mode was activated via the property Sending mode active
Procedure
For the correct configuration of the SMS server, please contact the manufacturer.
• Inbox
• Outbox
• State
Configuration in zenon
1. Activate the sending mode via the property Sending mode active .
Note: You can find this property in the SMS message (SMS gateway) area of the Message Control
property group.
4. configure First letter of the lock/semaphore file : Sets the initial letter for the lock/semaphore files.
This starting letter is unique for the project. If a SMS gateway is used by various projects, for each
project an unique prefix must be defined.
• all outgoing messages are being checked. If the message starts with the text ALARM!, the
message is not sent in the usual format (ID; message) but in the format: ALARM! ID;
message.
Behavior in Runtime
2. Messages are composed according to the settings and are sent as soon as a corresponding function
is carried out.
3. If a user responds to a message their response is read when the messages are retrieved and is then
passed on to Message Control.
Smart Alarming
If the Smart alarming property has been activated, SMS messages are handled as follows:
2. If the messages starts with the text "ALARM!", the message is not sent in the usual format (ID;
message), but in the format ALARM:
ALARM! ID; message
3. With the sending of such a message, the recipient's mobile phone is automatically switched to very
loud if this is supported by the telephone.
Note: Incoming messages are also checked for this character string.
You can read information about the process in the Runtime in the subchapters and in the Voice
messages in Runtime chapter.
Modem
The following must be the case in order to send messages via a modem:
Voice over IP
• Server address
• User name
• Password
Attention: Not all technical possibilities of the protocol have been implemented in Message Control.
Audio file
The following must be the case in order to send messages as an audio file:
• One audio file each must be saved in the Files/Multimedia node for:
• Description
Message Control 24 / 154
• Acknowledgement
• Misentry
Text-to-Speech
• the sending mode was activated via the property Voice modem (audio file)
• One audio file each must be saved in the Files/Multimedia node for:
• Description
• Acknowledgement
• Misentry
Attention: The value for the project-specific Waiting period between trials and timeout property must
be greater than the value for the Waiting time option in the Send a Message functions (Receipt
Confirmation tab1).
Procedure
Configuration
1. Activate the sending mode via the property Voice modem (audio file) .
2. Configure the settings for Timeout [min] and Repeat welcome text .
Behavior in Runtime
3. The connection is considered established as soon as the call to the counterparty is signaled. The
greeting is played from this point. The greeting can be repeated using the #- key.
Then the PIN must be entered. Only then is the message played back.
4. The message must be acknowledged by the recipient with the respectively valid code:
Note: Only once the line has been closed is the status of the message evaluated (confirmed, rejected or
missing). As long as the line is open, it is possible to start over by pressing the star key * and entering the
code again. PIN can thus be changed to NA, for example.
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
• the sending mode was activated via the property Voice modem (Text-to-Speech)
Attention: The value for the project-specific Waiting period between trials and timeout property must
be greater than the value for the Waiting time option in the Send a Message functions (Receipt
Confirmation tab1).
Language Files
Depending on the version of the Editor (32-bit or 64-bit), the corresponding speech (32-bit-compatible or
64-bit-compatible) must be installed and configured.
To do this:
3. Start the Editor and select the configured speech in the Voice property.
Procedure
Configuration
1. Activate the sending mode via the property Voice modem (Text-to-Speech) .
2. Configure the settings for Timeout [min] and Repeat welcome text .
• Voice
• Speech rate
• Volume
Behavior in Runtime
3. The connection is considered established as soon as the call to the counterparty is signaled. The
description is played back from this point. The greeting can be repeated using the #- key.
Then the PIN must be entered. Only then is the text for the confirmation played back.
4. The message must be acknowledged or rejected by the recipient with the respectively valid code.
• Replay the file just listened to by pressing the hash key (#) on the phone
• Undo an entry by pressing the star key (*); In this case the description will be played back
again
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
• the sending mode was activated via the property Voice over IP (Audio file)
• One audio file each must be saved in the Files/Multimedia node for:
• Description
• Acknowledgement
• Misentry
Procedure
Configuration
1. Activate the sending mode via the property Voice over IP (Audio file) .
• Server address
• User name
• Password
Behavior in Runtime
4. The description must be acknowledged by the recipient with the respective valid code:
• Replay the file just listened to by pressing the hash key (#) on the phone
Note:
• If the call is not accepted, the substitute person is called up if one has been configured. The call is
canceled otherwise.
• The name of the audio file is shown in the list of messages in the Message column.
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
• the sending mode was activated via the property Voice over IP (Text-to-Speech)
Language Files
Depending on the version of the Editor (32-bit or 64-bit), the corresponding speech (32-bit-compatible or
64-bit-compatible) must be installed and configured.
To do this:
3. Start the Editor and select the configured speech in the Voice property.
Procedure
Configuration
1. Activate the sending mode via the property Voice over IP (Text-to-Speech) .
• Server address
• User name
• Password
• Voice
• Speech rate
• Volume
Behavior in Runtime
3. The connection is considered established as soon as the call to the counterparty is received. The
description is played back from this point. The greeting can be repeated using the # button.
4. The description must be acknowledged or rejected by the recipient with the respective valid code.
• Replay the file just listened to by pressing the hash key (#) on the phone
• Undo an entry by pressing the star key (*); In this case the description will be played back
again
Note:
• If the call is not accepted, the substitute person is called up if one has been configured. The call is
canceled otherwise.
• The message text is shown in the list of messages in the Message column.
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
Note: Changes should always be made using the properties of the zenon user interface.
Entry Description
• 0: active
• not 0: inactive
Default: 0
GSM_SMS_COM= COM port that is used for the connection to the modem.
Default: empty
GSM_SMS_PIN= PIN code which is used for authentication towards the modem.
Default: empty
Default: empty
Message Control 34 / 154
It corresponds to the Number of SMS center property in the
Editor.
Default: 0
• 0: inactive
• 1: active
Default: 0
Outlook_Profile= Name of the Outlook profile which should be used for sending.
Default: empty
Default: 0
POP_KEEP_MAILS= Defines whether e-mails that have been read remain on the
server:
Default: 0
POP_PASSWORD= Password for login at the incoming mail server (POP3). The
password is saved encrypted and is only decrypted for
authentication purposes.
Default: empty
• Minimum: 10
• Maximum: 4294967295
Default: 60
Default for:
• 0, no security
• 2: TLSv1
Default: 0
Default: empty
Default: empty
• 0: inactive
• 1: active
Default: 0
Default: empty
Default: empty
Default: empty
SMSGateway_Prefix= First letter of the SMS files. Must be unique for each project.
Length: 1 characters
Default:F
Length: 1 characters
Default:S
• 0: inactive
• 1: active
Default: 0
Default: empty
Default: 60
• 0, no security
SMTP_MAIL_RECIPIENT_AS= Select in which field of the message the recipients are written.
Default: 1
SMTP_OTHER_CREDS= Defines whether the outgoing server uses different log in data
than the incoming server.
• 0: inactive
• 1: active
Default: 0
Default: empty
• 0: Login data for the incoming mail server is also used for
the outgoing mail server.
Default: 0
Default: empty
• 1: active
• 0: inactive
Default: 0
Maximum: 65535
Default: 25
• 0, no security
• 2: TLSv1
Default: 0
Default: empty
SMTP_SRV_IS_POP= This entry defines whether the POP3 Server is used as SMTP
Server.
• 1: POP 3 is SMTP
Message Control 40 / 154
• 0: POP3 and SMTP are different Servers
Default: 0
Default:MsgCtrl_Alert:
Default: empty
SMTP_USER_IS_ADDR= Defines whether the user name for authentication towards the
outgoing server is used as sender address for outgoing mails.
Is only used if the SMTP_AUTH= entry is not 0.
• 1: active
• 0: inactive
Default: 0
• 0: inactive
• 1: active
Default: 0
• 32-bit Editor:
C:\Windows\SysWOW64\Speech\SpeechUX\[Link]
• 64-bit Editor:
C:\Windows\System32\Speech\SpeechUX\[Link]
Default: empty
• Minimum: -10
• Maximum: 10
Default: 0
• Maximum: 100
Default: 0
Default:MsgCtrl_Alert:
• 0: inactive
• 1: active
Default: 0
Default: 0
Default: 1
Default: 5
• 0: inactive
Default: 0
Note:
Default: empty
Default: empty
Default: 4000
Default: 5060
• 0: inactive
Default: 0
Note:
Default: empty
Information
Some properties can accept the values of other properties. You always save the value that was entered
last. The vale of the ini entries therefore does not always need to correspond to the values of the
properties displayed in the Editor. The following properties are affected:
1 operating system: An operating system (OS) is an interface between hardware and user which is responsible
for the management and coordination of activities and the sharing of the resources of a computer, that acts as
a host for computing applications run on the machine
2 project tree: Structured graphic display of all projects and modules in a workspace.
• Active during Runtime start property: Once this property is activated Message Control will
automatically start in Runtime.
• Function Send Message: activate: If this function is carried out Message Control is started.
Messages are only processed from this point of time on.
Message Control can be closed with the function Send Message: deactivate in the Runtime.
Project-specific properties
• Dynamic part of the subject via the property Dynamic part of the subject : Incoming messages are
filtered for this content for forwarding to Message Control.
• Logging the message via property Log in CEL : In the Chronologic Event List messages can be
logged according to different criteria:
• Confirm all:
All messages
• No confirmations:
No messages
• Marking the message status by means of color and graphics: The column status of the screen
Message Control can display the status of a message by means of a graphic and color.
Information
• If a call is interrupted without confirmation or a decline and the interruption is not classified as
a hardware error, then:
• If substitutes or group members who have not yet been messaged are messaged
• If a call is interrupted by a hardware error, then the call for the same addressee is sent again
according to the number of repetitions set in the Maximum number of attempts property.
1. Static part: unalterable subject which is defined in the global settings for e-mails.
2. Dynamic part: project-specific part of the subject. Is defined with the property Dynamic part of the
subject .
The dynamic part of the subject was set up according to the following rules:
• A parameter can:
• Define a certain variable1 that is called up on execution of the function by means of AML or
a limit value breach by means of its name: for example %Var1;
Caution: The variable1 whose limit value has been breached is not dynamically determined
for the subject!
• %: marks variables
• Text parts are separated from one another with a semi colon (;).
Example: $@Attention;%Var1;
1 variable: A variable represents a value in the memory of the control system. There are internal and external
variables. Variables are based on a datatype and a driver object type. Many properties of the variables are
stored centrally and can therefore be used in different locations of the control system (for example, properties
that can be configured in the Editor, like the unit, the measuring range etc.). In the Runtime, the state and the
time stamp are additional properties of the variable.
Engineering
Steps to create the screen using the properties if the screen creation dialog has been deactivated in the
menu bar under Tools, Settings and Use assistant:
To do this, select the New screen command in the tool bar or in the context menu of the Screens
node.
1. Select the Elements (screen type1) menu item from the menu bar.
4. If necessary, select additional elements in the Elements drop-down list. Place these at the
desired position in the screen.
Longer texts can also be displayed in the Runtime over several lines using the Automatic word wrap
property.
In the Editor, go to Representation in the properties of the respective list properties and activate the
checkbox of the Automatic word wrap property.
Insert template
Control Description
elements
Insert Opens the dialog for selecting a template for the screen type1.
template
Templates are shipped together with zenon and can also be created by the user.
Templates add pre-defined control elements to pre-defined position in the screen. Elements
that are not necessary can also be removed individually once they have been created.
Additional elements are selected from the drop-down list and placed in the zenon screen.
Elements can be moved on the screen and arranged individually.
Window
Suppressed Alarm/event groups for which messages were suppressed and the alarms of
alarm/event groups which are thus not displayed in the message queue.
Suppressed Alarm/event classes for which messages were suppressed and the alarms of
alarm/event which are thus not displayed in the message queue.
classes
Suppressed Alarm/event areas for which messages were suppressed and the alarms of
alarm/event areas which are thus not displayed in the message queue.
Suppressed pieces Equipment for which messages were suppressed and the alarms of which are
of equipment thus not displayed in the message queue.
List functions
Control Description
elements
Delete Deletes selected entry from the list. It is only possible to delete messages which have
not been sent yet.
Refresh Refreshes view. The current data is loaded onto the screen from the message queue.
The point of time of the last update can be displayed with the field Last update.
Filter profiles
Information
The columns of the list can be configured via the Filter for the function screen switching in the Editor, in
the Runtime via the control element Filter. The columns of the list can be provided with individual labels
and are localizable.
1 checkbox: A standard element of the graphical user interface (GUI) of a software. In general a checkbox has
two states. Sometimes it can have three or more states.
2 control element: Special elements for each screen type with which the control, selection and input is
implemented. These elements can be buttons, static texts, combo boxes, list boxes, graphical displays, input
fields, radio buttons, spin controls, calendar displays, date displays or time displays.
Ensure that the required contact data for sending has been configured for each user.
If a user or user group is to be notified in the Runtime and the data required for the sending type is
not available for a user, the sending is canceled. Another attempt to send is not made.
For groups, this means: If, for example, the fourth user of a list cannot be configured correctly, the
first three users of the list are notified. The process is canceled with the fourth user. They and all
subsequent users on the list do not get any more notifications. There is also no attempt to notify
the first three users again.
User
Parameter Description
Telephone Number of the voice-compatible telephone device of the user. Used for text to speech.
• The following separators are also permitted in AD user administration1: Minus (-),
slash (/) and space
Note: When communicating between AD and Message Control, separators are
ignored as soon as the data from the AD is mapped to a zenon object.
Cell Cellphone number of the user. Used for messages via GSM and SMS (text messages).
phone
Enter numbers. In addition, the following are permitted:
• The following separators are also permitted in AD user administration1: Minus (-),
slash (/) and space
Note: When communicating between AD and Message Control, separators are
ignored as soon as the data from the AD is mapped to a zenon object.
Substitute If a user has not been reached or they do not accept the message, a substitute person can
person be given. Click the ... button and the dialog opens to select an user. Only users who have
been activated as Message Control users are offered for selection.
PIN code PIN code with which the user confirms the receipt of the message.
The code consists of a four-digit number between 0000 and 9999.
NA code PIN code with which the user rejects the receipt of the message (not available). The
message is then sent to the next user in the list.
If there is no other user entered in the list, the message is entered as "not successfully
acknowledged". The function assigned to this is executed. In addition, a "rejected by" CEL
entry is created in each case.
The code consists of a four-digit number between 0000 and 9999.
Note: You can find further information on the assignment of functions in the Confirmation
of receipt - confirmation of receipt settings chapter.
Close dialog
Option Description
Cancel Discards all changes in all tabs and closes the dialog.
The acknowledgment codes for PIN (confirmation) and NA (rejection) must differ and should not
be too similar.
If both codes are identical the code is interpreted as PIN and therefore as confirmation of the
message.
If an unknown code is received, a SMS and e-‑mail is sent to the substitute person. The error
message is played back for voice messages.
Users can be sequenced through the property User order within a user group.
Parameter Description
In the Runtime the sequence of the users from the global user administration1 is added to the defined
sequence in this property. As a consequence, local users are always displayed before global users.
Information
Get details on the user administration1 in zenon in the manual User administration.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
With this:
• The Message Control screen will be displayed in order to manage the message queue
8. connect the function with a button in order to be able to access it in the Runtime
1 switch: Dynamic element which displays and modifies the value of a binary variable. It can also be used as a
momentary switch.
Parameter Description
Option Function
Add -> Moves the selected column from the available ones to the selected items. After you confirm
the dialog with OK, they are shown in the detail view.
<- Removes the marked columns from the selected items and shows them in the list of
Remove available columns. After you confirm the dialog with OK, they are removed from the detail
view.
<- All columns are removed from the list of the selected columns.
Remove
all
Down Moves the selected entry downward. This function is only available for unique entries,
multiple selection is not possible.
Close dialog
Options Description
Configuration of the properties of the columns for configurable lists. The settings have an effect on the
respective list in the Editor or - when configuring screen switching - in Runtime.
Available columns
Option Description
Available List of the available columns via Column selection. The highlighted column is configured
columns via the options in the Settings area.
Settings
Option Description
The column title is online language switchable. To do this, the @ character must be
entered in front of the name.
Possible settings:
User-defined Properties in order to define user-defined colors for text and background. The settings
colors have an effect on the Editor and Runtime.
Note:
• In addition, the respective focus in the list can be signalized in the Runtime by
means of different text and background colors. These are configured using the
project properties.
Text color Color for text display. Clicking on the color opens the color palette to select a color.
Background Color for the display of the cell background. Clicking on the color opens the color
color palette to select a color.
Lock column • Active: The filter for this column cannot be changed in the Runtime.
filter in the
Runtime Note: Only available for:
• Batch Control
• Extended Trend
• Filter screens
• Message Control
• Recipegroup Manager
• Shift Management
• Context List
Close dialog
Option Description
Cancel Discards all changes in all tabs and closes the dialog.
2. Select the Save current queue function in the Message Control group.
3. Link the function with a button in order to be able to access it in the Runtime
If a Limit Values is linked to a function Send a Message the messages are only created and sent if
neither variable nor alarm are suppressed.
• The variable is suppressed if its area or a linked equipment1 group is contained in the list of
suppressed elements.
• The alarm is suppressed if the alarm/event group, the alarm/event class or the alarm area is
contained in the list of suppressed elements.
Suppressed entries are logged in the CEL if the property Log in CEL is configured with all confirmations
or only negative confirmations.
Engineering of a function
6. connect the function with a button in order to be able to access it in the Runtime
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
2 alarm/event class: Is used for classifying events in the AML/CEL. Can be used freely, e.g. for the local
allocation to areas but also for the grouping according to priorities such as message, failure, alarm etc. In
contrast to alarm/event groups, the alarm/event classes can be used for coloring the AML/CEL. Likewise
alarm/event classes can be assigend to alarm areas.
Parameter Description
Activate Active: When activating the function the selected elements are added to the list of
suppressed elements.
Deactivate Active: When activating the function the selected elements are removed from the list of
suppressed elements.
• Inactive: This dialog is not shown in the Runtime during operation. The function or
the command is immediately executed with the project configuration created in the
Editor.
Close dialog
Option Description
Cancel Discards all changes in all tabs and closes the dialog.
Selecting elements from a list performed via mouseclick. Multiple selection is possible. A simple
mouseclick is enough, it is not necessary to press additional keys. Clicking twice on a selected element
deselects the element.
Option Description
• Display of information
List of provides models and groups for selection The list separates the display into equipment1
equipment1 models from the global project and from local projects.
models
Local equipment1 models can be created, edited or deleted.
Note: Equipment models from the global project cannot be displayed if there are models
with the same name from the local project. Affected models are displayed by clicking on
Hierarchic Checkbox for the activation of the hierarchical filtering of the equipment1 model
filter
• active: Variables that are linked to a subhierarchy of the selected equipment1 group
are taken into account when filtering and are contained in the display in the Runtime.
• Inactive: When filtering, only variables that are linked to the selected equipment1
group are taken into account.
Default: active
Close dialog
Option Description
Attention: Any changes that have been made to the structure of local equipment1 models are
retained.
Configuration
New models and groups can be created for the active project and existing ones can be deleted.
Remove model
3. Add the new group to the list in the lower area of the dialog with the Add button.
Note:
1. Select the desired elements in the list in the lower area of the dialog (multiple selection is possible).
Note: Changes in a tree element remain preserved independent of clicking button Cancel. Cancel only
means that no element was selected.
In the Runtime
When executing the function the setting configured in the dialog is sent as request to the process-
executing computer. It is then analyzed.
Ensure that the required contact data for sending has been configured for each user.
If a user or user group is to be notified in the Runtime and the data required for the sending
type is not available for a user, the sending is canceled. Another attempt to send is not made.
For groups, this means: If, for example, the fourth user of a list cannot be configured correctly,
the first three users of the list are notified. The process is canceled with the fourth user. They
and all subsequent users on the list do not get any more notifications. There is also no attempt
to notify the first three users again.
• Sending mode
• Message
• Acknowledgment of receipt
For linking with a limit value or reaction matrix, content that is dynamically generated in the Runtime
can be sent. In order to use several Send a Message functions for a limit value, use a script that
contains these functions and is linked to the limit value.
Information
In the Runtime the function Send a Message is always performed at the computer executing the
process. This is the computer that executes the function in Runtime.
Parameter Description
sending Selection of the sending mode from the drop-down list: The following are available
mode depending on configuration:
Type Configuration of recipient pattern from the drop-down list. In doing so, the dialog to select
a user or a user group is opened.
The following are available:
• User group:
Sending to a group.
The Method option stipulates how group members are notified.
• User:
Dispatch to an individual user.
Configured users or user groups can be amended using the Recipient name option.
Method Only available if, for the Type User group or User group with shift filter option has been
selected.
• Group call:
All users of the group will receive the message parallel.
(Notice: In versions prior to zenon 7.00, this method corresponded to the group
sending dispatch type.)
• Following call:
The message is delivered to the users according to the defined sequence group
successively until the first user positively acknowledges receipt. The group is only run
through once. If there is no positive acknowledgement the sending is ended.
Name Active: The variable is read in Runtime and a user or user group from the user
Message Control 75 / 154
from administration is read off by means of its value. Click on button ... in order to open the
variable dialog for selecting a variable.
Dialog can only be closed if all required options have been configured.
Cancel Discards all changes in all tabs and closes the dialog.
1 user administration: Programm or part of a programm in which you can define which users exist in a system,
which rules apply to them when logging on to the system and which rights they have in the system.
Note: Notification can only be used for configured shifts. Linking to shift models is not possible.
Configuration
To notify users:
• The Message Control group property has been activated for the user group
3. Stipulate, for the user group, the sequence in which the users are to be notified. Use the User order
property for this. The users are notified in the stipulated order.
4. For Message Control, configure the recipient in the Send a Message function:
3. Select the user group configured for shift management as the recipient of the message.
Note: To change the group later, select the Recipient name option.
4. Select a method.
Note: If group call is selected, all recipients are notified at the same time, and consecutively
with following call and infinite successive call.
Procedure in Runtime
1. The function looks, in the set user group, for the first user who is configured for Message Control.
2. A check is carried out to see whether this user is included one of the shifts that is currently active.
4. If the user is not included, they cannot be contacted or they reject the message, the next user in the
user group is searched for and compared to the current shift.
5. This process is carried out until a user confirms the message or the group has been gone through in
full.
The behavior in the Runtime depends on which method has been selected for the user group with shift
filter:
Style Procedure
Group call: • The message goes to all users of the selected type who are linked in a shift for
which the function execution is active.
All users found are notified at the same time.
• If a user does not confirm the message, a message is sent to their substitute if
they are linked in a shift.
Following call: • An attempt is made to find the first user of the group who is linked to the shift.
• If they cannot be contacted, the next user is searched for and notified.
• This is run through once until the end of the group has been reached.
• If no shift is still active during the process or no relevant users are linked in the
active shifts, the notification is ended.
A corresponding entry is made in the CEL.
Endless • An attempt is made to find the first user of the group who is linked to the shift.
following call:
• This user is notified.
• If they cannot be contacted, the next user is searched for and notified.
• If no shift is still active during the process or no relevant users are linked in the
active shifts, the notification is ended.
A corresponding entry is made in the CEL.
Note:
• Only users who are linked in a shift for which the execution of the function is active are notified.
• Depending on the configuration, messages can also be sent to users who are no longer active in any
shift.
Example: The type of sending (such as telephone) needs some time for sending. If, at the time of
generating the message, there are already further messages in the queue, the new message is sent
with a delay. If the shift has been switched in the mean time, the message is nevertheless sent to the
user of the previous shift.
• The group contains the users User 1, User 2, User 3, User 4, User 5 and User 6, in exactly this order.
• The Send a Message function is configured with the following call method.
• At the time of the initial sending, a shift is active with User 4, User 5 and User 6.
• The function compares the users of the group to the users in the shift.
• However, at this time, the original shift has already ended and the next shift has started with User 1,
User 2 and User 3.
• Because all users are arranged in the group before User 6, no further message is now sent.
Recommendation: Select infinite successive call as a method . Then all users are contacted until one
reacts. In our example, User 1 would be notified after a shift change to the new shift.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
You can find details on configuration of the parameters for messages in the Parameters for messages
chapter.
Information
If parameters or values of additional variables are included in a message, these variables are not
automatically logged on at the driver. If a variable is not logged on at the point of time the function is
being carried out it must be logged on during the activity. Under certain circumstances (e.g. in case of
slow serial communication with the hardware) this can result in delays since it has to be waited until
the first value is provided by the driver and can be analyzed by the function.
1 driver: A computer program or module which controls the interaction with connected or build-in devices
(hardware). For this it uses interfaces to the communication bus or other communication systems with which
the device is connected in order to send or receive control signals or data to or from the device.
2 variable: A variable represents a value in the memory of the control system. There are internal and external
variables. Variables are based on a datatype and a driver object type. Many properties of the variables are
stored centrally and can therefore be used in different locations of the control system (for example, properties
that can be configured in the Editor, like the unit, the measuring range etc.). In the Runtime, the state and the
time stamp are additional properties of the variable.
Parameter Description
• Text components are considered parameters if they are separated from the rest of
the text with a semicolon (;) and end with a semicolon (;).
Parameters can be copied from the List of limit value text parameters. You can read
more about the subject in the Parameters for meesages chapter.
active Active: Adds additional parameters from the limit value to the constant text.
Configuration via options:
• from variable
Attention: If this option is active only limit value violations can trigger this function.
from Parameters are taken over from the defined variable. Click on button ... in order to open
variable the dialog for selecting a variable.
from Parameters are taken over from the variable whose limit value was violated.
penultimate
variable
list limit Selecting parameters from list by activating the corresponding checkbox1. Sequence is
value text definded by drag & drop with the mouse or the buttons move entry up and move entry
parameters down.
Split placeholders:
Displays placeholders which can be used in free message text.
If the option from variable or from penultimate variable or the variable selection is
changed the example entry will be adjusted. Placeholders can be copied.
• Parameter: Parameter
• Origin: Only information, not used for free text. Indicates which variables can be
used for the parameter :
main variable via limit value
For details, see the Parameters for messages and Parameter limit value text chapters.
Show this Active: Opens this dialog in the Runtime before executing the function.
dialog in the
Runtime Attention - Behavior in the Runtime:
• In the Runtime this function is always performed at the computer executing the
process. If the function is started on a client the dialog is displayed on the computer
executing the process.
• If no entry is made the dialog is automatically closed after 30 seconds and the
function is carried out.
• If the dialog is edited and closed with OK the changes will be saved and the function
carried out.
• If the dialog is closed with cancel no message is being sent. This process is
documented in the CEL provided for the property Log in CEL all confirmations or
only negative confirmations was selected.
Dialog can only be closed if all required options have been configured.
Cancel Discards all changes in all tabs and closes the dialog.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
2 variable: A variable represents a value in the memory of the control system. There are internal and external
Parameter Description
• Text components are considered parameters if they are separated from the rest of
the text with a semicolon (;) and end with a semicolon (;).
Appendix Configuration of an appendix to the e-mail. Any desired file can be sent as an
attachment.
Clicking on the ... button opens the dialog to select a file with the presetting to the
Files/graphics node.
If the attachment is in another folder:
When sending the message the selected file is added as attachment to the e-mail.
Note: To send files from other folders, select the From variable option.
from Sending of attachments using a variable. Any desired file can thus be sent from any
variable desired path:
The value of the string variables is read in the Runtime and the content is analyzed. The
path to the appendix is set according to the analysis:
• No absolute path: The value of the string variables is attached to the path to the
zenon graphics folder.
When setting the path, a check is not carried out to see which expansion the file has.
active Active: Adds additional parameters from the limit value to the constant text.
Configuration via options:
• from variable
Attention: If this option is active only limit value violations can trigger this function.
from Parameters are taken over from the defined variable. Click on button ... in order to open
variable the dialog for selecting a variable.
list limit Selecting parameters from list by activating the corresponding checkbox1. Sequence is
value text definded by drag & drop with the mouse or the buttons move entry up and move entry
parameters down.
Split placeholders:
Displays placeholders which can be used in free message text.
If the option from variable or from penultimate variable or the variable selection is
changed the example entry will be adjusted. Placeholders can be copied.
• Parameter: Parameter
• Origin: Only information, not used for free text. Indicates which variables can be
used for the parameter :
main variable via limit value
main variable via AML
additional variable via limit value or AML
For details, see the Parameters for messages and Parameter limit value text chapters.
Show this Active: Opens this dialog in the Runtime before executing the function.
dialog in the
Runtime Attention - Behavior in the Runtime:
• In the Runtime this function is always performed at the computer executing the
process. If the function is started on a client the dialog is displayed on the computer
executing the process.
• If the dialog is edited and closed with OK the changes will be saved and the function
carried out.
• If the dialog is closed with cancel no message is being sent. This process is
documented in the CEL provided for the property entries into CEL all confirmations
or only negative confirmations was selected.
Dialog can only be closed if all required options have been configured.
Cancel Discards all changes in all tabs and closes the dialog.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
2 string variable: Variable whose value contsists of a alphanumeric character sequence.
• Modem
or
• VoIP
Parameter Description
Description Select the file that contains the description of the message.
Click on button ... in order to open the dialog for selecting a file. This has to be
deposited in the node File/Multimedia.
The file can be played for testing with the button Play.
Acknowledgement Select the file that contains the text for the message if the description is
confirmed positively.
Click on button ... in order to open the dialog for selecting a file. This has to be
deposited in the node File/Multimedia.
Misentry Select the file containing the text in case of failure entries by the recipient.
Click on button ... in order to open the dialog for selecting a file. This has to be
deposited in the node File/Multimedia.
The file can be played for testing with the button Play.
Show this dialog Active: Opens this dialog in the Runtime before executing the function.
in the Runtime
Attention - Behavior in the Runtime:
• If the dialog is edited and closed with OK the changes will be saved and the
function carried out.
• If the dialog is closed with cancel no message is being sent. This process is
documented in the CEL provided for the property entries into CEL all
confirmations or only negative confirmations was selected.
Note: The entries are validated in the tabs by clicking on OK. If incorrect
configurations are discovered, the user is informed by means of a message box.
The user can then change the configuration or continue with the saving of the
incorrect configuration.
Cancel Discards all changes in all tabs and closes the dialog.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
• Modem
or
• VoIP
Parameter Description
Description Enter the text to be displayed as message via the Text-to-Speech engine.
The text can be entered as free message text. It can also contain dynamic
components. These are configured in the same way as dynamic texts.
The text can be played for testing with the button Play.
Acknowledgment Enter the text to be displayed as a message if, on positive confirmation of the
description, playback is to be via the Text-to-Speech engine.
The text can be entered as free message text. It can also contain dynamic
components. These are configured in the same way as dynamic texts.
Misentry Enter the text that is to be played back via the Text-to-Speech engine in the event of
incorrect entries.
The text can be entered as free message text. It can also contain dynamic
components. These are configured in the same way as dynamic texts.
The text can be played for testing with the button Play.
Show this dialog • Active: Opens this dialog in the Runtime before executing the function.
in the Runtime
Attention: Behavior in the Runtime
• If no entry is made the dialog is automatically closed after 30 seconds and the
function is carried out.
• If the dialog is edited and closed with OK the changes will be saved and the
function carried out.
• If the dialog is closed with cancel no message is being sent. This process is
documented in the CEL if all confirmations or only negative confirmations was
selected for the Log in CEL property (Project-specific settings group).
Note: The entries are validated in the tabs by clicking on OK. If incorrect
configurations are discovered, the user is informed by means of a message box.
The user can then change the configuration or continue with the saving of the
incorrect configuration.
Cancel Discards all changes in all tabs and closes the dialog.
1 CEL: Central management of events in the control system. The Chronological Event List (CEL) is maintained
twice: Once as a ring buffer in the memory and once as historic data stored in files on the hard disk. In contrast
to the Alarm Message List the CEL manages only the time stamp "received".
Synchronously-transmitted messages (voice message via text-to-speech and voice message via
audio file ) can only be confirmed synchronously via the respective transmission medium. The use
of other transmission methods for confirmation (such as email or SMS) is not possible. The
message must be acknowledged immediately via the same connection which is still open.
Acknowledgment settings
Parameter Description
Acknowledgment Active: The message is only removed from the message queue if, within the
necessary waiting period, an acknowledgment of receipt has arrived or the waiting period
has run out.
For voice messages this option is always active and cannot be deactivated.
Default: 5 minutes
Use message- Inactive: The codes defined in the properties of the user administration for
specific codes Message Control user /PIN code and Message Control user /NA code are
used.
Active: The defined codes in the options PIN code and NA code are used for
confirmation.
Dialog can only be closed if all required options have been configured.
Cancel Discards all changes in all tabs and closes the dialog.
Background : Receipt confirmations are generally introduced with RE: etc. If outgoing messages are
collected in the same folder as incoming ones, outgoing messages being interpreted as incoming
confirmations of receipt must be prevented. To do this, it is assumed that receipt confirmations differ
from outgoing messages in the 3 characters at the start.
1 user administration: Programm or part of a programm in which you can define which users exist in a system,
which rules apply to them when logging on to the system and which rights they have in the system.
Note: In order to securely log on a project during the Runtime start activate the property Active during
Runtime start in property group Project-specific settings for Message Control.
Creation of a message
• A parameter can:
• Define a certain variable1 that is called up on execution of the function by means of AML or
a limit value breach by means of its name: for example %Var1;
Caution: The variable1 whose limit value has been breached is not dynamically determined
for the subject!
• %: marks variables
• Text parts are separated from one another with a semi colon (;).
Partly different parameters are available for the main variable1, additional variable1 and depending on the
function call.
Attention: If additional variables are added using a placeholder, these variables first have to be registered
and read if they are not registered at the point of executing the function. The sending is then delayed. For
this reason, additional variables should only be used cautiously.
1 variable: A variable represents a value in the memory of the control system. There are internal and external
variables. Variables are based on a datatype and a driver object type. Many properties of the variables are
stored centrally and can therefore be used in different locations of the control system (for example, properties
that can be configured in the Editor, like the unit, the measuring range etc.). In the Runtime, the state and the
time stamp are additional properties of the variable.
1. In the Message tab1, activate the Text from limit value active option (Message Control function Send
a Message ).
Note: This option is not available for all dispatch types. In this case, configure the option Free
message text with dynamic text elements. (See Configuration of free message text section.)
4. Order the selected parameters by means of Drag&Drop or with the corresponding buttons.
Structure
$FreeText;%Variable%Text;
Start sign -> free text between semicolon -> contains parameters with %% as a sign
• Start sign: $
Parameters of "free text" are thus taken into account.
• Free text:
is inserted between semicolons (;)
Example
Hint
Place a space before the separator. The individual blocks are then separated correctly with a
space. The parameters (%%Name; for example) do not work however if a space is inserted in front
of %% or between Name and ;. If you want a space between 2 parameters, the string must follow
the displayed syntax: $%%Name; ;%%LimitText;
%%Name Name of the variable, Name of the variable, Name of the variable,
corresponds to corresponds to corresponds to
(Variable name:) property Name . property Name . property Name .
%%LimitText Limit value text of the Limit value text of the Text of the state as
alarm object with alarm object with defined in property
(Limit value text)
interpretation of the interpretation of the Limit value text .
dynamic limit value dynamic limit value
text. text.
%%MessageCreateTimeStamp Point of time during Point of time during Point of time during
which the message which the message is which the message is
(Time stamp of the message) is created. (Function created. (Function created. (Function
activation, not activation, not activation, not
violation or sending). violation or sending). violation or sending).
%%ResourceLabel Text for the resource Text for the resource Text for the resource
label identification of label identification of label identification of
(Resource Label Identification) the variable, the variable, the variable,
corresponds to corresponds to corresponds to
property Resources property Resources property Resources
label . label . label .
%%VariableStatus State of the variable State of the variable State of the variable
as string (when as string (when as string (when
(Status) activating the activating the activating the
function). function). function).
%%VariableTimeStamp Time stamp of the Time stamp of the Time stamp of the
variable (when variable (when variable (when
(Time stamp of the variable) activating the activating the activating the
function). function). function).
%%MessageTimeAcknowledge Available time for Available time for Available time for
acknowledgement in acknowledgement in acknowledgement in
(Remaining time for minutes. Only minutes. Only minutes. Only
confirmation) available if available if available if
acknowledgement of acknowledgement of acknowledgement of
receipt required was receipt required was receipt required was
activated. activated. activated.
(Address)
%%AlarmArea Alarm area of the Alarm area of the Alarm area of the
main variable. main variable. additional variable.
(Alarm area)
Error treatment
If invalid parameters are used a corresponding error message is displayed in the message:
<invalid parameter: 'Parameter'>.
This text can be changed and translated with the language switching. To do so, two keywords have to be
created:
• <Invalid Parameter:
• >
If parameters are used in the wrong context or if a parameter cannot be read (for instance because a
variable does not exist), the string IDS_STRING2501 (---) is added to the message instead of the value.
This text can be changed and translated with the language switching.
1 tab: Describes the single pages of a dialog in which certain setting can be made.
If Message Control is active and an event defined for message sending occurs:
During the analysis of messages in the e-mail folder all messages with matching subject line
are interpreted and set to status "read". If in the mailbox for Message Control, other messages
are also received (messages with a different subject), these may possibly be set to "read".
Message Control is being closed when closing the Runtime or by the function Send Message: deactivate.
If the Runtime is closed normally, an image of the current message queue is created and saved. This
image is reloaded during the start of Runtime and is being processed by Message Control. The data are
saved in a folder called MessageRT_Image.bin. The following data are saved:
• Suppressed areas
• Suppressed equipment
Network
You can find further information on the behavior in the network in the Networkchapter.
Acknowledging
Every message can unambiguously be identified by a GUID. According to the configured media and
sending mode messages can also be acknowledged through other media. For more information about
the acknowledgment of messages, see the Message Acknowledgment chapter.
Language switching
The language of message texts can completely be switched. To do so, the following will be analyzed:
The selectable columns in type Message Control are language switchable if they are configured
correspondingly.
Suppressed groups, classes, areas and equipment whose alarms are not displayed in the list are
displayed in separate list fields.
The columns of the message list can be configured individually (see Filter) and can be provided with
individual column headings. These labelings are localizable.
Insert template
Control Description
elements
Insert Opens the dialog for selecting a template for the screen type.
template
Templates are shipped together with zenon and can also be created by the user.
Window
Suppressed Alarm/event groups for which messages were suppressed and the alarms of
alarm/event groups which are thus not displayed in the message queue.
Suppressed Alarm/event classes for which messages were suppressed and the alarms of
alarm/event which are thus not displayed in the message queue.
classes
Suppressed Alarm/event areas for which messages were suppressed and the alarms of
alarm/event areas which are thus not displayed in the message queue.
Suppressed pieces Equipment for which messages were suppressed and the alarms of which are
of equipment thus not displayed in the message queue.
List functions
Control Description
elements
Refresh Refreshes view. The current data is loaded onto the screen from the message queue.
The point of time of the last update can be displayed with the field Last update.
Filter profiles
Profile administration
Medium To acknowledge
-: no
+: yes
If a message is not, incorrectly or rejectively acknowledged it is being sent to the next substitute person.
If a substitute is defined, the message is not sent again. The status is logged in the CEL. During the
acknowledging of messages linked functions can be carried out.
Information
• If a call is interrupted without confirmation or a decline and the interruption is not classified as a
hardware error, then:
• If substitutes or group members who have not yet been messaged are messaged
• If a call is interrupted by a hardware error, then the call for the same addressee is sent again
according to the number of repetitions set in the Maximum number of attempts property.
2. Activate the checkbox1 Acknowledgement required (always active for voice messages).
3. Define the waiting period (Timeout) within which the message must be acknowledged.
After the waiting period has expired the message will be sent to the next person on the list.
4. Configure the codes for confirmation (PIN) or rejection (NA code) as follows:
5. Define the functions which are to be executed after receiving the code for:
Acknowledgment in Runtime
During sending every message which must be acknowledged receives an individual, explicit identification
(GUID). All activities of the message are allocated by means of this identification. If a message must be
acknowledged, the identification is automatically added to the message text.
In order to acknowledge a message, according to the medium the recipient has to send the message
number and PIN in a defined format.
Thus it is also possible to acknowledge written messages through other sending modes than those
configured. The following must be the case for this:
E‑Acknowledging e-mails
• The response is being sent using the reply function of the e-mail program of the recipient.
• The original subject must not be changed in the email. This means: The contents defined in Outlook
in Subject (ID) or for SMTP in Mail subject must remain unchanged. These will identify and
allocate the message during receipt in zenon.
• GUID: At the start of the message. There must be no other character, including spaces, in
front.
• In Message Control e-mails for Message Control are identified by means of the subject.
Attention: The response subject must be marked as response. To do this, the message is checked
on receipt to see if it starts with at least three characters such as RE: or AW:.
• Message Control analyzes GUID and code and subsequently executes the functions set in the
function Send Message.
Note: if the medium SMS was configured a message sent via e-mail can also be acknowledged via SMS.
Acknowledging SMS
• The response is being sent using the reply function of the user's telephone.
• GUID: At the start of the message. There must be no other character, including spaces, in
front.
• Message Control analyzes GUID and code and subsequently executes the functions set in the
function Send Message.
Voice message
• The message is read to the recipient with the text of the description
• The recipient acknowledges the message via key signals with PIN code or NA code.
• Message Control analyzes the code and subsequently executes the functions set in the function
Send Message.
Note: In the list of messages, the name of the audio file is displayed in the Message column; with
sending by audio file, the message text is displayed with Text-to-Speech.
3. Establish connection: The connection is considered established as soon as the call to the
counterparty is signaled.
When a call is taken, it is not possible to distinguish whether the call was taken by a person or an
answering machine.
Attention: The value for the project-specific Waiting period between trials and timeout property
must be greater than the value for the Waiting time option in the Send a Message functions
(Receipt Confirmation tab).
4. If the connection cannot be established or the message is rejected with an incorrect PIN, the
substitute person is notified.
If no substitute person is configured, the call is canceled.
This message can be requested again by the recipient with the # key code.
6. The recipient reacts to the message with a confirmation or rejection. To do this, it enters the
corresponding code:
• Rejection: NA code
7. If receipt confirmation has been saved for the message functions, these are executed accordingly.
Code entry
• *: Delete entered character and start process again with welcome message.
The entry can be corrected at any time with the * key. In doing so, all characters entered are deleted and
the process is started again with the welcome message being played back.
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
2 tab: Describes the single pages of a dialog in which certain setting can be made.
Similarly, the list of suppressed elements is being synchronized and remanently saved.
The function Send message is only executed at the process-executing computer. Sending by the client is
not supported.
User
Users are edited by means of the zenon user administration1. For this reason, users can be edited at the
server, standby server or client. Editing on the zenon web client is also possible.
No resource sharing
The server and standby server must not share resources. Identical resources for different media at the
same computer must also not be used. That means:
• E-mail (SMTP): The server and standby server use different email accounts.
• E-mail (Outlook): The server and standby server use different Outlook profiles.
• GSM: The server and standby server use different modems and SIM cards with different telephone
numbers.
• SMS (SMS gateway): The Server and Standby Server use different files and folders.
• Voice message: The server and standby server use different modems and different telephone
numbers.
• Every computer:
• Outlook
In the event of a server failure, the standby server will resend all messages in the message queue that
must be acknowledged after having been upgraded to server. This may result in a duplicate sending of
After a failure resulting in a reboot of the computer GSM modems probably will have to be re-initialized
and their COM ports checked.
1 user administration: Programm or part of a programm in which you can define which users exist in a system,
which rules apply to them when logging on to the system and which rights they have in the system.
2 Standby Server: Programm which has all current data and connections of the server at its disposal and which
can take over instantly when the server fails.
Key:
• Y: Yes
• N: No
Procedure
The process of the function can be subdivided into main processes and subprocesses.
• Text description
• End call
Subprocesses:
• Substitute person
• Misentry
• Acknowledgement
Main processes:
2. Validation: Has the defined value for the Maximum number of attempts function been reached?
Note: If a message is forwarded to another user, this is considered a new message. The counter is
automatically set back to 1.
• N: The wait time between two attempts defined in the Waiting period between trials and
timeout function is waited for according to the configuration. The Send a Message
function is then executed again
4. Validation: Has the waiting time defined in the Timeout [min] function been exceeded?
Text description:
1. Description is sent.
• Y: Description is sent.
3. Has the waiting time that was defined in the waiting time option of the Send a Message function
been exceeded?
End call
• N: Continue to NA process.
Subprocesses
Substitute person:
Misentry:
Network
The network traffic can be read with Wireshark. In case of an unsecured transmission all the commands
sent to the server as well as the responses are visible in plain text in Capture. In case of encrypted
connections the SSL / TLS Handshake can be checked, however, the exchange of user data cannot be
checked.
Server
In order to check if a server supports certain commands, a Telnet session can be established with the
server.
In the command line the connection can only be opened with the command telnet [server name or IP
address] [port1 e.g. 25 or 110].
Mail server
The connection to the mail server can be checked with a mail-client program (e.g. Outlook). If an
unencrypted connection is used the analysis with Wireshark can display the supported SMTP and POP3
commands.
DNS
The name resolution can be checked with a program such as nslookup. nslookup can both resolve names
to IP addresses and IP addresses to names. To do so, a valid DNS server has to be registered in the IP
configuration of the computer.
GSM
For the analysis in case of problems with GSM it is possible for instance to use the following:
• HyperTerminal:
allows to send AT commands to the modem.
Message Control 122 / 154
Microsoft Hyperterminal or Putty (open source) for example.
Note: Hyperterminal was only supplied by Microsoft up to Windows XP. Can be copied manually for
other operating systems.
AT commands
1. Ensure that the driver suitable for the operating system is installed. To do this, it is preferable that
you use the driver from the modem manufacturer.
2. Check to see if the driver has been installed properly and that the modem is ready for operation.
3. Use a hyperterminal to connect to the COM port of the modem. Microsoft Hyperterminal or Putty
(open source) for example.
5. Test the AT commands that have created an error message in the LOG file. Note any possible
preparations for the modem, such as the creation of a message in the queue.
6. Check to see that the responses of the modem correspond to those in the list of supported AT
commands.
1 window: In the Editor there are several windows available which can be moves, changed in size and displayed
or not displayed. For example the output window displays the status information when loading a project andd
when creating the Runtime files. The position and size of the windows are saved in the Editor profiles.
2 LOG file: Text file in which error protocols are stored.
3 driver: A computer program or module which controls the interaction with connected or build-in devices
(hardware). For this it uses interfaces to the communication bus or other communication systems with which
the device is connected in order to send or receive control signals or data to or from the device.
4 Windows XP: Operating system by Microsoft. XP stands for "eXPerience".
SMTP mail
Outgoing The sending mode is not configured correctly. LOG • Is the Sending mode active
mails are messages like "inactive sending mode", "server not property activated?
not being available", "user cannot be found", "SMTP / POP 3
• Is the user who is supposed to
sent, authentication failed" are indicating this.
receive the mail set as
incoming
mails not „Message Control User"
received. (property Message Control
user activated)?
The server is registered correctly, but is not • Does the name resolution
available (error messages when connecting). work?
The server does not support a command (error • Check if the server supports
message with "Command not supported" or the command (e.g. with
similar in the LOG file). Thunderbird or Telnet).
The server requires an encrypted connection. • In this case the analysis with
Since the mail is sent in unencrypted form the Wireshark shows that the
server disconnects. server sends "STARTTLS".
Since this command is not
supported the connection
should be secured via SSL or
TLS.
The server does not support the selected • Select other protection
protection mechanism (error messages when configuration or plain text
establishing an encrypted connection). transmission.
SMS-GSM
zenon • Wrong COM port (file-not-found error when • Check COM port and modem
cannot opening the COM port). configuration.
establish a
connection • COM port1 busy (e.g. by the configuration • Check PIN, if necessary
with the software of the manufacturer, access-denied release manually with the PUK.
Connection • Has a connection first been established • Connect modem for the first
is between the modem and the GSM network? In time with manufacturer
established, most cases, the connection with the network software with the GSM
but sending is only established after accessing the network.
and manufacturer software!
receiving
• Miscellaneous messages
• Voice over IP
• SMS
• OpenSSL Library
• Debug
• Deep Debug
• MSG
• Warnings
DEBUG Attaching to current call. The sending mode attaches to the active call.
DEBUG Couldn't send MessageDeleteRequest The attempt to send a delete request telegram
notification to Mainstation. to the process-executing computer has failed.
DEBUG Current Message %Nachricht Inhalt% The current message (content, settings, etc.) is
traced in the LOG.
DEBUG File alignment request could not be send The attempt to send an alignment request
to mainstation. telegram to the process-executing computer
has failed.
DEBUG Mail to Benutzer '%s' was successfully The message to user [name] was successfully
added to the outbox. transferred to the Outlook outbox.
DEBUG Messaging canceled: The end of the The end of user group [name] was reached, the
Benutzer list for the Group (%s) has been sending is canceled.
reached.
DEBUG Requesting File alignment from An alignment request is sent to the process-
mainstation. executing computer.
DEBUG Send SMS to Benutzer %s. A SMS was sent to the user [address].
DEBUG Sending mail to Benutzer '%s' using A message for the user [name] is prepared and
address: %s. [sent] to the address.
DEBUG Sending MessageDeleteRequest for %d A delete request for [number] messages is sent
messages to Mainstation. to the process-executing computer.
DEBUG The #-sign was entered: Repeating the last # was entered: the last message is repeated.
message.
DEBUG The *-sign was entered: Clearing the A * was entered, the current entered code is
current key. being reset.
DEBUG The current call be terminated now. A call is active, it is closed now.
DEBUG The is no call in progress, nothing to No call is active, nothing can be closed.
terminate.
DEBUG The line %s has been closed. The line [] has successfully been closed.
DEBUG The line %s has been opened. The line [] has successfully been opened.
DEBUG The message %s should have been The message [ID] should already have been
acknowledged by now, handling TimeOut. confirmed, TimeOut is being processed.
DEBUG The message %s should have been sent by The message [ID] should already have been
now, handling hardware TimeOut. sent, TimeOut is being processed.
DEBUG The Message %s was NOT successfully The message [ID] could not be sent to
sent to %s! [recipient].
DEBUG The Message %s was not successfully The message [ID] could not be sent to [recipient]
sent to %s, and will be send again! and will be sent again.
DEBUG The Message %s was successfully sent to The message [ID] was successfully sent to
%s! [recipient].
DEBUG The next user (%s) for the group (%s) will The next user [name] from user group [name] is
be notified, previous Benutzer was:%s notified, the previous user was user [name].
DEBUG The sending of message %s was The sending process for message [ID] has been
completed. completed.
DEBUG Valid Acknowlegde-code entered. A valid PIN code for confirming the message
was entered.
DEBUG Valid NegAcknowlegde-code entered. A valid NA code for rejecting the message was
entered.
Message Control 130 / 154
Message Control 131 / 154
Deepdebug
Deep Debug
DEEPDEBUG A changed notification of The project received a change telegram for the
message(%s) was received, the message with the GUID [number]. The local
old message object will be (previous) object is updated.
updated!
DEEPDEBUG A delete message(s) request was A delete request telegram was received.
received!
DEEPDEBUG A getqueue request was received, An alignment request was received. The current
sending queue. queue and the current status are being sent.
DEEPDEBUG A file alignment request was A non-primary server has requested a sync of
received, sending alignment data. Runtime data1. This data is sent. The message
also contains the project names.
The entry is created on the primary server.
DEEPDEBUG All messages for project %s will All messages of project [name] are removed from
be removed. Message Control.
DEEPDEBUG An added notification of The project received an add telegram for message
message(%s) was received, the with GUID [number]. The new object is added.
message object will be added to
the list. (%s)
DEEPDEBUG Current message count is (%d) There are [number] messages in the queue. (Entry
DEEPDEBUG Last index set to %d. The last applied index was set to [value].
DEEPDEBUG Messaging TimeOut watchdog For the project [name] the TimeOut supervision
activated for Project '%s' was started.
DEEPDEBUG Messaging-Queue is being saved. The current message queue sill be saved.
DEEPDEBUG Project %s signed off. The project is logged off from the engine.
DEEPDEBUG SB state: %s(%u) The status of the standby server has changed and
is now %s (%d).
DEEPDEBUG Sending added notification for The message object with GUID [number] was
message %s to SB. created. The "new" object is also sent to the
standby server.
DEEPDEBUG Sending changed notification for The message object with GUID [number] has
message %s to SB. changed, the "new" object is sent to the standby
server.
DEEPDEBUG Sending remove notification for The message object with GUID [number] was
message %s to SB. removed; a remove telegram is sent to the standby
server.
DEEPDEBUG The message %s is added to the The message with GUID [number] was added to
Queue. the queue.
DEEPDEBUG The Message (%s) was removed The message with GUID [number] was removed
from the project queue. from the queue.
1 Runtime data: All data which are created and managed by the Runtime, e.g. data of the Alarm Message List, the
Chronological Event List, the Historian, etc. The data created by the Editor (Runtime files) and which are later
logLe_MSG Logging on to default mapi profile If no profile was selected, the sending mode
%s identifies the first profile and logs on with it.
MSG Logging off of MAPI profile %s. Log-off from profile [name].
MSG Selected dispatcher '%s' is busy->try The selected sending mode [type] is busy:
again... Another attempt will be made later.
MSG The incoming message for %s The incoming message [ID] contains a valid PIN
contains the correct Ack-Code. code for confirming the message.
MSG The incoming message for %s The incoming message [ID] contains a valid NA
contains the correct NegAck-Code. code for rejecting the message.
MSG The incoming message for %s does The incoming message [ID] does not contain a
not contain a valid code. valid code.
WARNINGS A Send-Message function was executed for a Group which does not contain any A sending-
Message Control users! message
function
was
executed
for a group
which is
empty or
does not
contain
activated
users for
Message
Control.
This
message is
created in
the LOG if
the devices
available
from zenon
will be
determined
and
displays
which
devices can
be
addressed
by the OS
Message Control 137 / 154
by means
of TAPI.
WARNINGS Not all required modes are supported: LINEBEARERMODE_VOICE: Once the
[ModemID],LINEMEDIAMODE_AUTOMATEDVOICE:[Modem number of
ID],LINEFEATURE_MAKECALL:[Modem ID]-> the device [Modem name] can't be used! TAPI
devices has
been
determined,
these are
filtered for
the
necessary
modes.
Note: If a
device
does not
support
one of the
required
modes, this
mode is not
shown.
This log
entry
displays
clearly
which
mode does
not exist.
• Debug
• Error
• Warning
DEBUG Attaching to current call. The sending mode attaches to the active call.
DEBUG Couldn't send MessageDeleteRequest The attempt to send a delete request telegram
notification to Mainstation. to the process-executing computer has failed.
DEBUG Current Message %Nachricht Inhalt% The current message (content, settings, etc.) is
traced in the LOG.
DEBUG File alignment request could not be send The attempt to send an alignment request
to mainstation. telegram to the process-executing computer
has failed.
DEBUG Mail to Benutzer '%s' was successfully The message to user [name] was successfully
added to the outbox. transferred to the Outlook outbox.
DEBUG Messaging canceled: The end of the The end of user group [name] was reached, the
Benutzer list for the Group (%s) has been sending is canceled.
reached.
DEBUG Requesting File alignment from An alignment request is sent to the process-
mainstation. executing computer.
DEBUG Send SMS to Benutzer %s. A SMS was sent to the user [address].
DEBUG Sending mail to Benutzer '%s' using A message for the user [name] is prepared and
address: %s. [sent] to the address.
DEBUG Sending MessageDeleteRequest for %d A delete request for [number] messages is sent
messages to Mainstation. to the process-executing computer.
DEBUG The #-sign was entered: Repeating the last # was entered: the last message is repeated.
message.
DEBUG The *-sign was entered: Clearing the A * was entered, the current entered code is
current key. being reset.
DEBUG The current call be terminated now. A call is active, it is closed now.
DEBUG The is no call in progress, nothing to No call is active, nothing can be closed.
terminate.
DEBUG The line %s has been closed. The line [] has successfully been closed.
DEBUG The line %s has been opened. The line [] has successfully been opened.
DEBUG The message %s should have been The message [ID] should already have been
acknowledged by now, handling TimeOut. confirmed, TimeOut is being processed.
DEBUG The message %s should have been sent by The message [ID] should already have been
now, handling hardware TimeOut. sent, TimeOut is being processed.
DEBUG The Message %s was NOT successfully The message [ID] could not be sent to
sent to %s! [recipient].
DEBUG The Message %s was not successfully The message [ID] could not be sent to [recipient]
sent to %s, and will be send again! and will be sent again.
DEBUG The Message %s was successfully sent to The message [ID] was successfully sent to
%s! [recipient].
DEBUG The next user (%s) for the group (%s) will The next user [name] from user group [name] is
be notified, previous Benutzer was:%s notified, the previous user was user [name].
DEBUG The sending of message %s was The sending process for message [ID] has been
completed. completed.
DEBUG Valid Acknowlegde-code entered. A valid PIN code for confirming the message
was entered.
DEBUG Valid NegAcknowlegde-code entered. A valid NA code for rejecting the message was
entered.
Message Control 141 / 154
Message Control 142 / 154
Error
Error
Error [SMTP / POP3] not connected The attempt was made to send data to the outgoing mail
server or to retrieve data from the incoming mail server,
although the server is not connected.
Error Creating Connection failed. The object for a connection (both secure and plain text) could
Errorcode: [Code] not be created.
Error Creating SSL/TLS Method The SSL/TLS method1 required for establishing a secure
failed. Errorcode: [Code] connection could not be created.
Error No Destination E-Mail- In case of an outgoing e-mail no target address was entered.
Address specified
Error Opening Connection failed. A connection (both secure and plain text) could not be
Errorcode: [Code] established.
Error Reading SSL Structure failed. Reading the SSL/TLS structure of a secure connection failed.
Errorcode: [Code]
Error SMTP AUTH should be used, SMTP authentication should be used, however the server does
but the Server neither not have the required commands for an EHLO response listed
supports AUTH LOGIN nor the in the list of supported extension commands (AUTH LOGIN
minimum implementation and AUTH PLAIN, the latter is the minimum implementation in
AUTH PLAIN accordance with RFC 2554).
Error The Server did not respond an The outgoing mail server did not respond to the EHLO
OK Code to HELO. Response: command or the HELO command with an OK code. (The
[response from the SMTP response is attached to the LOG message.) The server is
server] considered not to be available.
Error The Server did not send a The outgoing mail server has not sent the expected response
Waiting-For-Data-Response to to the AUTH LOGIN command of the corresponding user
the AUTH LOGIN [command / names. (The response is attached to the LOG message.)
Benutzer data]: [response
from the SMTP server]
Error The Server did not send a The outgoing mail server has not sent the expected response
Waiting-For-Data-Response to to the AUTH PLAIN command. (The response is attached to
Error The Server did not send an The SMTP server has not confirmed the AUTH LOGIN
OK-Response to the AUTH password data with OK. The login has failed.
LOGIN password data:
[response from the SMTP
server]
Error The Server did not send an The SMTP server has not confirmed the AUTH PLAIN data with
OK-Response to the AUTH OK. The login has failed. (The response is attached to the LOG
PLAIN data: [response from message.)
the SMTP server]
Error The Server did not send an The outgoing mail server has not confirmed the MAIL
OK-Response to the MAIL command (sending of a new mail) with OK. (The response is
command: [response from attached to the LOG message.)
the SMTP server]
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).
WARNING No Subject for No subject was specified for an outgoing mail. Though this is not an
the E-Mail error a mail without subject may cause a spam filter to block this mail.
specified
WARNING No Text for the E- No text was included for an outgoing mail. Though this is not an error
Mail specified a mail without text may cause a spam filter to block this mail.
WARNING The Server did The outgoing mail server responded with an error code to the EHLO
not respond an command (response contained in the LOG message). The SMTP
OK Code to server does not support extensions. Extensions are used for SMTP
EHLO. Response: authentication. This is not an error because SMTP authentication is
[response from not mandatory and the concerned functions carry out an error
the SMTP server] detection.
Errors
ERRORS VoIP:Error in VoIP Error message from the library for the connection.
connection '%s'
• % is replaced by the current code text for the SIP status
or a specific error text.
For example: VoIP:Error in VoIP connection 'User not
found'.
ERRORS VoIP:Error during hardware An error has occurred during the initialization of the
initialization hardware.
ERRORS VoIP:Error when trying to An error occurred during the attempt to carry out a Voice over
make a call IP call.
ERROR [telephone number] is The inserted telephone number of the short message center is
not a valid SMSC invalid. Has the country code (00xy or +xy) been set correctly?
telephone number!
Only the contained characters (probably + as prefix, otherwise only
numbers) will be checked, however, it is not being checked if the
telephone number actually exists or if this really is a short message
center!
ERROR [telephone number] is The inserted recipient telephone number is invalid. Only the
not a valid telephone contained characters (probably + as prefix, otherwise only numbers)
number! will be checked, however, it is not being checked if the telephone
number actually exists or if this really is a short message center!
ERROR Error on opening the The indicated serial port1 could not be opened. The indicated error
port1 [COM-Port]: number can be looked up in the MSDN Library and will give clues on
[error number in HEX] the probable causes of the error.
ERROR Error on configuring The indicated COM port could not be configured. State, timeouts and
theport1 [COM-Porp] buffers are configured. The indicated error number can be looked up
[state / timeouts / in the MSDN Library.
buffers]: [error
number in HEX]
ERROR The total input buffer The input buffer is too small to record all data sent by the modem.
([number] bytes) is The input buffer is created with a size of 12 KB. For receiving an SMS
too small for the of maximum size, approximately 400 bytes are required. This error
[number] bytes will occur if within a polling interval (see below) SMS data of more
received from the than 12 KB are incoming.
modem.
ERROR The modem returned The modem responded with an error message to an AT command.
an error to the [AT The error message is attached to the LOG message. An AT error code
command] may be contained in the error message.
command: [error
If an authentication via PIN code is required this is transferred with
message]
the command AT+CPIN. If an incorrect code is entered the modem
will respond with an error to this request.
ERROR The modem did not A timeout occurred while waiting for the response of the modem for
respond to the [AT an AT command.
ERROR The modem did not Though the modem has confirmed the AT command for activating
switch in SMS PDU the SMS-PDU mode with OK this has not been activated.
mode.
ERROR The modem did not Though the modem has confirmed the AT command for setting the
apply the SMSC telephone number of the short message center with OK the telephone
telephone number. number has not been saved as short message center.
ERROR Error: not connected An attempt was made to send, receive or delete an SMS while no
connection with the modem could be established beforehand.
ERROR The modem returned The modem responded with an error message to the transmission of
an error to the a SMS-PDU. The error message is attached to the LOG message. An
transmission of the AT error code may be contained in the error message.
PDU: [error message]
ERROR The modem did not While waiting for the response of the modem to the transmission of a
respond to SMS-PDU a timeout occurred.
transmission of the
PDU.
ERROR Error on writing data: An error occurred during the sending of data via the serial port1. The
[error number in HEX] error number can be looked up in the MSDN Library.
ERROR Not all bytes have Not all data were sent although the function for sending data via the
been sent. serial port1 did not report an error.
ERROR Error on reading data: An error occurred during receiving data via the serial port1. The error
[error number in HEX] number can be looked up in the MSDN Library.
ERROR The source SMSC The telephone number of the short message center of the sender
telephone number received during the SMS receipt contains an invalid character.
[telephone number]
contains the not
supported character
[character]
ERROR The source telephone The telephone number of the sender received during the SMS receipt
number [telephone contains an invalid character.
number] contains the
not supported
character [character]
ERROR The byte [byte as A byte contained in the PDU could not be converted into a number by
HEX] could not be a HEX string.
converted.
ERROR Insufficient buffer to The buffer for converting outgoing SMS (12 KB at 6144 characters) is
convert SMS text insufficient.
[Text]
ERROR The format flag [byte The formatting of an incoming SMS is not supported.
as HEX] is not
supported.
ERROR Could not convert A character contained in the 7-bit-SMS data section could not be
[byte as HEX] from decoded. The employed alphabets basis table and extension table
GSM 7-Bit-Alphabet. are attached as language identifiers (see Standard 3GPP TS 23.038
Baselanguage: [byte V10.0.0 (2011-03).)
as HEX],
Extensionlanguage
[byte as HEX]
ERROR Insufficient data to An SMS was received in several parts, the individual parts using
decode different alphabets. However, the information on the alphabets
multilanguage needed for conversion is not complete.
fragmented SMS!
ERROR The input byte A received Unicode SMS does not contain valid Unicode text (only an
stream is not a valid even byte number is valid, since there are 2 bytes per character in
unicode text. Unicode).
ERROR Insufficient Buffer to The 12 KB buffer is too small for decoding a PDU.
decode PDU
ERROR The PDU is not a A received PDU is not a valid hex dump of a byte stream.
valid byte stream.
ERROR The PDU length does The number of bytes contained in a received PDU does not match the
not match the SMS length specification in the SMS control data.
text length
ERROR The Modem requests The modem requests the Personal Unlock Key (PUK) for
the PUK. authentication. This is not used by Message Control and, as a
Attention: Incorrect entering of the PUK may render the SIM card
useless!
ERROR The Modem The PIN status check of the modem delivered an unexpected result.
responded with an The response of the modem to the check of the PIN status is
unknown PIN Status: attached to the LOG message.
[response from the
modem]
ERROR The Modem requests The modem requires an authentication with a PIN code, however, the
a PIN and the PIN- user did not enter any.
Input is empty.
ERROR The Modem did not Although the transmission of the PIN code was confirmed with OK by
respond with READY- the modem, the PIN status of the modem was not set on “READY” (no
State after PIN- PIN input required anymore). The response of the modem to the
Authentication: check of the PIN status is attached to the LOG message.
[String]
DEBUG Port [COM-Port] The indicated serial port1 was opened successfully.
opened successfully
DEBUG Modem configured The modem was successfully configured for the SMS-PDU mode and
successfully for SMS- the indicated telephone number of the short message center.
PDU-Mode and SMSC
[telephone number]
DEBUG Connection to The connection to the modem and the serial port1 was closed.
modem closed.
DEBUG SMS successfully An SMS was successfully sent to the indicated telephone number.
sent to [telephone
number]
DEBUG Successfully received An SMS was successfully received from the indicated telephone
SMS from [telephone number.
number]
DEBUG The Modem does not The modem does not require a PIN authentication.
need a PIN.
• 2xx = OK
• 4x and 5 xx = error
ERROR Creating SSL/TLS Method failed. The SSL/TLS method1 required for establishing a secure
Errorcode: [Code]. Errormessage: connection could not be created.
[String]
ERROR Creating Connection failed. The object for a connection (both secure and plain text)
Errorcode: [Code]. Errormessage: could not be created.
[String]
ERROR Reading SSL Structure failed. Reading the SSL/TLS structure of a secure connection
Errorcode: [Code]. Errormessage: failed.
[String]
ERROR Opening Connection failed. A connection (both secure and plain text) could not be
Errorcode: [Code]. Errormessage: established.
[String]
ERROR The Server did not respond an OK The outgoing mail server neither responded to the EHLO
Code to HELO. Response: nor HELO command with an OK code (response is
[Antwort des SMTP Servers] attached to the LOG message). The server is considered
not to be available.
ERROR The Server did not send a Waiting- The outgoing mail server has not sent the expected
For-Data-Response to the AUTH response to the AUTH LOGIN command of the
LOGIN [command / Benutzer
Message Control 152 / 154
data]: [response from the SMTP corresponding user names. The response is attached to
server] the LOG message.
ERROR The Server did not send an OK- The SMTP server has not confirmed the AUTH LOGIN
Response to the AUTH LOGIN password data with OK. The login has failed.
password data: [response from
the SMTP server]
ERROR The Server did not send a Waiting- The outgoing mail server has not sent the expected
For-Data-Response to the AUTH response to the AUTH PLAIN command. The response is
PLAIN command: [response from attached to the LOG message.
the SMTP server]
.
ERROR The Server did not send an OK- The SMTP server has not confirmed the AUTH PLAIN
Response to the AUTH PLAIN data with OK. The login has failed. The response is
data: [response from the SMTP attached to the LOG message.
server]
ERROR SMTP AUTH should be used, but SMTP authentication should be used, however, during
the Server neither supports AUTH the EHLO response the server has not listed the required
LOGIN nor the minimum commands in the list of supported extension
implementation AUTH PLAIN commands.
ERROR [SMTP / POP3] not connected The attempt was made to send data to the outgoing mail
server or to retrieve data from the incoming mail server,
although the server is not connected.
ERROR The Server did not send an OK- The outgoing mail server has not confirmed the MAIL
Response to the MAIL command: command (sending of a new mail) with OK. The
[response from the SMTP server] response is attached to the LOG message.
ERROR The Server did not send an OK- The outgoing mail server has not confirmed the RCPT
Response to the RCPT command: command (adds a recipient) with OK. The response is
[response from the SMTP server] attached to the LOG message.
ERROR The Server did not send a Waiting- The outgoing mail server has not sent the expected
For-Data-Response to the DATA response to the DATA command (mail data is being
command: [response from the transferred). The response is attached to the LOG
SMTP server] message.
ERROR The Server did not send an OK- The outgoing mail server has not confirmed the
Respone to the transmitted Data: transmitted mail data with OK. The response is attached
Message Control 153 / 154
[response from the SMTP server] to the LOG message.
ERROR APOP Authentication is required For authentication at the incoming mail server the APOP
but the Server did not send APOP command is required, however, the incoming mail server
Data has not sent the required data.
ERROR Creating APOP Digest failed. The MD5 hash for APOP authentication could not be
Errorcode: [Code]. Errormessage: created.
[String]
ERROR The Server did not send an OK- The incoming mail server has not confirmed a command
Response to the [POP3- with OK. The response is attached to the LOG message.
Kommando] command: [response
from the POP3 server] The following commands might be affected: APOP,
USER, PASS, STAT, RETR, DELE.
ERROR The OK-Response to the STAT The response of the incoming mail server to the STAT
command did not have the command did not correspond to the format definition
expected Format: [Response from according to RFC 1939.
the POP3 server]
Format: OK<space>[number of mails in mailbox]<space>
[total size of all mails in mailbox in bytes]
ERROR [Sending / Receiving] Data failed. Sending or receiving data via an OpenSSL network
Errorcode: [Code]. Errormessage: connection has failed.
[String]
1 method: In object-oriented programming, a method is a subroutine that is exclusively associated either with a
class (in which case it is called a class method or a static method) or with an object (in which case it is an
instance method).