Sip-Dect Om Ima r21a

SIP - DECTOM IntegratAlerting App

Installation, Aded Messaging &lication

ministration & User Guide

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 requirAastra products, pletouch with your loc

You can also find infat http://www.aast

We hope you enjoyApplication.e further technical support or information about other ase contact the person responsible for your system or get in

al dealer.

ormation about this device and other products on our website ra.de or http://www.aastra.com.

using your SIP - DECT OM Integrated Messaging & Alerting

Contents

OM Integrated Messaging & Alerting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Supported Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2OM IMA Service Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Other Valid Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Notes on Licences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Installation. . . . . .

Activating the OEnabling MessagConfiguring the

Configuration . . .

Basic MessagingMessage MatrixURI Syntax . . . . . vCard Support . Configuration FiConfiguration Fi

MailBoxAccoSendmailAccRSS / feed . . AlarmScenar

Debugging the OM

OMM Console LUsing the OMMOMM Console R

Appendix . . . . . . .

Abbreviations . Trademarks . . . .

Index . . . . . . . . . . . i

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

M IMA Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5ing for DECT Handsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

OM IMA Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13le Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15le Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16unt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16ount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19io / as . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

IMA Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

ogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27 Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30eference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

OM Integrated Messaging & Alerting


The OpenMobility Integrated Messaging & Alerting service (in the following OM Integrated Messaging & Alerting service or OM IMA) is a messaging and alarm service for the OMM-SIP / SIP DECT solution. The OM Integrated Messaging & Alerting service supports the delivery of messages to or from DECT portable parts.

The OMM-SIP / SIP plete system comprnetwork with up to of the complete me

Architecture of the O

The OpenMobility Mservice (OM IMA) boLinux server systemalarm server, commwith the OM IMA se

Open(Runs

OMM1

DECT solution generally targets larger DECT networks. A com-ises as many as 4500 DECT handsets communicating in a DECT 2048 RFPs. The following figure depicts the overall architecture ssaging solution.

penMobility Messaging & Alerting service

anager (OMM) and the OM Integrated Messaging & Alerting th run on a single Radio Fixed Part (RFP) or on a dedicated

. External messaging solutions, such as a message server or an unicate by means of a networked and encrypted XML interface rvice.

Mobility Manager on a single RFP) Alarm

Server

MessageServer

IMA


2

Supported Message Format

The main purpose of the OM IMA service is to deliver text messages, track alarms and control the necessary signalling to the RFPs available in the DECT network. All delivered text messages support the following characteristics:

messages contain up to 1000 characters;

messages have a priority such as bulk, normal, or high;

messages can b

messages may t

messages may r

messages may tphone book wh

paging messagereceiver presses

OM IMA Serv

The OM IMA serviceOMM. Therefore, notures:

sending and recincludes normallist;

sending messagapplication to th

sending of alarmpredefined SOS

With additional con

management ofmessages;

querying arrivedE-Mails, or sendiconfiguration);

subscribe to RSSalarm message be received in the background or in the foreground (pop-up);

rigger a read confirmation which is sent to the originator;

equire a manual confirmation from the receiver;

ransport a vCard that is automatically stored in the recipients ich may also configure a short dialling entry;

s include a call back number that is dialled immediately if the the off hook key while the message is displayed.

ice Features

runs directly on the same RFP or server that also runs the additional hardware is required for the following set of fea-

eiving text messages between DECT portable parts which messages, alarm messages or messages queuing up in a job

es from a messaging server such as the OpenMobility Locating e DECT portable parts;

messages from a DECT portable part (triggered by pressing a key or by the ManDown function).

figuration, the following features are possible:

confirmations and applying escalation rules for alarm

