0% found this document useful (0 votes)
73 views157 pages

Message Control Manual v8.20 Guide

The Message Control module (v. 8.20) facilitates automatic sending and acknowledgment of messages through various media, including email, SMS, and voice messages. It outlines compatibility requirements for different versions, configuration settings, and limitations, as well as supported AT commands for message transmission. The document also details the necessary conditions for using each communication medium and provides guidance for converting projects from older versions.

Uploaded by

khanhuneti03
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
73 views157 pages

Message Control Manual v8.20 Guide

The Message Control module (v. 8.20) facilitates automatic sending and acknowledgment of messages through various media, including email, SMS, and voice messages. It outlines compatibility requirements for different versions, configuration settings, and limitations, as well as supported AT commands for message transmission. The document also details the necessary conditions for using each communication medium and provides guidance for converting projects from older versions.

Uploaded by

khanhuneti03
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Manual

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:

• EMail via Microsoft Outlook or via SMTP

• SMS via GSM modem or via a SMS gateway

• Voice message with audio file via modem or via voice over IP to telephone

• Voice message, text-to-speech via modem or via voice over IP to telephone

The status of this transmission is logged in the Chronologic Event List (CEL).

The configuration takes place in two stages:

• 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.

Context menu project-specific settings in project manager.

Menu item Action

Help Opens online help.

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.

Message Control 1 / 154


Compatibility with version [Link]
Changes in version 7 compared to older versions

As of version zenon 7.00 SP0 module Message Control differs basically from earlier versions in terms of
technology and configuration.

Important technical changes:

• COM Server is no longer used

• the additional component of company DerDack is no longer used

• the ZenMsgQueue is replaced by an own screen of type Message Control

• 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)

• there is no detail view anymore

• the shift model and the calendar functionality has been removed

• there are no Runtime changeable files anymore

• 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.

Only projects from version 5.50 SP7 on can be converted to version 7.

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:

Show recipient-database function was removed.


This function can no longer be created with the Editor. At the conversion it is not deleted however. Its
call up in the Runtime has no effect and creates a log entry.

• 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.

• Runtime changeable files:


Because the user administration was changed, Runtime changeable files are no longer required for
Message Control. There is no possibility in version 7 to read back old Runtime data. If the Runtime
files of a project prior to version 7 are needed, you must read them back in an Editor prior to zenon 7
and then converted.

• Shifts and calendars:


The functionality for shifts and calendars was removed. Existing functions with target type Shift are
changed to target type Group at the conversion. However no group is linked. 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.

Import and export

Previous versions of message control and versions from zenon 7.00 SP0 on save their settings in
different files:

• up to 6.51 SP0: [Link]

• from version 7.00 SP0 on: [Link]

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.

Message Control 3 / 154


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.
2 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
changed in the Runtime also count; such as data for the standard recipes, recipegroup manager, user
administration, etc.
3 Runtime files: Are files created by the Editor which are read and interpreted by the Runtime. Some Runtime files
are modified by the Runtime; e.g. standard recipe, recipegroup manager, etc. The Runtime files are stored in the
Runtime folder.

Message Control 4 / 154


Compatibility with version 5.50
Direct transfer of content from version 5.50 to version 8.20 is not possible. In order to be able to convert
project configurations of the Message Control module from version 5.50 to the current version, carry out
the following steps:

1. First convert the projects to zenon version 6.51.


All users and groups are updated.
Note: This interim step is absolutely necessary. Direct conversion of the project configuration from
version 5.50 to the current version is not possible!

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.

Message Control 5 / 154


Requirements
The requirements for using Message Control depend on the desired transmission media:

Medium Requirement

E-mail Running Microsoft Outlook instance


message
via Outlook
:

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.

SMS Compatible suitable SMS server.


message
via SMS
gateway :

Speech Voice modem with DTMF functionality or voice over IP server.


output:
Text-to-speech engine.

Telephone: Voice modem with DTMF functionality.

If an ISDN adapter is used it must support the following functions.

• Support of voice messages (LINEMEDIAMODE_AUTOMATEDVOICE)

• Support of DTMF signals (for receiving the PIN code when acknowledging a
message)

• Support of Telephony Application Programming Interface (TAPI)

Voice over Voice over IP access.


IP:
The following conditions must be met in order to use VoIP:

• The VoIP provider must support the SIP and RTP protocols.

• The corresponding ports must be open in the firewall:


SIP (Default: 5060)

Message Control 6 / 154


RTP (Default: 4000)
RTCP (Default: 4001)

Ports for VoIP

Two protocols are used for VoIP:

• SIP: uses port for SIP port.


Note: SIP-TLS is not currently supported. VoIP should therefore not be used in critical environments
that require encryption.

• RTP: uses ports for RTP and RTCP.


RTCP must always be 1 higher than RTP.

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:

• SIP port : 5060

• RTP port : 4000

• RTCP port : 4001


This port cannot be changed. It is always 1 higher than the RTP port .

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.

Message Control 7 / 154


Limitations
Under certain circumstances, the functionality of Message Control can be limited or not available.

DTMF signals with cellphones and voice over IP

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.

Solution: Try a different combination of cellphone and VoIP provider.

Detecting signals

DTMF signals from some cellphones can be interpreted with misunderstandings by some VoIP providers.

Solution: Try a different combination of cellphone and VoIP provider.

Windows CE

The Message Control module is not available under Windows CE.

Message Control 8 / 154


Supported AT commands
Message Control supports the following AT commands:

Goal Command Answer Comment on the


response.

Connection test: AT\r \r\nOK\r\n at the end

Query PIN status AT+CPIN?\r +CPIN: At a desired point


in the response
plus \r\n at the
end

Enter PIN: AT+CPIN="[PIN- \r\nOK\r\n at the end


Code]"\r

Switch modem to SMS-PDU mode: AT+CMGF=0\r \r\nOK\r\n at the end

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:

Send message to this number. AT+CMGS= "[PDU \r\n>


Modem signalizes Ready for PDU if the length]" \r [Space]
command was accepted:

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

Message Control 9 / 154


Delete SMS with the given index from the AT+CMGD= \r\nOK\r\n at the end
memory: [Index]\r

Note: For AT+CMGD commands, it is sufficient if one of the two versions is supported.

Arguments:

• \r --> Carriage Return --> 0x0D

• \n --> Line Feed --> 0x0A

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.

Message Control 10 / 154


Configure Message Control
Message Control is configured via:

• global properties of the media for sending

• project-specific properties for the message

• Functions which are executed in the Runtime for sending and management of messages

Messages can be sent and acknowledged as:

• E‑email

• SMS

• Voice message

Configuring the sending of a message

In order to configure the sending of a 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.

3. Configure the medium.

4. Configure the project-specific properties.

5. Configure the users or user groups that are to be reached via the medium.

6. Create a Send message function and

link the function:

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.

Configuration of the message

A message is composed of several parts:

• Subject: defined for e-mails using:

• Subject (ID) in the global settings for Outlook

Message Control 11 / 154


• Mail subject in the global settings for e-‑mail message via SMTP

• Dynamic part of the subject property in the project-specific settings for e-‑mail via SMTP
or Outlook

• Description and incorrect entry: is defined for language messages using:

• Voice message via text to speech

or

• Voice message by audio file

• Message text: defined for e-mails, SMS and voice messages in:

• the Option Constant Text

Configure management of the message queue

In order to administrate messages in the Runtime:

1. create a screen of type Message Control

2. create and configure a function Screen switch for this screen.

3. link the function to a button

By doing so in the Runtime, the status of messages can be checked and the message queue can be
monitored.

Message Control in the Runtime

In order to use Message Control in the Runtime:

1. activate Message Control via

• 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.

Message Control 12 / 154


• 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.

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".

Message Control 13 / 154


General settings for sending
The media used employed for sending the messages are globally defined and can be used by every
project and every working area.

Available media for sending include the following:

• E-mail message via Outlook

• E-mail message via SMTP

• SMS message via GSM modem

• SMS message via SMS gateway

• Voice message audiofile via modem

• Voice message text-to-speech via modem

• Voice over IP as audio file

• Voice over IP as text-to-speech

In order to configure the properties:

1. Highlight the Workspace

2. Select the Message Control group in properties.

3. Activate and configure the desired media types.

The settings in [Link] are saved in the area [Message Control].

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.

Message Control 14 / 154


E-mail message via Outlook
In order to send a message as e-mail via Microsoft Outlook it is required that:

• 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:

• 32bit Outlook requires the 32-bit version of zenon.

• 64bit Outlook requires the 64-bit version of zenon.

Mixed operation is not possible in any combination.

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 .

3. Define an unambiguous subject via the property Subject (ID) .


This subject is the criterion for passing on incoming messages to the module Message Control. E-
mails which do not contain this ID are not passed on to the Message Control. It has to:

• have a length of at least four characters

• remain unchanged in case of answers

4. Configure the properties for Project-specific settings .

5. Configure Users and user groups.

6. Create required functions and connect them with buttons or events.

Behavior in Runtime

1. As soon as the Runtime is started messages are retrieved.

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.

4. Receipt of the message is acknowledged.


Message Control 15 / 154
1 tab: Describes the single pages of a dialog in which certain setting can be made.

Message Control 16 / 154


E-mail message via SMTP
In order to send a message as e-mail via an SMTP server it is required that:

• the sending mode was activated via the property Sending mode active

• the executing computer is connected with the mail server

• an e-mail account is defined

• the mail server is configured with the access data

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. Configure the properties for:

• Add Email recipient as :


Select whether the recipients of the message are written in the Tp field or in the field Bcc.

• Incoming mail server

• Outgoing mail server

3. Configure the properties for project-specific settings.

4. Configure Users and user groups.

5. Create required functions and connect them with buttons or events.

Behavior in the Runtime

