MICROTRONIX access 1000 series User manual

Microtronix
Access 1000/4000 MWI Gateway
SIP/SMDI Router and Translator
Quick Start Guide 0.11.1
www.microtronix.com

Microtronix MWI Gateway – SIP/SMDI Router and Translator
Table of Contents
1. O er iew................................................................................................................................3
1.1 MWI Routing.....................................................................................................................4
1.2 SMDI to SIP Translation...................................................................................................4
1.3 SIP to SMDI Translation...................................................................................................4
2. Getting Started......................................................................................................................5
2.1 Package heck List..........................................................................................................5
2.2 Installation.........................................................................................................................5
2.3 Web Interface....................................................................................................................5
3. Configuration.........................................................................................................................6
3.1 IP Network onfiguration..................................................................................................6
3.2 Serial Port onfiguration...................................................................................................6
3.3 UMS SIP Interface onfiguration......................................................................................7
3.3 VMS SMDI Interface onfiguration..................................................................................8
3.4 Switch SMDI Interface onfiguration................................................................................9
3.5 SIP Switch Interface onfiguration.................................................................................11
4. Message Waiting Indicator Test.........................................................................................13
4.1 Overview.........................................................................................................................13
4.2 Telephone number (DN).................................................................................................13
4.3 Message Waiting Indication............................................................................................13
4.3 Message format..............................................................................................................13
4.3 Test Button......................................................................................................................13
5. Telephone Number Database.............................................................................................14
5.1 Overview.........................................................................................................................14
5.2 Learning Telephone Numbers.........................................................................................14
5.3 Database Manager.........................................................................................................14
6. Appendix..............................................................................................................................15
6.1 Serial and onsole ables.............................................................................................15
Connecting to a DTE device.....................................................................................................15
Connecting to a DCE device.....................................................................................................15
6.2 SMDI Messaging Examples............................................................................................16
6.3 Standards........................................................................................................................16
7. Contact Microtronix............................................................................................................17
www.microtronix.com 2

Microtronix MWI Gateway – SIP/SMDI Router and Translator
1. Overview
The Microtronix Access 1000/4000 MWI Gateway provides routing and translation of
Message Waiting Indicator (MWI) notifications from VoIP Unified Messaging Servers and
legacy Voice Mail Systems to one or more legacy or VoIP telephone switches/ PBXs.
The MWI Gateway receives MWI input from either:
●Legacy VMS via SMDI messages over serial interface or T P/IP socket
●VoIP UMS/VMS via SIP Notify messages over T P/IP or UDP/IP sockets
Routing of MWI messages to multiple switches may be accomplished with:
●Domain name in the SIP Notify request URI
●Telephone number in the SIP Notify request URI
●Telephone number in the SMDI OP or RMV messages
MWI output (with message translation where necessary):
●SMDI via serial RS232 port directly to legacy PBX
●SMDI via T P/IP to remote terminal server connected to serial port of legacy PBX
●SMDI via T P/IP to PBX supporting SMDI over T P
●Sip Notify (message-summary) via UDP/IP to VoIP PBX
www.microtronix.com 3

Microtronix MWI Gateway – SIP/SMDI Router and Translator
1.1 MWI Routing
When there are multiple destination switches as in the diagram above, an optional telephone
number database may be used for routing MWI messages. The database is self-learning and
may be populated from a comma separated values ( SV) text file containing telephone
number and matching switch interface number. A database manger application allows
adding, deleting, and reassigning phone numbers manually.
1.2 SMDI to SIP Translation
When there is only single VoIP switch/PBX destination configured, routing is unnecessary and
the MWI Gateway acts as a simple SMDI to SIP translator.
1.3 SIP to SMDI Translation
When there is only single legacy switch/PBX destination configured, routing is unnecessary
and the MWI Gateway acts as a simple SIP to SMDI translator.
www.microtronix.com 4

