PROPERTY MANAGEMENT SYSTEM COMMUNICATION INTERFACE SPECIFICATION NEC America, Inc. NDA-30115-001 Revision 1.
LIABILITY DISCLAIMER NEC America reserves the right to change the specifications, functions, or features in this document at any time without notice. NEC America has prepared this document for use by its employees and customers. The information contained herein is the property of NEC America and shall not be reproduced without prior written approval from NEC America. Copyright 1999 NEC America, Inc.
Property Management System Communication Interface CONTENTS TABLE OF CONTENTS Page Chapter 1 - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Chapter 2 - Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Asynchronous Transmission. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Line Control Characteristics . . .
CONTENTS Property Management System Communication Interface Page Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Message Waiting Lamp Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MWL Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MWL Status . . . . . . . . . . . . . .
Property Management System Communication Interface CONTENTS Page Room Recovery (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Room Data Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Guest Room Secretary Telephone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Connecting Room . . . . . . . . . . . . . . . . . . . .
CONTENTS Property Management System Communication Interface Page Page iv NDA-30115 Revision 1.
Property Management System Communication Interface FIGURES LIST OF FIGURES Figure Title 2-1 2-2 2-3 2-4 2-5 2-6 2-7 4-1 4-2 4-3 4-4 4-5 4-6 4-7 4-8 4-9 4-10 4-11 4-12 4-13 4-14 4-15 4-16 4-17 4-18 4-19 4-20 4-21 4-22 4-23 4-24 4-25 4-26 4-27 4-28 4-29 4-30 4-31 4-32 4-33 4-34 4-35 4-36 4-37 4-38 4-39 Start Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 NEAX to PMS Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIGURES Property Management System Communication Interface Figure Title 4-40 4-41 4-42 4-43 4-44 4-45 4-46 4-47 4-48 4-49 4-50 4-51 4-52 4-53 4-54 4-55 4-56 4-57 4-58 4-59 A-1 B-1 B-2 B-3 B-4 B-5 B-6 B-7 B-8 B-9 Reservation Cancellation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Guest Name Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Room Data Change 90 . . . . . . . . . . . . . . . . . . . . .
Property Management System Communication Interface TABLES Table Title 2-1 2-2 2-3 2-4 2-5 2-6 2-7 2-8 2-9 2-10 B-1 B-2 B-3 Line Control Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Control Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Base Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Message Names .
TABLES Table Page viii Property Management System Communication Interface Title Page NDA-30115 Revision 1.
Property Management System - Communication Interface Chapter 1 Overview Overview This document is a description of the interface between the NEC NEAX2400 IMS (hereafter referred to as the NEAX) and the hotel’s Property Management System (PMS). This document contains almost all (see below) of the information specified in the NEAX2400 IMS Hotel System PMS Interface Specifications (document ND90265 (E) Issue 2), and is intended to replace it.
Overview Property Management System - Communication Interface This Page Left Blank. Page 2 NDA-30115 Revision 1.
Property Management System - Communication Interface Chapter 2 Architecture Architecture The PMS communicates with the NEAX over one or more serial cables. A maximum of three lines can be provided as data links between the NEAX and the PMS. The three lines are designated as Line 1, Line 2 and Line 3. Line 1 is used for Hotel Processing messages; Line 2 and Line 3 are used for Interactive messages.
Architecture Property Management System - Communication Interface Asynchronous Transmission Line Control Characteristics The characteristics of the signals transmitted across the communications link are as follows: Table 2-1 Line Control Characteristics Item Page 4 Conditions Control Method Contention method (point to point) Operating Mode Half duplex (if modems are used, set to full duplex) Synchronization Start-stop system Data Rate 1200, 2400 or 4800 bits/second (bps) Frame Contents ASCII
Property Management System - Communication Interface Architecture The control codes used for the message texts are: Table 2-2 Control Codes Control Code Hexadecimal Value Function STX 02 Indicates the start of a block. ETX 03 Indicates the end of a block. EOT 04 Indicates the end of transmission of a block or release of the data link by the sender. ENQ 05 Used to query other party for expected response.
Architecture Property Management System - Communication Interface The messages (but not the control codes or start sequence) sent between the NEAX and the PMS must have header and trailing sections as defined in the following format: 0 1 02H ‘1’ STX SA 2 3 ‘!’ ‘L’ UA EI 4 6 FTC 8 MSC 9 FC ... 03H xx Message ETX BCC Message Count Range Block Check Code Range Table 2-3 Base Message Format The message format breaks down as follows: • STX -- Start of text block. (One byte - 02H.
Property Management System - Communication Interface Architecture A Violation Code message will be sent to the PMS in the following cases: • When the message counter does not match the number of characters received. • When a station number not existing in the NEAX is specified in the message data from the PMS. • Upon receipt of an invalid Wake Up time (e.g. 25:00). Transmission Sequence The sequence of transmitting a message is slightly different for the PMS and NEAX.
Architecture Property Management System - Communication Interface From the NEAX to the PMS Send Receive Start Sequence Accept Send Message Receive Send Accept retry Reject Reject 1 retry 3 quit quit No Answer 2 retry No Answer 4 quit retry quit Contention Interrupt Interrupt Abort Query Abort Pause retry Pause Wait 1 second 1 - Retry is 3 times; quit on 4th Reject. 2 - Retry is 15 times; quit on 16th No Answer. 3 - Retry is 3 times; quit on 4th Reject.
Property Management System - Communication Interface Architecture From the PMS to the NEAX Send Receive Start Sequence Accept Send Message Receive Send Accept retry Reject Reject 3 quit No Answer No Answer 4 quit Query Contention 1 retry Interrupt continue Interrupt 2 Pause quit Pause Wait 1 second Wait 1 second 1 - Do not respond. Immediately cease send attempt and receive message from NEAX. 2 - Ignore Interrupt and send message if 8 messages in queue.
Architecture Property Management System - Communication Interface Timers The following timers are used to maintain data transmission: Sender Timer Upon sending a start sequence, message text or query, this timer begins counting and stops counting upon receiving a valid answer control code. This timer is set to one (1) second. If a timeout occurs after the transmission of a start sequence, a start sequence will be resent up to 15 times.
Property Management System - Communication Interface Architecture Table 2-5 Line Control Characteristics Item Conditions Control Method Contention method (point to point) Operating Mode Half duplex (if modems are used, set to full duplex) Synchronization Synchronous Data Rate 4800 or 9600 bits/second (bps) Frame Contents EBCDIC Error Control Method CRC-16 (X16 + X15 + X2 + 1) Bit Transmission Order Priority is given to low order bits Transmission Intervals At each data generation.
Architecture Property Management System - Communication Interface The control codes used for the message texts are: Table 2-6 Control Codes Control Code Page 12 Hexadecimal Value Function SYN 32 Synchronization code. STX 02 Indicates the start of a block. ETX 03 Indicates the end of a block. ENQ 2D Used as the start sequence code. It indicates a reception request to the other side and a request to answer an information block just sent.
Property Management System - Communication Interface Transmission Protocol Architecture The messages sent between the NEAX and the PMS must have header and trailing sections as defined in the following format: 55H 32H 32H 32H 02H 03H xx FFH PAD-LSYN SYN SYN STX Data ETX CRC PAD-T Cyclic Redundancy Check Area Figure 2-5 Base Message Format The elements of the message is as follows: • PAD-L -- The leading pad character. (One byte - 55H.) • SYN -- Synchronization character.
Architecture Property Management System - Communication Interface The message format breaks down as follows: • STX -- Start of text block. (One byte - 02H.) • SA -- System Address. (One byte - ‘1’ [31H].) • UA -- I/O Unit Address. (One byte - ‘!’ [21H].) • EI -- Entry Index. (One byte - ‘L’ [4CH].) • FTC -- Feature Code. (See below.) A list is provided in Appendix C, “Feature Codes”. • MSC -- Message Counter. This represents the length of the message.
Property Management System - Communication Interface Architecture Transmission Sequence Table 2-7 Data Transmission Sequence (1 of 2) ACK0/ ACK1 ENQ Neutral (A) a: ACK0 -> (B) b: NAK -> (A) c: ENQ -> (D) Waiting for STX (B) (ACK last received) -> (B) Waiting for ETX, CRC (C) f: NAK -> (B) g: EOT -> (A) Waiting for ACK after start sequence (D) f: ENQ -> (D) g: EOT -> (A) d: ENQ -> (D) e: EOT -> (A) d: ENQ -> (D) e: EOT -> (A) Message -> (E) j: EOT -> (A) f: ENQ -> (D) g: EOT -> (A) Waiting fo
Architecture Property Management System - Communication Interface Table 2-8 Data Transmission Sequence (2 of 2) Status EOT TTD WACK (Timeouts) Neutral (A) (Transmission Request) ENQ -> (D) Waiting for STX (B) -> (A) d: NAK -> (B) e: EOT -> (A) Waiting for ETX, CRC (C) -> (A) Waiting for ACK after start sequence (D) -> (A) d: ENQ -> (D) e: EOT -> (A) d: ENQ -> (D) e: EOT -> (A) f: ENQ -> (D) g: EOT -> (A) Waiting for ACK after message (E) -> (A) d: ENQ -> (D) e: EOT -> (A) d: ENQ -> (D
Property Management System - Communication Interface Timers and Counters Architecture Retransmission Counts Table 2-9 Retransmission Counts Meaning Count The number of retransmissions of the start sequence when there is no answer after transmitting the start sequence. 7 The number of retransmissions of the start sequence when NAK is received after transmitting the start sequence.
Architecture Property Management System - Communication Interface Cabling Considerations When the PMS is connected to the NEAX through a modem, the cables should just be “straight through” cables. There should be no crossing. When the PMS is directly connected to the NEAX, use the following pin assignments: NEAX Pin No. Signal Cable PMS Signal Pin No.
Property Management System - Communication Interface Chapter 3 Message Descriptions Message Descriptions There are several message groups: • Data Link Maintenance Messages • Maid Status • Message Waiting Lamp Control • Restriction Control • Check In/Check Out (Model 60) • Check In/Check Out (Model 90) • Wake Up/Group Announcement • Room Move/Swap/Copy (Model 60) • Room Data Change • Extension Report • Room Recovery (Model 60) • Room Recovery (Model 90) • Direct Data Entry (Model 90) • Extension Connectio
Message Descriptions Property Management System - Communication Interface • Recovery Start Report -- After receiving the Nop Test Recover Answer message, the PMS must download NEAX database information (see “Room Recovery (Model 60)” on page 27 and “Room Recovery (Model 90)” on page 28). This message notifies the NEAX of the incoming download. • Recovery End Report -- Reports to the NEAX that the PMS database download is complete.
Property Management System - Communication Interface Release for Maintenance Message Descriptions Either 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.
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.
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.
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.
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.
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.
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.
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.
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.
Message Descriptions Property Management System - Communication Interface This Page Left Blank. Page 30 NDA-30115 Revision 1.
Property Management System - Communication Interface Chapter 4 Message Formats Message Formats All messages sent between the NEAX and the PMS must have header and trailing sections as defined in the following format: 0 1 02H ‘1’ STX SA 2 3 ‘!’ ‘L’ ** ** EI FTC MSC UA 4 6 8 9 ** FC ... 03H xx Message ETX BCC Message Count Range Block Check Code Range ** Options defined below Figure 4-1 Base Message Format The message format breaks down as follows: • STX -- Start of text block.
Message Formats Property Management System - Communication Interface Note 3: In the case of messages that are almost identical, the FC will be marked with “**”. Also, differing FTC values will be marked with “*”. The final message is then constructed by simply inserting the desired FC value (and, if necessary, the desired FTC value). All messages in this section have been previously defined in NEAX2400 IMS Hotel System PMS Interface Specification (except for one Maid Status message, which is so noted).
Property Management System - Communication Interface Message Formats The format of all Data Link Maintenance messages are exactly as follows: 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘7’ ‘0’ ‘0’ UA EI FTC 8 ‘7’ MSC ** FC 9 11 Blank 2 12 03H xx ETX BCC ** Multiple Function Codes use this message. See below.
Message Formats Property Management System - Communication Interface • 51-7 -- Guest Room 7 (Model 90) Note: This message was not previously defined in NEAX2400 IMS Hotel System PMS Interface Specification. • 51-8 -- Negative Answer (Model 90) • 51-9 -- Positive Answer (Model 90) • 52-1 -- Administration 1 (Model 90) • 52-2 -- Administration 2 (Model 90) • 52-3 -- Administration 3 (Model 90) • 52-4 -- Administration 4 (Model 90) All messages designated “Model 90” are used only by the Model 90 version.
Property Management System - Communication Interface Message Formats Guest Room 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘5’ UA EI 6 ‘1’ ‘2’ FTC 21 6 ‘3’ MSC 27 LEN 8 9 15 ** Extension FC 6 Maid 6 28 03H xx ETX BCC ** Multiple Function Codes use this message. See below.
Message Formats Property Management System - Communication Interface Room Answer 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘5’ UA EI 6 ‘1’ ‘2’ FTC 22 ‘0’ MSC 23 Room Status 8 9 ** Extension FC 24 15 6 21 LEN 6 Request 1 25 Cleaning Status 03H xx 1 1 ETX BCC ** Multiple Function Codes use this message. See below.
Property Management System - Communication Interface Message Formats Administration 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘5’ UA EI 6 ‘2’ ‘2’ FTC 21 6 ‘3’ MSC 27 LEN 8 9 15 ** Extension FC 6 Maid 6 28 03H xx ETX BCC ** Multiple Function Codes use this message. See below.
Message Formats Property Management System - Communication Interface Message Waiting Lamp Control These messages are used to control the message waiting lamps on all of the phones. Messages sent by the PMS are commands to turn a message waiting lamp on or off. Messages sent by the NEAX are notification that a message waiting lamp has been turned on or off. This message group uses multiple Feature Codes.
Property Management System - Communication Interface Message Formats MWL Status 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘5’ UA EI 16 Option 1 6 8 ‘3’ ‘1’ ‘5’ FTC MSC 17 19 VMC 2 9 15 ‘1’ Extension FC 6 Status 1 20 03H xx ETX BCC Figure 4-8 MWL Status Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. • Status -- Message Waiting Lamp status.
Message Formats Property Management System - Communication Interface Restriction Control There are two messages. They are identical, except that message 15-1 is sent from the PMS to the NEAX, and message 15-2 is sent by the NEAX to the PMS. These messages simply communicate a new restriction code for an extension. These messages are used by both the Model 60 and the Model 90 version.
Property Management System - Communication Interface Message Formats 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. These messages are exclusively used by the Model 60 with the sole exception of Check Out Outgoing Call Report (16-C) which is also used by the Model 90 version.
Message Formats Property Management System - Communication Interface Check Out 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ UA EI FTC 8 ‘1’ MSC 9 15 16 ‘2’ Extension 03H xx FC 6 ETX BCC Figure 4-11 Check Out The only message field is the extension number who is being checked out. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. The Room Status is set to “Out” and Room Cut-Off is set.
Property Management System - Communication Interface Message Formats Check In 2 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ UA EI 16 FTC 17 Stay 8 ‘3’ MSC 9 15 ‘A’ Extension Language FC 6 1 18 03H xx ETX BCC 1 Figure 4-13 Check In 2 This causes the Room Status to be set to Stay and cancels Room Cut-Off. Message fields are: • Extension -- Extension number.
Message Formats Property Management System - Communication Interface Check In 3 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘1’ ‘6’ ‘3’ UA EI FTC 21 1 ‘4’ MSC 22 Language 8 Stay 1 9 15 ‘B’ Extension Group ID FC 6 6 23 38 Display Name 03H xx 15 39 ETX BCC Figure 4-14 Check In 3 This causes the Room Status to be set to Stay and cancels Room Cut-Off. Message fields are: • Extension -- Extension number.
Property Management System - Communication Interface Message Formats Check Out Outgoing Call Report 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ UA EI FTC 8 ‘1’ MSC 9 15 16 ‘C’ Extension 03H xx FC 6 ETX BCC Figure 4-15 Check Out Outgoing Call Report The only message field is the extension number who is being checked out. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Check In/Check Out (Model 90) The messages in this group are used exclusively by the Model 90 version. In addition to the following messages, the Check Out Outgoing Call Report message (16-C) is also used by the Model 90 version.
Property Management System - Communication Interface Message Formats • Cleaning Status-- Cleaning status. The possible combinations with room status are listed below: Room 1 1 1 1 2 2 Clean 0 1 2 3 0 1 Status of the Room Stay (Occupied) Stay, Cleaning in progress Stay, Cleaning ended Stay, Inspected Stay, Departure Day Stay, Departure Day, Cleaning in progress • Key -- Room key status: • 0 -- Key is in the key rack. • 1 -- Key is not in the key rack. • VIP -- VIP category: • 0 -- Guest is not a VIP.
Message Formats Property Management System - Communication Interface Check Out 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ UA EI 16 Cleaning Status 1 8 ‘4’ FTC MSC 17 18 Key 1 9 15 ‘2’ Extension FC 6 Room Status 1 19 03H xx ETX BCC Figure 4-18 Check Out When Cleaning Status is set to 0, 1, or 2, Room Cut Off is cancelled. Message fields are: • Extension -- Extension number.
Property Management System - Communication Interface Message Formats Check In Cancellation 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ UA EI FTC 8 ‘1’ MSC 9 15 16 ‘4’ Extension 03H xx FC 6 ETX BCC Figure 4-19 Check In Cancellation The only message field is the extension number that was previously checked in. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface • Cleaning Status -- Cleaning status. The possible combinations with room status are listed below: Room 1 1 1 1 2 2 Clean 0 1 2 3 0 1 Status of the Room Stay (Occupied) Stay, Cleaning in progress Stay, Cleaning ended Stay, Inspected Stay, Departure Day Stay, Departure Day, Cleaning in progress • Key -- Room key status: • 0 -- Key is in the key rack. • 1 -- Key is not in the key rack.
Property Management System - Communication Interface Message Formats • Key -- Old room key status: • 0 -- Key is in the key rack. • 1 -- Key is not in the key rack. • New Extension -- New extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. • Room Status 2 -- Room status of the new room. This flag is used in conjunction with the cleaning status flag to determine the status of the room.
Message Formats Property Management System - Communication Interface Provisional Check Out 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ UA EI FTC 8 ‘1’ MSC 9 15 16 ‘8’ Extension 03H xx FC 6 ETX BCC Figure 4-23 Provisional Check out The only message field is the extension number that has been provisionally checked out. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Wake Up/Group Announcement The Function Codes are as follows: • 19-1 -- Wake Up Setting (Sent by NEAX) • 19-2 -- Wake Up Cancellation (Sent by NEAX) • 19-3 -- Wake Up Execution Result • 19-4 -- Wake Up Setting (Sent by PMS) • 19-5 -- Wake Up Cancellation (Sent by PMS) • 19-6 -- Group Announcement Setting (Sent by NEAX) • 19-7 -- Group Announcement Cancellation (Sent by NEAX) • 19-8 -- Group Announcement Execution Result • 19-9 -- Group A
Message Formats Property Management System - Communication Interface Wake Up Cancellation (NEAX) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 6 ‘9’ ‘1’ FTC 20 Source 1 8 ‘6’ MSC 9 15 ‘2’ Extension FC 6 Blank 4 21 03H xx ETX BCC Figure 4-26 Wake Up Cancellation (NEAX) Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Wake Up Execution Result 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 6 20 Result 1 ‘9’ ‘1’ FTC 19 8 ‘6’ MSC 9 15 ‘3’ Extension FC 6 Time 4 21 03H xx ETX BCC Figure 4-27 Wake Up Execution Result Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Wake Up Setting (PMS) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 6 ‘9’ ‘1’ FTC 20 Source 1 8 ‘6’ MSC 9 15 ‘4’ Extension FC 6 Time 4 21 03H xx ETX BCC Figure 4-28 Wake Up Setting (PMS) Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Wake Up Cancellation (PMS) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 6 ‘9’ ‘1’ FTC 20 Source 1 8 ‘6’ MSC 9 15 ‘5’ Extension FC 6 Blank 4 21 03H xx ETX BCC Figure 4-29 Wake Up Cancellation (PMS) Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Group Announcement Setting (NEAX) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 Source 1 6 8 ‘9’ ‘1’ ‘7’ FTC MSC 20 21 Type 1 9 15 ‘6’ Group ID FC 6 Time 4 22 03H xx ETX BCC Figure 4-30 Group Announcement Setting (NEAX) Message fields are: • Group ID -- Group number to set. If the group number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Group Announcement Cancellation (NEAX) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 6 ‘9’ ‘1’ FTC 20 Source 1 8 ‘6’ MSC 9 15 ‘7’ Group ID FC 6 Blank 4 21 03H xx ETX BCC Figure 4-31 Group Announcement Cancellation (NEAX) Message fields are: • Group ID -- Group number to cancel. If the group number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Group Announcement Execution Result 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 6 8 ‘9’ ‘2’ ‘3’ FTC MSC 25 26 21 Time 4 Result 1 9 ‘8’ Extension Group ID FC 6 27 Type 1 15 6 28 03H xx ETX BCC Figure 4-32 Group Announcement Execution Result Message fields are: • Extension -- Extension number.
Property Management System - Communication Interface Message Formats Group Announcement Setting (PMS) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 Source 1 6 8 ‘9’ ‘1’ ‘7’ FTC MSC 20 21 Type 1 9 15 ‘9’ Group ID FC 6 Time 4 22 03H xx ETX BCC Figure 4-33 Group Announcement Setting (PMS) Message fields are: • Group ID -- Group number to set. If the group number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Group Announcement Cancellation (PMS) 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 19 6 ‘9’ ‘1’ FTC 20 Source 1 8 9 15 ‘6’ ‘A’ Group ID MSC FC 6 Blank 4 21 03H xx ETX BCC Figure 4-34 Group Announcement Cancellation (PMS) Message fields are: • Group ID -- Group number to cancel. If the group number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Room Move/Swap/Copy (Model 60) This message group is used exclusively by the Model 60 version. The Function Codes are: • 20-1 -- Room Move • 20-2 -- Room Swap • 20-5 -- Room Copy Room Move leaves the second extension’s maid status unchanged, cancels the second extension’s Room Cut-Off and sets all other data to that of the first extension.
Message Formats Property Management System - Communication Interface Room Data Change This message group uses multiple Feature Codes.
Property Management System - Communication Interface Message Formats Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. • Language -- Language category for the guest. The possible values are: • 0 -- Not specified • 1 -- Japanese • 2 -- English • 3 -- German • 4 -- French • 5 -- Spanish • 6 -- Chinese • 7 -- Russian. • Stay -- Room stay.
Message Formats Property Management System - Communication Interface Group Cancellation 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘2’ UA EI 6 8 ‘1’ ‘1’ FTC ‘7’ MSC 9 15 ‘3’ Extension FC 6 21 Zero 22 03H xx ETX BCC 6 Figure 4-38 Group Cancellation Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. • Zero -- Six zero (‘0’) characters.
Property Management System - Communication Interface Message Formats Guest Name Change 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘2’ UA EI 6 8 ‘1’ ‘2’ FTC 9 15 30 ‘6’ Extension Display Name ‘6’ MSC FC 6 31 03H xx ETX BCC 15 Figure 4-41 Guest Name Change Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. • Display Name -- The display name of the guest.
Message Formats Property Management System - Communication Interface • Room Status -- Room status. This flag is used in conjunction with the cleaning status flag to determine the status of the room. • Cleaning Status -- Cleaning status.
Property Management System - Communication Interface Message Formats Room Status Change 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘6’ UA EI 6 ‘1’ ‘1’ FTC 16 17 8 ‘3’ MSC 9 15 ‘3’ Extension FC 6 Room Status 1 18 Cleaning Status 03H xx 1 ETX BCC Figure 4-43 Room Status Change If Room Status is set to ‘0’ and Cleaning Status is set to either ‘3’ or ‘4’, the room data is cleared.
Message Formats Property Management System - Communication Interface Room Key Status Change 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘6’ UA EI 6 8 ‘1’ ‘1’ FTC ‘2’ MSC 9 15 ‘4’ Extension FC 16 Key 6 1 17 03H xx ETX BCC Figure 4-44 Room Key Status Change Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Extension Assignment Report 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ UA EI 16 6 ‘7’ ‘1’ FTC 17 Class 1 8 ‘3’ MSC 9 15 ‘F’ Extension FC 6 Def 1 18 03H xx ETX BCC Figure 4-46 Extension Assignment Report Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Room Recovery (Model 60) These messages are used by the PMS to update the database in the Model 60 version of the NEAX. First a Recovery Start Report (70-3) is sent. Then, one or more sets of Room Image messages are sent. Finally, a Recovery End Report (704) is sent. The messages are grouped into a set of four messages.
Property Management System - Communication Interface Message Formats Room Image Set 1 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘1’ ‘7’ UA EI 6 ‘2’ FTC 16 1 ‘8’ MSC 17 Status 8 1 15 ** Extension Vacancy FC 18 Code 9 Blank 14 6 32 1 33 03H xx ETX BCC ** Multiple Function Codes use this message. See below.
Message Formats Property Management System - Communication Interface Room Image Set 2 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ UA 17 EI FTC 18 ‘3’ MSC 19 Code Stay 1 1 22 8 23 Reserve 1 27 9 15 16 ** Extension Vacancy FC 6 1 20 21 Language Cleaning Status 1 Status 1 1 28 Wake Up Wake Up 03H xx Result Time 1 4 ETX BCC ** Multiple Function Codes use this message. See below.
Property Management System - Communication Interface Message Formats • Stay -- Room stay. The possible values are listed below: Stay 1 2 3 4 VIP No Yes No Yes Out No (Key is not in key rack.) No (Key is not in key rack.) Yes (Key is in key rack.) Yes (Key is in key rack.) • Reserve -- Reserve flag. Possible values are: • 0 -- Room is not reserved • 1 -- Room is reserved. • Language -- Language category for the guest.
Message Formats Property Management System - Communication Interface Room Image Set 3 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘1’ ‘7’ ‘3’ UA EI 17 FTC 18 Stay 1 1 27 Wake Up Time 4 ‘8’ MSC 19 Code 23 8 Reserve Blank 1 5 15 16 ** Extension Vacancy FC 6 1 Status 1 20 21 Language Cleaning Wake Up Status Result 1 32 9 1 38 6 1 42 Group ID Blank 2 4 22 1 43 03H xx ETX BCC ** Multiple Function Codes use this message. See below.
Property Management System - Communication Interface Message Formats • Stay -- Room stay. The possible values are listed below: Stay 1 2 3 4 VIP No Yes No Yes Out No (Key is not in key rack.) No (Key is not in key rack.) Yes (Key is in key rack.) Yes (Key is in key rack.) • Reserve -- Reserve flag. Possible values are: • 0 -- Room is not reserved • 1 -- Room is reserved. • Language -- Language category for the guest.
Message Formats Property Management System - Communication Interface Room Recovery (Model 90) These messages are only used by the Model 90. When the PMS receives a Nop Test Recover Answer (70-2) message, it sends one Room Data Report message for each room. Prior to sending any recovery messages, however, a Recovery Start Report (70-3) must first be sent. Recovery is concluded by sending a Recovery End Report (70-4).
Property Management System - Communication Interface Message Formats • Cleaning Status -- Cleaning status.
Message Formats Property Management System - Communication Interface Guest Room Secretary Telephone 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ UA EI FTC 8 ‘7’ MSC ‘3’ 9 15 Boss FC 21 Secty 6 6 22 03H xx ETX BCC Figure 4-51 Guest Room Secretary Telephone The message fields are: • Boss -- Extension number of the boss. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Property Management System - Communication Interface Message Formats Message Status Report 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ UA EI 16 Option 1 8 ‘5’ FTC MSC 17 19 VMC 2 9 15 ‘5’ Extension FC 6 Status 1 20 03H xx ETX BCC Figure 4-53 Message Status Report The message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface Wake Up 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ UA EI FTC 19 20 Blank 1 8 ‘6’ MSC 9 15 ‘6’ Extension FC 6 Time 4 21 03H xx ETX BCC Figure 4-54 Wake Up The message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters. • Time -- Time for which a wake up call is set.
Property Management System - Communication Interface Message Formats Direct Data Entry 0 1 02H ‘1’ STX SA 2 3 4 ‘!’ ‘L’ ‘5’ UA EI 6 ‘9’ ‘4’ FTC 45 6 ‘7’ MSC 51 LEN 8 9 15 ‘1’ Extension FC Numeric Input 6 30 52 03H xx ETX BCC Figure 4-55 Direct Data Entry • Extension -- Extension number. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface 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.
Property Management System - Communication Interface Message Formats Connecting Room Set 0 1 02H ‘1’ STX SA 2 3 4 6 ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ UA EI FTC 8 ‘7’ MSC ‘3’ 9 15 21 22 Master Secondary 03H xx FC 6 ETX BCC 6 Figure 4-58 Connecting Room Set The message fields are: • Master -- Extension number of the master extension. If the extension number is less than six digits, left justify the number and fill the remaining bytes with space (20H) characters.
Message Formats Property Management System - Communication Interface This Page Left Blank. Page 86 NDA-30115 Revision 1.
Property Management System - Communication Interface Chapter 5 References References The following document was used to prepare this specification: • NEAX2400 IMS Hotel System PMS Interface Specification (4252/4253/5250 Feature Package), ND-90265 (E) NDA-30115 Revision 1.
References Property Management System - Communication Interface This Page Left Blank. Page 88 NDA-30115 Revision 1.
Property Management System - Communication Interface Chapter 6 Glossary Glossary BCC EI ETX FC FTC MSC MWL NEAX PMS SA STX Suite Room UA Violation Code NDA-30115 Revision 1.0 Block Check Code. Computed by an exclusive OR of the message from the SA field to the ETX character, inclusive. This is used to assist in error control. Entry Index. Always ‘L’ for the PMS interface. End of Text. Special control character used to denote the end of a message block. Always 03H. Function Code.
Glossary Property Management System - Communication Interface This Page Left Blank. Page 90 NDA-30115 Revision 1.
Property Management System - Communication Interface Room Status Appendix A Room Status Normally, room status information is managed in the PMS. Whatever the room status may be, the NEAX operates according to the direction provided from the PMS. The NEAX processes calls within the range shown in Figure A-1 If the room status information provided from the PMS does not coincide with the status currently stored by the NEAX, a status closest to the room’s status defined in the NEAX will be designated.
Room Status Property Management System - Communication Interface Updating Room Status Information in the NEAX The messages containing room status information, sent from the PMS, are as follows: Check In: 16-1, 16-A, 16-B, 56-1 Check Out: 16-2, 56-2 Room Change: 20-1, 56-6 Room Data Image: 17-3, 17-7, 17-B Maid Status Answer: 51-9 Check In Cancel: 56-4 Room Data Change: 61-1 Room Status Change: 61-3 Check Out Cancel: 56-5 Recovery Room Data Report: 57-1.
Property Management System - Communication Interface Inspection End Room Status 3 2 1 Cleaning Start, Cleaning End and Inspection End each have separate feature access codes to be dialed.
Room Status Page A-4 Property Management System - Communication Interface NDA-30115 Revision 1.
Property Management System - Communication Interface PMS Line Failure Printouts Appendix B PMS Line Failure Printouts Normal Text This data is printed out on the Hospitality printer when the guest room information of the NEAX is processed according to a message from the PMS. More specifically, this data is printed out when the NEAX data is forcibly changed using a message from the PMS.
PMS Line Failure Printouts Property Management System - Communication Interface Table B-2 Wake Up Results Wake Up Results Explanation ATT ANSWER Attendant Console answers. ATT CALLED Attendant Console has been called. ATT CALLING: ROOM STA ANSWER While Attendant Console is calling, a guest room station has answered. ATT NO ANSWER: ROOM STA CALLED An Attendant Console has not answered, a guest room station has been called. ROOM STA BUSY A guest room station is currently on a call.
Property Management System - Communication Interface PMS Line Failure Printouts Table B-3 Types of Failure Failure Type Explanation I/O PKG NOT READY The I/O package is not mounted, or it is in the make-busy state. DR OFF/TX NOT RDY The data-ready has switched off during transmission. Does not become clear-to-send during transmission. SINQ STOP/S-120 The status inquiry message has stopped. LINE SUP. TIMEOUT The monitor timer of the transmission supervisory program timed out, then restarted.
PMS Line Failure Printouts Property Management System - Communication Interface 0/1 : RTS signal OFF/ON 0/1 : CTS signal OFF/ON 0/1 : DR signal OFF/ON 0/1 : CI signal OFF/ON Figure B-6 I/O Port Status 0/1 : For transmission FIFO FULL/blank 0/1 : For reception FIFO DATA absent/present 0/1 : For transmission FIFO DATA present/absent 0/1 : -/XOFF request (FIFO HALF FULL) 0/1 : -/parity error (terminal to IOC) 0/1 : -/overrun error (terminal to IOC) 0/1 : -/framing error (terminal to IOC) 0/1 : Port (PACKAGE
Property Management System - Communication Interface PMS Line Failure Printouts Transmission Failure When a message has failed to be transferred from the NEAX to the PMS, the following error message will be printed out. Entry Error: [XX-X] TRANSFER ERR XXXXXXXXXXXXXXXX... FTC-FC of message Message Data XX:XX Current Time Figure B-9 Transmission Failure Printout NDA-30115 Revision 1.
PMS Line Failure Printouts Property Management System - Communication Interface This Page Left Blank. Page B-6 NDA-30115 Revision 1.
Property Management System - Communication Interface Feature Codes Appendix C Feature Codes Feature Code NDA-30115 Revision 1.
Feature Codes Property Management System - Communication Interface This Page Left Blank. Page C-2 NDA-30115 Revision 1.
Property Management System - Communication Interface Function Codes Appendix D Function Codes FTC FC Description Source Model 70 0 Nop Test Normal Answer NEAX ALL 70 2 Nop Test Recover Answer NEAX ALL 70 3 Recovery Start Report PMS ALL 70 4 Recovery End Report PMS ALL 70 5 Data Link Release Request PMS/NEAX ALL 70 6 Data Link Release Confirmation PMS/NEAX ALL 70 8 Extension Number Request PMS ALL 70 F Nop Test PMS ALL 11 1 Cleaning Start (Guest) NEAX ALL 1
Function Codes Property Management System - Communication Interface FTC FC Description Source Model 13 4 MWL Off NEAX ALL 53 1 MWL Status PMS 90 53 2 MWL On (FDT) NEAX 90 53 3 MWL Off (FDT) NEAX 90 15 1 Restriction Control PMS ALL 15 2 Restriction Control NEAX ALL 16 1 Check In 1 PMS 60 16 2 Check Out PMS 60 16 5 Check Out MWL Off Report NEAX 60 16 6 Check Out MWL On Report NEAX 60 16 A Check In 2 PMS 60 16 B Check In 3 PMS 60 16 C Check O
Property Management System - Communication Interface FTC FC Description Function Codes Source Model 17 A Room Image Set 3 (Normal Answer) NEAX 60 17 B Room Image Set 3 (Recovery Request) PMS 60 17 C Room Image Set 3 (Recovery Answer) NEAX 60 57 1 Recovery - Room Data Report PMS 90 57 3 Recovery - Secretary Telephone PMS 90 57 4 Recovery - Connecting Room PMS 90 57 5 Recovery - Message Status Report PMS 90 57 6 Recovery - Wake Up PMS 90 19 1 Wake Up Setting N
Function Codes Property Management System - Communication Interface FTC FC Description Source Model 59 9 Direct Data Entry Positive Answer PMS 90 62 1 Guest Room Secretary Telephone PMS 90 62 2 Guest Room Secretary Telephone NEAX 90 62 3 Connecting Room Set PMS 90 62 4 Connecting Room Cancel PMS 90 Page D-4 NDA-30115 Revision 1.