1. As soon as the Runtime is started messages are retrieved.

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.

4. Receipt of the message is acknowledged.

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.

Message Control 17 / 154


If during this procedure an error occurs, such as authentication failed or command not supported, all
active connections are closed.

The correct settings for the configuration are available from the provider of the employed e-mail account.

Procedure

Retrieving incoming e-mails

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.

5. If there is a POP3 connection this is also closed.

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.

Message Control 18 / 154


SMS message via GSM modem
For sending a message as SMS via a GSM modem:

• 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.

4. Check the connection by clicking Check connection .

5. Enter the telephone number for the short message center in the property field Number of SMS center
.

6. Configure the properties for Project-specific settings .

7. Configure Users and user groups.

8. Create required functions and connect them with buttons or events.

Behavior in Runtime

1. As soon as the Runtime is started the connection to the modem is being established and configured.

2. Messages are being retrieved.

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.

5. Receipt of the message is acknowledged.

Message Control 19 / 154


6. If after retrieving no incomplete multi-part messages are present anymore the messages which were
read are deleted at the modem.

7. During the closing of Runtime the modem is disconnected.

Information

If the modem is reconnected or the computer rebooted it is recommended to:

• 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.

Constants, timeouts and parameters

Entry Value Description

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.

COM state • Baud: 9600 Standard configuration of a serial port1.


configuration
• Binary mode

• Parity check:
Inactive

• Clear-to-Send and
Data-Set-Ready:
not controlled

• Data-Terminal-
Ready and
Request-To-Send
Flow Control:
activated

Message Control 20 / 154


• Bit per byte: 8

• Parity: None

• Stop Bit: 1

Buffer

Limit Maximum Description


value

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 maximum size of an SMS to be sent is 6144 Unicode


characters.

1 COM port: Serial communication interface.

Message Control 21 / 154


SMS message via SMS gateway
For sending a message as SMS via a SMS gateway:

• the sending mode was activated via the property Sending mode active

• a compatible SMS server must be present and configured

Procedure

SMS server configuration

For the correct configuration of the SMS server, please contact the manufacturer.

The following is applicable in order for it to work with zenon:

• The following folders must be present:

• Inbox

• Outbox

• State

• zenon moves messages to these folders.

• The SMS gateway reads and fills these folders.

• zenon monitors these folders:


As soon as new messages or information is in them, these are forwarded to Message Control.

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.

2. Configure Outbox folder , Inbox folder and Status folder .

3. Configure the First letter of the SMS file .


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.

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.

5. Configure the property Smart alarming .


If the property is activated the SMS are treated as follows:

• 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.

Message Control 22 / 154


• Along with the sending of a message starting with ALARM! the recipient’s cellphone is
automatically switched to "very loud", provided this is supported by the phone.

• Incoming messages are also checked for this character string.


If there is a (!) in position 6, the first six characters are cut off and the message is forwarded
by Message Control.

6. Configure the properties for Project-specific settings .

7. Configure Users and user groups.

8. Create required functions and connect them with buttons or events.

Behavior in Runtime

1. As soon as the Runtime is started messages are retrieved.

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.

4. Receipt of the message is acknowledged.

Smart Alarming

If the Smart alarming property has been activated, SMS messages are handled as follows:

1. All outgoing messages are checked.

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.

Message Control 23 / 154


Voice messages
Voice messages can be sent as:

• Audio file via modem

• Text-to-speech via modem

• Voice over IP as audio file

• Voice over IP as text-to-speech

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:

• a modem must be connected to the sending computer and must be configured

• The telephone of the recipient must support DTMF

Voice over IP

To send messages by means of Voice over IP, it must be correctly configured.


Mandatory fields:

• Server address

• User name

• Password

Furthermore, the following must be the case:

• The telephone of the recipient must support DTMF

• The VoIP provider supports the SIP and RTP protocols

• The firewall has the corresponding ports open

• SIP (Default: 5060)

• RTP (Default: 4000)

• RTCP (Default: 4001)

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 following must be the case in order to send messages as text-to-speech:

• The telephone of the recipient must support DTMF

• A text-to-speech (TTS) engine must be installed.

• The corresponding language file must be installed

Message Control 25 / 154


Voice message audiofile via modem
For the sending of a message as an audio file via a modem, the following must be the case:

• 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

• a modem must be connected to the sending computer and must be configured

• The telephone of the recipient must support DTMF

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 .

3. Select the modem for sending via property Line name .


Selection from a drop-down menu which lists all modems configured in the system control.

4. Configure the properties for Project-specific settings .

5. Configure Users and user groups.

6. Create required functions and connect them with buttons or events.

7. This method must be acknowledged.

Behavior in Runtime

1. A function calls up the dispatch method.

2. A call is initiated via the modem.

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:

• PIN code for confirmation

• NA code for rejection

Message Control 26 / 154


• Replay the file just listened to by pressing the hash key (#) on the phone

• Undo the entry by pressing the star key (*);


In this case the greeting will be played back again

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).

Message Control 27 / 154


Voice message text-to-speech via modem
For sending a voice message via text-to-speech:

• the sending mode was activated via the property Voice modem (Text-to-Speech)

• a modem must be connected to the sending computer and must be configured

• The telephone of the recipient must support DTMF

• A text-to-speech (TTS) engine must be installed.

• The corresponding language file must be installed

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:

1. Close the Editor.

2. Select the correct speech for the Editor ([Link]):

• 32-bit-compatible speech for the 32-bit Editor:


C:\Windows\SysWOW64\Speech\SpeechUX\[Link]

• 64-bit-compatible speech for the 64-bit Editor:


C:\Windows\System32\Speech\SpeechUX\[Link]

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 .

3. Select the modem for sending via property Line name .


Selection from a drop-down menu which lists all modems configured in the system control.

4. Configure the properties for text-to-speech:

• Voice

• Speech rate

• Volume

Message Control 28 / 154


5. Configure the properties for Project-specific settings .

6. Configure Users and user groups.

7. Create required functions and connect them with buttons or events.

8. This method must be acknowledged.

Behavior in Runtime

1. A function calls up the dispatch method.

2. A call is initiated via the modem.

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.

• PIN code for confirmation

• NA code for rejection

• 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).

Message Control 29 / 154


Voice over IP as audio file
The following must be the case for the sending of a voice message as an audio file via Voice over IP:

• the sending mode was activated via the property Voice over IP (Audio file)

• Voice over IP is configured in the Editor

• One audio file each must be saved in the Files/Multimedia node for:

• Description

• Acknowledgement

• Misentry

• The telephone of the recipient must support DTMF

• The VoIP provider supports the SIP and RTP protocols

• The firewall has the corresponding ports open

• SIP (Default: 5060)

• RTP (Default: 4000)

• RTCP (Default: 4001)

Procedure

Configuration

1. Activate the sending mode via the property Voice over IP (Audio file) .

2. Configure the settings of the Voice over IP group:

• Server address

• User name

• Password

3. Configure the properties for Project-specific settings .

4. Configure Users and user groups.

5. Create required functions and connect them with buttons or events.

6. This method1 must be acknowledged.

Behavior in Runtime

1. A function calls up the dispatch method1.

2. A call is initiated via the VoIP server.

Message Control 30 / 154


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 by the recipient with the respective valid code:

• PIN code for confirmation

• NA code for rejection

• Replay the file just listened to by pressing the hash key (#) on the phone

• Undo an input by pressing the star key (*)

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).

Message Control 31 / 154


Voice over IP as text-to-speech
The following must be the case for sending the message via Text-to-Speech:

• the sending mode was activated via the property Voice over IP (Text-to-Speech)

• Voice over IP configured

• The telephone of the recipient must support DTMF

• A text-to-speech (TTS) engine must be installed.

• The corresponding language file must be installed

• The VoIP provider supports the SIP and RTP protocols

• The firewall has the corresponding ports open

• SIP (Default: 5060)

• RTP (Default: 4000)

• RTCP (Default: 4001)

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:

1. Close the Editor.

2. Select the correct speech for the Editor ([Link]):

• 32-bit-compatible speech for the 32-bit Editor:


C:\Windows\SysWOW64\Speech\SpeechUX\[Link]

• 64-bit-compatible speech for the 64-bit Editor:


C:\Windows\System32\Speech\SpeechUX\[Link]

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) .

2. Configure the properties of the Voice over IP group.

• Server address

• User name

• Password

Message Control 32 / 154


3. Configure the properties for text-to-speech:

• Voice

• Speech rate

• Volume

4. Configure the properties for Project-specific settings .

5. Configure Users and user groups.

6. Create required functions and connect them with buttons or events.

7. This method1 must be acknowledged.

Behavior in Runtime

1. A function calls up the dispatch method1.

2. A call is initiated via the VoIP server.

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.

• PIN code for confirmation

• NA code for rejection

• 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).

Message Control 33 / 154


[Link] entries
Message Control is mainly configured via global and project-specific properties. In the [Link] the
global properties of the media are displayed in section [Message Control].

Note: Changes should always be made using the properties of the zenon user interface.

Meaning of the INI entries:

Entry Description

[MESSAGECONTROL] Settings for the module Message Control.

Recommendation: Configuration via the properties of the


Message Control group in the workspace1 including
subgroups and the properties of the Project-specific settings
group in the Message Control node in the project tree.

GSM_SMS= Activation of SMS via GMS as sending type.

• 0: active

• not 0: inactive

Default: 0

The entry in [Link] corresponds to the entry [GSM]


On

This is taken into account when importing/exporting the ini


settings.

It corresponds to the property Sending mode active in group


SMS message (GSM modem) in the Editor.

GSM_SMS_COM= COM port that is used for the connection to the modem.

Default: empty

It corresponds to the Modem connection (serial) property in


the Editor.

