CMP PhoneSuite External Service Manual
PhoneSuite™ External Protocols
This document describes the protocols PhoneSuite uses to communicate with external
devices like printers and systems such as call accounting and property management
systems. There are three main sections:
• SMDR (Station Message Detail Record) describes the format of the raw call
records generated by PhoneSuite
• Call Accounting covers both integrated call accounting that prints on an
attached printer and also the record layouts and protocols when connecting to an
external Property Management System (PMS)
• PMS Control Interface is how an external Property Management System (PMS)
interacts with the PhoneSuite 112 (not the 64) to control functions such as check
in and out, wake-up call, call restrictions, and other functions.
Table of Contents
SMDR (Station Message Detail Record)...................................................................................... 3
PhoneSuite 64 SMDR layout ...................................................................................................................... 3
Incoming SMDR, PhoneSuite 64, 3-digit extension ............................................................................ 3
Incoming SMDR, PhoneSuite 64, 2-digit extension ............................................................................ 3
Outgoing SMDR, PhoneSuite 64, 3-digit extension ............................................................................ 3
Outgoing SMDR, PhoneSuite 64, 2-digit extension ............................................................................ 3
PhoneSuite 112 SMDR layout .................................................................................................................... 4
Incoming SMDR, PhoneSuite 112, 4-digit extension .......................................................................... 4
Incoming SMDR, PhoneSuite 112, 3-digit extension .......................................................................... 4
Outgoing SMDR, PhoneSuite 112, 4-digit extension .......................................................................... 4
Outgoing SMDR, PhoneSuite 112, 3-digit extension .......................................................................... 4
Call Accounting ............................................................................................................................. 5
Costed records, no PMS............................................................................................................................. 5
On-the-Fly costed call record, no PMS ...............................................................................................5
Costed records, with PMS........................................................................................................................... 5
Blind Send............................................................................................................................................... 6
Sample Data using the Blind Send Interface Protocol:........................................................................ 6
HOBIS A ................................................................................................................................................. 6
Sample Data using the HOBIS A Interface Protocol: .......................................................................... 8
HOBIS B ................................................................................................................................................. 8
Micros A.................................................................................................................................................. 9
Sample Data using the Micros A Interface Protocol:..........................................................................10
Micros B.................................................................................................................................................10
PMS Control Interface.................................................................................................................11
Message Format........................................................................................................................................11
Check In/Out Commands...........................................................................................................................12
Set Room Name(s)....................................................................................................................................12
Do Not Disturb On/Off................................................................................................................................13
Message Waiting Lamp On/Off..................................................................................................................13
Wakeup Call Set/Change/Clear.................................................................................................................14
Phone Restrict On/Off................................................................................................................................14
PMS Database Dump ................................................................................................................................15
Room Status..............................................................................................................................................15
Request PMS Database.............................................................................................................................15
Specific Compatibility.................................................................................................................................16
Mitel SX200 Digital.................................................................................................................................16
Hitachi HCX5000 ...................................................................................................................................16
Cabling and Setup .....................................................................................................................................17
ps_external_protocols_20050321.doc Page 1
ps_external_protocols_20050321.doc Page 2
SMDR (Station Message Detail Record)
Phone Suite produces Station Message Detail Records for all calls received by or made
from a PhoneSuite system. These are raw records and reflect the actual time of the call,
not an adjusted time such as generated by the Call Accounting option.
PhoneSuite 64 allocates three columns for an extension number while the PhoneSuite
112 uses four columns. The data on the 112 are therefore shifted one column to the right
relative to those on the 64.
The first column will be blank if the PhoneSuite 64 is configured to use two-digit
extensions or the PhoneSuite 112 is configured to use three-digit extensions.
The Operator extension is always right-adjusted and left-padded with blanks in the
extension field, so on the Model 64 record “0” will be in column 3 and in column 4 on the
Model 112.
In the following, EEEE is the extension number, TT is the trunk number, MM/DD/YY is
the date, HH:MM:SS is the time, N is the number dialed, and A is the optional account
code.
For incoming SMDR records, the first time field is the time the call was answered, the
second time field is the total duration of the call after being answered, and the third time
field is the length of time the call rang before it was answered.
For outgoing SMDR records, the first time field is the time the call was started, and the
second time field is the duration of the call
PhoneSuite 64 SMDR layout
On the PhoneSuite 64, SMDR data are sent to either the serial port, the parallel port, or
both according to the settings of the B70 and B71 commands.
Incoming SMDR, PhoneSuite 64, 3-digit extension
0 1 2 3 4 5
1234567890123456789012345678901234567890123456
EEE TT MM/DD/YY HH:MM:SS HH:MM:SS HH:MM:SS
Incoming SMDR, PhoneSuite 64, 2-digit extension
0 1 2 3 4 5
1234567890123456789012345678901234567890123456
EE TT MM/DD/YY HH:MM:SS HH:MM:SS HH:MM:SS
Outgoing SMDR, PhoneSuite 64, 3-digit extension
0 1 2 3 4 5 6 7....
12345678901234567890123456789012345678901234567890123456789012345678901234
EEE TT MM/DD/YY HH:MM:SS HH:MM:SS NNNNNNNNNNNNNNNN AAAAAAAAAAAA
Outgoing SMDR, PhoneSuite 64, 2-digit extension
0 1 2 3 4 5 6 7....
12345678901234567890123456789012345678901234567890123456789012345678901234
EE TT MM/DD/YY HH:MM:SS HH:MM:SS NNNNNNNNNNNNNNNN AAAAAAAAAAAA
ps_external_protocols_20050321.doc Page 3
PhoneSuite 112 SMDR layout
On the PhoneSuite 112, SMDR data appear on the parallel port, serial port 1, serial port
2, or any combination according to the setting of B70, B71, and B77 respectively. If the
full PMS serial port 1 interface is used by setting B71 to 64, then the SMDR records are
available only on the parallel port and serial port 2.
The PhoneSuite 112 incoming SMDR record may also display the incoming DID/DNIS
digits from an E&M wink start T1 line. From one to seven digits will display according to
the setting of the B25 command. In most cases this value will equal the number of digits
in the extension (three or four) as set by command B11.
The digits are left-adjusted in the field starting at column 48 and are represented by “D”
in the record layouts below. These digits will be displayed in the incoming SMDR record
only if a T1 digital trunk card is installed in the PhoneSuite 112 and the T1 signaling
method is E&M wink start.
Incoming SMDR, PhoneSuite 112, 4-digit extension
0 1 2 3 4 5
123456789012345678901234567890123456789012345678901234
EEEE TT MM/DD/YY HH:MM:SS HH:MM:SS HH:MM:SS DDDDDDD
Incoming SMDR, PhoneSuite 112, 3-digit extension
0 1 2 3 4 5
123456789012345678901234567890123456789012345678901234
EEE TT MM/DD/YY HH:MM:SS HH:MM:SS HH:MM:SS DDDDDDD
Outgoing SMDR, PhoneSuite 112, 4-digit extension
0 1 2 3 4 5 6 7....
12345678901234567890123456789012345678901234567890123456789012345678901234
EEEE TT MM/DD/YY HH:MM:SS HH:MM:SS NNNNNNNNNNNNNNNN AAAAAAAAAAAA
Outgoing SMDR, PhoneSuite 112, 3-digit extension
0 1 2 3 4 5 6 7....
12345678901234567890123456789012345678901234567890123456789012345678901234
EEE TT MM/DD/YY HH:MM:SS HH:MM:SS NNNNNNNNNNNNNNNN AAAAAAAAAAAA
ps_external_protocols_20050321.doc Page 4
Call Accounting
If a PhoneSuite Auto-Attendant/Call Accounting (AA/CA) card is installed, you can
configure it to print “costed-calls” in a variety of formats either standalone or in
conjunction with a Property Management System (PMS). You will usually want to print
the calls as soon as they are completed, or “on-the-fly,” by using command B59, function
34. The format of the printing is controlled by B59, function 50 that selects whether or
not a PMS is connected, and if so, which PMS handshaking protocol to use. The
interface speed (baud rate) is controlled by command B59, item 52.
Costed records, no PMS
If no PMS is installed, PhoneSuite can generate and print a costed record to any parallel
or serial port configured to print a “Call Accounting Event” report by the settings of
commands B70, B71, and B77. The format is the same for the PhoneSuite 64 and
PhoneSuite 112.
On-the-Fly costed call record, no PMS
0 1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890123456789
EXT TK DATE TIME NUMBER DIALED DESCRIPTION DURATN $ COST
EEEE TT MM/DD HH:MM NNNNNNNNNNNNN DDDDDDDDDDDDDDDD MMMM.T DDDDD.CC
Where
• EEEE is the extension number that received the call (if transferred from the
console, the extension that it was sent to is displayed). The extension number is
padded on the left with blanks
• TT is the trunk number. Trunks less than ten are left-padded with zero (e.g., “01”)
• MM/DD is the date the call was received
• HH:MM is the time the call was received
• NNNN... is the number dialed
• DDDD... is a description of the type of call made
• MMMM.T is the duration of the call in minutes and tenths-of-a-minute
• DDDDD.CC is the cost of the call in dollars and cents
Note:
• Two lines are printed for each on-the-fly record: the header line and the costedrecord line.
Costed records, with PMS
When PhoneSuite is configured to connect with a PMS, you need to select which
handshaking protocol to use: Blind Send, HOBIS A, HOBIS B, Micros A, or Micros B.
Selecting the protocol also determines the default layout of the call records. The
PhoneSuite AA/CA card provides commands to adjust the field layouts in case it is
necessary to comply with a non-standard PMS interface.
The connection from the AA/CA card to the PMS is through the supplied RJ11-to-DB9
cable. The RJ11 end plugs into connector J2 on the edge of the AA/CA board, the port
that will send the costed call data to the PMS
ps_external_protocols_20050321.doc Page 5
Blind Send
This Interface Protocol is used to send costed phone call records with no handshaking.
The records are sent as follows:
PhoneSuite sends: <record><CR><LF>
PMS responds: no response is expected or used
Where
• <record> is an ASCII text string with data about a single call
• <CR> is the carriage return character (0D hex, 13 decimal)
• <LF> is the line feed character (0A hex, 10 decimal).
The ASCII text string is sent in the following format:
0 1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890123456789
CCCC PPP EEEE MM/DD HH:MM NNNNNNNNNNNN DDDDDDDDDDDDDDDD MMMM $DDD.CC
Where the fields are:
Field Field Name Width Default
Position
CCCC
PPP
EEEE
MM/DD
HH:MM
NNNNNNNNNNNN
DDDDDDDDDDDD
MMMM
$DDD.CC
Counter 04 01 0 (in front of the digits)
Property Code 03 06 As in call accounting option 41
Extension 04 10 Space (in front of the digits)
Date 05 15 0 (in front of any single digit)
Time 05 21 0 (in front of any single digit)
Number Dialed 12 27 Space (after the digits)
Description
(Type of Call)
Duration 04 57 0 (in front of the digits)
Cost 07 63 0 (in any empty space after $)
16 40 Space (after the description)
Notes:
The Default Position shows the location of the first character in the field (the left edge of
the field).
The Cost field includes the dollar sign as part of that field.
Empty Spaces Filled With
Sample Data using the Blind Send Interface Protocol:
1 2 3 4 5 6
123456789012345678901234567890123456789012345678901234567890123456789
0001 CMP 101 09/21 10:25 3035552345 Local Call 0001 $000.50
0923 CMP 203 09/23 17:44 12125678900 Long Distance 0005 $001.45
0028 CMP 405 10/05 06:30 18002221234 Toll Free 0003 $000.50
Note: The column number ruler shown in this sample data does not print; it is included
as an aid in determining where each field starts and ends.
HOBIS A
This Interface Protocol is based on the original AT&T* HOBIS-to-PMS Interface and is
employed by more than 90% of Property Management Systems. Systems using Hobis A
include: Amstar, CLS, Compass, Compu-solve, Dehan, Encore, Fabco, HIS, Holidex,
ps_external_protocols_20050321.doc Page 6
Loading...