Академический Документы
Профессиональный Документы
Культура Документы
Welcome to Aastra
Thank you for choosing this Aastra product. Our product meets the strictest
requirements with regard to quality and design.
The following user guide will assist you in using your SIP-DECT OM Integrated
Messaging & Alerting Application and provide answers to all your most important
questions.
If you should require further technical support or information about other
Aastra products, please contact the person responsible for your system or get in
touch with your local dealer.
You can also find information about this device and other products on our website
at http://www.aastra.de or http://www.aastra.com.
We hope you enjoy using your SIP-DECT OM Integrated Messaging & Alerting
Application.
Contents
OM Integrated Messaging & Alerting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Supported Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
OM IMA Service Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Other Valid Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Notes on Licences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Activating the OM IMA Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Enabling Messaging for DECT Handsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Configuring the OM IMA Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Basic Messaging Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
Message Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
URI Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
vCard Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Configuration File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Configuration File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
MailBoxAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
SendmailAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
RSS / feed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
AlarmScenario / as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Debugging the OM IMA Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
OMM Console Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Using the OMM Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
OMM Console Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
AXI
OMM
External
Message
Server
IMA
OpenMobility Manager
(Runs on a single RFP)
Locating
Server
paging messages include a call back number that is dialled immediately if the
receiver presses the off hook key while the message is displayed.
Messages can include options when sent to Aastra 600 c/d DECT handsets that
overwrite handset settings. Options include settings for melody, volume,
ringer, vibrator, or display color as well as they may disconnect a call, initiate a
callback, or suppress the in-band signalization.
Tip:
sending and receiving text messages between DECT portable parts which
includes normal messages, alarm messages or messages queuing up in a job
list;
sending vCards from a messaging server, e.g. to configure a short dialling entry
for a feature access code (FAC) that triggers a function such as a door opener;
overwrite handset settings with message options sent to Aastra 600 c/d DECT
handsets, e. g. increase volume setting in an alarm scenario.
Note, that the limited storage capacity of the RFP does not allow to store the
message contents. However, it is possible to extend the OM IMA service with a
separate messaging application, which runs for example on a PC server system.
Notes on Licences
Application licence
In order to use the OM IMA service, you need the appropriate licences to configure
and use the application. Upload the received licence file either in the
OM Management Portal (Java tool) or via the OMM Web service. To operate the
OM IMA service, the following licences are required:
OM Messaging & Alerting System Licence: enables extra priorities for receiving
text messages (emergency, locating alert) and enhanced messaging / alarm
features (e.g. set audio parameters, display colors). Without this license only
standard messaging is available.
Note
Basic messaging (receiving messages with DECT handsets with basic priorities) is
always possible without extra licensing.
The licence confirmation you received contains detailed information on activating
the service. Note, that you can also start with the automatically applied demo
license, which is valid for 72 hours.
Installation
Installation
The OM Integrated Messaging & Alerting service does not require any installation, because the necessary software is already present in the software container
of the OMM. However, you need to activate the OM IMA service to be started.
Certificate warning
To overcome the browser warning automatically, a regularly re-paid validation
certificate for the OMMs network address needs to be issued by a third party.
For connecting to the web user interface of the OMM in your LAN you can
safely ignore this message and store a permanent exception in your browser.
After accepting the certificate warning, the browser displays the OMMs login
page.
2. Enter the User name that is configured at the OMM for the Full access
account type. This is omm by default, but you may have changed this setting
at the OMM. Enter the Password for the OMM. Confirm with OK.
3. The OMMs web service main page is displayed. In the menu tree to the left,
navigate to the System: System settings page. Scroll down to the
OM Integrated Messaging & Alerting service section.
Installation
Installation
Installation
Installation
Configuration
Configuration
The OM Integrated Messaging & Alerting service is configured by writing down
the desired configuration in a configuration file. The configuration file is then
downloaded by the OM IMA service on startup. Before we dive into the configuration file details, you need some basic information about the message structure
and some basic concepts.
Urgent Message: a message from a user, with pop-up display and confirmation;
Alarm Job: a system urgent job message (from alarm application only);
Note
Text messaging is also possible with the Aastra 142d DECT handset. However, this
feature can be used only in conjunction with the Aastra Alarm Server (AS 7900).
10
Configuration
Each message consists of the following components:
OMM Message Structure
Component
Format / Purpose
Date/Time, ID
Sender
Senders Name
Recipient
Recipients Name
Priority
Flags
Encoding
Confirmations required
Content Type
Content
While different message types can be identified by specific display icons, the specific message handling will support the message purpose. Further options can be
configured, see AlarmScenario / as starting on page 20.
For example, a Pop-up message is displayed in a window overlaying the current
display. If the DECT handset user closes the window temporarily, the message is redisplayed (Re-Popup) after some activity e.g. after the user completed a phone
call. Also, each message carries a flag (Auto Delete Option) which deletes the
message automatically after the final confirmation.
11
Configuration
Message Matrix
The following table show how specific message types are handled on the
Aastra 600 c/d DECT handsets.
Messaging Matrix: Message Handling
Message Type
Priority
Stored in
Folder
Pop-up
Re-Popup
Idle Box
Yes
No
No
Yes
Yes
No
Normal Message
Normal
Inbox
Yes
As configured
After Call
(if popup)
Urgent Message
High
Inbox
Yes
Yes
Yes
Alarm Message
Alarm
Inbox
Yes
Yes
Yes
Normal Job
Normal
Jobs
Yes
Yes
Yes
Urgent Job
High
Jobs
Yes
Yes
Yes
Alarm Job
Alarm
Jobs
Yes
Yes
Yes
Yes
Yes
Yes
Confirmation
Read
Accepted
Audible
Completed Signal
Idle Box
None
Info / Confirmation
None
Confirmation tone
Normal Message
None
Handset config:
normal msg. tone
Urgent Message
Yes
Handset config:
urgent msg. tone
Alarm Message
Yes
Handset config:
alarm msg. tone
12
Configuration
Messaging Matrix: Message Confirmation and Signal
Message
Confirmation
Audible
Type
Read
Accepted
Completed Signal
Normal Job
Yes
Yes
Handset config:
normal msg. tone
Urgent Job
Yes
Yes
Yes
Handset config:
urgent msg. tone
Alarm Job
Yes
Yes
Yes
Handset config:
alarm msg. tone
Localization Alert
Yes
Defined by admin.
URI Syntax
For some configuration items, you need to specify recipient or destination
attributes. These are encoded with a specific syntax, denoted as URI.
URI Types
URI
Description
tel:
ppn:
cb:
mailto:
alarm:
Triggers an alarm
emailsubject:
13
The tel:* URI addresses all DECT handsets that are able to use messaging.
Note, that messages sent to this URI cannot enforce confirmations, thus also no
confirmation timeout and no alarm scenario escalation is supported.
Configuration
vCard Support
The Aastra 600 c/d DECT handsets support receiving vCards that are automatically
pushed to the personal directory of the DECT handset. The vCard syntax
(RFC 2426) defines different keys that needs to be translated to the directory entry
keys of the DECT handsets:
vCard Keys
Directory Key
vCard Keys
Content
Name
Primary: FN:
Secondary: N:
[String]
(UTF-8 or Latin-1)
Private number
Primary: TEL;HOME
Secondary: ;HOME;VOICE
Tertiary: TEL;ISDN
[Number]
Business number
Primary: TEL;WORK
Secondary: ;WORK;VOICE
Tertiary: TEL;VOICE
Quaternary: TEL;PREF
[Number]
Mobile number
Primary: TEL;CELL
Secondary: ;CELL;VOICE
[Number]
Fax number
Primary: TEL;FAX
Secondary: ;FAX
[Number]
Primary: EMAIL
[E-mail Address]
Secondary: EMAIL;PREF;INTERNET
Quick-dial
X-QC
2 - 9
Melody name
X-MEL
[String]
VIP-number
X-VIP
[Number]
Character set
Primary: VERSION
Secondary: CHARSET
[Mapping ID]
Framing
During translation, the DECT handset evaluates the primary key first. If this is not
found, the subsequent keys alternatives are evaluated. The following example
shows an alarm scenario with vcard:
<AlarmScenario>
<as alarmTriggerId="VCARD" level="1"
recipients="tel:*" priority="PrioNormal"
14
Configuration
alarmMsg="BEGIN:VCARD
VERSION:3.0