GSM_SMS_PIN= PIN code which is used for authentication towards the modem.

Default: empty

It corresponds to the PIN code property in the Editor.

GSM_SMS_SMSC= Telephone number of the message center of the GSM provider.

Default: empty
Message Control 34 / 154
It corresponds to the Number of SMS center property in the
Editor.

GSM_BULK_DELETE= Behavior when deleting an SMS:

• 0: Messages are deleted with the Index method. SMSs that


have been read are deleted individually

• 1: Messages are deleted with the Statusflag method. All


SMSs that have been read are deleted at the same time.
Note: This method is faster and more powerful, but is not
supported by all modems.

Default: 0

It corresponds to the Delete SMS with status flag syntax of


AT+CMGD command property in the Editor.

Outlook= Email notification via Outlook:

• 0: inactive

• 1: active

Default: 0

It corresponds to the property Sending mode active in group


Mail message (Outlook) in the Editor.

Outlook_Profile= Name of the Outlook profile which should be used for sending.

Default: empty

It corresponds to the Profile property in the Editor.

POP_APOP= Controls authentication at the incoming mail server with


messaging via SMTP/POP.

• 0: User (USER) and password (PASS) are used for


authentication.

• 1: The APOP command is used for authentication instead


of user and password.

Default: 0

It corresponds to the property Use APOP for authentication in


group Mail message (SMTP) in the Editor.

POP_KEEP_MAILS= Defines whether e-mails that have been read remain on the
server:

Message Control 35 / 154


• 0: E-mails are deleted after they have been fetched from
the server,

• 1: E-mails remain after they have been fetched from the


server.

Default: 0

Note: As POP3 offers no possibility to filter mails when


fetching them, always all mails which are in the incoming mail
are fetched. If this property is active, the server's memory
consumption increases and the performance can decrease
when fetching mails.

It corresponds to the Keep read mail on server property in the


Editor.

POP_PASSWORD= Password for login at the incoming mail server (POP3). The
password is saved encrypted and is only decrypted for
authentication purposes.

Must only be configured in the Editor.

Default: empty

It corresponds to the property Password in group Incoming


mail server in the Editor.

POP_POLL_INTERVALL= Minimum period between two POP3 requests in seconds. Value


should not be below the POP3 server guideline.

• Minimum: 10

• Maximum: 4294967295

Default: 60

It corresponds to the Minimum time between two requests (s)


property in the Editor.

POP_PORT= Port in which the POP3 server is addressed.

• Maximum value: 6553

Default for:

• Insecure connection: 110

• Secure connection: 995

It corresponds to the property Port in group Incoming mail


server in the Editor.

Message Control 36 / 154


POP_SECURITY= Type of connection protection to the POP3 Server.

• 0, no security

• 1: SSLv2 and SSLv3

• 2: TLSv1

Default: 0

It corresponds to the property Encryption in group Incoming


mail server in the Editor.

POP_SERVER= Address of the POP3 server.

Default: empty

It corresponds to the property Server address in group


Incoming mail server in the Editor.

POP_USER= User name for the incoming server.

Default: empty

It corresponds to the property User name in group Incoming


mail server in the Editor.

SMSGateway= SMS notification via SMS gateway:

• 0: inactive

• 1: active

Default: 0

It corresponds to the property Sending mode active in group


SMS message (SMS gateway) in the Editor.

SMSGateway_Inbox= Incoming folder of the SMS server for sending SMS.

Default: empty

It corresponds to the Inbox folder property in the Editor.

SMSGateway_OriginId= Sender identification for sending SMS.

Default: empty

It corresponds to the Sender ID property in the Editor.

SMSGateway_Outbox= Outgoing folder of the SMS server for sending SMS.

Default: empty

Message Control 37 / 154


It corresponds to the Outbox folder property in the Editor.

SMSGateway_Prefix= First letter of the SMS files. Must be unique for each project.

Length: 1 characters

Default:F

It corresponds to the First letter of the SMS file property in


the Editor.

SMSGateway_SemaphorPrefix= First letter of the lock file.

Length: 1 characters

Default:S

It corresponds to the First letter of the lock/semaphore file


property in the Editor.

SMSGateway_SmartAlarm= Smart alarming is used. Must be unique for each project.

• 0: inactive

• 1: active

Default: 0

It corresponds to the Smart alarming property in the Editor.

SMSGateway_Statusbox= Folder for the status message at SMS sending.

Default: empty

It corresponds to the Status folder property in the Editor.

SMSGateway_TimeOut= Timeout for outgoing messages in minutes. Defines after what


period of time a message is interpreted as "not send
successfully".

Default: 60

It corresponds to the Timeout property in the Editor.

SMTP_AUTH= Authentication at the outgoing server.

• 0, no security

• 1: log in to the POP3 Server before sending

• 2: SMTP AUTH with signing in to the SMTP server before


dispatch

Message Control 38 / 154


Default: 0

It corresponds to the property Authentication at outgoing mail


server in group Outgoing mail server in the Editor.

SMTP_MAIL_RECIPIENT_AS= Select in which field of the message the recipients are written.

• 1: All recipients are entered in the To field.

• 0: All recipients are entered in the Bcc field.


This way each recipient receives an individualized
message. The recipient cannot see the other recipients of
the message.

Default: 1

It corresponds to the Add Email recipient as property in the


Mail message (SMTP) group in Editor

SMTP_OTHER_CREDS= Defines whether the outgoing server uses different log in data
than the incoming server.

• 0: inactive

• 1: active

Default: 0

It corresponds to the property Use different log in data as at the


incoming mail server in group Outgoing mail server in the
Editor.

SMTP_PASSWORD= Hex dump of the encrypted password for authentication at the


outgoing server.

Default: empty

It corresponds to the property Password in group Outgoing


mail server in the Editor.

SMTP_OTHER_CREDS= Sign-in data for SMTP server.

• 0: Login data for the incoming mail server is also used for
the outgoing mail server.

• 1: For the authentication at the outgoing mail server


different login data than at the incoming mail server are
used.

Default: 0

It corresponds to the property Use different log in data as at the


incoming mail server in group Outgoing mail server in the

Message Control 39 / 154


Editor.

SMTP_OUT_ADDR= Address for outgoing e-mails.

Default: empty

It corresponds to the property Address for sent mails in


group Outgoing mail server in the Editor.

SMTP_POP_MAIL= Email notification via SMTP/POP:

• 1: active

• 0: inactive

Default: 0

It corresponds to the property Sending mode active in group


Outgoing mail server in the Editor.

SMTP_PORT= Defines the used port at the SMTP Server.

Maximum: 65535

Default: 25

It corresponds to the property Port in group Outgoing mail


server in the Editor.

SMTP_SECURITY= Type of encryption for connection to the SMTP Server.

• 0, no security

• 1: SSLv2 and SSLv3

• 2: TLSv1

Default: 0

It corresponds to the property Encryption in group Outgoing


mail server in the Editor.

SMTP_SERVER= The SMTP Server entered by the user.

Default: empty

It corresponds to the property Server address in group


Outgoing mail server in the Editor.

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

It corresponds to the property Use incoming mail server for


outgoing mails in group Outgoing mail server in the Editor.

SMTP_SUBJECT= Subject for outgoing e-mails and for detecting whether an


incoming e-mail at the server is relevant for the sending type.

Incoming e-mails must have this text as subject in order to be


processed by the system. E-mails which do not contain this
subject are neither passed on to Message Control nor deleted
from the server.

Default:MsgCtrl_Alert:

It corresponds to the property Mail subject in group Outgoing


mail server in the Editor.

SMTP_USER= User name saved for the outgoing server.

Default: empty

It corresponds to the property User name in group Outgoing


mail server in the Editor.

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

It corresponds to the property Use user name as address for


sent mails in group Outgoing mail server in the Editor.

Speech= Text-to-Speech notification via modem:

• 0: inactive

• 1: active

Default: 0

It corresponds to the property Voice modem (Text-to-Speech)


in group Voice message in the Editor.

Speech_Name= Selection of speech and language for text-to-speech.

Message Control 41 / 154


Ensure that the correct voices for the Editor have been
selected:

• 32-bit Editor:
C:\Windows\SysWOW64\Speech\SpeechUX\[Link]

• 64-bit Editor:
C:\Windows\System32\Speech\SpeechUX\[Link]

Default: empty

It corresponds to the property Voice in group Text-to-Speech


in the Editor.

Speech_Rate= Speech speed.

• Minimum: -10

• Maximum: 10

Default: 0

It corresponds to the property Speech rate in group Text-to-


Speech in the Editor.

Speech_Volume= Speech volume. Number equals the percent value of the


maximum value of the selected speech.

• Maximum: 100

• Minimum: 0 Number taken from the operating system


without change.

Default: 0

It corresponds to the property Volume in group Text-to-


Speech in the Editor.

Subject= Unique ID which incoming e-mails must contain in order to be


processed in Message Control.

Default:MsgCtrl_Alert:

It corresponds to the property Subject (ID) in group Mail


message (Outlook) in the Editor.

Telephone= Notification by means of audio file via modem:

• 0: inactive

• 1: active

Default: 0

Message Control 42 / 154


It corresponds to the property Voice modem (audio file) in
group Voice message in the Editor.

Telephone_IgnoreDisconnect= Behavior in the event of a loss of connection::

• 1: A disconnection (e.g. recipient ends call) is ignored and


the message is played back completely before the line is
closed.

• 0: Message is aborted when the connection breaks.

Default: 0

It corresponds to the property Ignore disconnect in group


Voice message in the Editor.

Telephone_Line= Entry of the modem to be used. Must already be configured on


the computer.

It corresponds to the property Line name in group Phone


settings in the Editor.

Telephone_LineId= Automatically created device ID which identifies the selected