mail from an E-Mail server, triggering alarm messages by ng E-Mail via a messages gateway (requires additional

feeds and either receive news as text message or trigger an ased on RSS feed contents (requires additional configuration);


sending entries stored in the personal telephone book of a DECT handsets as vCard to another DECT handset;

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;

sending a paging message from a DECT handset that requests the sender to immediately dial a call back number that is part of the paging message.

Note, that the limited storage capacity of the RFP does not allow to store the message contents. separate messaging

Other Valid D

This user guide desOM Integrated Mesgiven in the docum

SIP - DECT; OM SDescribes the insystem.

SIP - DECT; OM LIf you have also refer to this userusage of the OM

SIP - DECT; OM HThis user guide features and the

SIP - DECT; AastrThis user guide DECT terminal s3

However, it is possible to extend the OM IMA service with a application, which runs for example on a PC server system.

ocumentation

cribes installation, administration and usage of the saging & Alerting service. Please observe also the information entation to other parts of your OMM SIP - DECT installation:

ystem Manualstallation, administration, and maintenance of the SIP - DECT

ocating Applicationpurchased the OpenMobility Locating application, please guide which describes the installation, administration, and Locating application.

andset Sharing & Provisioningdescribes the enhanced user and handset management OM provisioning concept.

a 610d, 620d, 630d Messaging & Alerting Applicationsdescribes the special messaging features of the Aastra 6x0d eries and how to use them.


4

Notes on Licences

Application licenceIn 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 System Lice

OM Messaging &OM Messaging L

The licence confirmthe service. Note, thlicense, which is valnce [Number]: Enables telephony for a number of RFPs

Alerting System Licence andicence [Number]: Enables messaging for a number of handsets

ation you received contains detailed information on activating at you can also start with the automatically applied demo id for 72 hours.

Installation

Installation

The OM Integrated Messaging & Alerting service does not require any instal-lation, 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.

Activating th

You can activate the

1. Start a web browbrowsers addreprotocol and yo

Certificate warni

To overcome thecertificate for thFor connecting safely ignore thi

After accepting page.

2. Enter the User naccount type. That the OMM. Ent

3. The OMMs webnavigate to the OM Integrated5

e OM IMA Service

OM IMA service on the OMM.

ser. Enter the DNS name or IP address of the OMM in the ss input. The OMMs web server switches to the secured HTTPS u will typically see a browser display like the following one.

ng

browser warning automatically, a regularly re-paid validation e OMMs network address needs to be issued by a third party. to the web user interface of the OMM in your LAN you can s message and store a permanent exception in your browser.

the certificate warning, the browser displays the OMMs login

ame that is configured at the OMM for the Full access is is omm by default, but you may have changed this setting er the Password for the OMM. Confirm with OK.

service main page is displayed. In the menu tree to the left, System: System settings page. Scroll down to the Messaging & Alerting service section.

Installation

6

Activating the OM

Activate the ActOM IMA service.

Switching on the AcOM IMA service is ruportable part to anoand de-activate theIMA service

ive check box. Leave the URL input field blank for the basic Confirm with the OK button available at the top of the page.

tive check box starts the OM IMA service on the OMM. If the nning, you can for example send messages from one DECT ther. To stop the OM IMA service, repeat the above procedure

Active check box.

Installation

Enabling Messaging for DECT Handsets

There are several options that you can enable or disable for a DECT handsets. However, you cannot view or change these options in the OMMs web service. Start the OM Management Portal (OMP) for this task:

1. Double click the OMP.jar file that is available on the OMM SIP 2.1 installation medium. Note, that you need the Sun/Oracle Java runtime environment installed on you

2. Enter the IP add

3. Navigate to the more of the dispto view the user

OM Managemen

4. Activate or de-a

Sending messausers to send m

Sending vCardto send private p

Receiving vCarshould be storedusers automaticmanually enablemode ends auto

5. Confirm your se7

r PC in order to run the OMP.

ress, User name, and Password for accessing the OMM.

Portable parts: Users page. Activate the check box for one or layed user entries. In the Tasks pane, click the Configure link entry details. Switch to the Messaging tab.

t Portal (OMP) - Messaging options for users

ctivate the desired options:

ges permission: Enable this option to allow DECT handset essages.

s permission: Enable this option to allow DECT handset users hone book entries as vCard messages.

ds permission: Enable this option if received vCard messages in the private phone book of the respective DECT handset

ally. If this option is disabled, the DECT handset user needs to receiving vCards. The manually enabled vCard receiving matically after 10 minutes.

ttings with OK.

Installation

8

Configuring the OM IMA Service

To configure and use additional functions with the OM IMA service, you need to provide a configuration file. Here is a first example of the configuration file, which will send a message if the SOS button is pressed on a DECT portable part:

figuration, proceed as follows:

example to the clipboard. Start an ASCII editor such as the ad application. Paste the example into the ASCII editor and

e. Change the phone number in the recipients attribute to ly subscribed DECT portable part.

uration file on a server located in your LAN and configure the n the OMMs System: System settings page accordingly (see

he OM IMA Service starting on page 5). Here are some s setting:

.1/IMA.cfg: If you use the automatic DHCP configuration for ready have an active TFTP server. Place the configuration file in directory next to the OMM firmware file (omm_ffsip.tftp).

dir/ima.cfg: You can also provide the configuration file on n your LAN. If you develop an sophisticated IMA application, it a web server on your PC to provide frequently changed es during development and testing.

pany.lan/subdir/IMA-CONFIG.XML: you can also provide the e on any FTP server in your LAN.

st operating systems the directory and file names of the URL e. If you confirm the changed URL setting, the OM IMA service ill download the configuration file which in turn changes the configuration. If the OM IMA service cannot load the e, you will see a small red warning sign on the OMMs System: s page.

Installation

OM IMA Service:

Examine the detsettings or chanerrors are indica

3. Press the configplace the SOS caentered in the c9

cannot download configuration file

ailed status message on the OMMs Status page. Correct the ge the TFTP, HTTP, or FTP servers configuration until no further ted.

ured SOS softkey on a second DECT portable part. This should ll and concurrently sends a text message to the number you

onfiguration file.

Configuration

10

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 configu-ration file details, you need some basic information about the message structure and some basic concepts.

Basic Messag

While the OM Integfor all types of DECThandsets offer the ftypes:

Idle Box: a system

Info Message / C

Normal Messagepop-up display o

Urgent Message

Alarm Message:

Normal Job: a m

Urgent Job: a job

Alarm Job: a sys

Localization Aletypically used to

Each message cons

OMM Message Str

Component

Date/Time, ID

Sender

Senders Name

Recipienting Concepts

rated Messaging & Alerting service allows messaging service portable parts, only the Aastra 610d/620d/630d DECT

ull feature set. This includes support for the following message

pop-up message without confirmation nor tone;

onfirmation: a system pop-up message announced by a tone;

: a standard message from another user without confirmation; nly if that is configured on the receiving DECT handset;

: a message from a user, with pop-up display and confirmation;

a system message (from alarm application only);

essage automatically added to the job list;

message with completion confirmation;

tem urgent job message (from alarm application only);

rt: a special system message which triggers an audible tone locate a person in danger (e.g. after Man-Down or SOS).

ists of the following components:

ucture

Format / Purpose

Time stamp when message was sent, and a unique ID

Identifies originator, URI (e.g. tel:1001 or maito:a@b)

For displaying purposes only

Identifies addressee, URI (e.g. tel:2002)

Configuration

While different mescific message handmessage is displayehandset user closesPopup) after some message carries a flically after the final