Microtronix MWI Gateway – SIP/SMDI Router and Translator
2. Getting Started
2.1 Package Check List
heck that the package shipped contains the following items:
●Access 1000 or 4000 unit (with MWI Gateway software package)
●A /D power adapter with A power cord, or -48VD wiring harness
●onsole/serial cable (DB9F-DB25M)
●DB25MF serial cable
●RJ45 Ethernet patch cable (blue)
●Optional USB flash drive (internal or external mount)
●Optional rack mount shelf
2.2 Installation
1) Install the MWI Gateway. It may be placed on a shelf in a rack.
2) onnect the unit to the IP network through the LAN port.
3) onnect the SMDI serial port(s) of any SMDI VMS or PBX to the WAN ports on the
back of the unit using appropriate cables and adapters.
4) Plug in the USB flash drive if externally mounted.
5) onnect D power adapter and A power cord, or attach -48VD wires to the supply.
6) Wait a few seconds for the boot process to complete. The RUN led will start to blink.
2.3 Web Interface
The default IP Address of the MWI Gateway is 10.1.1.240. The P which will be used to
access the web interface must be configured (temporarily) for an address in the same subnet,
for example, 10.1.1.200. onnect the P to the same LAN, or connect directly to the MWI
Gateway.
Open a web browser (like Windows Internet Explorer) from the P , and enter in the URL field:
http://10.1.1.240/
or
https://10.1.1.240/
When prompted, login using the default user: admin, and password: admin.
The home page of the unit will be displayed with the main menu down the left hand side. The
unit can now be configured by selecting the main menu items. Each page has a Help button
in the upper right corner for viewing additional information specific to the current page.
www.microtronix.com 5

Microtronix MWI Gateway – SIP/SMDI Router and Translator
3. Configuration
3.1 IP Network Configuration
To configure the Ethernet network port, a static IP address is recommended:
1) From the main menu System section, select the Ethernet option to display the
configuration form.
2) In the IP Address field, specify a valid IP address.
3) In the Netmask field specify the valid subnet mask.
4) If needed, specify a Default Gateway IP address.
5) lick the Apply button to set changes.
Since the IP connection may be lost due to the change, the new address may need to be
entered in the browser.
For more information on additional network configuration, click the Help button on the page.
3.2 Serial Port Configuration
If an SMDI link to a switch or PBX is not connected via T P/IP, then the RS232 serial device
ports must be configured:
1) From the main menu Serial section, select Terminal Ser er to display the device
configuration form.
2) Select a device from the drop-down list.
3) onfigure the device settings to match the attached PBX.
4) Select whether the DTR signal from the PBX will be used to control the connection.
5) lick the Enabled checkbox.
6) Ensure that Con ersion Type RAW is selected.
7) The Listening TCP Port may remain in the default setting (ttyS0 = 4000, ttyS1=
4001, ...)
8) lick the Start / Restart Terminal Ser er checkbox.
9) lick the Apply button for the changes to be saved and to take affect.
Repeat these steps for each device.
For additional information, click the Help button on the page.
To view the status of the terminal server connections, select Terminal Ser er from the Status
section of the main menu.
www.microtronix.com 6

Microtronix MWI Gateway – SIP/SMDI Router and Translator
3.3 UMS SIP Interface Configuration
The VoIP UMS or VMS connects to the MWI Gateway over an IP network as shown in the
diagram below. The UMS is configured with the IP address of the MWI Gateway and delivers
unsolicited SIP Notify messages over either T P or UDP sessions. More than one UMS may
connect to the MWI Gateway.
The MWI Gateway needs to be configured to accept the incoming connections from the UMS
and extract the domain name and telephone number from one of the fields of the SIP Notify
message.
From main menu MWI Gateway section, select UMS SIP Interface to display the
configuration form.
If the MWI Gateway needs to register itself, enter the Registar IP address and Registrar
UDP port.
To accept incoming sip Notify messages:
1) Specify the T P and/or UDP port number to which the UMS interface will connect.
The normal default is port number 5060.
2) Select the SIP NOTIFY header field containing the SIP-URI that will be used for
extracting userid (telephone number) and domain name for routing the MWI message
to a matching switch.
lick Apply to commit the settings and restart the application.
For additional information, click the Help button on the page.
The SIP Notify Ser er link displays the current running status of the application with a red or
green indicator. licking the link will display the application status and message statistics.
www.microtronix.com 7