modem. Serves - for several modems with the same name - the
purpose of distinguishing the devices.

Attention: For information only. Must not be changed here.

It corresponds to the property Line ID in group Phone


settings in the Editor.

Telephone_Timeout= Time in minutes after which a standing condition should be


canceled and closed. Time interval must be longer as the time
needed for playing back and confirming the message.

Default: 1

It corresponds to the property Timeout [min] in group Voice


message in the Editor.

Telephone_WelcomeMessageCount= Number of repetitions for the welcome text.

Default: 5

It corresponds to the property Repeat welcome text in group


Voice message in the Editor.

VOIP_AUDIO= Voice message as audio file by means of Voice over IP:

• 0: inactive

Message Control 43 / 154


• 1: Voice over IP (Audio file)

Default: 0

It corresponds to the property Voice over IP (Audio file) in


group Voice message in the Editor.

Note:

The following conditions must be met in order to use VoIP:

• The VoIP provider must support the SIP and RTP


protocols.

• The corresponding ports must be open in the firewall:


SIP (Default: 5060)
RTP (Default: 4000)
RTCP (Default: 4001)

VOIP_DOMAIN= Server address of the VoIP provider.

Default: empty

It corresponds to the property Server address in group Voice


over IP in the Editor.

VOIP_PASSWORD= Password for VoIP access.

Is saved in encrypted form and must only be changed in the


user interface.

Default: empty

It corresponds to the property Password in group Voice over


IP in the Editor.

VOIP_RTP= Number of the RTP port for VoIP.

Default: 4000

It corresponds to the property RTP port in group Voice over IP


in the Editor.

VOIP_SIP= Number of the SIP port for VoIP.

Default: 5060

It corresponds to the property SIP port in group Voice over IP


in the Editor.

VOIP_TTS= Voice message via Voice over IP as a Text-to-Speech.:

• 0: inactive

Message Control 44 / 154


• 1: Voice over IP (Text-to-Speech)

Default: 0

It corresponds to the property Voice over IP (Text-to-Speech)


in group Voice message in the Editor.

Note:

The following conditions must be met in order to use VoIP:

• The VoIP provider must support the SIP and RTP


protocols.

• The corresponding ports must be open in the firewall:


SIP (Default: 5060)
RTP (Default: 4000)
RTCP (Default: 4001)

VOIP_USER= User name for VoIP access.

Default: empty

It corresponds to the property User name in group Voice over


IP in the Editor.

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:

• SMTP_SERVER= -> Server address

• SMTP_USER= -> User name

• SMTP_PASSWORD= -> Password

• SMTP_OUT_ADDR= -> Address for sent mails

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.

Message Control 45 / 154


Project-specific settings
You can find the project-specific settings in the node Message Control in the corresponding project. The
properties for configuration of the message and its delivery are contained there. General propertiesfor
sending media are configured in the properties Message Control of the working area.

Activating Message Control for the project

In the Runtime, the Message Control module can be activated as follows:

• 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

The following can be set in the 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

• Negative confirmations only:


Only messages that are rejected or not responded to (including repetitions)

• Positive confirmations only:


Only messages that have already been acknowledged

• 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.

• Rules for the repetition of interrupted calls

Information

Rules for interrupted calls:

• If a call is interrupted without confirmation or a decline and the interruption is not classified as
a hardware error, then:

Message Control 46 / 154


• The call is not repeated for the same addressee

• 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.

Configuration of the message

The message comprises:

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 .

Structure of the dynamic part of the subject

The dynamic part of the subject was set up according to the following rules:

• A parameter can:

• Be a key from the language table, such as @MyText;

• 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!

• Be a compiled entry in the language table: for example %@Var2+MultipleText

• $: marks text that contains the parameter.

• @: marks language switching

• %: marks variables

• %%: marks limit value text parameters for variables

A variable1 can be stated between the two percentage marks.


If no variable1 is given, the value relates to the main variable1.

• Text parts are separated from one another with a semi colon (;).

• Messages end with a semicolon (;).

Parameter In the Runtime Action

key: A check is made to see if an • Existing: entry is added to the


entry in @MyText is present message.
@MyText
in the language table for the
current language. • non-existent: According to the
settings of the project properties
Show untranslated keywords

Message Control 47 / 154


either @MyText or MyText is added
to the message.

Variable: A check is made if the • Existing: Value of the variable1 is


variable1 exists and the value taken and added to the text as
%Var1%
can be read. string.

• Not existing/not readable: The text


xxx is added to the message.

Compound entry: A check is made if: • Variable and text exist:


text is added to the message.
@StringTable+%var1Text • 1. the variable1 exists Example: Value of the variable1 is
and the value can be
33. The language table is then
read. Value is attached checked for @StringTable33 and
to the prefix text the corresponding text is added.
("MultipleText") as
string. • non-existent: According to the
settings of the project properties
• 2. an entry in the Show untranslated keywords
language table exists for either @MyText or MyText is added
the text to the message.

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.

Message Control 48 / 154


Create a screen of type Message Control
The message control screen is for managing the message queue of a project in the Runtime.

Engineering

Two procedures are available to create a screen:

• The use of the screen creation dialog

• The creation of a screen using the properties

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:

1. Create a new screen.

To do this, select the New screen command in the tool bar or in the context menu of the Screens
node.

2. Change the properties of the screen:

1. Name the screen in the Name property.

2. Select Message Control in the Screen type property.

3. Select the desired frame in the Frame property.

3. Configure the content of the screen:

1. Select the Elements (screen type1) menu item from the menu bar.

2. Select Insert template in the drop-down list.


The dialog to select pre-defined layouts is opened. Certain control elements are inserted into the
screen at predefined positions.

3. Remove elements that are not required from the screen.

4. If necessary, select additional elements in the Elements drop-down list. Place these at the
desired position in the screen.

4. Create a screen switch function.

Message Control 49 / 154


If you want to edit the list directly using the monitor, activate the Multi-Touch functionality.
You can find detailed information in relation to this in the Configure interactions chapter.

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.

The line height must be amended manually.

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

Lists and fields which can be displayed in the Runtime.

Control elements Description

Message queue List of messages.


Message Control 50 / 154
Contains messages which have been sent, confirmed or deleted or remain to be
sent.

The messages are only displayed and cannot be edited anymore.

Column headings can be named individually and are localizable by putting @


before them.

Number of Number of currently existing messages.


messages

Last Update Point of time of last update.

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 elements to control lists.

Control Description
elements

Filter Opens Dialog to configure the filters for the view.

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.

Stop/Continue Starts and stops the cyclic update of the list.

Filter profiles

Message Control 51 / 154


Profile administration

Control elements Description

Profile selection Opens the dialog for selecting a profile.

Save Saves current setting as a profile.

Delete Deletes profile.

Import Opens dialog for importing profiles from a file.

Export Opens dialog for exporting profiles from a file.

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.

Message Control 52 / 154


User Administration
Users and user groups for Message Control are created and managed in the zenon user administration1.
In the user administration1 the property Message Control user or respectively Message Control group
must be active in order to use an user in Message Control.

Users and user groups are referenced by names.

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

Message Active: The user is used by the module Message Control.


Control
User

Telephone Number of the voice-compatible telephone device of the user. Used for text to speech.

Message Control 53 / 154


Enter numbers. In addition, the following are permitted:

• The prefix + as an abbreviation for 00 of the international area code is 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.

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 prefix + as an abbreviation for 00 of the international area code is 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.

Email E-mail address of the user

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

OK Applies all changes in all tabs and closes the dialog.

Cancel Discards all changes in all tabs and closes the dialog.

Message Control 54 / 154


Help Opens online help.

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.

Sequence within the user group

Users can be sequenced through the property User order within a user group.

Parameter Description

User List of all available users.

Up Moves selected user up one place.

Down Moves selected user down one place.

Message Control 55 / 154


OK Applies settings and closes the dialog.

Cancel Discards all changes and closes the dialog.

Help Opens online help.

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".

Message Control 56 / 154


Functions
Functions control the use of Message Control in the Runtime.

With this:

• Message control is activated and deactivated

• messages are sent

• The Message Control screen will be displayed in order to manage the message queue

• the message queue is saved

• elements for messages are disabled

Message Control 57 / 154


Screen switching to a screen of type Message Control
With a switch1 to a Message Control screen, you call up the screen in Runtime in order to monitor the
message queue. To configure screen switching:

1. Create a new function

2. Select Screen switch

3. the selection dialog for the screen is opened

4. select the desired screen of type Message Control

5. the dialog for configuring the column settings is opened

6. configure the columns

7. close the configuration by clicking OK

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.

Message Control 58 / 154


Column settings
Settings for filtering messages

Parameter Description

List field Display of the configured columns.

Column selection Opens the dialog for selecting the columns.

Column Format Opens a dialog to format the columns.

OK Applies all changes and closes dialog.

Cancel Discards all changes and closes the dialog.

Help Opens online help.

Message Control 59 / 154


Column selection
Definition of the columns displayed in the Runtime.

Option Function

Available List of columns that can be displayed in the table.


columns

Selected Columns that are displayed in the table.


columns

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.

Add all - Moves all available columns to the selected columns.


>

<- 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

Message Control 60 / 154


Up Moves the selected entry upward. This function is only available for unique entries, multiple
selection is not possible.

Down Moves the selected entry downward. This function is only available for unique entries,
multiple selection is not possible.

Close dialog

Options Description

OK Applies settings and closes the dialog.

Cancel Discards all changes and closes the dialog.

Help Opens online help.

Message Control 61 / 154


Column format
Formatting of columns.

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

Settings Settings for selected column.

Labeling Name for column title.

The column title is online language switchable. To do this, the @ character must be
entered in front of the name.

Width Width of the column in characters.


Calculation: Number time average character width of the selected font.

