30/04/2013 Alert Oxepaging Driver 1/12

Micromedia International

Technical

specification

Author : Pierre Chevrier

Company : Micromedia International

Date : 30/04/2013

Pages : 12

Alert Oxepaging Driver

Réf. : ETT_20100406_000001.docx

Description and configuration guide for the Alert OXEPaging driver.

To A CC Company

Attached documents:

30/04/2013 Alert Oxepaging Driver 2/12

30/04/2013 Alert Oxepaging Driver 3/12

Contents Introduction ............................................................................................................................................. 4

Architecture ............................................................................................................................................. 4

OXE configuration .................................................................................................................................... 5

Phone configuration ............................................................................................................................ 5

License ................................................................................................................................................. 6

Alert Configuration .................................................................................................................................. 6

License ................................................................................................................................................. 6

Driver configuration ............................................................................................................................ 6

The General group .......................................................................................................................... 7

The Connection group .................................................................................................................... 7

The Advanced group ....................................................................................................................... 8

The two others groups .................................................................................................................... 8

Alarm and message configuration ...................................................................................................... 8

Call process .............................................................................................................................................. 9

Call sequence ...................................................................................................................................... 9

On the terminal ................................................................................................................................. 10

Default Ring .................................................................................................................................. 10

LED ................................................................................................................................................ 10

Display........................................................................................................................................... 10

Options ......................................................................................................................................... 11

OXE limits .............................................................................................................................................. 11

Troubleshooting’s .................................................................................................................................. 11

All calls end on failure in Alert, but the messages are received by phones. .................................... 11

The messages are truncated on the phones (accent removed) ....................................................... 12

30/04/2013 Alert Oxepaging Driver 4/12

Introduction

The OXEPaging driver is used to send text messages on digital phones connected to an Alcatel

OmniPCX Enterprise. The driver replaces the old “Notification server” program.

This document describes the architecture of the Alert-OXE link and the PBX and driver configuration.

The Alcatel specific restrictions will be described at the end of the document.

Architecture

ALERT has to be connected to the OXE on a TCP/IP link. ALERT uses an Alcatel interface named

“Paging Interface”. This interface is based on a subset of the CSTA protocol (Escape Services).

The link between the OXE and the phones is the classic UA link.

DECT

Phone with display

TCP/IP

CSTA link

Alcatel OmnipcX Enterprise

Alert server

+

OXEPaging driver

Notification Server

Notification Server

30/04/2013 Alert Oxepaging Driver 5/12

OXE configuration

The Paging Interface is the interface used by the Notification Server application. This Notification

Server application is now obsolete. Although the protocol is the same on an Alcatel 4400 or an

Alcatel OXE, it has been only validated for OXE from versions 5 to 9.

For the Alcatel 4400, you should use the Notification Server program and the corresponding ALERT

driver.

Phone configuration Only devices with dynamic keys can be paging recipients:

- Reflexes 4020 and 4035. - DECT 4074 - Mobile 100/200/300/400 - IP Touch

The terminal must be configured with:

- Mono-line mode - NS (Notification server) or Paging Interface parameter set to YES. (See next screenshot)

- Access rights for alarm consult. - Optional: create a prefix for alarm consult.

30/04/2013 Alert Oxepaging Driver 6/12

License The Paging Interface use is checked by an Alcatel license called “Notification Server” or “Paging

Interface”. The Alcatel lock identifier is the 89. Its value must be more than or equal to 50.

See your PBX installer for more information about it.

Despite the use of a CSTA link, no CSTA license is needed for the Paging Interface.

Alert Configuration

License The OXEPaging driver is a licensed ALERT driver. Contact Micromedia International for more

information.

Driver configuration The driver is not installed on standard setup. Select it in the custom installation box:

30/04/2013 Alert Oxepaging Driver 7/12

Once installed, and when ALERT is running, select “Options/Communications” and the “Drivers” tab. Then edit the Alcatel OXEPaging driver properties. The following dialog box is then displayed.

The General group

The name of the driver can be set here.

Check the Trace in Alert event log box to log all the sent messages.

The One message per call box can be used to send only one message by call.

The Connection group

It describes the connection settings. The driver accepts redundant OXE configuration. You need to

supply the IP address for the two OXE.

The connection is done on the CSTA IP port: 2555. The ALERT server should have access granted to

this port on the OXE.

In case of OXE disconnection, the link is tried on the secondary OXE. In case of failure, an ALERT

alarm can be set: Alarm to set on OXE link failure.

The OXE link will be re-established after the reconnection timeout. This will be repeated until a valid

connection can be restored.

30/04/2013 Alert Oxepaging Driver 8/12

