NEC Property Management System Communication Interface Specification

							NDA-30115  Revision 1.0Page 21
Property Management System - Communication Interface Message Descriptions
Release for 
MaintenanceEither system may request a temporary release of the data link for maintenance 
purposes by transmitting a Data Link Release Request message to the other system. 
The receiving system will perform any necessary processing and return the Data 
Link Release Confirmation message as soon as possible.
During the NEAX maintenance, the PMS may continue to send Nop Test 
messages, provided that EIA pin 6 (Data Set Ready) from the NEAX is in the “on” 
condition. The NEAX will turn on the EIA pin 6 “on” and respond to Nop Test 
messages when maintenance is completed.
While the data link is release on request of the PMS, the NEAX will continue to 
attempt to read Nop Test messages from the PMS. The PMS may set EIA pin 20 
(Data Terminal Ready) to the “off” condition to indicate that reading should not be 
attempted.
When EIA pin 20 is in the “on” state and a Nop Test message is received from the 
PMS, the NEAX will assume that PMS maintenance has ended and that 
communication can be resumed.
NEAX Operations 
During Loss of 
CommunicationThe NEAX will continue to support the basic telecommunications functions if the 
data link or PMS become unavailable. Upon detection of a data link failure, the 
NEAX will automatically switch to the “Link Failed Mode” to perform the 
following tasks:
Enable Check In and Check Out on the Attendant Console and Front Desk 
Te r m i n a l .
Continue support of Message Waiting and/or Controlled Restriction if both 
features are active in the NEAX.
Recovery from 
Loss of 
CommunicationIn the event of a PMS failure, it is assumed that Check In and Check Out must be 
done manually and entered into the PMS system at a later time. The PMS should 
not resume transmission of the Nop Test message and attempt to reestablish 
communication until the database has been brought up to date. This prevents the 
transmission of incorrect data prematurely through the database recovery 
procedure.
In cases where the PMS has remained operational during a data link failure, the 
PMS will continue to attempt sending Nop Test messages. A Nop Test Answer 
message (either Normal or Recover) from the NEAX will indicate that 
communication has been reestablished.
A Nop Test Normal Answer message indicates that the NEAX has had no status 
change during the data link failure period and has automatically switched back to 
the normal operating mode of an active data link.
A Nop Test Recover Answer message indicates that the NEAX has failed and that 
status memory has been initialized for each room with the following:
Room Status is Occupied (Checked In),
Controlled Restriction Level is set to the preassigned restriction,
Message Waiting Lamps are off,
Wake Up times are cleared. 
						

							Page 22NDA-30115  Revision 1.0
Message Descriptions Property Management System - Communication Interface
Maid Status
These messages are used by the NEAX to communicate the actions of the cleaning 
personnel. If the message is designated “Model 90” then that message is only used 
by the Model 90 version. The other messages are used by both versions.
Cleaning Start (Guest)
Cleaning End (Guest)
Inspection End (Guest)
Out of Order (Guest)
Cleaning Start (Administration)
Cleaning End (Administration)
Inspection End (Administration)
Guest Room 1 (Model 90)
Guest Room 2 (Model 90)
Guest Room 3 (Model 90)
Guest Room 4 (Model 90)
Guest Room 5 (Model 90)
Guest Room 6 (Model 90)
Guest Room 7 (Model 90)
Note:
This message was not previously defined in NEAX2400 IMS Hotel System PMS 
Interface Specification.
Negative Answer (Model 90)
Positive Answer (Model 90)
Administration 1 (Model 90)
Administration 2 (Model 90)
Administration 3 (Model 90)
Administration 4 (Model 90)
For an expanded explanation of how the NEAX treats maid status information, 
refer to Appendix A, “Room Status”. 
						

							NDA-30115  Revision 1.0Page 23