Alignment Alignment. Selection by means of radio buttons.

Possible settings:

• Left: Text is justified on the left edge of the column.

Message Control 62 / 154


• Centered: Text is displayed centered in the column.

• Right: Text is justified on the right1 edge of the column.

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:

• These settings are only available for configurable lists.

• 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.

User defined Active: User-defined colors are used.


colors

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

OK Applies all changes in all tabs and closes the dialog.

Cancel Discards all changes in all tabs and closes the dialog.

Help Opens online help.


Message Control 63 / 154
1 left: Key which moves the cursor to the left.

Message Control 64 / 154


Save current queue
This function saves an image of the current message queue. If the Runtime is closed normally, this image
will be replaced by a valid image of the queue when the Runtime is closed. To engineer the function:

1. Create a new function.

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

This function is always performed at the computer executing the process.

Message Control 65 / 154


Group/class/area/equipment suppressed
Message Control has a list of deactivated elements. Deactivated means that their alarms do not trigger a
message. The list can be changed with this function. Alarms and equipment1 can be activated or
deactivated. The engineering takes place in the Editor and can be released for changes 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

To configure the function:

1. Create a new function

2. in group Message Control select the function Group/class/area/equipment1 suppressed

3. the dialog for configuring the elements to be suppressed or activated is opened.

4. configure the elements

5. Close the dialog by clicking on OK.

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.

Message Control 66 / 154


General

Parameter Description

Alarm/event List of configured alarm/event groups.


groups

Alarm Areas List of configured alarm areas.

Alarm/event List of configured alarm/event classes.


classes

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.

Message Control 67 / 154


Show dialog Checkbox to select whether this dialog is shown in Runtime:
in the
Runtime • active: This dialog is called up during operation in the Runtime on the current
computer. In the network, this dialog is called up on the computer that executes the
function. As a result, changes to existing parameter settings of an zenon Editor
configuration are possible during execution in zenon Runtime.

• 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

OK Applies all changes in all tabs and closes the dialog.

Cancel Discards all changes in all tabs and closes the dialog.

Help Opens online help.

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.

Message Control 68 / 154


Equipment Modeling

Option Description

Toolbar Symbols to:

• Edit local equipment1 models

• Expand or collapse the display

• 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

Message Control 69 / 154


the warning symbol (triangle with exclamation mark). For details, see the Equipment
modeling manual, Editing local equipment1 models chapter.

Add Adds the selected groups to the filter list.

Remove Removes all selected groups from the filter list.

Filter list Shows all equipment1 groups that are to be filtered.

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

OK Applies settings and closes the dialog.

Cancel Discards the selection and closes the dialog.

Attention: Any changes that have been made to the structure of local equipment1 models are
retained.

Help Opens online help.

Configuration

New models and groups can be created for the active project and existing ones can be deleted.

Add model to project

To add a new model:

1. Click on the project.

2. In the toolbar select New Equipment model

Remove model

To remove an existing model:

1. Click on the model.

Message Control 70 / 154


2. Select Remove in the toolbar.

Add groups to the model

To add a group to a model:

1. select the desired equipment1 model


Attention: If there are naming conflicts between global and local equipment1 models, the local
equipment1 models are displayed and the global ones are ignored. You can get information on
possible conflicts by clicking on the corresponding symbol (triangle with exclamation mark) in the
toolbar.

2. Select an equipment1 group or level.

3. Add the new group to the list in the lower area of the dialog with the Add button.

Note:

• Subgroups are not automatically added.

• it is possible to link as many groups as you want.

Remove group from the model

To delete a group from a model:

1. Select the desired elements in the list in the lower area of the dialog (multiple selection is possible).

2. Click the Delete button

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.

1 equipment: Methodical compilation of components in order to fulfill a certain purpose.


2 toolbar: A row, a column or a block of buttons which are displayed on the monitor screen. If you click on these
buttons, the linked commands are carried out. The tool bars can be customized and moved on the monitor
screen. The setting is saved int eh Editor profiles. Tool bars are only available in the Editor.

Message Control 71 / 154


Send a Message
This function allows for a sending of messages in the Runtime. To do so, link this function with:

• an alarm (function for group, class or area)

• a limit value (property Limit Values /Execute function instantly ),

• a response matrix (function)

• a time control (via button or PFS)

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.

To configure the function:

1. Create a new function.

2. Select the Send a Message function in the Message Control group.

3. The dialog for configuration is opened:

Message Control 72 / 154


4. Configure

• Sending mode

• Message

• Acknowledgment of receipt

5. Close the dialog by clicking on OK.


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.

6. Link the function.

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.

Message Control 73 / 154


Sending mode
In this tab1 the sending mode, recipient and method are configured.

Parameter Description

sending Selection of the sending mode from the drop-down list: The following are available
mode depending on configuration:

• E-mail message via Outlook

• E-mail message via SMTP

• Voice message audiofile via modem

• Voice message Text-to-Speech via modem

• SMS message via SMS server

• SMS message via GSM modem

• Voice over IP as audio file

• Voice over IP as Text-to-Speech

Message Control 74 / 154


Note: In the drop-down list, only media whose Sending mode active property has been
activated in the Message Control Properties of the workspace are shown.

Recipient Recipient settings:

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.

• User group with shift filter:


Selection of a user group for the shift management. Users linked to a shift can be
notified.
Recommendation: Select infinite successive call as a method .

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.

Selection of sending method from drop-down list. Possible methods:

• 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.

• Endless following call:


In principle corresponds to the Following call, however, includes a repetition: After the
last recipient the group is being run through again beginning on the top. The message
is being sent until it is positively acknowledged by the first recipient.

Note: This setting is independent of the Maximum number of attempts property.

Recipient Only available if the option Name from variable is deactivated.


name
Opens dialog for selection of a recipient or a recipient group - depending on the selection
in the option Type.

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.

OK Applies all changes in all tabs and closes the dialog.

Dialog can only be closed if all required options have been configured.

Cancel Discards all changes in all tabs and closes the dialog.

Help Opens online help.

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.

Message Control 76 / 154


Send message to user group with shift filter
Users that have been assigned to a shift can be notified of alarms and events automatically using the
Message Control module.
Notification is configured by means of the two modules shift management and Message Control.

Note: Notification can only be used for configured shifts. Linking to shift models is not possible.

Configuration

To notify users:

1. Link the desired user to the shift.

2. Link the user to a user group.


Ensure that, for users who need to be notified:

• The Message Control user property has been activated

• 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:

1. Open the function and switch1 to the Dispatch Type tab.

2. Select User group with shift filter in the Type option.


The User group selection dialog is opened.

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.

5. Configure the further options of the function.

Procedure in Runtime

Procedure when triggering the Send a Message function:

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.

3. If a user is included in an active shift, they are notified.

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.

Message Control 77 / 154


The precise procedure depends on the configured method.

Methods for user group with shift filter

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.

• This user is notified.

• 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.

• This is run through cyclically until a user is 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.

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.

Message Control 78 / 154


• Following call and Endless following call: No further messages are created if no user of the selected
group is active in the active shift.
Example: The message sending with endless subsequent call starts during Shift 1.
None of the recipients acknowledges the message. A shift-free time of 5 seconds is configured
between Shift 1 and the subsequent Shift 2.
If the timeout for acknowledgment runs out in precisely these 5 minutes, there is no recipient
available at this point in time. The sending of the message is aborted. No messages are sent to their
user, even after the start of Shift 2.

Example with following call:

A message is sent to a group.

• 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.

• User 4 is notified first.


If they do not react, User 5 is notified and then User 6.

• 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".

Message Control 79 / 154


Message
In this tab1 the content of the message is defined. Available options and configuration depend on the
selection of the sending media in the option sending mode on the tab1 sending mode.

Messages are individually configured:

• E-mail via Outlook and SMS via GSM or SMS gateway

• E-mail message via SMTP

• Voice message by audio file

• Voice message via text to speech

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.

Message Control 80 / 154


E-mail via Outlook and SMS via GSM or SMS gateway
Configuration of the message text for:

• E-mail message via Outlook

• SMS message via GSM modem

• SMS message via SMS gateway

Parameter Description

Free Integral part of the message.


message
text This text is searched for placeholders:

• $: indicates "formatted" text. The text is subsequently parsed for parameters.

• Text components are considered parameters if they are separated from the rest of
the text with a semicolon (;) and end with a semicolon (;).

• A Parameter can be:


- key of the language table

Message Control 81 / 154


- name of a variable
- compound entry in the language table

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.

Text from Properties for additional parameters from limit values.


limit value

active Active: Adds additional parameters from the limit value to the constant text.
Configuration via options:

• from variable

• from penultimate variable

• list limit value text parameters

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.

Structure: %Variable%Parameter; (origin)

• %: percentage sign as prefix for variables and parameters

• Variable: Variable. If no variable is indicated the following parameter refers to the


main variable.

• Parameter: Parameter

• ;: semicolon ends string.

• Origin: Only information, not used for free text. Indicates which variables can be
used for the parameter :
main variable via limit value

Message Control 82 / 154


main variable via AML
additional variable via limit value or AML

For details, see the Parameters for messages and Parameter limit value text chapters.

If invalid parameters are used a corresponding error message is displayed in the


message:
<Invalid parameter: 'Parameter'>.

Move Places selected element one step higher.


selected
entry up

Move Places selected element one step lower.


selected
entry down

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.

OK Applies all changes in all tabs and closes the dialog.

Dialog can only be closed if all required options have been configured.

Cancel Discards all changes in all tabs and closes the dialog.

Help Opens online help.

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

Message Control 83 / 154


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.

Message Control 84 / 154


E-mail message via SMTP
E-mail message via SMTP

Configuration of the message text for:

• E-mail message via SMTP

Parameter Description

Free Integral part of the message.


