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 Codes, Process Codes, and Operations 
69 Check-In/Check-Out 
Other Considerations
The Check-Out Confirmed-Room Already Vacant (16,7) (N), (36,4) (T), or (26,4) 
(A) and the Check-In Confirmed-Room Already Occupied (16,8) (N), (36,2) (T), or 
(26,2) (A) messages will be sent to the PMS when a check-out request is received 
for a vacant room and a check-in request is received for an occupied room, 
respectively. A Check-Out Confirmed-Other message type (46,5) (T) or (29,5) (A) 
will be sent to the PMS if the room’s message lamp is on due to a non-PMS mes-
sage. These are not counted as error or invalid conditions by the switch.
The name characters are ASCII and must be between 0x20 (space character) 
and 0x7e (tilda character) in value. If the name consists of less than 15 
characters, the name field must be left-justified by padding the remaining 
characters with the space (0x20) character.
The data portion of the coverage path field in the check-in message for the 
transparent PMS protocol consists of three or four Binary Coded Decimal (BCD) 
characters representing the thousands, hundreds, tens, and unit digits with the 
following valid values:
n0 — No coverage is provided for the RSN
n1-xxxx — Coverage path used (see the coverage path values on page 15)
n0xbbb or 0xbbbb— Coverage path value of the “Default Coverage Path for 
Client Rooms” field on the switch is used.
The LANGUAGE frames identify which language is for the INTUITY Lodging voice 
messaging for the guest rooms (A). To use the default language, send blanks. To 
use a particular language, send the language number as defined in the 
INTUITY 
Lodging Property Management System Interface Specifications
, (585-310-234). 
At the time of publication, the following is a list of the different language encodes 
supported by INTUITY Lodging.
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 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
70 Check-In/Check-Out 
The VM PASSWD frames are used to change the voice mail password when a 
guest checks in (A). To use the default password, send blanks. The default 
password is defined by the type of interface link used with the INTUITY 
(GuestWorks or standalone). The default password for GuestWorks mode is #. 
The default password for standalone mode is *.
In a Suite Check-in environment, check-in requests sent from the PMS to the 
switch activates all of the pre-administered suite telephones. However, on the 
PMS, you may have to check in more than one room depending upon how the 
suites have been administered on the PMS.
Failure Considerations
When loss of communication with the PMS occurs due to failure of the data link or 
the PMS, the switch will enable the   and   buttons so that a 
switch terminal (attendant console or display telephone with console permissions) 
can be used for check-in and check-out. Check-in and check-out on the switch 
terminal will perform the functions outlined above except guest name and cover-
age path information which can be entered later using Guest Information Input/
Change messages from the PMS or the database swap can fill in. Manual check-
in/check-out always sets the coverage path to “Default Coverage Path for Client 
Rooms.”
During the recovery procedure, the RSN’s occupancy status specified by the PMS 
in the (17,3) (N), (37,3) (T), or (27,3) (A) room image message may be different 
from the switch status for the indicated room, implying a check-in or check-out be 
performed for that RSN in the switch for synchronization.
Examples of Check-In Message Activity
The following chart shows an example of check-in message activity for the Nor-
mal, Transparent, and ASCII modes. These examples match the data shown in 
Figure 7
, Figure 8, and Figure 9, respectively.
Parisian French 0x32 0x62 11
Arabic Female 0x32 0x64 13
Russian 0x33 0x34 20
LanguageHex Value and Message Position INTUITY 
Lodging 
Numbering Language 1 Language 2
Check InCheck Out 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
71 Check-In/Check-Out  
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
72 Room Data Image 
Room Data Image
The Room Data Image feature provides a means for sending and receiving the 
set of pertinent status items for a particular RSN to or from each system (the PMS 
or the switch). Two of the process codes are provided for “informational 
exchange” about the other system’s status and do not imply that status changes 
are to be performed. The other two process codes are provided for the “database 
exchange” recovery procedure and can imply status changes in either or both sys-
tems.
Feature Codes
The Room Data Image feature codes are as follows:
n17 — Normal mode
n37 — Transparent mode
n27/RMI — ASCII mode
This feature message format is shown in Figure 19 on page 47
.
Process Codes
The process codes for the Room Data Image feature are shown in Ta b l e 1 8.
Table 18. Room Data Image Process Codes [Feature
Codes 17 (N), 37 (T), or 27/RMI (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Request to send the data image for indicated room for infor-
mational purposes only.
2 Switch to PMS Response to received process code 1 message.
3 PMS to Switch Database update status information and/or request for 
switch status.
4 Switch to PMS Database update switch status response to process code 3. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
73 Room Data Image 
Operational Considerations
Process codes 1 and 2 are used in the informational exchange mode. The PMS 
will request status items from the switch by sending process code 1; the switch 
will reply with pertinent data by returning process code 2. Process code 1 does 
not imply or dictate any status change to the receiving system. The PMS may ini-
tiate a process code 1 request at any time.
Process codes 3 and 4 are reserved for the database exchange procedure only. 
The switch will acknowledge but not process the messages and return violation 
messages if they are sent at any other time. The database “swap” procedure is 
defined as the message sequence between and including the transmission of the 
(70,3) (N) (T) or (71,3) (A) database exchange “start” message and the 
transmission of the (70,4) (N) (T) or (71,4) (A) database exchange “end” message 
(both originated by the PMS). The (70,3) (N) (T) or (71,3) (A) message signals the 
start of database synchronization. Then, for each room, a process code 3 
message is sent by the PMS specifying current PMS status data and/or 
requesting switch status data. The switch will process the process code 3 
message and return a process code 4 message containing any requested switch 
status. Thus the exchange constitutes a synchronization of the two systems’ 
databases for a particular room. After the process code 3/process code 4 
exchange for all rooms, the (70,4) (N) (T) or (71,4) (A) message from the PMS 
signals the end of the database synchronization procedure.
The Room Data Image feature message item fields are shown in Ta b l e 1 9
.
The name characters are ASCII and must be between 0x20 (space character) 
and 0x7e (tilda character) in value. If the name consists of less than 15 
characters, the name field must be left-justified by padding the remaining 
characters with the space (0x20) character. Table 19. Room Data Image Feature Message Item Fields
Fields Values
Room Station Number (RSN) Extension number
*Occupied/Vacant Status 0=Vacant, 1=Occupied
Message Waiting Lamp Status 0=Off, 1=On
Controlled Restriction Level Code See Table 13
Guest Name (T) (A) Name string
Coverage Path Number (T) (A) 1-xxxx*, 0xbbb or 0xbbbb
Voice Mail Password (future) FFFF (transparent)
sp sp sp sp (ASCII)
Voice Mail Language (future) FF (transparent)
sp sp (ASCII)
* Can also take null values as described below. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
74 Room Data Image 
The coverage path field in the room data image message for the transparent and 
ASCII PMS protocols consists of three or four BCD characters representing the 
thousands, hundreds, tens, and unit digits with the following valid values:
n0 — No coverage is provided for the RSN
n1-xxxx — Coverage path used (see the coverage path values on page 15)
n0xbbb or 0xbbbb — Coverage path value of the “Default Coverage Path for 
Client Rooms” field on the switch is used.
n0xfff or 0xffff — “Null” coverage path value used in room data image mes-
sage only to request coverage path value stored on the switch for an RSN.
There are two types of room messages: status request (process codes 1 and 3) 
and status response (process codes 2 and 4). If the switch receives a status 
request message, it appropriately processes the message and returns a status 
response message. Appropriate processing depends on the values received in 
the status fields of the status request message.
If a status request message with process code 1 is received at the switch for any 
field that is null (0xf in non-ASCII fields and 0x3f in all bytes of ASCII fields), the 
switch fills in the corresponding field in the status response message with the 
internal data associated with that field or a null if status is unavailable. For all 
fields that are non-null, the non-null value that was received is ignored, but is 
returned in the corresponding field of the response message. The status response 
message with process code 2 is then transmitted to the PMS.
If a status request message with process code 3 is received at the switch for any 
field that is null, the switch fills in the corresponding field in the status response 
with the data associated with that field or a null if status is unavailable. For all 
fields that are non-null, the switch will update its internal data with the received 
values, place a null in the corresponding field in the status response message, 
and transmit the response message with process code 4.
NOTE:
A field is reserved in the room image message for each status item possible 
in a data link configuration, even though not all the feature messages may 
be activated. The switch will ignore any request for status or implied change 
for any field for which normal status changes are not communicated. For 
instance, if the controlled restriction (15,x) (N), (35,x) (T), or (25,x) (A) fea-
ture message is not enabled in a particular data link configuration, the con-
trolled restriction field in the room image message is likewise inactive. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
75 Room Data Image 
Ta b l e 2 0 provides a listing of room image messages and the examples which 
follow show the typical use of the room image exchange.
Table 20. Data Field Interpretations for Room Data
Image Messages
Message DirectionStatus Field Specification
Null Non-Null
(17,1) (N)
(37,1) (T)
(27,1) (A)PMS to Switch Status request Ignored
(17,2) (N)
(37,2) (T)
(27,2) (A)Switch to PMS No status available Returned status
(17,3) (N)
(37,3) (T)
(27,3) (A)PMS to Switch Status request PMS status: switch should set 
its status
(17,4) (N)
(37,4) (T)
(27,4) (A)Switch  to  PMS Either no status available or 
status has been updatedSwitch status returned 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
76 Room Data Image 
Examples
Ta b l e 2 1 shows a sample informational request for a room, originated by the PMS. 
The switch shows the room with no message waiting, guest name “Smith,J” and 
coverage path 1. All feature messages except the controlled restriction 
communication are active.
Using the same system configuration used for the example above, the process 
code 3/process code 4 exchange for database update purposes would look like 
Ta b l e 2 2
.
The switch will set the status of the room to “occupied,” with the message waiting 
lamp on. Table 21. Informational Exchange
Originator MessageOccupied
/VacantMessage 
WaitingControlled 
RestrictionGuest
NameCall
Coverage
Path
PMS (37,1) (T)
(27,1) (A)1* Null NullNull† Null
Switch (37,2) (T)
(27,2) (A)1 0 Null‡ Smith, J§ 001
* The PMS must always provide the occupied/vacant status.
† A Null for a guest name field is 15 question mark characters (0x3f).
‡ The Controlled Restriction Communication was not enabled. Therefore, the switch
has no information available for request.
§ Remaining characters in this field will be padded with ASCII space (0x20).
Table 22. Room Synchronization Exchange
Originator MessageOccupied
/VacantMessage 
WaitingControlled
RestrictionGuest
NameCall
Coverage
Path
PMS (37,3) (T)
(27,3) (A)1* 1 Null Smith,J 001
Switch (37,4) (T)
(27,4) (A)Null Null Null† Null‡ Null
* The PMS must always provide the occupied/vacant status.
† The Controlled Restriction Communication was not enabled. Therefore, the switch
has no information available for request.
‡ A Null for a guest name field is 15 question mark characters (0x3f). 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
77 Room Data Image 
PMS Considerations for Process Code 3
Process code 3 sent from the PMS and the associated process code 4 sent from 
the switch constitutes an individual “room database exchange” for the purpose of 
updating a database after a detected failure.
Process code 3 provides a way for the PMS to send the switch the current valid 
data stored in the PMS, and to request the current valid data stored in the switch. 
This is done to force a database update during the recovery procedure after a 
failure.
The PMS should insert its current status values in the occupied/vacant field 
because the PMS is considered the “master.” The PMS is always considered the 
source for room occupied/vacant status. The master source for message waiting 
lamp status, controlled restriction status, guest names and coverage path number 
may vary based on a particular operating environment (T) (A). If the PMS wishes 
to receive the current switch data for message waiting lamp status, controlled 
restriction, and guest name or coverage path number (T) (A), the PMS must place 
nulls in the appropriate positional fields of the process code 3 message requesting 
switch response, if applicable.
Switch Actions Upon Receipt of Room Image
with Process Code 3
The switch will change its database to the passed values in the process code 3 
message from the PMS for non-null, active fields. Switch status will be returned in 
the null, active fields.
Switch processing is done in the following sequence:
1. Perform any implied occupied/vacant status change (see detailed descrip-
tion below).
2. Process individual status fields for message waiting lamp status, controlled 
restriction status, coverage path (T) (A), and guest name (T) (A).
3. Return status for any requested active fields. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
78 Room Data Image 
Vacant-to-occupied or occupied-to-vacant transitions as implied in the received 
process code 3 message will perform the corresponding check-in or check-out 
operations in the switch as follows:
nVacant-to-Occupied (PMS has occupied, switch has vacant)
1. The standard check-in operations for controlled restriction, with no 
status change of either the message waiting lamp status or wakeup 
status; the status of the RSN in the switch is set to Occupied; active 
fields in the process code 3 message for status items from the PMS 
will then override the switch status (for example, a non-null message 
lamp field will override switch status if the message waiting mes-
sage feature is active).
2. The process code 4 (room image recovery response) will then be 
sent to the PMS with switch status items supplied for the null fields 
(and ‘?’ fields for guest name characters) in the received process 
code 3 message (T) (A), and nulls in the received active fields.
nOccupied-to-Vacant (PMS Vacant, Switch Occupied)
1. The status of the RSN in the switch is set to Vacant.
2. Outward (or Toll) Restriction will be placed on the RSN.
3. Since the possibility exists that a manual check-in was done through 
the switch which may not have yet been entered in the PMS after a 
PMS failure, the wakeup and message waiting lamp status settings 
are not reset in the switch.
4. Any active fields in the received process code 3 message from the 
PMS for the indicated RSN will override the switch status.
5. The process code 4 message is returned to the PMS with nulls in 
the received active fields, and with data supplied in received null 
fields.
PMS Actions for Room Image Complement
Message (Process Code 4)
Process code 4 is sent from the switch to the PMS and provides the complement 
data image in response to the process code 3 image sent from the PMS. It is 
assumed that the PMS will update its status accordingly for the active fields 
returned from the switch.
Other Considerations
In ASCII Mode, the restriction level value is a 2-digit field. When the restriction 
level is sent to the PMS, it is sent as “digit-blank.” The switch can receive the 
restriction level in several different ways: 0-digit, digit-blank, or blank-digit.