Property Management System - Communication Interface Message Descriptions
Message Waiting Lamp Control
These messages are used to control the message waiting lamp on an extension. The 
message waiting lamp is used to notify a guest about the existence of text messages. 
If the message is designated “Model 90” then that message is only used by the 
Model 90 version. The other messages are used by both versions.
When the NEAX is configured to use the suite room feature, the primary extension 
represents all extensions in that suite. Therefore, a message set to the primary 
extension controls the message waiting lamps on all extensions in that suite.
MWL On -- This message is sent by the PMS to turn on a message waiting lamp.
MWL Off -- This message is sent by the PMS to turn off a message waiting 
lamp.
MWL On -- This message is sent by the NEAX to notify the PMS that a 
message waiting lamp has been turned on.
MWL Off -- This message is sent by the NEAX to notify the PMS that a 
message waiting lamp has been turned off.
MWL Status -- This message is sent by the PMS. (Model 90)
MWL On (FDT) -- This message is sent by the NEAX to notify the PMS that a 
message waiting lamp has been turned on by the front desk. (Model 90)
MWL Off (FDT) -- This message is sent by the NEAX to notify the PMS that a 
message waiting lamp has been turned off by the front desk. (Model 90)
Restriction Control
There are two messages. They are identical except that one is originated by the 
PMS, the other by the NEAX. Each message simply transmits the restriction code. 
Both the Model 60 and the Model 90 version use these messages.
Check In/Check Out (Model 60)
These messages do not represent unique features as such, but are a convenient tool 
for activating a sequence of functions commonly performed when a guest checks 
in or out of a room. With one exception, all of these messages are used exclusively 
for Model 60. The sole exception is Check Out Outgoing Call Report, which is also 
used by Model 90.
When the NEAX is configured to use the suite room feature, the primary extension 
represents all extensions in that suite. Therefore, a message set to the primary 
extension controls the status of all extensions in that suite.
Check In 1 -- Sets the Room Status to Stay and cancels Room Cut-Off. This 
message is sent by the PMS. This message should not be used. Use Check In 3 
instead.
Check Out -- Sets the Room Status to Out and sets Room Cut-Off. This message 
is sent by the PMS. 
						

							Page 24NDA-30115  Revision 1.0
Message Descriptions Property Management System - Communication Interface
Check Out Message Waiting Lamp Off Report -- This message is sent by the 
NEAX to report that the Message Category “Front” of that specific guest room 
is Off.
Check Out Message Waiting Lamp On Report -- This message is sent by the 
NEAX to report that the Message Category “Front” of that specific guest room 
is On.
Check In 2 -- Same as Check In 1, but also sets the Language and Room Stay. 
This message should not be used. Use Check In 3 instead.
Check In 3 -- Same as Check In 2, but also sets the Guest Name and Group 
Number.
Check Out Outgoing Call Report -- The NEAX sends this message if, after 
receiving a check out message from the PMS, it determines that the guest 
extension is engaged in an outgoing call.
Check Out Message Waiting Report -- This message is generated by the NEAX 
to report the status of waiting messages.
Check In/Check Out (Model 90)
These messages do not represent unique features as such, but are a convenient tool 
for activating a sequence of functions commonly performed when a guest checks 
in or out of a room. All of these messages are used exclusively for Model 90. There 
is also the addition of the Check Out Outgoing Call Report message which is 
technically a Model 60 message, but is available for Model 90.
When the NEAX is configured to use the suite room feature, the primary extension 
represents all extensions in that suite. Therefore, a message set to the primary 
extension controls the status of all extensions in that suite.
Check In -- This message is sent by the PMS to notify the NEAX of a check in. 
This cancels Room Cut-Off.
Check Out -- This message is sent by the PMS to notify the NEAX of a check 
out.
Check In Cancellation -- This message is sent by the PMS. It cancels a 
previously sent check in message. The room status is set to “Va c a n t .”
Check Out Cancellation -- This message is sent by the PMS. It cancels a 
previously sent check out message. Under some circumstances the NEAX may 
fail to perform this function which means that the guest must be checked in 
again.
Room Change -- This message is sent by the PMS to notify the NEAX of a guest 
room change.
Provisional Check In -- This is a provisional check in message generated by the 
NEAX. The room status is set to “Stay” and Room Cut-Off is cancelled.
Provisional Check Out -- This is a provisional check out message generated by 
the NEAX. If maid status is not performed, room status is set to “Vacant;” if 
maid status is performed, room status is set to “Out.”
Check Out Message Waiting Report -- This message is generated by the NEAX 
upon receiving a check out message to report the status of waiting messages. 
						

							NDA-30115  Revision 1.0Page 25