message
text This text is searched for placeholders:

• $: indicates "formatted" text. The text is subsequently parsed for parameters.

• Text components are considered parameters if they are separated from the rest of
the text with a semicolon (;) and end with a semicolon (;).

• A Parameter can be:


- key of the language table
- name of a variable
- compound entry in the language table

Message Control 85 / 154


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.

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:

• Activate the Direct file selection checkbox1.

• Click on the ... button for the file selection.

• Select the desired folder and the desired file.

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:

• Active: Select a string variable.


Click on button ... in order to open the dialog for selecting a variable.

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:

• Absolute path: The path is used unchanged.

• 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.

Text from Properties for additional parameters from limit values.


limit value

active Active: Adds additional parameters from the limit value to the constant text.
Configuration via options:

• from variable

• from penultimate variable

• list limit value text parameters

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.

Message Control 86 / 154


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.

Structure: %Variable%Parameter; (origin)

• %: percentage sign as prefix for variables and parameters

• Variable: Variable. If no variable is indicated the following parameter refers to the


main variable.

• Parameter: Parameter

• ;: semicolon ends string.

• 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.

If invalid parameters are used a corresponding error message is displayed in the


message:
<Invalid parameter: 'Parameter'>.

Move Places selected element one step higher.


selected
entry up

Move Places selected element one step lower.


selected
entry down

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.

Message Control 87 / 154


• 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 entries into CEL all confirmations
or only negative confirmations was selected.

OK Applies all changes in all tabs and closes the dialog.

Dialog can only be closed if all required options have been configured.

Cancel Discards all changes in all tabs and closes the dialog.

Help Opens online help.

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.

Message Control 88 / 154


Voice message by audio file
Configuration of the message text for voice messages via audio file using:

• 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.

Message Control 89 / 154


The file can be played for testing with the button Play.

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:

• In the Runtime this function is always performed at the computer executing


the process. If the function is started on a client1 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 entries into CEL all
confirmations or only negative confirmations was selected.

OK Applies all changes in all tabs and closes the dialog.

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.

Help Opens online help.

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".

Message Control 90 / 154


Voice message via text to speech
Configuration of the message text for voice messages via text-to-speech using:

• 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.

Message Control 91 / 154


The text can be played for testing with the button Play.

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

Note the following when calling up this dialog in the Runtime:

• In the Runtime this function is always performed at the computer executing


the process. If the function is started on a client1 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 if all confirmations or only negative confirmations was
selected for the Log in CEL property (Project-specific settings group).

OK Applies all changes in all tabs and closes the dialog.

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.

Help Opens online help.

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".

Message Control 92 / 154


Acknowledgment of receipt
In this tab1 the required confirmations and the response to them are defined.

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 Settings for acknowledgment of receipt.


of receipt

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.

Message Control 93 / 154


Waiting period Period of time in minutes during which the receipt has to be acknowledged before
the message is forwarded to a substitute person.

Default: 5 minutes

Confirmation Settings for confirmation codes.


codes

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.

PIN code Individual code for confirming the message.


The code consists of a four-digit number between 0000 and 9999.

NA code Individual code for rejecting the message.


The code consists of a four-digit number between 0000 and 9999.

Function Selection of functions to be executed after a message has been confirmed,


execution rejected or not acknowledged at all.

on Functions which are executed if the message is confirmed.


acknowledgement
A click on the Select button opens the function selection dialog.

on missing Functions which are executed if there is no response to the message.


acknowledgement
A click on the Select button opens the function selection dialog.

on negative Functions which are executed if the receipt of message is rejected.


acknowledgement
A click on the Select button opens the function selection dialog.

OK Applies all changes in all tabs and closes the dialog.

Dialog can only be closed if all required options have been configured.

Cancel Discards all changes in all tabs and closes the dialog.

Help Opens online help.

Configuration of confirmation of receipt via‑email

Message Control 94 / 154


When interpreting receipt confirmations via email,‑the first 3 characters of the subject line are ignored.

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.

Configuration: The subject of a receipt confirmation must be introduced by 3 desired characters.

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.

Message Control 95 / 154


Send Message: activate
This function activates Message Control for the project in which the function is located. When the
function is called the project is logged on in Message Control. From this point of time on messages are
created and transmitted.

To configure the function:

1. Create a new function

2. in group Message Control select the function Send Message: activate

3. the function is created

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.

Message Control 96 / 154


Send Message: deactivate
This function deactivates Message Control for the project in which the function is located. When the
function is called all messages of this project are removed from the message queue and the project is
logged off from Message Control. Subsequently, the message queue of the project will be cleared. As
long as Message Control is deactivated for a project no new messages can be created or transmitted.

To configure the function:

1. Create a new function

2. in group Message Control select the function Send Message: deactivate

3. the function is created

Message Control 97 / 154


Parameters for messages
The text of messages can be configured dynamically. It is searched for placeholders before dispatch and
evaluated. Control characters are noted in the process. This applies for:

• E-mail via Outlook and SMS via GSM or SMS gateway

• E-mail message via SMTP

• Voice message via text-to-speech via modem or VoIP

• Dynamic part of the subject property:

Creation of a message

Syntax for the structure of a message:

• A parameter can:

• Be a key from the language table, such as @MyText;

• 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!

• Be a compiled entry in the language table: for example %@Var2+MultipleText

• $: marks text that contains the parameter.

• @: marks language switching

• %: marks variables

• %%: marks limit value text parameters for variables

A variable1 can be stated between the two percentage marks.


If no variable1 is given, the value relates to the main variable1.

• Text parts are separated from one another with a semi colon (;).

• Messages end with a semicolon (;).

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.

List of parameter text

Parameter In the Runtime Action

Message Control 98 / 154


key: A check is made to see if an • Existing: entry is added to the
entry in @MyText is present in message.
@MyText the language table for the
current language. • non-existent: According to the
settings of the project properties
Show untranslated keywords either
@MyText or MyText is added to the
message.

Variable: A check is made if the • Existing: Value of the variable1 is


variable1 exists and the value taken and added to the text as string.
%Var1% can be read.
• Not existing/not readable: The text
xxx is added to the message.

Compound entry: A check is made if: • Variable and text exist:


text is added to the message.
@StringTable+%var1Text • 1. the variable1 exists and Example: Value of the variable1 is 33.
the value can be read. The language table is then checked
Value is attached to the for @StringTable33 and the
prefix text ("MultipleText")
corresponding text is added.
as string.
• non-existent: According to the
• 2. an entry in the language settings of the project properties
table exists for the text Show untranslated keywords either
@MyText or MyText is added to the
message.

Example: $@Caution ;%Var1%Name;

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.

Message Control 99 / 154


Text from limit value and free text
Messages can be configured with free text. This can also contain texts from limit values and dynamic
text elements. Not all dispatch types in Message Control support texts from limit values. However all
texts with dynamic elements can be added to.

Configuration of text from limit value

To link limit values:

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.)

2. Activate the option from violated variable.

3. Activate the checkboxes for the desired values.


For parameters, see List of limit value text parameters.

4. Order the selected parameters by means of Drag&Drop or with the corresponding buttons.

5. Ensure that the limit value violation triggers the function.

Configuration of free message text

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 (;)

• Prefix for Limit value text parameters:


2 percentage signs (%% or % variable name %).

If no variable is indicated the following parameter refers to the main variable.

• End of the character sequence: Semicolons (;).

Example

$Text Message Control ;%%Name; Text ;%%LimitText; Text ;%Master%VariableStatus ;Text;

• $: Start of the message with the first message text

• %%Name: Name of the violated variable plus text

• %%LimitText: Limit value text of the violated variable plus text

Message Control 100 / 154


• %Master%VariableStatus: Status of the Master variables plus text

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;

list limit value text parameters

Parameter Main variable - Main variable - Additional variable


Activating via limit Activating via AML AML/limit value
value

%%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 .

%%Identification Description of the Description of the Description of the


variable, corresponds variable, corresponds variable, corresponds
(Identification) to property to property to property
Identification . Identification . Identification .

%%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 .

%%LimitTimeReceived Time stamp of the Time stamp of the -


alarm object. alarm object.
Message Control 101 / 154
(Time alarm is generated)

%% No parameter. Value No parameter. Value No parameter. Value


of the variable when of the variable when of the variable when
(Current value) activating the activating the activating the
function (without function (without function (without
unit). unit). unit).

%%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 Address. Address. Address.

(Address)

%%Unit Technical unit Technical unit Technical unit


according to according to according to
Measuring unit: Measuring unit Measuring unit Measuring unit
property. property. property.

%%AlarmArea Alarm area of the Alarm area of the Alarm area of the
main variable. main variable. additional variable.
(Alarm area)

%%LimitTimeAcknowledged -- Time stamp of the --


alarm object.
(Time alarm is acknowledged)

%%UserId -- User identification of --


the user who started
(User identification) the action. Conforms

Message Control 102 / 154


to property User
name .

%%UserName -- Complete name of --


the user who started
(User name)
the action. Conforms
to property Complete
name .

%%ComputerName -- Name of the --


computer on which
(Computer name) the action was
started.

%%Comment -- Comment of the --


alarm object.
(Comment)

%%AlarmGroup Alarm/event group of Alarm/event group of Alarm/event group of


the alarm object (as the alarm object (as the alarm object (as
(Alarm/event group) text). text). text).

%%AlarmClass Alarm/event class of Alarm/event class of Alarm/event class of


the alarm object (as the alarm object (as the alarm object (as
(Alarm/event class) text). text). text).

%%AlarmTimeActive -- Period of time the --


alarm has been
(Time alarm is pending) pending.

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.

Message Control 103 / 154


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.

Message Control 104 / 154


Message Control in the Runtime
In the Runtime Message Control is either started automatically (property Active during Runtime start
active) or with the function Send Message: activate.

