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
Feature Description 
49 Summary of Message Formats 
Figure 21. Guest Information Input/Change Message Formats 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Description 
50 Summary of Message Formats 
Figure 22. Status Inquiry Message Formats 
						

							Feature Codes, Process Codes, and Operations 
51 Feature Code Summary 
DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, 
and Operations
This section discusses the operations associated with each feature message. The 
set of feature messages actually used may vary among various PMS system 
applications. General operation, summary of the process codes defined and their 
uses, and switch and/or PMS considerations will be discussed for each feature 
message.
Feature Code Summary
The feature codes are summarized in Ta b l e 6. The feature codes shown apply to 
the normal mode (N), the transparent mode (T), and the ASCII mode (A).
Table 6. Feature Code Summary 
Feature/Page NumberFeature 
Code* Purpose
Housekeeper Status-Room - 
page 5311 (N)
31 (T)
21/HKR (A)Communicate housekeeper-dialed 
status changes originated from 
room
Housekeeper Status-Remote
Status Designated Station - 
page 53
12 (N)
32 (T)
22/HKS (A)Communicate housekeeper-dialed 
changes originated from a desig-
nated station
Message Waiting - page 59
13 (N)
33 (T)
23/MSG (A)Communicate message waiting 
lamp status changes
Controlled Restriction - page 62
15 (N)
35 (T)
25/CR (A)Communicate changes in room 
telephone calling restrictions 
placed on RSN
Check-in/check-out - page 65
16 (N) Communicate room check-ins and 
check-outs
Continued on next page 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
52 Feature Code Summary 
Check-in - page 6536 (T)
26/CKI (A)Check-in when using guest name 
display
Check-out - page 65
46 (T)
29/CKO (A)Check-out when using guest name 
display
Room Data Image - page 72
17 (N)
37 (T)
27/RMI (A)Exchange status information for an 
RSN
Room Change/Swap - page 79
20 (N)
30 (T)
24/RMC (A)Perform room change or swap 
operations between two rooms
Guest Information Input/Change - 
page 81
38 (T)
28/GIC (A)Communicate guest name or cov-
erage path information changes
Status Inquiry and Failure Manage-
ment - page 83
70 (N) (T)
71/STS (A)Data link maintenance
* The ASCII Mode feature codes also show the ASCII representation of the feature code.
Ta b l e 6 .Feature Code Summary  — Continued
Feature/Page NumberFeature 
Code* Purpose
Continued on next page 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
53 Housekeeper Status 
Housekeeper Status
The Housekeeper Status feature enables on-line tracking of the housekeeper ser-
vices and room state changes using the following:
nSix process codes for dialing from room telephones
nFour process codes for dialing from designated station lines
nEach process code may include up to six additional information digits, 
available for room state changes and/or auxiliary processing such as 
housekeeper ID tracking.
The Housekeeper Status feature capability is an optional switch feature available 
through administration.
Feature Codes
The Housekeeper Status from Room feature codes are as follows:
n11 — Normal mode
n31 — Transparent mode
n21/HKR — ASCII mode.
The Housekeeper Status from Designated Station feature codes are as follows:
n12 — Normal mode
n32 — Transparent mode
n22/HKS — ASCII mode.
These feature message formats are shown in Figure 12 on page 40
 and Figure 13 
on page 41. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
54 Housekeeper Status 
Process Codes
The process codes for the Housekeeper Status from Room feature are shown in 
Ta b l e 7
.
The process codes for the Housekeeper Status from Designated Station feature 
are shown in Table 8
. Table 7. Housekeeper Status from Room Process Codes
[Feature Codes 11 (N), 31 (T), or 21/HKR (A)]
Process 
CodeMessage 
Direction Indications
1 through 6 Switch to PMS The associated feature access code was dialed from the 
RSN indicated. Message may include up to six house-
keeper ID digits in addition to the RSN.
8 PMS to Switch PMS rejects the validity of the message text or an invalid 
state change was indicated.
9 PMS to Switch PMS accepts the status change.
Table 8. Housekeeper Status from Designated Station
Process Codes [Feature Codes 12 (N), 32 (T), or 22/HKS (A)]
Process 
CodeMessage 
Direction Indications
1 through 4 Switch to PMS The associated feature access code and the indicated 
station number were dialed from a designated station. 
Message may include up to six housekeeper ID digits in 
addition to the RSN.
8 PMS to Switch PMS rejects the message.
9 PMS to Switch PMS accepts the message. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
55 Housekeeper Status 
Operational Considerations (act-pms)
The following sections describe the Housekeeper Status operational consider-
ations when the feature is active in the switch and the PMS is active.
Feature Access Code/Message Process
Code Correlation
The feature access code (FAC) determines the process code used when the call 
originates from the room or from a designated station. The correlation between an 
FAC and the process code is specified by the relative numbering of the FAC in the 
switch installation translation. The meanings of the process codes (for example, 
that process code 21 means “housekeeper in room”) are assigned by the PMS. 
For further clarification, refer to the implementation or administration manuals for 
your switch. Ta b l e 9
 and Ta b l e 1 0 show some example feature access codes.
