Lucent Technologies DEFINITY Enterprise Communications Server And GuestWorks Property Management System Interface Specifications

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
9 Administration Options 
Take Down Link for Lost Messages
This indicates whether the link will be taken down if messages are being lost. The 
switch determines that messages are being lost if it receives a message that is out 
of sequence. When this occurs, the link is brought down momentarily, and the 
switch requests a database swap from the PMS.
Administration Options on Page 2
Dual Wakeup
This indicates whether the Dual Wakeup feature is enabled.
Daily Wakeup
This indicates whether the Daily Wakeup feature is enabled.
VIP Wakeup
This indicates whether the VIP Wakeup feature is enabled.
VIP Wakeups Per 5 Minutes
This field appears only if VIP Wakeup is set to y.  Valid entries Usage
y Enter y to allow the PMS link to be brought down if messages 
are being lost.
nEnter n to keep the link operating. Careful monitoring of the 
PMS error log is recommended when using this option.
Valid entries Usage
y/nEnter y if each guest can request two wakeup calls within 
one 24-hour time period.
Valid entries Usage
y/nEnter y if each extension can request daily wakeup calls.
Valid entries Usage
y/nEnter y if the front desk is allowed to create VIP wakeup calls.
Valid entries Usage
0 to 50Enter the number of VIP Wakeup calls that you want the sys-
tem to allow in a five-minute interval. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
10 Administration Options 
Room Activated Wakeup with Tones
This indicates whether the Room Activated Wakeup with Tones feature is 
enabled.
!CAUTION:
Do not set the time for the following reports to coincide when the system 
does its scheduled maintenance tests (the default is 1 a.m.). See the Sys-
tem-Parameters Maintenance screen to verify the time and to coordinate 
this administration so the times do not overlap.
Time of Scheduled Wakeup Activity Report
This indicates the time of day that the Wakeup Activity Report will be printed on 
the Journal/Schedule Printer. This report summarizes the wakeup activity for each 
extension that had wakeup activity for the past 24 hours. 
Time of Scheduled Wakeup Summary Report
This indicates the time of day that the Wakeup Summary Report will be printed on 
the Journal/Schedule printer. This report gives an hour-by-hour summary of the 
number of scheduled wakeup calls and a list of extensions to which wakeup calls 
were attempted but did not complete during the hour. 
Time of Scheduled Emergency Access
Summary Report
This indicates the time of day that the Emergency Access Summary Report will be 
printed on the Journal/ Schedule printer. Valid entries Usage
y/nEnter y if guests are allowed to create their own wakeup calls. 
This allows room activated wakeup calls without the use of a 
speech synthesizer or a display telephone.
Valid entries Usage
hh:mm:am/pmEnter the time where hh=hour, mm=minute, am/pm=a.m. or 
p.m.
Valid entries Usage
hh:mm:am/pmEnter the time where hh=hour, mm=minute, am/pm=a.m. or 
p.m.
Valid entries Usage
hh:mm:am/pmEnter the time where hh=hour, mm=minute, am/pm=a.m. or 
p.m. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
11 Administration Options 
Announcement Type
This indicates the type of automatic wakeup announcement the hotel guest will 
receive. Allowable entries are as follows:
Depending on what data is entered in the Announcement Type field, one of the 
following four fields appears:
nAuxiliary Board for Announcement
nIntegrated Announcement Extension
nDefault Announcement Extension
nAnnouncement Ports. Valid entries Usage
externalApplicable when using an announcement adjunct.
If external is used, complete the Auxiliary Board for 
Announcement field.
integratedApplicable when using the TN750B or TN750C announce-
ment circuit pack.
If integrated is used, complete the Integrated Announce-
ment Extension field. The extension you enter must be a 
valid integrated announcement extension (administered on 
the Recorded Announcements screen) or a VDN. If you enter 
an invalid extension, the switch displays an error message.
mult-integMulti-integrated; applicable when using the TN750B or 
TN750C announcement circuit pack.
If mult-integ is used, complete the Default Announcement 
Extension field. The extension you enter must be a valid 
integrated announcement extension (administered on the 
Recorded Announcements screen) or a VDN. If you enter an 
invalid extension, the switch displays an error message.
voice- synthesisIf voice-synthesis is used, complete the Announcement 
Ports field.
music-on-holdIf music-on-hold is used, no other field appears.
silence If silence is used, no other field appears. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
12 Administration Options 
Auxiliary Board for Announcement
This field appears only when the external announcement type is used. This indi-
cates the equipment location of an auxiliary trunk circuit that connects to the 
external announcement equipment. Enter a 5-character circuit pack number. 
Integrated Announcement Extension
This field appears only when the integrated announcement type is used. This 
indicates the wakeup announcement extension when using the integrated 
announcement circuit pack. 
Default Announcement Extension
This field appears only when the mult-integ announcement type is used. This 
indicates the default wakeup announcement extension when using the integrated 
announcement circuit pack. 
Announcement Ports
This field appears only when the voice-synthesis announcement type is used. 
For the voice-synthesis announcement type, this indicates the equipment loca-
tion of two ports on the voice synthesizer circuit pack (TN725B). Valid entries Usage
1 to 3cabinet
A to Ecarrier
0 to 20slot
Valid entries Usage
valid extension 
or VDNEnter the extension of the announcement you want to use for 
wakeup calls.
Valid entries Usage
valid extension 
or VDNEnter the extension of the announcement you want to use for 
default wakeup calls.
Valid entries Usage
1 to 3cabinet
A to Ecarrier
0 to 20slot
01 to 04circuit 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
13 Administration Options 
Length of Time to Remain Connected to
Announcement
Enter the length of time in seconds that a hotel guest will be connected to an 
announcement. This applies only after the guest has heard the announcement 
completely one time, but continues to listen. 
Extension to Receive Failed Wakeup LWC
Messages
This indicates where unsuccessful wakeup Leave Word Calling (LWC) messages 
will be stored. This is administered to an unassigned extension (cannot be a VDN 
extension). A LWC lamp for that extension is then assigned to the attendant con-
sole as an indication of failed wakeup calls. 
Routing Extension on Unavailable Voice
Synthesis
This indicates where a wakeup call will go to if both wakeup announcements on 
the Speech Synthesizer circuit pack are not available. This is usually administered 
to an assigned extension (cannot be a VDN extension) or to the attendant (attd). 
Display Room Information in Call Display
This indicates the type of guest room information displayed on phone displays. Valid entries Usage
0 to 300
Valid entries Usage
Unassigned 
extension
Valid entries Usage
Assigned exten-
sion or attd
Valid entries Usage
y If this field is set to y, the phones will display the name and 
room number as defined in the Room field of the Site Data on 
the station form. Only the first five characters of this field are 
displayed. Note that the extension number and room number 
are not always the same number.
nIf this field is set to n, the phones will display the name and 
extension number. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
14 Administration Options 
Automatic Selection of DID Numbers
Enabling this field allows you to assign a random extension number to a guest’s 
phone number that is not associated with the room number. This allows callers 
outside of the hotel to dial a guest directly without front desk intervention.
Number of Digits from PMS
This indicates the number of digits being sent from the PMS to the switch to iden-
tify room numbers. 
NOTE:
If the Number of Digits from PMS field is blank and the PMS Sends 
Prefix field is set to n, the 
switch will not support an extension that starts 
with 0.
PMS Sends Prefix
This indicates whether the PMS sends a prefix digit to the switch as part of the 
room numbering plan. 
NOTE:
If the Number of Digits from PMS field is blank and the PMS Sends 
Prefix field is set to n, the 
switch will not support an extension that starts 
with 0. Valid entries Usage
y/nEnter y to use the Automatic Selection of DID Numbers for 
Guest Rooms feature.
Valid entries Usage
1 to 4When using normal mode, digits 1 through 4 are valid. 
1 to 5When using transparent or ASCII mode, digits 1 through 5 are 
valid.
blank If using mixed numbering in the switch, leave this field blank.
Valid entries Usage
y/n 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
15 Administration Options 
Number of Digits in PMS Coverage Path (T) (A)
This indicates whether the coverage paths are three or four digits long.There can 
be up to 9999 coverage paths (1-999 for csi/si, 1-9999 for r).
Depending on the number of digits in the coverage path (CP1, CP2, CP3, and 
CP4), leading digits in the paths must be padded with zeros and the final digit may 
be unused or defined as null (f).
 Coverage paths use “forward ordering.” The 