Message Ma

The following tableAastra 6x0d DECT h

Recipients Name For displaying purposes only

Priority Info, low, normal, high, alarm, locating alert

Flags Message or job, auto delete flag

Encoding

Confirmations requ

Content Type

Content

Messaging Matrix

Message Type

Idle Box

Info / Confirmation

Normal Message

Urgent Message

Alarm Message

Normal Job

OMM Message Structure

Component Format / Purpose11

sage types can be identified by specific display icons, the spe-ling will support the message purpose. For example, a Pop-up d in a window overlaying the current display. If the DECT the window temporarily, the message is re-displayed (Re-activity e.g. after the user completed a phone call. Also, each ag (Auto Delete Option) which deletes the message automat-confirmation.

trix

show how specific message types are handled on the andsets.

Content encoding (typically UTF-8)

ired Msg received, msg read, accept task, complete task

Typically plain text, others reserved for future ext.

If content type is plain text: up to 1000 characters

: Message Handling

Priority Stored in Folder

Auto De-lete Opt.

Pop-up Re-Popup

- - Yes No No

Low - Yes Yes No

Normal Inbox Yes As con-figured

After Call (if popup)

High Inbox Yes Yes Yes

Alarm Inbox Yes Yes Yes

Normal Jobs Yes Yes Yes

Configuration

12

Urgent Job High Jobs Yes Yes Yes

Alarm Job Alarm Jobs Yes Yes Yes

Localization Alert Loc-Alert - Yes Yes Yes

Messaging Matrix:

Message

Type

Idle Box

Info / Confirmation

Normal Message

Urgent Message

Alarm Message

Normal Job

Urgent Job

Alarm Job

Localization Alert

Messaging Matrix: Message Handling

Message Type Priority Stored in Folder

Auto De-lete Opt.

Pop-up Re-Popup Message Confirmation and Signal

Confirmation Audible

Read Accepted Completed Signal

None -

None Confirmation tone

None Handset config: normal msg. tone

Yes - - Handset config: urgent msg. tone

Yes - - Handset config: alarm msg. tone

Yes Yes - Handset config: normal msg. tone

Yes Yes Yes Handset config: urgent msg. tone

Yes Yes Yes Handset config: alarm msg. tone

Yes - - Defined by admin.

Configuration

URI Syntax

For some configuration items, you need to specify recipient or destination attributes. These are encoded with a specific syntax, denoted as URI.

Some URIs also sup

The tel:* URI aNote, that messaconfirmation tim

The emailsubje

vCard Suppo

The Aastra 6x0d DEpushed to the perso(RFC 2426) defines dkeys of the DECT ha

URI Types

URI Description

tel:

ppn:

cb:

mailto:

alarm:

omm:

loc:

emailsubject:

vCard Keys

Directory Key

Name13

port an asterisk wildcard:

ddresses all DECT handsets that are able to use messaging. ges sent to this URI cannot enforce confirmations, thus also no eout and no alarm scenario escalation is supported.

ct:Example* URI matches all subjects starting with Example.

rt

CT handsets support receiving vCards that are automatically nal directory of the DECT handset. The vCard syntax ifferent keys that needs to be translated to the directory entry

ndsets:

Addresses a DECT handset by phone number

Addresses a DECT handset by portable part number

Call back number (for callBackNumber parameter only)

Addresses an e-mail recipient

Triggers an alarm

URI for trigger by OMM (internal only)

URI for trigger by locating server (internal only)

Configures alarm trigger that is matched by e-mail subject

vCard Keys Content

Primary: FN:Secondary: N:

[String](UTF-8 or Latin-1)

Configuration

14

During translation, found, the subsequshows an alarm sce

Remove the line breaks in the alarmMsg attribute.

Secondary: ;WORK;VOICETertiary: TEL;VOICEQuaternary: TEL;PREF

Primary: TEL;CELLSecondary: ;CELL;VOICE

[Number]

Primary: TEL;FAXSecondary: ;FAX

[Number]

Primary: EMAILSecondary: EMAIL;PREF;INTERNET

[E-mail Address]

X-QC 2 - 9

X-MEL [String]

X-VIP [Number]

Primary: VERSIONSecondary: CHARSET

[Mapping ID]

...of vCard: BEGIN:VCARD and END:VCARD

Configuration

Configuration File Syntax

The OM Integrated Messaging & Alerting service configuration file has an XML syntax which can be edited by using a plain text editor such as the Windows Notepad application. If you are already familiar with the XML syntax require-ments, you may skip to Configuration File Reference starting on page 16.

The XML configuration file is always encoded in UTF-8. If you need to enter char-acters not availablethe file as UTF-8. FoUTF-8 entry from

In the first line of thAll subsequent lineexample illustrates the 1001 phone nu

Basic OM IMA config

Each configuration written as single tagother tags (e.g. .

ou can insert any number of white space characters (that is: , the tab character, or a line end character). This helps you to dly and readable display. You can also include XML comments !-- this is a comment -->) to improve readability.

ve one or more attributes (e.g. level="1"). An attribute needs predecessing characters by a white space. The attribute

nclosed in single or double quotation marks.

and the attribute names are case sensitive. For example d as different tags. The OMM service only accepts known XML Moreover, the XML tags needs to follow a prescribed sequence ly pre-defined attributes are allowed for specific tags.

Configuration

16

Configuration File Reference

In the OM Integrated Messaging & Alerting service configuration file, you will configure e-mail accounts, RSS feeds as well as alarm scenarios. You can write down the desired configuration statements in any sequence, provided that you keep the necessary XML syntax.

The following tables determine required attributes as Mandatory in the Default column. This columattribute is omitted

MailBoxAccoun

This configuration favailable messagesacquired E-mails as

Type/Values Default Description

EmailNone,EmailPOP3,NONE

Mandatory Determines the mailbox account type;

Use NONE to stop polling the account

[IP or DNS] Mandatory Determines the maibox server;

Either IP address or DNS name

true, false false If set to true the OM IMA service tries to use SSL for encryption;

If that fails, the standard port is tried (optional encryption with StartTLS)

[Number] 30 Poll interval (minimum time in seconds, 10-3600s are allowed)

[Number] 0 Used to ignore older mails stored in the mailbox;

Use 0 to poll all mails, otherwise use value in seconds after 01-01-1970

Configuration

The E-mail accountnew E-mail comes iserver. The OM IMAthe subject of the Ean E-mail with the f

tel:1001 Hello, y

If the E-mail cannotprovided that the S

IMA [noreply:im

Otherwise, the E-mhandset. The DECT the text message is

Notes

You can define ofile contains moentry is used.

Incoming E-mai

If an incoming Ecannot be reachtime.

mbPort [Number] 0 The port number for POP3;

Use 0 for standard port

mbSslPort [Number] 0 The port number for SSL encrypted POP3;

mbUser

mbPassword

Attribute Type/Values Default Description17

will be polled by the OM IMA service on a regularly basis. If a n, the E-mail will be fetched and removed from the E-mail service then forwards the E-mail to the recipient mentioned in -mail. For example, to send to a particular DECT handset, send ollowing subject:

ou just got mail!

be delivered, the OM IMA service will reply with an error mail endmailAccount is configured. For example:

a]: Error: Transmission attempt repeatedly failed

ail is send as normal text message to the addressed DECT handset user may response to this text message, which in turn forwarded to the original E-mail sender.

nly one configuration. If the configuration re than one configuration entries, only the last configuration

l is converted to the UTF-8 character set if applicable.

-mail cannot be delivered e.g. because the DECT handset ed, the original sender will get an error E-mail after a certain


[String] - user name for the POP3 mailbox account

[String] - password for the POP3 mailbox account

Configuration

18

SendmailAccount

This configuration file item is used to configure an e-mail account for sending mes-sages. The OM IMA service will forward text messages received from DECT handsets to this E-mail account.

Attribute Type/Values Default Description

auth

smtpServer

senderAddress

trySslFirst

smtpPort

smtpSslPort

smtpUser

smtpPasswordAuthNone,AuthPOP3,AuthSMTP

Mandatory The mail is always sent with SMTP;

Some SMTP servers require authentication with user name and password (AuthSMTP setting);

Some SMTP servers require to be polled first (send-after-poll: AuthPOP3 setting)

[IP or DNS] Mandatory Determines the SMTP server;

Either IP address or DNS name

[String] - The E-mail address used as the sender for all outgoing E-mails

true, false false If set to true the OM IMA service tries to use SSL for encryption;

If that fails, the standard port is tried (optional encryption with StartTLS)

[Number] 0 The port number for SMTP;


[Number] 0 The port number for SSL encrypted SMTP;


[String] - AuthSMTP only:

User name for SMTP

[String] - AuthSMTP only:

Password for SMTP

Configuration

RSS / feed

These configurationwhich are then typiconfigure an RSS fequently updated coRSS entry appears, athe service. The nec

1. You define the R

>

The port number for SSL encrypted POP3;


[String] - AuthPOP3 only:

User name for the POP3 mailbox account

[String] - AuthPOP3 only:

Password for the POP3 mailbox account

Configuration

20

Only the tag carries attributes that configure the RSS feed properties. Each single tag needs to be enclosed by tags.

To prevent the RSS new RSS entry is cothe ID and content during the previousbulk update which only forward the ne

Tip:

AlarmScenario

These configurationEach alarm scenarioescalation system wsubsequent alarms following example:

onfirm>ConfRead

>

or *.rss file type

[String] Mandatory An ID string which identifies the alarm scenario used to send out received news;

You need an tag with a matching alarmTriggerId attribute

[Number] 3600 Poll interval for the RSS feed

Configuration

Only the tag carries attributes that configure the alarm scenario. Each single tag needs to be enclosed by tags.

Attribute

alarmTriggerId

level

recipients

alarmMsg

21

Type/Values Default Description

[String] Mandatory An ID value or a string with keywords that trigger the alarm;

See section below: Details on alarmTriggerId Attribute

[Number] Mandatory The escalation level for the alarm scenario;

Use 1 for the first level alarm scenario. Add alarm scenarios with higher escalation levels but an identical alarmTriggerId setting

[String] Mandatory A semicolon separated list of URIs that should receive the alarm message;

Up to 10 recipients can be addressed;

See section below: Details on recipients Attribute

[String] Mandatory Text message template to be send to the recipients;

See section below: Details on alarmMsg Attribute

XML tags None Expected recipient confirmation;

See section below: Details on tag sequence

Configuration

22

requiredPosConfirmCount

[Number] 0 Number of expected confirmations;Use 0 to disable alarm scenario escalation;

Use 1 or above to escalate to

confirmTimeout

priority

popUp

autoDelete

vCard

postDialSeperator

Attribute Type/Values Default Descriptionthe next alarm scenario level if less than defined confirmations are detected

[Number] 0 Time to wait until the alarm scenario escalates;

Use 0 to disable alarm scenario escalation

PrioInfo, PrioLow, PrioNormal, PrioHigh, PrioAlarm

PrioHigh Priority setting for the text messages to be sent;

For details, refer to Message Matrix starting on page 11

true, false true Set to true to display text message as pop-up;

Set to false otherwise

true, false false Set to true to auto-delete the message from the DECT handset when it reaches the final state;

Set to false otherwise

true, false false If set to true, the alarm message contains a vCard

[String](arbitrary combination of # and *)

- Treats post-dialled digits that are dialled after the configured alarm trigger FAC (Feature Access Code). The separator characters splits the post-dialled digits into calling party numbers

Configuration

The most versatile falarm level if an alaconfigure such a muescalation scenario

1. The alarm is trigsimilar. The OMconfigured.

2. The OM IMA ser

Note

Alarm scenario mesthe required confirm

callbackNumber cb:[String]ortel:[String]

- Callback number that is sent within the alarm message to the recipient;

Enables the recipient to dial this number with the off-hook key;

Attribute Type/Values Default Description23

eature of an alarm scenario is the ability to escalate to the next rm is not sufficiently confirmed by the alarm recipients. If you

lti-level alarm scenario, you should bear in mind how a typical takes place:

gered, e.g. by a DECT handset user pressing the SOS button or IMA service sends a text message to the recipients as

vice now waits for confirmations from the alarm recipients.

sages of the previous alarm level or messages that received ations are deleted automatically.

cb:[Number]: call back to this number, e.g. cb:1234;

cb:#%1R: call back to first number extracted from post-dialled digits (#%1R - #%9R);

cb:%R: call back to originator of alarm message if applicable (i.e. the originator has a phone number).

Note: the tel: URI type is equivalent to cb:. Other URI types are not allowed.

Configuration

24

Details on alarmTriggerId AttributeThe alarmTriggerId identifies the alarm scenario and also selects the source which triggers the alarm. The following alarm triggers are supported:

Details on recipienThe mandatory rec(see URI Syntax starmailto:admin@domof post-dialled digit

Alarm Trigger Description

emailsubject:text Matches a specific subject received via the OMMs e-mail account (see MailBoxAccount starting on page 16). Note that the URI text may be terminated

SOS

MANDOWN

DISTRESS_OPERATMEOUT

PAGEBYMENU

CALLBACK

VCARD

OMM-

[RSS-Trigger]ts Attributeipients attribute defines a semicolon separated list of URIs ting on page 13). You can mix different URI types, e.g.

ain.com;tel:1001 is valid. In the recipients context, handling s is supported also. For example, tel:#%1R sends the alarm

by an asterisk character to ignore trailing subject text. Thus, the emailsubject:* URI matches all e-mails.

SOS call from a DECT handset detected

Man-down alarm from a DECT handset detected

OR_TI No operator reaction on alarm condition detected by the locating server.

Paging with optional call back triggered by DECT handset menu command detected

Callback by a DECT handset triggered by paging message detected

Special VCARD alarm trigger(see vCard Support starting on page 13)

OMM health state trigger: These start with OMM-, followed by OK-, WARNING-, or ERROR- and SYNC, STANDBY, AUTODB, DOWNLOAD, PROTOCOL, BRANDING, ENCRYPTION, or LICENSE. Example: OMM-WARNING-SYNC.

This trigger supports a wildcard, e.g. OMM-WARNING-* matches all warnings.

Also, a reason suffix is supported e.g. -License hurt makes up OMM-WARNING-LICENSE-License hurt.

Trigger defined by trigger attribute of an RSS feed (see RSS / feed starting on page 19).

Configuration

message to the first number extracted from the post-dialled digits (valid from #%1 to #%9).

Details on alarmMsg AttributeThe mandatory alarmMsg attribute defines a template for the text message. The template includes place holders which are replaced before the message is sent to all recipients. The following place holders are supported:

Details on tag sequencech one or more alarm confirmations to the alarm scenario. to an tag as enclosed tag sequence as shown in the fol-

nder (URI), e.g. tel:1001 if SOS button pressed on this phone

eceiver (URI), e.g. tel:30 if SOS button called this number

nding time (24 hour format, HH:MM:SS)

nding time (12 hour format, HH:MM:SS am/pm)

nding date (EU format, DD.MM.YYYY)

nding date (US format, YY-MM-DD)

ECT portable part number (ppn), e.g. 1 for first entry in list

ECT portable part user name

ECT portable part calling party number (CPN)

ame of the number extracted from post dialled-digits (#1 - #9)

umber extracted from post-dialled digits (#1 - #9)

essage content - from source that triggered the alarm

larm trigger ID, e.g. sos

revious alarm escalation level

onfirmations received (from previous escalation level)

ejects received (from previous escalation level)

onfirmations expected (of previous escalation level)

calation time-out (of previous escalation level)

Configuration

26

ConfRead

You can add the following alarm confirmations:

ConfRead

Note, that the alarmby adding the tel:*ConfOrder

ConfCompletion

confirmations are ignored, if you broadcast all DECT handsets URI to the recipients attribute.

Debugging the OM IMA Setup


If you develop a complex OM IMA configuration, you will need to create the con-figuration in several iterative steps. For example, you start with a simple configu-ration and add new features step by step. During this iterative development process, you need to repeatedly restart the OM IMA service, watch the configu-ration file parsing and verify the message processing triggered by the configu-ration.

To support the OMrunning on the RFPOM IMA configuratiOM IMA service, re-output.

CAUTION!

OMM Consol

The following descr

Please note:

For using the RFP/Othe OpenSSH clientInstall the SSH clienWindows/PuTTY in execute the ssh om

1. Start the PuTTYopens. In the HoRFP running thetype (SSH) settin27

IMA configuration development, the RFP and the OMM offer a debugging console which can be used during the on development cycle. For example, you can start and stop the load the configuration file, and watch the debugging console

Only use the console commands described here! Other available commands may destroy you configuration leaving you with an unusable OMM-SIP system!

e Login

iption applies, if you run the OMM on an RFP.

For a PC-based OMM, log in to the Linux GUI and open a terminal window. Enter the su command to elevate to administrative rights. Start the OMM console with the/usr/sbin/ommconsole command.

MM console, you need a secure shell (SSH) program such as (Linux) or the PuTTY SSH client (Open Source, Windows). t software on your PC and start an SSH session as described for the following steps. Under Linux, start a terminal program and m@your-omm-address command.

SSH client program. The PuTTY Configuration dialogue st Name input field, enter the IP address or DNS-Name of the OMM. Do not change the default Port (22) and Connection gs.


28

Creating an SSH

Switch to the Cothe left side of thusername inpuconsole for the

Switch back to tha descriptive na

2. To open a savedthe PuTTY ConfFor any initial SSkey fingerprint.

Opening an SSH

At the passwordaccount. Press thsession (Windows, PuTTY)

nnection/Data category available in the navigation tree on e PuTTY Configuration dialogue. In the Auto-login

t field, enter the user name that is configured at the OMMs web Full access account type. This is omm by default.

e Session category of the PuTTY Configuration dialog. Enter me in the Saved Sessions input field. Click the Save button.

session, select the desired entry in the Saved Sessions list of iguration dialog. Click the Open button to start the session. H session, an alert dialog informs you about the SSH servers Proceed by clicking the Yes button.

session (Windows, PuTTY)

prompt, enter the OMMs the password for the Full access e [Enter] key to proceed.


The RFPs console prompt is displayed, offering several commands ready to be executed. For example, you can type in the help command and confirm with the [Enter] key. This will display a list of available commands.

3. Enter the setconsole command. This will redirect the OMMs syslog messages to the current SSH session. For example, you will see a syslog message if you log in to the Web console of the OMM concurrently. Note, that the syslog message redirection is automatically cancelled if you close the SSH session.

4. Enter the ommline of the currechanges to om

Displaying the O

5. Enter the ima cOMM Console: I

6. To end the OMMand close the SSthe PuTTY term29

console command. This will call up the separate command ntly running OMM service program. The command prompt m and a different set of commands is available.

MM console (help output of IMA command)

ommand to display a list of available options. Refer to the MA Command Reference table below.

console, enter the exit command. To end the RFP console H session enter a second exit command. Alternatively, close

inal window.


30

Using the OMM Console

The OMM console accepts only a single internal telnet connection. Therefore, you cannot open another SSH session to display a second OMM console. If you do not enter a command while the OMM console is opened, the internal telnet session is closed after some time. This will end the OMM console automatically and in turn the RFPs console prompt is displayed. For this reason, you may need to re-enter the ommconsole command after a pause.

During a typical dev

1. Change the con

2. Start the SSH se

3. Enter the ommdisplayed, the co

4. Test the desired

5. When finished, e

Tip:elopment cycle you proceed as follows:

figuration file located on your (FTP/HTTP/TFTP) server.

ssion towards the RFP. Enter the setconsole command.

console and ima load commands. If no error message is nfiguration file has no syntax errors and is accepted.

message/alarm functions. Recycle with Step 1 as needed.

nter the exit command twice or close the SSH session.

In PuTTY, you can switch to a more readable black-on-white display. In the PuTTY Configuration dialog, load the desired session configuration. Navigate to the Window/Colours category. Activate the Use system colours switch. Save the session configuration.


OMM Console Reference

The following table gives a brief description of the IMA commands available in the OMM console.

OMM Console: IMA Command Reference

Command Purpose

ima start StThm

ima stop Enmbal

ima conn Dpke

ima dump Dsesuchp

ima conf Rwucho

ima send_msg SencoimThspfrexshp31

arts the OM IMA service program this is currently not running. e OM IMA configuration file is loaded and all configured

essaging functions are started.

ds the running OM IMA service program, thereby stopping all essaging functions. The internal network connection

etween the OM IMA service program and the OMM is closed so.

isplays the network connection status of the OM IMA service rogram. Display the next prompt line by pressing the [Return] y.

isplays the status of messages and alarms currently in the nding queue. Optionally, the registered backtrace bscriptions are displayed also. You can use this command to eck for and view undelivered messages. Display the next

rompt line by pressing the [Return] key.

eloads the OM IMA configuration from the server address hich you configured in the OMMs web console. Note, an nchanged OM IMA configuration file is ignored, this only a

anged OM IMA configuration file triggers the reconfiguration f the OM IMA service program.

nds a text message directly to the addressed device. You eed to add the receivers address (URI) and the message

ntent. Example:a send_msg tel:1001 this-is-a-messagee command accepts any valid URI and a single word without aces as message content. The message word is converted

om ISO-8859-1 (Windows ANSI), so if your SSH client uses for ample UTF-8 all characters expect ASCII-32 to ASCII-127 will ow up as double characters on the receiving DECT portable

art.

Appendix

32

Appendix

Abbreviations

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.

OM OpenMobility

OM AXI OM Application XML Interface

OMC OM Configurator

OM IMA OM Integrated Messaging & Alerting service

OML OM Locating

OMM OpenMobility Manager

OMP OM Management Portal

PP Portable Part

RFP Radio Fixed Part

SIP Session Initiation Protocol

URL Uniform Resource Locator

Index

Index

AAlarm Trigger 24AlarmScenario / as 20Architecture 1

BBasic Concepts 10

CCertificate 5Confirmation 2, 10Console 27

DDebugging 27DECT network 1Development cycle

EE-Mail 2Example (first) 8

Fftp 8

Hhttp 8HTTPS 5

IIdle Box 10IMA 1IMA commands 31Info Message 10

MMailBoxAccount 16ManDown 2Messaging solution

OOMM 1ommconsole (command) 29

P33

30

1

Password 5Place holder 25Pop-up 2Priority 2

RReference 16RFP 1RSS / feed 19RSS feed 2

SSendmailAccount 18setconsole (command) 29Size of messages 2SOS 2SSH 27Syntax 15

Ttftp 8TriggerId 24

UURI 13URL 6, 8User name 5UTF-8 15

VvCard 13

WWarning sign (red) 8Web service 5

Index

34

XXML interface 1XML syntax 15

Copyright 2011 www.aastra.comAll rights reservedAs of 09.03.2011 Subject to changes

SIP - DECT OM Integrated Messaging & Alerting ApplicationContentsOM Integrated Messaging & AlertingSupported Message FormatOM IMA Service FeaturesOther Valid DocumentationNotes on Licences

InstallationActivating the OM IMA ServiceEnabling Messaging for DECT HandsetsConfiguring the OM IMA Service

ConfigurationBasic Messaging ConceptsMessage MatrixURI SyntaxvCard SupportConfiguration File SyntaxConfiguration File ReferenceMailBoxAccountSendmailAccountRSS / feedAlarmScenario / as

Debugging the OM IMA SetupOMM Console LoginUsing the OMM ConsoleOMM Console Reference

AppendixAbbreviationsTrademarks

Index

Documents

Sip-Dect Om Ima r21a