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

							555-231-601
Comcode 108596669
Issue 2
December 1999
DEFINITY®
Enterprise Communications Server 
and GuestWorks
®
Property Management System
Interface Specifications 
						

							Copyright 
Ó 1999, Lucent Technologies
All Rights Reserved
Printed in U.S.A.
Notice
Every effort was made to ensure that the information in this book was 
complete and accurate at the time of printing.  However, information is 
subject to change.
Trademarks
INTUITY is a trademark of Lucent Technologies.
AUDIX, DEFINITY, and GuestWorks are registered trademarks of 
Lucent Technologies.
Ordering Information
Call: Lucent Technologies Publications Center
U.S. Voice: 1 888 582 3688
U.S. Fax: 1 800 566 9568
Canada Voice: +1 317 322 6619
Europe, Middle East, Africa Voice: +1 317 322 6416
Asia, China, Pacific Region, Caribbean,
Latin America Voice: +1 317 322 6411
Non-U.S. Fax: +1 317 322 6699
Write: Lucent Technologies Publications Center
2855 N. Franklin Road
Indianapolis, IN 46219
U.S.A.
Order: Document No. 555-231-601
2, December 1999
For more information about Lucent Technologies documents, refer to 
the section entitled “Related Documents” in “About This Document.”
You can be placed on a Standing Order list for this and other BCS doc-
uments you may need. Standing Order will enable you to automatically 
receive updated versions of individual documents or document sets, 
billed to account information that you provide. For more information 
on Standing Orders, or to be put on a list to receive future issues of this 
document, please contact the Lucent Technologies BCS Publications 
Center.
Product Support
To receive support for this specification, call 1-800-242-2121. Outside 
the continental United States, contact your local Lucent Technologies 
authorized representative.
European Union Declaration of Conformity
The “CE” mark affixed to the equipment described in this book indi-
cates that the equipment conforms to the following European Union 
(EU) Directives:
• Electromagnetic Compatibility (89/336/EEC)
• Low Voltage (73/23/EEC)
• Telecommunications Terminal Equipment (TTE) i-CTR3 
BRI and i-CTR4 PRI
For more information on standards compliance, contact your local dis-
tributor.
Comments
To comment on this document, return the comment form.
Lucent Technologies Web Page
The World Wide Web home page for Lucent Technologies is
http://www.lucent.comAcknowledgment
This document was prepared jointly by the Lucent Technologies Cus-
tomer Training & Information Products Organization and the Product 
Documentation Development group of Global Learning Solutions
Bell Laboratories
Denver, CO 80234-2703. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Contents 
iii  
Contents
Contents iii
About This Document ix
nIntended Audienceix
nReasons for Reissuex
nConventionsx
nProduct Supportxi
nRelated Documentsxi
System Description 1
nLink Interface1
nAdministration Options3
Administration Options on Page 15
Message Waiting Configuration5
Controlled Restrictions Configuration5
Housekeeper Information Configuration5
Number of Housekeeper ID Digits5
Extension of PMS Log Printer6
Extension of Journal/Schedule Printer6
Client Room Coverage Path Configuration (T) (A)6
Default Coverage Path for Client Rooms (T) (A)7
Forward PMS Message to INTUITY
Lodging (T) (A)7
Extension of PMS7
PMS Protocol Mode7
ASCII mode (A)8
Seconds Before PMS Link Idle Timeout8
Milliseconds Before PMS Link Acknowledgment
Timeout8
PMS Link Maximum Retransmissions8
PMS Link Maximum Retransmission Requests8
Take Down Link for Lost Messages9 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Contents 
iv  
Administration Options on Page 29
Dual Wakeup9
Daily Wakeup9
VIP Wakeup9
VIP Wakeups Per 5 Minutes9
Room Activated Wakeup with Tones10
Time of Scheduled Wakeup Activity Report10
Time of Scheduled Wakeup Summary Report10
Time of Scheduled Emergency Access
Summary Report10
Announcement Type11
Auxiliary Board for Announcement12
Integrated Announcement Extension12
Default Announcement Extension12
Announcement Ports12
Length of Time to Remain Connected to
Announcement13
Extension to Receive Failed Wakeup LWC
Messages13
Routing Extension on Unavailable Voice
Synthesis13
Display Room Information in Call Display13
Automatic Selection of DID Numbers14
Number of Digits from PMS14
PMS Sends Prefix14
Number of Digits in PMS Coverage Path (T) (A)15
Digit to Insert/Delete15
Administration Options on Page 316
Definition for Rooms in State 1 - 616
Suite Check-in16
Implementation Examples17
Names Registration17
Coverage Path17
Voice Mail Password (A)18
Voice Mail Languages (A)18 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Contents 
v  
Feature Description 19
nLine Control Characteristics19
Message Envelope21
nExchange Protocol and Message Responses29
Sending Rules30
Receiving Rules31
nLink Setup and Drop Conditions33
Link Setup33
Link Drop33
nTimeout Control33
nMessage Text Format Structure and Encoding34
Message Text Ordering38
nSummary of Message Formats40
Feature Codes, Process Codes, and Operations 51
nFeature Code Summary51
nHousekeeper Status53
Feature Codes53
Process Codes54
Operational Considerations (act-pms)55
Feature Access Code/Message Process
Code Correlation55
Switch Originating Dialing Procedures56
PMS Response to Housekeeper Status
Feature Message57
Switch Response to PMS Returned Messages57
Failure Considerations58
Operational Considerations (act-nopms)58
nMessage Waiting59
Feature Codes59
Process Codes59
Operational Considerations60
Feature Active with PMS60
Feature Active Without PMS61
PMS Considerations61
Other Considerations61 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Contents 
vi  
nControlled Restriction62
Feature Codes62
Process Codes62
Operational Considerations63
Switch Operations (act-pms)63
PMS Considerations64
Switch Operations (act-nopms)64
Other Considerations64
nCheck-In/Check-Out65
Feature Codes65
Process Codes66
Operational Considerations67
Switch Actions68
Other Considerations69
Failure Considerations70
Examples of Check-In Message Activity70
nRoom Data Image72
Feature Codes72
Process Codes72
Operational Considerations73
Examples76
PMS Considerations for Process Code 377
Switch Actions Upon Receipt of Room Image
with Process Code 377
PMS Actions for Room Image Complement
Message (Process Code 4)78
Other Considerations78
nRoom Change/Room Swap79
Feature Codes79
Process Codes79
Operational Considerations80
nGuest Information Input/Change81
Feature Codes81
Process Codes81
Operational Considerations82 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Contents 
vii  
nStatus Inquiry and Failure Management83
Feature Codes83
Process Codes84
Operational Considerations85
Recognition of Data Link Failure86
Release of Data Link for Maintenance
(Process Codes 5, 6)87
Switch Operations During Loss of
Communication88
PMS Operations During Loss of Communication88
Recovery from Loss of Communication89
The Database Exchange Procedure90
Examples of Status Inquiry Message Activity92
Acronyms and Glossary 95
nAcronyms95
nGlossary96
Index 99 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Contents 
viii   
						

							About This Document 