following table illustrates examples of how this must be designed:
Digit to Insert/Delete
Enter the leading digit that may be deleted and inserted back as described in the 
following text. The current PMS message set uses the extension number as the 
room identifier. In many customer configurations, the leading digit of the extension 
number is dropped to screen the room number. To accommodate PMS devices 
that are based on room number and not extension, this leading digit may be 
deleted on messages from the switch to the PMS, and then inserted back on mes-
sages from the PMS.
NOTE:
The PMS interface supports 3-, 4-, or 5-digit extensions, but prefixed exten-
sions do not send the entire number across the interface. Only the assigned 
extension number is sent. Therefore, you should not use prefixed exten-
sions for numbers that are also going to use the Digit to Insert/Delete func-
tion. Valid entries Usage
3 or 4
N-Digit 
Coverage PathsPath Number
ExamplesDigit Format
(CP1 to CP4)
3-Digit 5
22
314005f*
022f*
314f*
4-Digit 5
22
314
21330005
0022
0314
2133
* This is an unused nibble that is unused or filled out with a 
null (f). This value is ignored.
Valid entries Usage
blank No digit insertion or deletion is done.
0 to 9Selected digit is inserted or deleted. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
16 Administration Options 
Administration Options on Page 3
Definition for Rooms in State 1 - 6 
Enter up to a 30-character definition for each room status. For example, you could 
define state 1 as Clean, Ready To Use and state 2 as Occupied, Needs Cleaning. 
The status defined here must match the status defined in the PMS.
The definitions for room states are for Housekeeping Status only. If you are not 
using Housekeeping Status, you do not need to complete these fields.
Suite Check-in
This field allows attendants to have the system automatically check-in several 
related extensions with one check-in command.
Valid entries Usage
y/nEnter y to use the Suite Check-in feature. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
17 Administration Options 
Implementation Examples
Names Registration
When a guest in a hotel calls any hotel service, the attendant should be able to 
use the displayed name to address the caller appropriately. One way for the PMS 
vendor to implement this is to have an additional field on the check-in form to 
enter an “f” for a female guest, “m” for a male guest, or “x” for multiple guests. 
Using this field and the Last Name field, the PMS can then send appropriate name 
field content. For example, the name field could read “Mr. LastName” or “Ms. Last-
Name” or “LastName” (multiple guests).
Coverage Path
The Call Coverage feature provides customized coverage for unanswered calls to 
guest rooms. For example, you can have calls routed to the front desk, to voice 
messaging, or to another room.
There are two steps to implementing this feature on the PMS:
1. The PMS should provide a way to enter a “default coverage path number” 
as part of the setup of the PMS software. This field must be alterable by the 
hotel personnel.
2. The PMS should add a field on the check-in form to enter a 3- or 4-digit 
Coverage Path number so that the front desk personnel will be able to 
enter a number if a guest desires a customized coverage path. If any num-
ber other than 0 or blank is entered, the selected coverage path is used. If 
0 is entered, no coverage is used. If a blank is entered, the default cover-
age path on the PMS is used. If the PMS default coverage path field is also 
blank, then the PMS can send “0xbbb” or “0xbbbb” coverage path. This will 
cause the switch to use its default coverage path (see the Default Cover-
age Path for Client Rooms administration on page 7
 and the Number of 
Digits in PMS Coverage Path administration on page 15
). 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
18 Administration Options 
Voice Mail Password (A)
This message is used to change the voice mail password for a room upon 
check-in. This operation applies only to ASCII mode. Check-in is the only mes-
sage that will change the INTUITY mailbox password. To use the INTUITY default 
password, send ASCII blanks. To change the password, it must conform to the fol-
lowing restrictions:
nIt must be four digits long
nIt cannot be the same number as the room number
nIt cannot be the same digits (for example, 1111 or 9999)
nIt cannot be a sequence of digits (for example, 1234 or 9876).
nThe default password is defined by the type of interface link used with the 
INTUITY (GuestWorks or standalone). The default password for Guest-
Works mode is #. The default password for standalone mode is *.
Voice Mail Languages (A)
When interfacing to the INTUITY Lodging voice messaging system, there is a 2-
digit encoding used to select the different guest language interfaces. To use the 
default, send ASCII blanks. The digits will be sent as ASCII digits. The following is 
a list of the different language encodes supported by INTUITY Lodging:
NOTE:
Contact your Lucent Technologies representative for more information 
about language support.LanguageHex Value and Message Position INTUITY 
Lodging 
Numbering Language 1 Language 2
American English 0x32 0x30 00
Japanese 0x32 0x31 01
Latin American Spanish 0x32 0x32 02
Greek 0x32 0x33 03
Mandarin 0x32 0x34 04
Reserved for future use 0x32 0x35 05
UK English 0x32 0x36 06
Canadian French 0x32 0x37 07
Brazilian Portuguese 0x32 0x38 08
German 0x32 0x61 10
Parisian French 0x32 0x62 11
Arabic Female 0x32 0x64 13
Russian 0x33 0x34 20