Property Management System - Communication Interface Message Descriptions
Wake Up/Group Announcement
These messages allow for the management of wake up calls and group 
announcements. Both the Model 60 and the Model 90 version use these messages.
Wake Up Setting (NEAX) -- This message is sent by the NEAX to notify the 
PMS that a wake up call has been set.
Wake Up Cancellation (NEAX) -- This message is sent by the NEAX to notify 
the PMS that a wake up call has been cancelled.
Wake Up Execution Result -- This message is sent by the NEAX to report the 
results of the wake up call.
Wake Up Setting(PMS) -- This message is sent by the PMS to set a wake up call.
Wake Up Cancellation (PMS) -- This message is sent by the PMS to cancel a 
wake up call.
Group Announcement Setting (NEAX) -- This message is sent by the NEAX to 
notify the PMS that a group announcement has been set.
Group Announcement Cancellation (NEAX) -- This message is sent by the 
NEAX to notify the PMS that a group announcement has been cancelled.
Group Announcement Execution Result -- This message is sent by the NEAX 
to report the results of a group announcement.
Group Announcement Setting (PMS) -- This message is sent by the PMS to set 
a group announcement.
Group Announcement Cancellation (PMS) -- This message is sent by the PMS 
to cancel a group announcement.
Room Move/Swap/Copy (Model 60)
These messages are used to transfer room information. All of these messages are 
used exclusively for Model 60. The messages are:
Room Move -- This takes the data for one room and moves it to another room. 
This will leave the second extension’s maid status unchanged, cancels Room 
Cut-Off and sets all other data to that of the first extension. The first extension’s 
maid status is set to ‘1’, Room Cut-Off is set, Do Not Disturb and Message 
Waiting is reset, Wake Up is cancelled, Language is set to “Undefined” and 
Guest Name and Group Number are cleared.
Room Swap -- This takes the data for one room and moves it to another room, 
while taking the other room’s data and moving it to the first room.
Room Copy -- This exactly copies the data for one room to another room 
without changing the data for the first room. The PMS should take care to be 
consistent in the manner in which this message is used. If the PMS sends a 
Room Copy message after check in, it should send a Room Copy message after 
check out. 
						

							Page 26NDA-30115  Revision 1.0
Message Descriptions Property Management System - Communication Interface
Room Data Change
These messages are used to change the room information while a guest is still 
checked in. Messages designated “Model 60” are only used by the Model 60 
version; “Model 90” are only used by the Model 90 version. Messages with neither 
designation may be used by either version. The messages are as follows:
Room Data Change 60 -- This is used to change room data after check in. This 
message is sent by the PMS. (Model 60)
Group Formation -- This is used when adding a guest to a group or changing a 
guest’s group after check in. This message is sent by the PMS.
Group Cancellation -- This is used to remove a guest from a group after check 
in. This message is sent by the PMS.
Reservation Setting -- This is used to set reservation for a guest room. The 
reservation information is cleared by check in processing or when the room 
status becomes “Va c a n t” or “Out of Order”. (Model 60)
Reservation Cancellation -- This cancels guest room reservation. (Model 60)
Guest Name Change -- This is used to change the guest name after check in. 
This message is sent by the PMS. (Model 60)
Room Data Change 90 -- This is used to change room data after check in. This 
message is sent by the PMS. (Model 90)
Room Status Change -- This is used to change the room status and/or the 
cleaning status of the room after check in. This message is sent by the PMS. 
(Model 90)
Room Key Status Change -- This is used to change the room key status after 
check in. This message is sent by the PMS. (Model 90)
Extension Report
These messages are used by the NEAX to report to the PMS when an extension has 
been removed or a new extension has been added. Both the Model 60 and the 
Model 90 version use these messages. 
						

							NDA-30115  Revision 1.0Page 27
