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
About This Document 
xi Product Support 
nAdministration command paths and options you enter in the administration 
fields are shown as follows:
change system-parameters hospitality
nField names referring to the administration screens are shown as follows:
Queue Length
Product Support
To receive support within the United States and Canada concerning this specifica-
tion, call 1-800-242-2121. Outside the United States and Canada, contact your 
local Lucent Technologies authorized representative.
Related Documents
n555-020-706 — 7400A Data Module User Guide
n555-020-707 — 7400B Data Module User Guide
n555-020-709 — 8400B Plus Data Module User’s Guide
n555-230-723 — GuestWorks® and DEFINITY® ECS Release 8 Hospitality 
Operations
n555-230-833 — DEFINITY® ECS Release 8 Documentation Library (CD)
n555-231-109 — GuestWorks® Issue 6 Technician Handbook
n555-231-208 — DEFINITY® Business Communications System and 
GuestWorks® Issue 6 Overview
n555-233-502 — DEFINITY® ECS Release 8 Administrator’s Guide
n585-310-234 — INTUITY™ Lodging Property Management System
Interface Specifications 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
About This Document 
xii Related Documents  
						

							System Description 
1 Link Interface 
DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description
Link Interface
The PMS Interface is a full duplex EIA RS232C-D asynchronous data link that 
operates under specific message protocols and formats. The characteristics of the 
link, the protocols used, and the message text are described in detail in the
“Feature Description” starting on page 19
. Figure 1 shows the various ways a 
switch can link to a PMS.
Figure 1. Switch-to-PMS Connectivity 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
2 Link Interface 
The PMS Interface feature permits a co-located PMS to request more 
sophisticated room status functions via the switch and communication of 
housekeeper status changes from the switch. In addition, the PMS may perform 
guest folio preparation and perform sophisticated message waiting and room 
telephone restriction functions utilizing the switch control capabilities. The PMS 
can communicate with the switch by sending and receiving specific messages 
associated with the functions to be performed.
The PMS can receive the following from the switch:
nHousekeeper-dialed status changes from room and designated tele-
phones.
nTelephone restriction status changes entered on telephones (Controlled 
Restrictions).
nMessage waiting lamp changes entered on telephones and changes in 
Message Waiting status.
nStatus inquiry and room data image messages indicating failures, requests 
for database updates, requests or confirmation of impending link release 
for maintenance, and normal link operations.
nNames registration (which includes the guest name and coverage path 
number) via room data image request (T) (A). This is a response message 
to the PMS.
The PMS can send the following to the switch:
nRoom check-in and check-out messages. Check-in/check-out messages 
are required to support the data link since the PMS controls room status. 
Check-in messages may be sent with or without guest name information 
(T) (A). Check-ins may also include the coverage path number (T) (A) 
which correlates to the destination of an unanswered call to a guest’s room 
(for example, hotel attendant, voice mail, etc), the guest’s language inter-
face attribute (A), and the guest’s voice messaging password (A).
nGuest Information Input/Change messages (T) (A). This allows input or 
changes in guest information after check-in [guest name, coverage path, 
language interface attribute (A), and voice messaging password (A)].
nRoom change or room swap messages specifying the “from” and “to” 
Room Station Numbers (RSN). These messages are required to support 
the data link so that the switch will always reflect the most current guest 
room status information.
nTelephone restriction changes entered on PMS terminals. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
3 Administration Options 
nMessage waiting lamp changes entered on PMS terminals.
nText or FAX notations entered on a PMS terminal (A).
nStatus inquiry and room data image messages indicating failures, requests 
for database updates, requests or confirmation of impending link release 
for maintenance, and normal link operations.
The messages to be sent and received depend on the functions required for the 
particular application. This is discussed in detail in “Administration Options” 
starting on page 3. The specific actions taken by the switch for each of the 
messages is discussed in “Feature Codes, Process Codes, and Operations” 
starting on page 51.
Administration Options
This section shows the switch administration screens used to administer the PMS 
Interface options and a description of those options. Screens are shown for the 
most recent version of GuestWorks and DEFINITY ECS. 
!CAUTION:
The screens and options described here may differ slightly depending on 
the switch being used. Refer to the administration documents provided with 
your switch to verify which options you must administer. The values shown 
in these screens are for example only. Actual field values must be deter-
mined by the technician in consultation with the PMS vendor.
change system-parameters hospitality  Page   1 of   3
                              HOSPITALITY
                       Message Waiting Configuration: act-nopms
               Controlled Restrictions Configuration: act-pms
               Housekeeper Information Configuration: act-pms
                     Number of Housekeeper ID Digits: 0
                        Extension of PMS Log Printer:
               Extension of Journal/Schedule Printer:
             Client Room Coverage Path Configuration: act-nopms
              Default Coverage Path for Client Rooms: 1