Microtronix MWI Gateway – SIP/SMDI Router and Translator
3.3 VMS SMDI Interface Configuration
The VMS connects to the MWI Gateway via an SMDI link which may be one of the following
as depicted in the diagram below:
If connecting directly using a serial port, the SMDI interface connects to the built-in T P
terminal server at the local IP address, 127.0.0.1. If connecting remotely via T P/IP, the IP
address of the remote terminal server or of the VMS itself will be used for initiating the
connection. Leave the IP address blank if accepting a connection from any source.
To configure SMDI interfaces:
1) From the main menu MWI Gateway section, select VMS SMDI Interface to display the
configuration form.
2) If initiating a connection towards the VMS, specify the IP address and T P port
number of the remote or local terminal server that corresponds to the serial link of the
VMS. If accepting connections from any source, leave the IP field blank to listen for a
connection. Selecting T P port 0 disables this interface.
3) lick the Apply button to commit changes made.
The Status and Statistics field is a link that displays the current running status of the
corresponding application with a red or green indicator. licking the link will display the
application status and SMDI message statistics.
For additional configuration information, click on the Help button.
www.microtronix.com 8

Microtronix MWI Gateway – SIP/SMDI Router and Translator
3.4 Switch SMDI Interface Configuration
To route incoming MWI messages to legacy switches using SMDI, the MWI Gateway supports
connections to legacy switches and PBXs as depicted in the diagram below:
When multiple switches are to be configured, start with the switch with the most telephone
numbers, followed by switches with decreasing numbers. This increases the likelyhood of an
early match when the MWI router application is learning a new number. Assign an interface
number for each stating with 0.
If destination switches are addressed by the UMS by a unique domain name, enter it in the
Domain field. Lookup by telephone number in the database will not be necessary unless
there are exceptions.
The destination switch/PBX SMDI interface may be one of the following:
1. Direct connection to serial SMDI port of PBX via internal Terminal Ser er
2. T P/IP connection to a PBX supporting SMDI over T P
3. T P/IP connection to a remote terminal server with serial connection to PBX
The fourth option shows the Microtronix SMDI Translator (3A Translator replacement) being
www.microtronix.com 9

Microtronix MWI Gateway – SIP/SMDI Router and Translator
used to connect to a Lucent 5ESS Switch's custom ISDN API interface, and providing SMDI
over T P/IP or serial RS232.
If connecting directly using a serial port, the SMDI interface connects to the built-in T P
terminal server using the local IP address, 127.0.0.1. If connecting remotely via T P/IP, the
IP address of the remote terminal server, PBX, or SMDI Translator will be used.
To configure switch interfaces, repeat the following steps for each interface:
1) From the main menu MWI Gateway section, select Switch Interfaces to display the
configuration form.
2) Below the form, a table labelled Switch/PBX Interfaces is displayed. This table lists
the switch Interfaces with their current configuration and status.
3) To edit or enable a Switch Interface setting, select the corresponding radio button on
the right side of the interface table. The current values will populate the fields in the
form above. The interface unit number will display in the Switch Number box.
4) Domain: field - specify the domain name that will be used to match the domain field of
the SIP-URI field of incoming SIP Notify messages. Messages matching this will be
delivered to this switch. If the name is entered as “default”, then messages that have
no other match will be delivered to this switch. If left blank, then only telephone
number lookup will apply for this switch.
5) Select SMDI in the Protocol drop-down list.
6) Enter the IP Address and T P Port Number of the terminal server that corresponds to
the serial link connected to the Switch. If an SMDI connection to a remote terminal
server is desired, specify the external IP address and the T P port for that terminal
server to receive the SMDI-Switch Interface connection (leave the IP field blank to
listen for the remote terminal server to initiate the connection). Otherwise, the built-in
terminal server can be specified by using the local loopback IP address (127.0.0.1).
The T P port specified will be 400x, where x is equal to the SMDI-Switch Interface
number (ie. Device Port 0 = 4000).
7) Specify the SMDI keepalive interval, which is the time it takes in seconds between
receiving a response to a heartbeat message and when the next heartbeat message
will be sent.
8) lick the Apply button to commit changes made.
For additional configuration information, click on the Help button.
The Interface number field in the Switch Interfaces table is a link that displays the current
running status of the corresponding application with a red or green indicator. licking the link
will display the application status and message statistics.
www.microtronix.com 10