To connect to the PBX, only if the current redundant station is the active one, check the Redundancy:

connect the active station only box.

The Advanced group

The Maximum call duration is the maximum duration in seconds for one call (different messages for

one user)

Increase the Message sending period to slow down the message frequency from Alert to the PBX.

The OXE protocol answer timeout is the maximum time to wait for the OXE answers. When this

timeout occurs (Messages cannot be deposit), Alert can send the failed messages again if the Retry

to send message if OXE doesn’t answer option is checked.

The two others groups

They define how ALERT interacts with the terminals:

Which ring is used (No ring or ring cadency from 0 to 5). Notice that cadency 4 is a continuous ring.

What kind of message is sent to the terminal (with or without acknowledgement)

How the acknowledgement on the terminal is processed in ALERT.

The check box Send alarms acknowledgements to the phone needs to be checked if you want to

remove alarms from the phone when they are acknowledged in ALERT.

Alarm and message configuration An Alcatel notification message has two parts:

- The name, which is a short message of 14 characters. - The message on 128 characters.

The short message is the first displayed on the terminal. To access the long message, the user needs

to press two dynamic keys.

When an alarm is defined in ALERT, specify the two messages (Short and long).

Do the same when sending service messages.

30/04/2013 Alert Oxepaging Driver 9/12

If no short message is set, the long message will be used as notification message name. (Truncated to

14 characters)

Call process

This part explains how the call is processed on different involved components.

Call sequence The next diagram illustrates a call sequence.

30/04/2013 Alert Oxepaging Driver 10/12

Alert OXEPaging driver OXE Terminal

Call number X

OXE acknowledgement

Send paging message to OXE

Send message to the phone

Display message and ring

Read acknowledgement

Message Read

Store message

Call ackowledged if Ack on transmission

End of displaying messages

Ack key pressedAck

Message acknowledgement

End key pressed

Call ackowledged if Ack on read

Call ackowledged if Ack on explicit ack

The acknowledgement dynamic key is displayed on the terminal if the explicit acknowledgement is

requested in the driver options box.

The call acknowledgement process depends of the choice in the driver settings screen. The call

sequence is affected by those options.

On the terminal When a notification message reaches the terminal, depending on the message priority, different

notification signals are set:

Default Ring

Message call: same ring as an internal call.

Alarm call: different ring cadency.

LED

On DECT: blinking LED.

On Reflexes terminals: green blinking LED on normal calls and red blinking LED on urgent calls.

Display

The short message is displayed.

30/04/2013 Alert Oxepaging Driver 11/12

When the user picks-up the phone, the short message is displayed prefixed by a character:

- No prefix: message call without explicit acknowledgement.

- “!”: message call with explicit call acknowledgement.

- “*”: alarm call without explicit acknowledgement

- “#”: alarm call with explicit acknowledgement (alarm or call)

- “@”: discrete call (no ring)

Options

In the OXE configuration, an option can be activated “NS read before acknowledgement”, to force

the message to be read before acknowledging it.

This option can be found at “System/Other system parameters”. Its value can be true or false.

OXE limits

The PBX can only store up to 1000(before R8.0) messages in memory, 32000 in R8.0 and after. If a new message is generated, the oldest is deleted. In addition, the PBX stores a maximum of 8 messages per terminal. In release R8.0, this parameter can be set from 8 to 50. This can be set in the user (extension) settings. When the terminal message storage is full, all new messages are ignored. There are two types of messages: with or without acknowledgement. For an acknowledged message, it is deleted from the memory only when the message is explicitly acknowledged by the user. For the other messages, it is deleted while reading by the user. For information, this Paging interface has the same limit than mini-messaging service. Mini-Messaging is a feature provided by the PBX to allow a terminal to send a text message to another terminal. However, a device configured to be addressed by the paging interface cannot receive a standard mini-message. The Paging Interface can manage about 2000 messages per hour (temporary peak with 3500 messages per hour has been validated too).

Troubleshooting’s

All calls end on failure in Alert, but the messages are received by phones. This may occurs in redundancy, when both stations are connected to the PBX. To fix it, only one Alert should be connected. Check the “Redundancy: connect the active station only” option in the configuration box.

30/04/2013 Alert Oxepaging Driver 12/12

The messages are truncated on the phones (accent removed) This is due to the PBX code page configuration. The driver can send with a specific code page. This is a hidden option. Stop Alert, edit the oxepaging.ini file. Change the “ConvertCodePage=1” key to “ConvertCodePage=20127”. This change the default code page from OEM to US-ASCII (7bits). Save the oxepaging.ini file and restart Alert.