Forward PMS Messages to Intuity Lodging? n
                              PMS LINK PARAMETERS
                                    Extension of PMS: 7899
                                   PMS Protocol Mode: transparent ASCII mode? y
Seconds before PMS Link Idle Timeout: 20
Milliseconds before PMS Link Acknowledgement Timeout: 500
                    PMS Link Maximum Retransmissions: 5
            PMS Link Maximum Retransmission Requests: 5
                    Take Down Link for Lost Messages? y 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
4 Administration Options 
The following sections describe the administration options. The options are 
grouped as they are located on each page of the administration screens.
!CAUTION:
Not all administration options are available for each release. Items marked 
with (T) apply only to transparent mode and items marked with (A) apply 
only to ASCII mode.
change system-parameters hospitality  Page   2 of   3
                              HOSPITALITY
Dual Wakeups? y  Daily Wakeup? y  VIP Wakeup? y
VIP Wakeups Per 5 Minutes: 5
Room Activated Wakeup With Tones? y
                    Time of Scheduled Wakeup Activity Report: 12:00:am
                     Time of Scheduled Wakeup Summary Report: 12:30:am
           Time of Scheduled Emergency Access Summary Report: 12:45:am
                                           Announcement Type: silence
          Length of Time to Remain Connected to Announcement: 30
             Extension to Receive Failed Wakeup LWC Messages: 399
            Routing Extension on Unavailable Voice Synthesis:
                    Display Room Information in Call Display? n
Automatic Selection of DID Numbers? y
                                  Number of Digits from PMS:
PMS Sends Prefix? n
                      Number of Digits in PMS Coverage Path: 3
Digit to Insert/Delete:
change system-parameters hospitality  Page   3 of   3
ROOM STATES  HOSPITALITY
          Definition for Rooms in State 1: OCCUPIED/DIRTY
          Definition for Rooms in State 2: OCCUPIED/MAID IN ROOM
          Definition for Rooms in State 3: OCCUPIED/CLEAN
          Definition for Rooms in State 4: VACANT/CLEAN
          Definition for Rooms in State 5: 
          Definition for Rooms in State 6: 