!CAUTION:
The definitions administered in the switch must match the definitions admin-
istered on the PMS.
Table 9. Housekeeper Status from Room Feature Access
Code Examples
FA CProcess 
Code Definition
21 1 Housekeeper in Room
22 2 Room Clean - Vacant
23 3 Room Clean - Occupied
24 4 Room Not Clean - Vacant
25 5 Room Not Clean - Occupied
26 6 Room Clean - Needs Inspection
Table 10. Housekeeper Status from Designated Station
Feature Access Code Examples
FA CProcess 
Code Definition
31 1 Housekeeper in Room
32 2 Room Clean - Vacant
33 3 Room Clean - Occupied
34 4 Room Not Clean - Vacant 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
56 Housekeeper Status 
Switch Originating Dialing Procedures
The dialing procedures for the housekeepers are determined by the switch instal-
lation translation. The assignable items are as follows:
nFeature access codes (six possible for room-originated updates, four pos-
sible for designated station-originated updates) which correlate with PMS 
feature message process codes
nTelephones capable of remote housekeeper status change [designated 
station(s)]
nNumber of additional information digits (for example, number of House-
keeper ID digits) to be dialed and transmitted to the PMS (the same num-
ber of ID digits are used for either room or remote designation station).
The Housekeeper Status messages can carry, in addition to the affected station 
number, up to six arbitrary variable digits entered by the caller via the touch-tone 
or rotary dial. With no additional information digits specified in switch translation, 
the dialing sequences are as follows:
nRoom originated — FAC only
nDesignated station — FAC + (dial tone) + affected station
If the number of additional digits specified in switch translation is nonzero (1-6), 
another dial tone is returned to the caller after the standard dialing sequence. The 
caller can then dial up to the number of digits specified (extra dialed digits are 
ignored). For a room originated call, for instance, the dialing sequences are as 
follows:
nHousekeeper in Room — FAC + (dial tone) + 1-6 additional digits + (confir-
mation tone)
nDesignated Station — FAC + (dial tone) + digits of affected station + (dial 
tone) + 1-6 additional digits + (confirmation tone)
These additional digits can represent a Housekeeper ID number and/or a dialed 
status of the room or special request to the PMS. The dialed digits will be entered 
in the DIG1 through DIG6 fields of the transmitted Housekeeper Status feature 
message for interpretation by the PMS (see Figure 12 on page 40
 or Figure 13 on 
page 41).
If the switch’s translation defines the number of additional digits to be less than 
six, the digits will be placed starting at nibble DIG1 and the unused nibbles of the 
fixed length message will be padded out. If no additional digits are specified, all 
six DIG fields will be transmitted as nulls.
If an incomplete dial time-out occurs, no message will be sent to the PMS and 
intercept tone will be returned to the caller. If an incomplete sequence is dialed 
and the Housekeeper hangs up, no message will be sent to the PMS. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
57 Housekeeper Status 
PMS Response to Housekeeper Status
Feature Message
After the housekeeper dialing sequence is completed, the feature message (pro-
cess codes 1-6 or 1-4) formatted with the affected RSN and any additional dialed 
digits is sent to the PMS.
The PMS must interpret the received message information and return the 
message to the switch within a 4-second interval. The message text returned to 
the switch must be identical to the message received, with the exception of the 
message count and process code. The process code returned must be 8 
(signifying rejection of the received message) or 9 (signifying acceptance of the 
received message information).
Switch Response to PMS Returned Messages
After the initial originating dialing sequence and message transmission to the 
PMS, the switch awaits the PMS returned message for a 4-second period. The 
switch will return one of the following tones to signify the completion status of the 
status update (provided the caller remains off-hook):
nReorder tone: if a valid process code 8 or 9 message response is not 
received from the PMS before the 4-second interval
nConfirmation tone: if a Content Valid (process code 9) message response 
is received from the PMS before the 4-second interval
nIntercept tone: if a reject (process code 8) message response is received 
from the PMS before the 4-second interval.
If the caller goes on-hook (hangs up) before the time-out period or before the 
housekeeper status response message is received from the PMS, the received 
response message is ignored by the switch. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
58 Housekeeper Status 
Failure Considerations
In the case of a data link or PMS failure (communication is severed), the switch 
will internally log message data, which would have been sent to the PMS for that 
call, using the list pms-down (or list maintenance pms-down) report available 
from the administration terminal. The message will have one of the following for-
mats:
Messages can also be routed to the optional PMS Log printer in the following 
format:
PMS dd/mm/yy   hh:mm   xxxx FROM ROOM:Code x* PMS link out of service
or
PMS dd/mm/yy   hh:mm   xxxx FROM STATION:Code y
* PMS link out of service
The caller is always given confirmation tone if the printer is up, assuming that later 
on immediate or manual entry into the PMS can be done from the printed copy or 
the list pms-down (or list maintenance pms-down) log command. The caller is 
given reorder tone if the printer is unavailable. 
For a DEFINITY G3V1 system, Housekeeper Status data will not be stored in the 
switch. Therefore, during switch failure, room status information is not included in 
the database update procedure. Upon PMS failure, the data backups are the 
internal switch logging (list pms-down or list maintenance pms-down) and the 
optional printer output (PMS Log).
For the DEFINITY G3V2 through G3V4, DEFINITY ECS, and GuestWorks, the 
 button is used to determine the room status even when the link to the 
PMS is down.
Operational Considerations (act-nopms)
With the feature inactive, the switch will not send housekeeper information to the 
PMS. However, this information will be logged on the PMS Log printer if a printer 
is available. The message will be printed as “Feature active nopms.” The switch 
will ACK messages from the PMS for Housekeeper status; however, the switch 
will send a violation message to the PMS and not act on the received message.
Extension Event Reason Date/Time
XXXX
XXXXXfrom room, code x
*
from station, code y*
PMS link-out
PMS link-outxx:yy A
xx:yy P
* In this example, “x” is a number from 1 to 6 and “y” is a number from 1 to 4.
Maid Status