If Message Control is active and an event defined for message sending occurs:

• a message configured for this is being sent

• its acknowledgement is being analyzed

• the functions used for acknowledgement are executed

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".

Procedure in the Runtime

The message queue can be managed with a Message Control screen.

Message Control is being closed when closing the Runtime or by the function Send Message: deactivate.

Time stamp in Alarm Message List and Message Control

Message Control 105 / 154


When the function Send message is activated a copy of the alarm object is transmitted to the function.
The message text is created and translated when the function is activated. If the function is activated via
AML it will use a copy of the alarm object from the AML. So the content always corresponds to a current
combination of process and alarm status.

Message queue - remanance

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:

• Current messages in the queue

• Suppressed alarm groups

• Suppressed alarm class

• 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 area Constant Text

• the parameter Dynamic Limit value Text

• Limit value text of a limit value in the AML/CEL

The selectable columns in type Message Control are language switchable if they are configured
correspondingly.

Message Control 106 / 154


Connect screen of the type Message Control
The message control screen makes a copy of the current message queue and control elements for
analysis and filtering available in the Runtime. The content of the elements displayed in the message list
list field corresponds to the point of time when the screen is connected and is not automatically updated.
The display can be updated anytime by clicking on the button Update. The button Stop/Continue allows
for a cyclical update. A text field indicates the point of time of the last update.

The message list contains messages with this status:

• Waiting for dispatch

• Is currently being sent

• Has already been sent, but not yet confirmed

• There was an error while sending

All sent messages can be checked in the CEL1.

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.

Message Control 107 / 154


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

Lists and fields which can be displayed in the Runtime.

Control elements Description

Message queue List of messages.

Contains messages which have been sent, confirmed or deleted or remain to be


sent.

The messages are only displayed and cannot be edited anymore.

Column headings can be named individually and are localizable by putting @


before them.

Number of Number of currently existing messages.


messages

Last Update Point of time of last update.

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 elements to control lists.

Control Description
elements

Filter Opens Dialog to configure the filters for the view.


Message Control 108 / 154
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.

Stop/Continue Starts and stops the cyclic update of the list.

Filter profiles

Profile administration

Control elements Description

Profile selection Opens the dialog for selecting a profile.

Save Saves current setting as a profile.

Delete Deletes profile.

Import Opens dialog for importing profiles from a file.

Export Opens dialog for exporting profiles from a file.

1 equipment: Methodical compilation of components in order to fulfill a certain purpose.


2 screen type: Defines the type of screen and the elements which are available in it as standard. For each screen
type there are elements (buttons, lists, etc.) available which adapted for the functions. For example in screen
type Alarm Message List all objects are available which are necessary to display and filter alarms.

Message Control 109 / 154


Acknowledgment of messages
Messages can be confirmed or rejected by the recipient. Depending on the medium messages must
either mandatorily or optionally be acknowledged.

Medium To acknowledge

-: no

+: yes

E-mail message via Outlook -

E-mail message via SMTP -

SMS message via GSM modem -

SMS message via SMS gateway -

Voice message by audio file +

Voice message via text to speech +

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

Rules for interrupted calls:

• If a call is interrupted without confirmation or a decline and the interruption is not classified as a
hardware error, then:

• The call is not repeated for the same addressee

• 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.

Configuring the confirmation

In order to configure the confirmation or rejection of the message:

Message Control 110 / 154


1. In the function Send Message open the tab Acknowledgement of receipt.

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:

1. properties of the user:


Message Control user -> PIN code and NA code
or

2. in the function via:


checkbox Use message-specific codes -> PIN code and NA code

5. Define the functions which are to be executed after receiving the code for:

1. message was confirmed

2. message was neither confirmed nor rejected

3. message was rejected

6. Close the dialog by clicking on the OK button.

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:

• the message must have been sent as e-mail or SMS

• the response must be as e-mail or SMS

• the response must contain the GUID

• the response must contain the code for acknowledgement

• the medium used for responding must be configured

E‑Acknowledging e-mails

An e-mail is acknowledged as follows:

• 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.

Message Control 111 / 154


• However the subject must have at least three characters placed in front of it as a response. For
example RE: or AW:.

• The response text must contain:

• GUID: At the start of the message. There must be no other character, including spaces, in
front.

• Semi-colon (;): Separator.

• Text: Contains PIN code or NA code.

• 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

A SMS is acknowledged as follows:

• The response is being sent using the reply function of the user's telephone.

• The response text must contain:

• GUID: At the start of the message. There must be no other character, including spaces, in
front.

• Semi-colon (;): Separator.

• Text: Contains PIN code or NA code.

• Message Control analyzes GUID and code and subsequently executes the functions set in the
function Send Message.

Voice message

Voice messages always must be acknowledged. A voice message is acknowledged as follows:

• The telephone of the recipient must support DTMF.

• The receiving modem of the equipment must support DTMF.

• 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.

• The recipient can:

• have messages repeated:


by pressing the # key on the telephone. The previously-sent message (description,
confirmation or error message) is repeated.

Message Control 112 / 154


• re-set sent code:
by pressing the * key on the telephone. The code (PIN or NA) previously sent by the
recipient is revoked. The playback of the message starts with the description again.

• Message Control analyzes the code and subsequently executes the functions set in the function
Send Message.

Note: Voice messages always must be acknowledged by telephone.

1 equipment: Methodical compilation of components in order to fulfill a certain purpose.

Message Control 113 / 154


Voice messages in Runtime
The procedure for the sending of voice messages is as follows:

1. A function calls up the desired dispatch method1.

2. The call is initiated by means of the VoIP-Server or the modem.

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.

Another attempt is made if no connection can be established.


The number of attempts corresponds to the value in the Project-specific settings /Maximum
number of attempts property. The time between the attempts corresponds to the value in the
Project-specific settings /Waiting period between trials and timeout property.
Note: If a message is forwarded to another user, this is considered a new message. The counter is
automatically set back to 1.

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.

5. A welcome message is played back as soon as the call is taken.

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:

• Confirmation: PIN code

• Rejection: NA code

7. If receipt confirmation has been saved for the message functions, these are executed accordingly.

Code entry

The code is entered by DTFM. The following characters are interpreted:

• #: Repeat current message.

• *: Delete entered character and start process again with welcome message.

• Numbers (0 - 9): Entry of the 4-digit code

Message Control 114 / 154


Only the first four sounds are interpreted when entering the code. All other DTMF key tones are ignored
for PIN and NA, but lead to the message being repeated.

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.

Message Control 115 / 154


Network
In the network, the message queue is permanently being synchronized between server and standby
server. If new messages are created at the server these are transferred to the standby. When the server or
standby server are booting, the message queue is synchronized with the primary server or standby server.
Since the server and standby server use different resources, messages can only be acknowledged at the
sending computer.

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:

uses a separate modem and telephone number respectively for:

• SMS via GSM

• SMS message via SMS gateway

• Voice message with audiofile

• Voice message text-to-speech

• Outlook

• E-mail message via SMTP

Behavior in case of failure

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

Message Control 116 / 154


messages, but it ensures correct acknowledgement, since messages can only be acknowledged at the
sending computer.

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.

Message Control 117 / 154


Voice message process
The process when sending a voice message and when receiving the confirmation corresponds to the
following diagram:

Key:

• Y: Yes

• N: No

Procedure

The process of the function can be subdivided into main processes and subprocesses.

Message Control 118 / 154


Main processes:

• Start Send a Message function

• Text description

• End call

Subprocesses:

• Substitute person

• Misentry

• Acknowledgement

Main processes:

Start "Send message" function:

1. Send a Message function executed

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.

• Y: Send a Message is ended.

• N: Call is carried out.

3. Validation: Is the call announced at the partner?

• 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

• Y: There is a wait for a response.

4. Validation: Has the waiting time defined in the Timeout [min] function been exceeded?

• Y: Further with Substitute person process.

• N: There is a wait for the call to be taken.

5. Validation: Is the call taken?

• N: Further with Substitute person process.

• Y: Further with text description process.

Text description:

1. Description is sent.

2. Validation: Is # or * being sent by the partner?

• Y: Description is sent.

Message Control 119 / 154


• N: Checking for the waiting time.

3. Has the waiting time that was defined in the waiting time option of the Send a Message function
been exceeded?

• Y: Further with End call process.

• N: There is a wait for the entry of the PIN or NA code.

4. Validation: Has there been a correct PIN or NA code?

• Y Continue with Confirmation process.

• N: Continue with incorrect entry process.

5. Validation: Received code *?

• Y: Continue with text description process.

• N: Continue with End call process.

End call

1. Validation: Has PIN been received?

• Y: Execute linked function for PIN, if present.

• N: Continue to NA process.

2. Validation: Has NA been received?

• Y: Execute linked function for NA, if present.

• N: Continue to the next point No confirmation.

3. No confirmation received: Execute linked function if present.

4. End Send a Message function.

Subprocesses

Substitute person:

• Validation: Has a substitute person been defined?

• Y: Function for the substitute person is executed once again.


Continue with check: Has the defined value for the Maximum number of attempts
function been reached?

• N: Continue to End call process Item 3: No confirmation received.

Misentry:

• Validation: Entry # or number between 0 and 9?

• N: Validation: Received code *?

• Y: Back to checking process: Entry # or number between 0 and 9?

Message Control 120 / 154


Confirmation:

• Validation: Entry # or number between 0 and 9?

• N: Validation: Received code *?

• Y: Back to checking process: Entry # or number between 0 and 9?

Message Control 121 / 154


Messages and error handling
Messages, notes and errors can be logged and displayed with the Diagnosis Viewer in a separate module
[Message Control]. Message details can be found in section LOG entries.

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 Windows 7, the Telnet client can be installed as follows:

1. Open system control.

2. Open Programs and functions.

3. Open Activate or deactivate Windows functions.

4. Activate checkbox in front of Telnet client.

5. Close dialog by clicking OK.

6. The Telnet client is being installed.

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:

• Serial Port Monitoring:


for supervising the communication between zenon and the GSM modem.

• 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

For troubleshooting with 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.

4. Type in the AT command AT in the main window of the terminal.


The modem should respond with OK.

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".

Message Control 123 / 154


Check list
In case of problems check:

Problem Possible cause Solution

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)?

• Was an e-mail address


configured for the user?

• Are the user data transferred


to the Runtime after a change
(property Runtime changeable
data )?

• Is the configuration of the


sending mode correct?
Compare to the data of the e-
mail provider.

The server is registered correctly, but is not • Does the name resolution
available (error messages when connecting). work?

• Is the server available (Ping)?

• Does the firewall allow for the


connection with the configured
port1? Both the computer
firewall and the domain
firewall can block this. Check
with Telnet.

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).

If possible select a different


configuration (e.g. SMTP AUTH
commands can be bypassed with
Message Control 124 / 154
"register at the incoming mail
server before sending e-mails".
APOP can be deactivated and
replaced by user and password.

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.

modem. error when opening the COM port).

• Error when configuring the COM port/modem


not responding.

• The modem does not support the SMS-PDU


mode (AT+CMGG error message or PDU mode
error message in LOG).

• Probably the modem requires a PIN / is the


PIN incorrect? (PIN error messages in LOG)

• Too many attempts to log on with an incorrect


PIN? (PUK error message in LOG) In this case,
the connection between zenon and the
modem is only possible again once the PUK
has been entered manually and thus the lock
been lifted.

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

Message Control 125 / 154


do not • Despite this the modem is not connected with • Put modem in different
work. the network (check with manufacturer location.
software): Look for a location with better
• Check telephone number.
reception.
Has the country code for the
• The SMSC telephone number that has been SMSC (00xy or +xy) been set
entered is not correct. Check the number correctly?
before entering it into zenon or when
establishing a connection for the first time.
This check can also be carried out with the
Check connection property activated. Load
SMSC with HyperTerminal from modem and
write.

• Look at error message in LOG

1 COM port: Serial communication interface.


2 LOG file: Text file in which error protocols are stored.

Message Control 126 / 154


LOG entries
Entries in the LOG file1 of the Diagnosis Viewer.

• Miscellaneous messages

• E-mail via SMTP/POP

• Voice over IP

• SMS

• OpenSSL Library

1 LOG file: Text file in which error protocols are stored.

Message Control 127 / 154


Miscellaneous messages
The listing of these LOG entries is ordered alphabetically according to levels and entries.

• Debug

• Deep Debug

• MSG

• Warnings

Message Control 128 / 154


Debug
Debug

Level Entry Description

DEBUG Attaching to current call. The sending mode attaches to the active call.

DEBUG Connected A connection has been established.

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 Invalid code '%s' entered. An invalid code was entered.

DEBUG Mail to Benutzer '%s' was successfully The message to user [name] was successfully
added to the outbox. transferred to the Outlook outbox.

DEBUG MessageDeleteRequest Response: %d A delete response was received: [Number]


messages were deleted from the queue. messages were removed from the queue.

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.

Message Control 129 / 154


DEBUG SMS to Benutzer %s transmitted to the A SMS was transferred to the user [address] in
outbox. the outbox.

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

Level Entry Description

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 A remove notification of The project received a remove telegram for


message(%s) was received, the message with GUID [number]. The local (previous)
message object will be removed object is deleted.
from the list. (%s)

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 An ChangeSuppressionRequest A ChangeSuppression-Request was received. The


was received. The local local suppression status is updated.
suppression-state will be updated!

DEEPDEBUG An update of the message control The project received a MessageControl-


state was received. The local state StateChange telegram for message with GUID
will be updated! [number]. The new object is added.

DEEPDEBUG Current message count is (%d) There are [number] messages in the queue. (Entry

Message Control 132 / 154


is created when creating and deleting messages.)

DEEPDEBUG Firing MessageAcknowledged MessageAcknowledged is being fired.

DEEPDEBUG Firing MessageAcknowledgeTimeOut is being fired.


MessageAcknowledgeTimeOut

DEEPDEBUG Firing MessageCreated MessageCreated is being fired.

DEEPDEBUG Firing MessageDeleted MessageDeleted is being fired.

DEEPDEBUG Firing MessageIn: Message is being fired, Id value is %s,


(Identfier:'%s',Message:'%s') MessageTExt is %s.

DEEPDEBUG Firing MessageNegAcknowledged MessageNegAcknowledged is being fired.

DEEPDEBUG Firing MessageSendError MessageSendError is being fired.

DEEPDEBUG Firing MessageSent MessageSent is being fired.

DEEPDEBUG Last index set to %d. The last applied index was set to [value].

DEEPDEBUG MessageAcknowledged fired MessageAcknowledged was fired.

DEEPDEBUG MessageAcknowledgeTimeOut MessageAcknowledgeTimeOut was fired.


fired

DEEPDEBUG MessageChangedNotify received The project received a changed notification for


for Message %s ignored (no message with GUID [number] from Message
longer Mainstation)! Control, however, it is no longer the process-
executing instance.

DEEPDEBUG MessageCreated fired MessageCreated was fired.

DEEPDEBUG MessageDeleted fired MessageDeleted was fired.

DEEPDEBUG MessageIn fired: Message was fired, Id value is %s, MessageTExt is


(Identfier:'%s',Message:'%s') %s.

DEEPDEBUG MessageNegAcknowledged fired MessageNegAcknowledged was fired.

DEEPDEBUG MessageSendError fired MessageSendError was fired.

Message Control 133 / 154


DEEPDEBUG MessageSent fired MessageSent was fired.

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 Project %s signed on. The project is logged on to Message Control.

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 MessageCtrl- A MessageControl-StateChange telegram is sent


StateChanged to SB. 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 Switch to server:%s The current instance is upgraded to server.

DEEPDEBUG Switch to standby:%s The current instance is downgraded to 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

Message Control 134 / 154


changed in the Runtime also count; such as data for the standard recipes, recipegroup manager, user
administration, etc.
2 standby: Programm which has all current data and connections of the server at its disposal and which can take
over instantly when the server fails.

Message Control 135 / 154


MSG
LOG Level MSG & MSG

Level Entry Description

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 Logging on to mapi profile %s Log-on on profile [name].

MSG MessageControl has been activated. Message Control was activated.

MSG MessageControl has been Message Control was deactivated.


deactivated.

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.

Message Control 136 / 154


Warnings
Warnings

Level Entry Description

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.

WARNINGS Index exceeded 99999, starting from 0. Maximum


index for
file name
reached,
starts again
with 0.

WARNINGS TAPI returned [number] available devices. Number of


modems
that can be
addressed
via TAPI.

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.

Message Control 138 / 154


E-mail via SMTP/POP
The listing of these LOG entries is ordered alphabetically according to levels and entries.

• Debug

• Error

• Warning

Message Control 139 / 154


Debug
Debug

Level Entry Description

DEBUG Attaching to current call. The sending mode attaches to the active call.

DEBUG Connected A connection has been established.

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 Invalid code '%s' entered. An invalid code was entered.

DEBUG Mail to Benutzer '%s' was successfully The message to user [name] was successfully
added to the outbox. transferred to the Outlook outbox.

DEBUG MessageDeleteRequest Response: %d A delete response was received: [Number]


messages were deleted from the queue. messages were removed from the queue.

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.

Message Control 140 / 154


DEBUG SMS to Benutzer %s transmitted to the A SMS was transferred to the user [address] in
outbox. the outbox.

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

Level Entry Description

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

Message Control 143 / 154


the AUTH PLAIN command: the LOG message.)
[response from the SMTP
server]

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).

Message Control 144 / 154


Email via SMTP/POP - warning
Warning

Level Entry Description

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.

Message Control 145 / 154


Voice over IP
LOG entries for VoIP:

Errors

Level Entry Description

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.

Message Control 146 / 154


SMS
Error

Level Entry Description

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.

Message Control 147 / 154


command]
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]

Message Control 148 / 154


ERROR The syntax of the The time stamp of the GSM network received during the SMS receipt
timestamp [time does not correspond to the expected format.
stamp] is incorrect.

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

Message Control 149 / 154


consequence, the attempt to establish a connection with the modem
is cancelled. After an incorrect PIN code was entered several times
the SIM card in the modem requests the PUK for authentication,
subsequently requiring to reset the PIN code.

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.

Message Control 150 / 154


DEBUG Authentication with Authentication with the configured PIN code succeeded.
the PIN succeeded.

1 COM port: Serial communication interface.


2 switch: Dynamic element which displays and modifies the value of a binary variable. It can also be used as a
momentary switch.

Message Control 151 / 154


LOG entries - OpenSSL library
Error codes and the error messages from the OpenSSL Library in format „Errorcode: [Code].
Errormessage: [String]".

The server responses have the following structure:

• POP3 responses only start with „OK“ if no error has occurred.

• SMTP server responses start with a three-digit status code:

• 2xx = OK

• 3xx = waiting for data

• 4x and 5 xx = error

Error messages in the Diagnosis Viewer.

Level Entry Description

ERROR No Destination E-Mail-Address In case of an outgoing mail no target address was


specified entered.

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.

The following commands are required: AUTH LOGIN and


AUTH PLAIN, the latter is the minimum implementation
according to RFC 2554.

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.

Note: If the DELE command still contains the reference


„Could not delete mail“ the e-mail was received though
could not be deleted. Since the e-mail was successfully
received it is being forwarded to Message Control.

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).

Message Control 154 / 154

You might also like