Microtronix MWI Gateway – SIP/SMDI Router and Translator
3.5 SIP Switch Interface Configuration
To route incoming MWI messages to VoIP switches using SIP, the MWI Gateway supports
UDP/IP connections to VoIP/Soft switches and PBXs as depicted in the diagram below:
add diagram
TODO
hoose a switch Interface Number to represent each destination switch and configure it with
the appropriate Protocol (SIP or SMDI).
If each destination switch is addressed by the UMS by a unique domain name, enter it in the
Domain field. Lookup by telephone number in the database will not be necessary unless
there are exceptions.
It the destination switch/PBX is VoIP, then enter the IP Address and UDP Port Number of it's
sip interface.
To configure switch interfaces, repeat the following steps for each interface:
1) From the main menu MWI Gateway section, select Switch Interfaces to display the
configuration form.
2) Below the form, a table labelled Switch/PBX Interfaces is displayed. This table lists
the switch Interfaces with their current configuration and status.
3) To edit a Switch Interface setting, select the corresponding radio button on the right
side of the interface table. The current values will populate the fields in the form above.
The interface unit number will display in the Switch Number box.
4) Domain: field - specify the domain name that will be used to match the domain field of
the SIP-URI field of incoming SIP Notify messages. Messages matching this will be
delivered to this switch. If the name is entered as “default”, then messages that have
no other match will be delivered to this switch. If left blank, then only telephone
number lookup will apply for this switch.
5) Select Protocol used by the remote switch.
6) If the protocol is SMDI, enter the IP Address and T P Port Number of the terminal
server that corresponds to the serial link connected to the Switch. If an SMDI
connection to a remote terminal server is desired, specify the external IP address and
the T P port for that terminal server to receive the SMDI-Switch Interface connection
(leave the IP field blank to listen for the remote termianl server to initiate the
connection). Otherwise, the MWI Gateway's built-in terminal server can be specified by
using the local loopback IP address (127.0.0.1). The T P port specified will be 400x,
where x is equal to the SMDI-Switch Interface number (ie. Device Port 0 = 4000).
7) If the protocol is SIP, enter the IP Address and UDP Port Number of the VoIP PBX
SIP interface. It should expect to receive unsolicited Notify messages. It may register
with the MWI Gateway.
8) Specify the keepalive interval, which is the time it takes in seconds between receiving
a response to a heartbeat message and when the next heartbeat message will be sent.
www.microtronix.com 11

Microtronix MWI Gateway – SIP/SMDI Router and Translator
9) lick the Apply button to commit changes made.
For additional configuration information, click on the Help button.
The Interface number field in the Switch Interfaces table is a link that displays the current
running status of the corresponding application with a red or green indicator. licking the link
will display the application status and message statistics.
www.microtronix.com 12

Microtronix MWI Gateway – SIP/SMDI Router and Translator
4. Message Waiting Indicator Test
4.1 Overview
The MWI Gateway can generate MWI messages internally by using the MWI Test page .
hoose the main menu option to display the test page.
The test page has 3 input fields for selecting a telephone number, on/off indicator, and
message format; and a Test button to initiate the test.
4.2 Telephone number (DN)
Enter the telephone number of the telephone that should receive an MWI message. The
maximum number of digits is 14. A single digit can be sent as a “keep-alive” signal that
should invoke a negative response.
4.3 Message Waiting Indication
hoose ON or OFF depending on the desired affect on the telephone. Sending one then the
other in successive tests should cause a toggle of the specific indicator on the telephone.
This could be a stutter tone, lamp, or a test message depending on the type of phone and
switch/PBX to which the phone is attached.
4.3 Message format
hoose SIP Notify or SMDI as the source generator for the message.
If SIP Notify is chosen, a SIP Notify “messge-summary” is sent via the Listening TCP port of
the UMS SIP Interface. The port number shoul be non-zero. The SIP interface will forward
the message to the MWI Gateway for delivery to it's routed destination switch/PBX.
If SMDI is chosen, an SMDI message is send via the listening TCP Port Number of the VMS
Interface. The VMS interface must not be in use by another source, and must be configured
for listening on a non-zero TCP Port Number, IP Address blank or set to 0.0.0.0, and
Protocol set to SMDI.
4.3 Test Button
lick on the Test button to generate and send the MWI mesage to the selected input
interface, and observe the target telephone. Messages will be displayed in a new window to
reflect the progress.
www.microtronix.com 13