Property Management System - Communication Interface Message Descriptions
Room Recovery (Model 60)
These messages are used by the PMS to update the database in the Model 60 
version. These messages will usually only be sent if requested by the NEAX using 
the Nop Test Recover Answer message. However, the PMS may, if necessary, 
initiate a recovery with a direct request from the NEAX.
Before any recovery messages can be sent, the PMS must first send a Recovery 
Start Report message. After all information about rooms has been sent by recovery 
messages, a Recovery End Report message must be sent. Both of these messages 
are defined in the Data Link Maintenance section.
The recovery messages are grouped into three sets of four messages. Within each 
set of four messages, the format of the messages is identical, except for the 
Function Codes, which specify the message. Each set of messages contains more 
fields (and can therefore convey more information) than the preceding set.
Each set of four messages is composed of two pairs of messages. The PMS must 
use the same set of recovery messages during the recovery period. The first pair of 
messages is used when the PMS, in normal operation (i.e. not error recovery), 
needs to update the information on a given extension. The second pair of messages 
is used during recovery. This pair will only be used in response to the NEAX 
sending a Nop Test Recover Answer or Recovery Request message.
The first message (of either pair) is used by the PMS as an update/ request for 
information on an extension. If a field contains a valid entry, the NEAX database 
is updated; if the field is entirely filled with NULL (00H) characters, it is a request 
for the NEAX to send the value from the NEAX database. The second message is 
the response from the NEAX to the PMS.
Room Image Set 1 -- Contains the following fields: Extension, Vacancy, MWL 
and Restriction Level.
Room Image Set 2 -- In addition to the above fields, the following are added: 
Room Stay, Reserve, Language, Cleaning Status and Wake Up.
Room Image Set 3 -- In addition to the above fields, Group Number and Group 
Announcement are added. 
						

							Page 28NDA-30115  Revision 1.0
Message Descriptions Property Management System - Communication Interface
Room Recovery (Model 90)
These messages are used by the PMS to update the database in the Model 90 
version after a failure recovery. These messages will usually only be sent if 
requested by the NEAX using the Nop Test Recover Answer message. However, 
the PMS may, if necessary, initiate a recovery with a direct request from the 
NEAX.
Before any recovery messages can be sent, the PMS must first send a Recovery 
Start Report message. After all information about rooms has been sent by recovery 
messages, a Recovery End Report message must be sent. Both of these messages 
are defined in the Data Link Maintenance section.
Room Data Report -- Once Recovery has been requested by the NEAX, the 
PMS uses this message to report the data for each room.
Guest Room Secretary Telephone -- This message is used to recover data for a 
secretary telephone.
Connecting Room -- If any rooms are connecting, this message is used to 
establish the relationship.
Message Status Report -- This reports the status of the Message Waiting Lamp.
Wake Up -- Any wake up data is reported by this message.
Direct Data Entry (Model 90)
These messages are used to send numeric information from the NEAX to the PMS. 
An employee provides this information by entering an access code at a guest room 
telephone. Then the NEAX captures all numeric input following the access code 
and sends the digits to the PMS.
The NEAX expects to receive a response to this message within 30 seconds. If no 
response is sent, or a Negative Answer is received, a reorder tone will be heard. If 
a Positive Answer is received, the NEAX will recognize that the information has 
been entered successfully and the service set tone will be heard.
Direct Data Entry -- This message is sent by the NEAX and contains the 
numeric information entered at the guest room telephone.
Direct Data Entry Negative Answer -- This message is sent by the PMS to notify 
the NEAX that the numeric data sent from the specified guest room telephone 
has been rejected.
Direct Data Entry Positive Answer -- This message is sent by the PMS to notify 
the NEAX that the numeric data sent from the specified guest room telephone 
has been accepted. 
						

							NDA-30115  Revision 1.0Page 29
Property Management System - Communication Interface Message Descriptions
Extension Connection
These messages are used to associate extensions. This association will be either in 
the form of a Boss/Secretary or of a Master/Secondary. In either case, both of the 
rooms to be connected must be checked in. There may only be one Secretary for 
each Boss, but a Secretary may be assigned to multiple Bosses. A Master and 
Secondary may only be assigned on a one to one basis. The effect of the Boss/
Secretary association is that whenever the Boss extension is called, only the 
Secretary extension will ring. In the case of Master/Secondary, whenever the 
Master extension is called, both the Master extension and the Secondary extension 
will ring. All of these messages are used exclusively for Model 90.
Guest Room Secretary Telephone (PMS) -- This message is sent by the PMS to 
set or cancel the guest room telephone.
Guest Room Secretary Telephone (NEAX) -- This message is sent by the 
NEAX to notify the PMS that a guest room secretary telephone has been set or 
cancelled.
Connecting Room Set -- This message is sent by the PMS to connect a main 
room with a sub room. This message should only be sent after both rooms have 
been checked in.
Connecting Room Cancel -- This message is sent by the PMS to cancel a room 
connection. 
						

							Message Descriptions Property Management System - Communication Interface
Page 30NDA-30115  Revision 1.0
This Page Left Blank.