FN:Miller
TEL;HOME;VOICE:1234

END:VCARD" vCard="true" />
</AlarmScenario>
Please note:
15
Configuration
An XML tag may have one or more attributes (e.g. level="1"). An attribute needs
to be separated from prepending characters by a white space. The attribute value
needs to be enclosed in single or double quotation marks.
The XML tag names and the attribute names are case sensitive. For example <A>
and <a> are handled as different tags. The OMM service only accepts known XML
tags and attributes. Moreover, the XML tags needs to follow a prescribed sequence
and nesting and only pre-defined attributes are allowed for specific tags.
MailBoxAccount
This configuration file item is used to configure an E-mail account for polling
available messages. The OM IMA service will poll this account and forward the
acquired E-mails as text messages to different DECT handsets.
<MailBoxAccount />
Attribute
Type/Values Default
mailbox
EmailNone,
EmailPOP3,
NONE
[IP or DNS]
mbServer
Description
trySslFirst
true, false
false
Configuration
<MailBoxAccount />
Attribute
Type/Values Default
Description
pollTime
[Number]
30
sinceTimestamp
[Number]
mbPort
[Number]
mbSslPort
[Number]
mbUser
[String]
mbPassword
[String]
The E-mail account will be polled by the OM IMA service on a regularly basis. If a
new E-mail comes in, the E-mail will be fetched and removed from the E-mail
server. The OM IMA service then forwards the E-mail to the recipient mentioned in
the subject of the E-mail. For example, to send to a particular DECT handset, send
an E-mail with the following subject:
tel:1001 Hello, you just got mail!
If the E-mail cannot be delivered, the OM IMA service will reply with an error mail
provided that the SendmailAccount is configured. For example:
IMA [noreply:ima]: Error: Transmission attempt repeatedly failed
Otherwise, the E-mail is send as normal text message to the addressed DECT
handset. The DECT handset user may response to this text message, which in turn
the text message is forwarded to the original E-mail sender.
17
Configuration
Notes
SendmailAccount
This configuration file item is used to configure an E-mail account for sending messages. The OM IMA service will forward text messages received from DECT
handsets to this E-mail account.
<SendmailAccount />
Attribute
Type/Values Default
auth
AuthNone,
AuthPOP3,
AuthSMTP
Description
smtpServer
[IP or DNS]
senderAddress
[String]
trySslFirst
true, false
false
smtpPort
[Number]
Configuration
<SendmailAccount />
Attribute
Type/Values Default
Description
smtpSslPort
[Number]
[String]
AuthSMTP only:
User name for SMTP
smtpPassword
[String]
AuthSMTP only:
Password for SMTP
mbPort
[Number]
AuthPOP3 only:
The port number for POP3;
Use 0 for standard port
mbSslPort
[Number]
AuthPOP3 only:
The port number for SSL
encrypted POP3;
Use 0 for standard port
mbUser
[String]
AuthPOP3 only:
User name for the POP3 mailbox
account
mbPassword
[String]
AuthPOP3 only:
Password for the POP3 mailbox
account
RSS / feed
These configuration file items are used to configure one or more news sources
which are then typically polled to deliver text messages to DECT handsets. You
configure an RSS feed which is usually offered by a web site that publishes frequently updated content. The RSS feed is then polled on a regularly basis. If a new
RSS entry appears, a message is sent to the DECT handsets which are attached to
the service. The necessary configuration is splitted in two parts:
1. You define the RSS feed to poll. For example:
<RSS>
<feed url="http://rss.cnn.com/rss/cnn_tech.rss" trigger="CNNtech"/>
</RSS>
19
Configuration
2. You define a corresponding alarm scenario (see AlarmScenario / as starting on
page 20) which is used to send a text message when a new RSS entry is
detected. For example:
<AlarmScenario>
<as alarmTriggerId="CNNtech" level="1"
recipients="tel:1001;tel:1002" alarmMsg="CNN: %c"
priority="PrioInfo" autoDelete="true" popUp="false" />
</AlarmScenario>
Only the <feed /> tag carries attributes that configure the RSS feed properties.
Each single <feed /> tag needs to be enclosed by <RSS></RSS> tags.
<feed />
Attribute
Type/Values Default
url
[String]
Description
trigger
[String]
refresh
[Number]
3600
To prevent the RSS feed source from overloading the OM IMA service, only one
new RSS entry is considered when the RSS feed is polled. During a poll operation,
the ID and content of the newest RSS entry is compared against the values stored
during the previous poll operation for this. If, for example, the RSS feed delivers a
bulk update which marks several RSS entries as new, the next poll operation will
only forward the newest entry as text message.
Tip:
AlarmScenario / as
These configuration file items are used to configure one or more alarm scenarios.
Each alarm scenario is triggered by a pre-defined signal. You can establish a tiered
escalation system with up to three escalation levels. This can be used to trigger
subsequent alarms if the original alarm is not confirmed by its recipients as in the
following example:
20
Configuration
<AlarmScenario>
<as alarmTriggerId="MANDOWN" level="1"
recipients="tel:1001;tel:1002;tel:1003"
requiredPosConfirmCount="1" confirmTimeout="30"
priority="PrioAlarm" alarmMsg="%n (%R) MAN Down!">
<alarmConfirm>ConfRead</alarmConfirm>
</as>
</AlarmScenario>
<AlarmScenario>
<as alarmTriggerId="MANDOWN" level="2"
recipients="tel:*;mailto:manager@company.com"
priority="PrioAlarm" alarmMsg="Unhandled: %n (%R) MAN Down!"/>
</AlarmScenario>
Only the <as /> tag carries attributes that configure the alarm scenario. Each single
<as /> tag needs to be enclosed by <AlarmScenario></AlarmScenario> tags.
<as />
Attribute
Type/Values Default
alarmTriggerId
[String]
Description
level
[Number]
recipients
[String]
21
Configuration
<as />
Attribute
Type/Values Default
alarmMsg
[String]
Description
<alarmConfirm>
XML tags
None
requiredPosCon
firmCount
[Number]
Number of expected
confirmations;
Use 0 to disable alarm scenario
escalation;
Use 1 or above to escalate to
the next alarm scenario level if
less than defined confirmations
are detected
confirmTimeout
[Number]
priority
popUp
PrioInfo,
PrioLow,
PrioNormal,
PrioHigh,
PrioAlarm
PrioHigh
true, false
true
autoDelete
true, false
false
vCard
true, false
false
22
Configuration
<as />
Attribute
Type/Values Default
Description
postDialSeperator [String]
(arbitrary
combination
of # and *)
callbackNumber
cb:[String]
or
tel:[String]
23
compareDescrip
tion1
[String]
optional
compareDescrip
tion2
[String]
optional
Configuration
<as />
Attribute
Type/Values Default
Description
compareSender
[Numbers]
optional
If the message is sent to an Aastra 600 c/d DECT handset, the following message
option attributes may be added to the <as /> tag. Note that using message
options requires the OM Messaging & Alerting System Licence (see Notes on
Licences starting on page 4).
Message Options for Aastra 600 c/d DECT Handsets
Option Attribute
Value
Description
melody
[Numbers],
0-10
volume
[Numbers],
0-100
ringerTone
true, false
increasingVol
true, false
vibraCall
true, false
noInband
true, false
disconnectCall
[Numbers], 1
Configuration
Message Options for Aastra 600 c/d DECT Handsets
Option Attribute
Value
Description
autoCallback
[Numbers], 1
textColourR,
textColourG,
textColourB
[Numbers],
0-255
Three values
required
bgColourR,
bgColourG,
bgColourB,
[Numbers],
0-255
Three values
required
The following example shows how to use message options with an alarm scenario:
<AlarmScenario>
<as alarmTriggerId="Alarm-Fire" level="1"
compareSender="tel:201;" recipients="tel:*" priority="PrioAlarm"
popUp="true" textColourR="255" textColourB="255" textColourG="255"
bgColourR="255" bgColourB="0" bgColourG="0" alarmMsg="Fire!!!"
disconnectCall="1" vibraCall="1" increasingVol="1" ringerTone="1"
melody="2" volume="50">
<alarmConfirm>ConfRead</alarmConfirm>
<alarmConfirm>ConfOrder</alarmConfirm>
</as>
</AlarmScenario>
Escalating Alarm Scenarios
The most versatile feature of an alarm scenario is the ability to escalate to the next
alarm level if an alarm is not sufficiently confirmed by the alarm recipients. If you
configure such a multi-level alarm scenario, you should bear in mind how a typical
escalation scenario takes place:
1. The alarm is triggered, e.g. by a DECT handset user pressing the SOS button or
similar. The OM IMA service sends a text message to the recipients as
configured.
2. The OM IMA service now waits for confirmations from the alarm recipients.
25
Configuration
Note
Alarm scenario messages of the previous alarm level or messages that received
the required confirmations are deleted automatically.
Details on alarmTriggerId Attribute
The alarmTriggerId identifies the alarm scenario and also selects the source
which triggers the alarm. The following alarm triggers are supported:
Alarm Trigger
Description
emailsubject:text
SOS
MANDOWN
DISTRESS_OPERATOR_TI
MEOUT
PAGEBYMENU
CALLBACK
VCARD
26
Configuration
Alarm Trigger
Description
OMM-
UMONLOCERR-
User monitoring triggers: UMON-WARNUSERSTATE, UMON-ERR-USERSTATE and LOCERRUSERSTATE provide cause information when a user
becomes unavailable.
[RSS-Trigger]
27
Place holder
Replacement by
%s
%r
%t
%T
%d
%D
%p
DECT portable part number (ppn), e.g. 1 for first entry in list
Configuration
Place holder
Replacement by
%n
%R
%#1n
%#1R
%c
%i
%I
%u
%x
%e
%o
28
Configuration
<AlarmScenario>
<as alarmTriggerId="SOS"
level="1" recipients="tel:1001"
alarmMsg="SOS was initiated: %c"
>
<alarmConfirm>ConfRead</alarmConfirm>
</as>
</AlarmScenario>
You can add the following alarm confirmations:
<alarmConfirm>ConfRead</alarmConfirm>
<alarmConfirm>ConfOrder</alarmConfirm>
<alarmConfirm>ConfCompletion</alarmConfirm>
Note, that the alarm confirmations are ignored, if you broadcast all DECT handsets
by adding the tel:* URI to the recipients attribute.
29
For using the RFP/OMM console, you need a secure shell (SSH) program such as
the OpenSSH client (Linux) or the PuTTY SSH client (Open Source, Windows).
Install the SSH client software on your PC and start an SSH session as described for
Windows/PuTTY in the following steps. Under Linux, start a terminal program and
execute the ssh omm@your-omm-address command.
1. Start the PuTTY SSH client program. The PuTTY Configuration dialogue
opens. In the Host Name input field, enter the IP address or DNS-Name of the
RFP running the OMM. Do not change the default Port (22) and Connection
type (SSH) settings.
30
31
32
33
Purpose
ima start
ima stop
ima conn
ima dump
ima conf
ima send_msg
34
Appendix
Appendix
Abbreviations
OM
OpenMobility
OM AXI
OMC
OM Configurator
OM IMA
OML
OM Locating
OMM
OpenMobility Manager
OMP
OM Management Portal
PP
Portable Part
RFP
SIP
URL
Trademarks
Microsoft, Windows, Windows XP, Windows Vista, and Windows 7 are
registered trademark of Microsoft Corporation.
Linux is a registered trademark of Linus Torvalds.
Firefox, Mozilla are registered trademark of the Mozilla Foundation.
OracleTM and JavaTM are a registered trademarks of Oracle Corporation.
All other product and brand names are trademarks, registered trademarks, or
service marks of their respective holders.
35
Index
Index
A
Alarm Trigger 26
AlarmScenario / as 20
Architecture 1
B
Basic Concepts 10
C
Certificate 5
Confirmation 2, 10
Console 30
D
Debugging 30
DECT network 1
Development cycle 33
E
E-Mail 3
Example (first) 8
F
ftp 8
H
http 8
HTTPS 5
I
Idle Box 10
IMA 1
IMA commands 34
Info Message 10
M
MailBoxAccount 16
ManDown 2
Messaging solution 1
O
OMM 1
ommconsole (command) 32
P
Password 5
Place holder 27
Pop-up 2
Priority 2
R
Reference 16
RFP 1
RSS / feed 19
RSS feed 3
S
SendmailAccount 18
setconsole (command) 32
Size of messages 2
SOS 2
SSH 30
Syntax 15
T
tftp 8
TriggerId 26
U
URI 13
URL 6, 8
User name 5
UTF-8 15
V
vCard 14
W
Warning sign (red) 8
Web service 5
X
XML interface 1
XML syntax 15
36