HOSPITALITY FEATURES
Suite Check-in? y 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
5 Administration Options 
Administration Options on Page 1
Message Waiting Configuration
This indicates whether message waiting notification requests and changes are 
being exchanged between the switch and the PMS.
Controlled Restrictions Configuration
This indicates whether controlled restriction information is being exchanged 
between the 
switch and the PMS. 
Housekeeper Information Configuration
This indicates whether housekeeper information is being exchanged between the 
switch and the PMS. 
Number of Housekeeper ID Digits
This is the number of digits that the housekeeper must dial for identification.Valid entries Usage
act-nopms The message is acknowledged (MESSAGE ACK), but no 
action is taken.
act-pmsThe option act-pms indicates that message waiting is active 
on the switch and information between the PMS and switch is 
being transmitted. If the PMS vendor supports text message 
waiting, use act-pms.
Valid entries Usage
act-nopms The message is acknowledged (MESSAGE ACK), but no 
action is taken. 
act-pmsIf active (act-pms), the switch and the PMS exchange and 
accept controlled restriction information.
Valid entries Usage
act-nopms The message is acknowledged (MESSAGE ACK), but no 
action is taken.
act-pmsIf active (act-pms), the switch and PMS exchange and accept 
housekeeper information.
Valid entries Usage
0 to 6 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
6 Administration Options 
Extension of PMS Log Printer 
This is a valid data extension number that is assigned to the data module con-
nected to the PMS/Log printer. 
Extension of Journal/Schedule Printer
This is a valid data extension number assigned to the data module that is con-
nected to the Journal/Schedule printer. 
Client Room Coverage Path Configuration (T) (A)
This indicates whether the switch and the PMS exchange coverage path informa-
tion for guest telephones. Valid entries Usage
Valid data 
extension num-
berCannot be a Vector Directory Number (VDN) extension. This 
extension is dialed by the switch to send housekeeping and 
PMS events to the printer.
Valid entries Usage
Valid data 
extension num-
berCannot be a VDN extension. This extension can be the same 
as the PMS/Log printer, and both sets of reports may be 
printed on the same printer. This extension is dialed by the 
switch to send journal information or to schedule reports to the 
printer.
Valid entries Usage
act-nopmsThe message is acknowledged (MESSAGE ACK), but no 
action is taken.
act-pmsIf active (act-pms), the switch and PMS exchange and accept 
coverage path information. This field does not apply to normal 
mode. When upgrading from a release that does not support 
this feature, the field is set to act-pms if the PMS protocol 
mode is administered for transparent or ASCII mode. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
7 Administration Options 
Default Coverage Path for Client Rooms (T) (A)
This indicates the coverage path assigned when the switch receives a check-out 
message for a valid extension or a new check-in. This applies only to RSNs with a 
“client room” class of service in the “occupied” mode. This field does not apply to 
normal mode; it is used only for transparent or ASCII mode. The value in this field 
is also used during a translation save as the coverage path for each RSN with “cli-
ent room” class of service. 
Forward PMS Message to INTUITY
Lodging (T) (A)
This field determines whether PMS messages destined for the INTUITY voice 
mail system are transmitted through the switch (GuestWorks mode) or directly to 
the INTUITY system (standalone mode).
Extension of PMS
This indicates the data extension number the switch must dial to access PMS.
PMS Protocol Mode
This indicates the message protocol mode used between the switch and PMS. Valid entries Usage
1 to 999 (csi/si)
1 to 9999 (r)
Valid entries Usage
yEnter y if the PMS-to-INTUITY messages will be sent through 
the switch (GuestWorks mode). With this mode, a separate 
hardware link from the PMS to the INTUITY system is not 
used.
n Enter n if the PMS-to-INTUITY messages will be sent directly 
from the INTUITY Lodging system to the PMS (standalone 
mode). With this mode, a separate hardware link from the PMS 
to the INTUITY system is required.
Valid entries Usage
Assigned 
extensionCannot be a VDN extension. When this extension is entered 
and PMS is ready, the switch brings up the link.
Valid entries Usage
normal Normal mode
transparentTransparent mode (to enable ASCII mode, the mode must be 
transparent) 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
System Description 
8 Administration Options 
ASCII mode (A)
This indicates whether the ASCII-only mode is being used for the PMS message 
set. The PMS Protocol Mode field must be set to transparent. This field does not 
apply to normal mode.
Seconds Before PMS Link Idle Timeout 
This indicates the idle time in seconds that the switch waits for an acknowledg-
ment from the PMS before the 
switch enters link failure mode from the PMS trans-
mission link. 
Milliseconds Before PMS Link Acknowledgment
Tim eo u t  
This indicates the amount of time in milliseconds the system waits for an acknowl-
edgment from the PMS indicating it correctly received a message. 
PMS Link Maximum Retransmissions
This indicates the number of times that the switch will retransmit a message to the 
PMS in response to a negative acknowledgment or send an inquiry for acknowl-
edgment from the PMS before abandoning the message.
PMS Link Maximum Retransmission Requests
This indicates the number of times that the switch will allow the PMS to request 
acknowledgment for a message that it sent.Valid entries Usage
y/n
Valid entries Usage
5 to 20
Valid entries Usage
100 to 1500This regulates how quickly the system responds to a message 
from the PMS (also known as “pace timing”). This value is also 
used as the “inquiry message” (ENQ) time-out value. In most 
cases, keep this as short as possible.
Valid entries Usage
1 to 5
Valid entries Usage
1 to 5