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 
79 Room Change/Room Swap 
Room Change/Room Swap
The Room Change/Room Swap feature is used by the PMS to notify the switch 
that a Room Change or a Room Swap has been made between two rooms. A 
room change message will be transmitted to the switch when a guest in an occu-
pied room wishes to be moved to a different vacant room. A room swap message 
will be transmitted when guest status information is to be exchanged between two 
occupied rooms. It is expected that each Room Change/Room Swap performed in 
the PMS will immediately be transmitted to the switch. This feature message is 
provided to allow automatic wakeup entries, message waiting indicators for PMS 
activation, controlled restrictions, and room status to be assigned to the correct 
room. Also, guest names and coverage information will be assigned to the correct 
room (T) (A).
Although feature operations (for example, check-in and check-out) could be used 
to partially simulate this operation, the functions performed on the switch will not 
be exactly the same. For example, an Automatic Wakeup request is canceled 
automatically if a check-out/check-in sequence is used.
Feature Codes
The Room Change/Room Swap feature codes are as follows:
n20 — Normal mode
n30 — Transparent mode
n24/RMC — ASCII mode.
This feature message format is shown in Figure 20 on page 48
.
Process Codes
The process codes for the Room Change/Room Swap feature are shown in 
Ta b l e 2 3
.
Table 23. Room Change/Room Swap Process Codes
[Feature Codes 20 (N), 30 (T), or 24/RMC (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Room change to STAx from STFx [x=1-4 (N), or 1-5 (T) (A)].
2 PMS to Switch Room swap between STAx and STFx [x=1-4 (N), or 1-5 (T) 
(A)].
3 Switch to PMS Room change/swap performed but an error was detected in 
room status. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
80 Room Change/Room Swap 
Operational Considerations
Process code 1 is used for the room change message. When the message is 
received, the switch will transfer the automatic wakeup entry, do not disturb, PMS 
type message waiting, controlled restrictions, as well as guest name (T) (A), cov-
erage path, and voice mail from the old room to the new room. If the new room is 
not vacant (switch status “vacant”) or the old room is not occupied (switch status 
“occupied”), the switch will return the message with a process code of 3 indicating 
that the change was performed but the status states were inconsistent. The room 
change will effect the following status states:
nRoom Status - Change the old room in the switch to vacant and the new 
room to occupied.
nWakeup - Move the old room wakeup entry to the new room canceling any 
existing entry. If the old room has no entry, leave any existing entry for the 
new room intact.
nMessage Waiting - Turn on the message waiting for the new room if the old 
room or the new room has a message waiting on.
nControlled Restriction - Move the old room controlled restriction to the new 
room. If the old room is vacant with outward restriction (and Controlled Out-
ward Restriction active), the new room should have no restriction.
nReplace the coverage path number of the new room with the guest’s cover-
age path number and change the old room to the default path (T) (A). How-
ever, if the room state of the old and new rooms are not occupied and 
vacant, respectively, the coverage path is swapped instead. Thus, in the 
event of an error, repeating the operation returns the room to its original 
state.
nChange the guest name in the old room to the new room and blank out the 
guest name in the old room (T) (A). However, if the room state of the old 
and new rooms are not occupied and vacant, respectively, the name infor-
mation is swapped. Thus, in the event of an error, repeating the operation 
returns the room to its original state.
Process code 2 is used for the room swap message. When the message is 
received, the switch will swap the automatic wakeup entry, do not disturb, PMS 
type message waiting, controlled restrictions, as well as guest name (T) (A), 
coverage path, and voice mail between room 1 and room 2. Since normal change 
is from an occupied room to an occupied room, both rooms should be occupied. If 
other status states are present, the swap will be performed changing both rooms 
to the occupied state, with the exception that outward restriction in a vacant room 
will be changed to no restriction. The switch will also return the message with the 
process code of 3, indicating that the swap was done but the status states were 
inconsistent. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
81 Guest Information Input/Change 
Guest Information Input/Change
Guest Information Input/Change feature allows changes to or inputs of guest 
information (guest name and coverage path) after the check-in of the associated 
RSN has been completed. The message can be used to input a name and cover-
age path subsequent to check-in, change an incorrect guest name, and/or alter 
the coverage path number. See “Implementation Examples” starting on page 17
.
Feature Codes
The Guest Information Input/Change feature codes are as follows:
nThis feature code is not supported in normal mode
n38 — Transparent mode
n28/GIC — ASCII mode.
This feature message format is shown in Figure 21 on page 49
.
Process Codes
The process codes for the Guest Information Input/Change feature are shown in 
Ta b l e 2 4
.
Table 24. Guest Information Input/Charge Process Codes
[Feature Codes 38 (T) or 28/GIC (A)]
Process 
CodeMessage 
Direction Indications
1 PMS to Switch Change/Input the following guest name and coverage Path 
Number for RSN.
2 Switch to PMS Change/Input complete as requested for RSN.
3 Switch to PMS Change/Input received, no action taken, RSN vacant.
4 Switch to PMS Change/Input received, no action taken, information the 
same as that stored for RSN. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
82 Guest Information Input/Change 
Operational Considerations
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 charac-
ters, the name field must be left-justified by padding the remaining characters with 
the space (0x20) character. These characters may consist of “Unknown” or “To Be 
Decided” if the name is not known.
* When sending the Guest Information Input/
Change 38 (T) or 28 (A) message to alter a guest name or coverage path number, 
the PMS must send both the name and coverage number even if only one or the 
other is being changed/inputted.
One of three responses will be returned when the PMS sends a GI message to 
update or input the guest information. When the PMS sends the switch a process 
code 1 message, the switch will try to perform the input or change the information. 
If the change/input is successful, the switch will return a process code 2 message 
to the PMS. If the PMS sends a process code 1 message for an RSN that is 
vacant, the switch will acknowledge the receipt of the message with process 
code 3 to the PMS, but will not change any data for that RSN. If the PMS sends a 
process code 1 message for an RSN but the data stored within the switch for that 
RSN is the same as sent, the switch will return a process code 4 message 
acknowledging the receipt of the message without changes.
The coverage path field in the guest information input/change message for the 
transparent PMS protocol mode 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.
* This feature allows a property to preregister a guest without having to know the guest name. This is 
useful in those situations when a business (for example, an airline or a sports team) reserves rooms 
for employees without providing the actual employee name. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
83 Status Inquiry and Failure Management 
Status Inquiry and Failure 
Management
The Status Inquiry and Failure Management feature provides general data link 
maintenance activity.
NOTE:
See 
INTUITY Lodging Property Management System Interface Specifica-
tions
, (585-310-234) for information about troubleshooting the data link 
between the PMS and the INTUITY Lodging system.
Feature Codes
The Status Inquiry and Failure Management feature codes are as follows:
n70 (7A)— Normal mode
NOTE:
In Normal mode, feature code 70 is transmitted as 7A.
n70 — Transparent mode
n71/STS — ASCII mode.
This feature message format is shown in Figure 22 on page 50
. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
84 Status Inquiry and Failure Management 
Process Codes
The process codes for the Status Inquiry and Failure Management feature are 
shown in Ta b l e 2 5
.
Table 25. Status Inquiry and Failure Management Process
Codes [Feature Codes 70 (N) (T) or 71/STS (A)]
Process 
CodeMessage 
Direction Indications
F PMS to Switch Heartbeat message; must be issued by the PMS within 
every LIT interval and no more often than 500 ms.
0 Switch to PMSAcknowledgment of no operation (NOP) “are you there” 
message from the PMS, indicating that the switch has had 
no changes that were not communicated to the PMS and 
has not initialized. Note that while in the “normal mode” the 
process code 0 is encoded as an A in the message frame 
sent to PMS (see Figure 7
). This message will be sent only 
in response to a (70,F) (N) (T) or (71,F) (A) message from 
the PMS. 
1 Switch to PMS NOP acknowledgment indicating that at least one non-com-
municated change in the switch has occurred during a com-
munications failure; the PMS must initiate a database 
exchange.
2 Switch to PMS NOP acknowledgment indicating that the switch had failed 
and the status memory has been initialized; the PMS must 
initiate a database exchange. 
3 PMS to Switch Start of database room exchange; the PMS will be sending 
a room image message for each room requiring status syn-
chronization.
4 PMS to Switch End of database exchange.
5 Switch to PMS
or
PMS to SwitchRelease of the data link is requested for maintenance activ-
ity; process code 6 is confirmation.
6 Switch to PMS 
or 
PMS to SwitchRelease of the data link confirmed; all necessary actions 
have been taken. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
85 Status Inquiry and Failure Management 
Operational Considerations
The primary purpose of the Status Inquiry messages is to indicate to both systems 
whether the data link interface is “up” (capable of normal communications) or 
“down” (not capable of normal communications).
The general philosophy of data link failure recognition and subsequent recovery is 
based on the following points:
nEither system may recognize a failure as defined below and the switch may 
request or the PMS may initiate a database synchronization procedure (the 
room image exchange) once the physical link is reestablished.
nThe PMS system has control of when a database exchange will be initi-
ated, which RSNs will be included in the exchange, and which status items 
will be supplied to the switch for update for each room. However, after the 
switch requests a Database Swap (process code 1 or process code 2), the 
switch will not process other messages except Status Inquiry process code 
F until a process code 3 data swap begin message is sent by the PMS. The 
switch will acknowledge the message but will not change any stored infor-
mation. Also, the switch will continue to use process code 1 or process 
code 2 status inquiry messages until the PMS sends a process code 3 
database message.
nThe NOP Status Inquiry process code F message must be sent to the 
switch at an interval not sooner than every 500 ms and not more than the 
administered LIT parameter; the receipt of this message informs the switch 
that the PMS is operational in case no other traffic has been received, and 
also provides the switch the stimulus to inform the PMS if the switch has 
detected a failure (via returned process codes 1 or 2).
nThe LIT must be administered consistently between the PMS and the 
switch. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
86 Status Inquiry and Failure Management 
Recognition of Data Link Failure
Either system may recognize a loss of communication by one or more of the fol-
lowing occurrences:
nLack of traffic within the LIT interval. The switch recognizes this by lack of 
any message received from the PMS within the period. The PMS recog-
nizes it when it does not receive a process code 1, process code 2, or pro-
cess code 3 message within the LIT immediately following its transmittal of 
a process code F message.
nWhen the PMS drops DTR.
nWhen the switch drops DSR.
nOther conditions, such as unavailability of buffers or queuing capability, 
which result in an inability to communicate the status change message.
nDropping of data link for maintenance requested and confirmed.
A data link failure will necessitate a database room exchange recovery procedure 
if any implied status change cannot be communicated to the other system and 
cannot be queued for later transmission. Note that even with a detected data link 
failure, a database recovery exchange is not necessarily needed if there has been 
no implied status changes lost (not transmitted or queued).
In addition to the above data link failures, the switch keeps track of erroneous 
events and drops the link if the internal switch counter goes over 50. The counter 
is incremented by one for any of the following events and decremented by one 
whenever a good message is received from the PMS.
nA control character was received without a DLE in front of it.
nA noncontrol character was received outside of the STX/ETX frame.
nAn ETX was received when a message was not being received.
nAn ACK, ENQ, NAK, or STX was detected in the middle of a message.
nAn unexpected ACK, or NAK was received.
nThe PMS sent an STX before the switch acknowledged the last message.
nThe message text of an incoming message was less than two bytes.
nThe message count for a message was the same as for the last message.
nAn ACK/NAK was never received after ENQs were transmitted (and 
retransmitted).
nThe switch exceeded maximum retransmission of a message.
nThe BCC timer expired. 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
87 Status Inquiry and Failure Management 
Release of Data Link for Maintenance
(Process Codes 5, 6)
Either system may request a temporary release of the data link for maintenance 
purposes by transmitting a process code 5 Data Link Release Reason (RR) 
request message to the other system. The receiving system should perform any 
processing required and return the process code 6 Data Link Release Confirmed 
message as soon as possible. If process code 6 is not returned within 5 seconds, 
the sender will stop the protocol or bring down the link.
During switch maintenance, the PMS may continue to send process code F 
Status Inquiry messages, provided that EIA pin 6 (Data Set Ready) from the 
switch is in the “on” state. The switch will turn EIA pin 6 on and respond to process 
code F messages when maintenance is completed.
While the data link is released on request of the PMS, the switch will continue to 
attempt to read process code F messages from the PMS. EIA pin number 20 
(Data Terminal Ready) in the “off” state from the PMS will indicate that reads 
should not be attempted. When EIA pin 20 is on and a process code F message is 
received from the PMS, the switch will assume that PMS maintenance is over and 
communication can be resumed. However, if messages other than status inquiry 
messages are transmitted, the switch will ignore the messages and bring down 
the link if ten or more such messages are recorded.
The switch will attempt to send a process code 5 message when the test pms-
link long or busyout pms-link commands are issued on the administration 
terminal. If either the PMS or switch sends the message with a process code 5 to 
request the release of the data link, the release reason field is filled in as shown in 
Ta b l e 2 6
.
Table 26. Data Link Release Reason (RR) Codes
Reason
Code Indication
1 One flushed message
2 Excessive protocol violations
3 Excessive violation messages
4 Cannot receive messages
5 Craft demanded maintenance
6 System demanded maintenance
7 Ten protocol startup violations
F Reason code not provided/supported 
						

							DEFINITY ECS and GuestWorks Property Management System
Interface Specifications  555-231-601  Issue 2
December 1999
Feature Codes, Process Codes, and Operations 
88 Status Inquiry and Failure Management 
Switch Operations During Loss of
Communication
The switch will continue to support the basic telecommunications functions if the 
data link or PMS becomes unavailable. Upon detection of a data link failure, the 
switch will automatically switch to the “Link Failed Mode” to perform the following 
tasks:
nEnable the   and   buttons so that an attendant console 
or display telephone with console permissions can be used for check-in 
and check-out.
nJournal any dialed housekeeper/status information to the optional PMS log 
printer for manual entry (either now or later) into the PMS system (or return 
reorder tone to housekeeper status calls if the housekeeper PMS Log 
Printer is not available).
nLog events normally sent to the PMS in an audit trail, accessed by the list 
pms-down command.
nContinue to support basic telecommunications.
nContinued support of message waiting and/or controlled restriction.
The switch will continue to attempt to receive messages from the PMS during data 
link failure. If a message is received from the PMS with no missed status change 
communications within the switch, data link operation will resume normally with no 
database exchange requested by the switch. If during data link failure the switch 
processes a status change which normally would have been sent to the PMS, the 
switch sets itself to return a process code 1 response (process code 2 if the link 
failure was due to a switch restart) to all process code F messages received from 
the PMS until a process code 3 message is received (T) (A). The receipt of a 
process code 1 response from the switch to a process code F will indicate to the 
PMS that a database image exchange should be initiated for database 
synchronization (T) (A).
PMS Operations During Loss of Communication
During the loss of communication, it is expected that the PMS will continue to 
operate normally, accepting check-ins and check-outs, etc. The PMS can queue 
the changes which normally would be sent to the switch in anticipation of resum-
ing communication. These changes should be queued in such a way that order of 
receipt in the PMS will be maintained.
In the case where the PMS remains operational during a data link failure, the PMS 
should continue sending the process code F Status Inquiry message as long as 
the PMS is ready to resume communication.
Check InCheck Out