ix Intended Audience 
DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
About This Document
This document describes the Property Management System (PMS) data link inter-
face for the DEFINITY® Enterprise Communications Server (ECS) and Guest-
Works®. This interface allows a PMS to provide front office and back office hotel/
motel management features with communications-related functions coordinated 
with the switch. Although this document is written for the hotel/motel environment, 
its specifications may also apply to hospitals and other extended-care facilities.
A PMS usually consists of a computer with one or more data terminals used to 
input data related to a guest’s stay at the property. A PMS terminal provides an 
efficient way for hotel staff to check guests in and out of the hotel, move guest 
check-in information from one room to another, control long distance calling 
access for a guest room, view long distance billing charges as prescribed by a call 
accounting adjunct, and control other information related to the guest. Information 
concerning housekeeper-dialed status changes, Controlled Restrictions, and 
Message Waiting can also be obtained from the switch and sent to the PMS. The 
switch receives check-in and check-out messages and guest information changes 
from the PMS, and can also receive Controlled Restriction and Message Waiting 
data from the PMS as necessary.
Intended Audience
The primary audience for this specification is PMS vendors who wish to create 
PMS products that interface to Lucent Technologies equipment. A secondary 
audience is installation and support personnel. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
About This Document 
x Reasons for Reissue 
Reasons for Reissue
This document replaces Issue 1. Changes in this release include the following:
nCheck-in/Check-out message changes for the Automatic Selection of 
Direct Inward Dialing (DID) Numbers feature (GuestWorks Issue 6 and 
DEFINITY ECS Release 8 [R8]).
nConsiderations related to the Suite Check-In feature (GuestWorks Issue 6 
and DEFINITY R8).
nGeneral updating and corrections.
Conventions
The following conventions are used in this document:
nThe term “switch” is used to refer to the DEFINITY ECS and GuestWorks.
nSpecifications that are supported only on GuestWorks are identified by 
“GW.”
nSpecifications that are supported only on the DEFINITY ECS Release 5.4 
and later are identified by “ECS.”
nSpecifications that are supported only on the DEFINITY ECS Release 8 
and later and the GuestWorks Issue 6 and later are identified by “R8.”
nThe designation “0x” in numbers such as “0x02” and “0xf” represents the 
term “Hexadecimal.” For these two examples, you should read them as 
“Hex 02” and “Hex f.”
nThis interface supports three modes of hospitality data: Normal Mode, 
Transparent Mode, and ASCII Mode. The switches that support each mode 
are as follows:
The normal mode gives you standard functionality; everything in normal 
mode is also supported in the transparent mode and the ASCII mode. Fea-
ture codes and specifications that support only normal, transparent, or 
ASCII modes are identified with either (N), (T), or (A). Switch ReleaseMode
Normal Transparent ASCII
DEFINITY Generic 3 Versions 1-4 
(G3V1-G3V4)Yes Yes No
DEFINITY ECS and GuestWorks Yes Yes Yes