Microtronix MWI Gateway – SIP/SMDI Router and Translator
5. Telephone Number Database
5.1 Overview
If MWI routing to multiple switch destinations is done by telephone number, the USB flash
drive will contain a telephone number SQL database. The database is initially empty unless
pre-populated by arrangement with Microtronix. A telephone number record has 3 fields:
1) Telephone number (up to 14 digits)
2) Switch interface number (matching switch or PBX)
3) Last received message waiting indication (ON / OFF)
The MWI Gateway will use the telephone number extracted from incoming SIP Notify or SMDI
MWI messages to route it to a matching switch by looking it up in the database.
5.2 Learning Telephone Numbers
If the telephone number does not yet exist in the database, a learning process begins. A
record is added and the telephone number assigned to the first available switch interface
(lowest interface number). The MWI value is also saved in case the switch rejects the phone
number. The MWI message is sent to the switch, and if it is rejected, the phone number and
MWI are used to send a message to the next available switch. The phone number is
reassigned to the new switch. This process is repeated until a switch has accepted the
number, or all have rejected it. If all switches reject the phone number, it will be asssigned to
switch interface number 99, and a log event generated.
If the telephone number extracted already exists (has been accepted) in the database, an
received MWI message is forwarded to the assigned interfacebut if that switch subsequently
rejects the telephone number, the telephone number is re-assigned to the next highest switch
interface number and the learning process resumes.
If a telphone number becomes assigned to switch interface 99, the Database Manager web
page can be used to manually reassign or delete it.
5.3 Database Manager
The Database Manager web page can be used to:
●find a telephone number switch interface assignment
●find a range of telephone number switch interface assignments
●find the numbers assigned to a switch interface
●reassign the switch interface for a phone number
●delete a phone number record
●add a new phone number record
www.microtronix.com 14

Microtronix MWI Gateway – SIP/SMDI Router and Translator
6. Appendix
6.1 Serial and Console Cables
When the DB25F WAN ports are configured in the internal Terminal Server for async serial,
they have an RS232 D E pin configuration like a modem.
Connecting to a DTE device
The following cables are used when connecting to a serial DTE device (like a P OM port)
that has a DB25M or DB9M (male) connector. If replacing a modem, avoid any modem
handshake issues by configuring the device's interface for “leased line” or “permanent
modem” type connection.
Straight through cable part numbers
811-SC6MF DB25MF - WAN port to DB25M
[284-MC1MF DB25M-DB9F - WAN port to DB9M
Connecting to a DCE device
The null modem cable is used when connecting to a serial D E device (like a modem) that
has a DB25F (female) connector. Any standard null modem cable should work, or can be
ordered.
Null modem cable part number
W4025-V24-DTE DB25M-DB25M - WAN port to DB25F
www.microtronix.com 15

Microtronix MWI Gateway – SIP/SMDI Router and Translator
6.2 SMDI Messaging Examples
1) SIP Notify message-summary received from the UMS contains the following fields:
●SIP-URI: sip:551234567@domain1
●message content: Messages-waiting: yes
If enabled, the telephone number 55512134567 is looked up in the database for the
destination switch interface. If not in the database, the switch interfaces are scanned for a
domain name match to ”domain1” starting at the lowest configured switch interface.
When a switch interface is determined and it is SMDI, the telephone number is used to
construct the SMDI MWI message to be sent to the matching switch.
OP:MWI 5551234567!<ctrl-D>
2) SIP Notify message summary received from the UMS contains the following fields:
●SIP-URI: sip:551234567@domain1
●message content: Messages-waiting: no
An SMDI MWI message will be sent to the matching switch.
RMV:MWI 5551234567!<ctrl-D>
3) If a transmitted SMDI MWI message contains a telephone number not assigned to the
destination switch, it will respond with an SMDI invalid message.
MWI5551234567 INV<cr><lf><ctrl-Y>
This will cause the MWI Gateway to remove the current SMDI interface assignment in the
database and re-assign to the next available switch interface number. It will transmit an MWI
message to the next switch (could be SIP Notify or SMDI).
6.3 Standards
SMDI: Simplified Message Desk Interface (Bellcore TR-NWT-000283)
RF 3261: Session Initiation Protocol (SIP)
RF 3265: Session Initiation Protocol - Specific Event Notification: (EXT. of 3261)
RF 3842: A Message Summary and MWI Event Package for SIP
RF 3966: The tel: URI for telephone numbers
ITU-T E.123 Notation for national and international telephone numbers
www.microtronix.com 16

Microtronix MWI Gateway – SIP/SMDI Router and Translator
7. Contact Microtronix
Microtronix Datacom Ltd.
4056 Meadowbrook Drive, Unit 126
London ON N6L 1E3
ANADA
Tel: [phone]
Fax: [phone]
General Inquiries: [email protected]
Sales Enquiries: [email protected]
ustomer Support: [email protected]
www.microtronix.com 17