NEC NDA-30115-001 - Manuals

NDA-30115 Revision 1.0 Page vii Property Management System Communication Interface TABLES Table Title Page 2-1 Line Control Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2-2 Control Codes . . . . . . . . . . . . . . . . . . . . . . . . . ...

NDA-30115 Revision 1.0 Page 1 Property Management System - Communication Interface Overview Chapter 1 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 alm...

Page 2 NDA-30115 Revision 1.0 Overview Property Management System - Communication Interface This Page Left Blank.

NDA-30115 Revision 1.0 Page 3 Property Management System - Communication Interface Architecture Chapter 2 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 designate...

Page 4 NDA-30115 Revision 1.0 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 Conditions ...

Page 6 NDA-30115 Revision 1.0 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: Table 2-3 Base Message Format The me...

NDA-30115 Revision 1.0 Page 7 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 sp...

Page 8 NDA-30115 Revision 1.0 Architecture Property Management System - Communication Interface From the NEAX to the PMS Figure 2-2 NEAX to PMS Protocol Start Sequence Accept Reject No Answer Contention Interrupt Abort Pause Message Accept Reject No Answer Interrupt Abort Pause End Code Wait 1 secon...

NDA-30115 Revision 1.0 Page 9 Property Management System - Communication Interface Architecture From the PMS to the NEAX Figure 2-3 PMS to NEAX protocol Start Sequence Accept Reject Contention Interrupt Pause Message Accept Reject No Answer Interrupt Pause End Code Wait 1 second Send Receive Receive...

Page 10 NDA-30115 Revision 1.0 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...

Page 12 NDA-30115 Revision 1.0 Architecture Property Management System - Communication Interface The control codes used for the message texts are: Table 2-6 Control Codes Control Code Hexadecimal Value Function SYN 32 Synchronization code. STX 02 Indicates the start of a block. ETX 03 Indicates the ...

NDA-30115 Revision 1.0 Page 13 Property Management System - Communication Interface Architecture Transmission Protocol The messages sent between the NEAX and the PMS must have header and trailing sections as defined in the following format: Figure 2-5 Base Message Format The elements of the message ...

NDA-30115 Revision 1.0 Page 19 Property Management System - Communication Interface Message Descriptions Chapter 3 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...

Page 20 NDA-30115 Revision 1.0 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 (Mode...

NDA-30115 Revision 1.0 Page 21 Property Management System - Communication Interface Message Descriptions Release for Maintenance 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 receiv...

Page 22 NDA-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 versio...

NDA-30115 Revision 1.0 Page 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. ...

NDA-30115 Revision 1.0 Page 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...

Page 26 NDA-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 onl...

NDA-30115 Revision 1.0 Page 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 t...

NDA-30115 Revision 1.0 Page 31 Property Management System - Communication Interface Message Formats Chapter 4 Message Formats All messages sent between the NEAX and the PMS must have header and trailing sections as defined in the following format: Figure 4-1 Base Message Format The message format br...

Page 32 NDA-30115 Revision 1.0 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 insertin...

NDA-30115 Revision 1.0 Page 33 Property Management System - Communication Interface Message Formats The format of all Data Link Maintenance messages are exactly as follows: Figure 4-2 Data Link Maintenance Message Format The message format breaks down as follows: • FC -- Function Codes that use this...

Page 34 NDA-30115 Revision 1.0 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...

NDA-30115 Revision 1.0 Page 35 Property Management System - Communication Interface Message Formats Guest Room Figure 4-4 Guest Room (General) Message fields are: • FC -- Function Codes that use this message format are: (FTC-FC) • 51-1 -- Guest Room 1 (Model 90) • 51-2 -- Guest Room 2 (Model 90) • 5...

Page 36 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Room Answer Figure 4-5 Room Answer (General) Message fields are: • FC -- Function Codes that use this message format are: (FTC-FN) • 51-8 -- Negative Answer (Model 90) • 51-9 -- Positive Answer (Model...

NDA-30115 Revision 1.0 Page 37 Property Management System - Communication Interface Message Formats Administration Figure 4-6 Administration (General) Message fields are: • FC -- Function Codes that use this message format are: (FTC-FC) • 52-1 -- Administration 1 (Model 90) • 52-2 -- Administration ...

Page 38 NDA-30115 Revision 1.0 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...

NDA-30115 Revision 1.0 Page 39 Property Management System - Communication Interface Message Formats MWL Status 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 (...

Page 40 NDA-30115 Revision 1.0 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 commun...

NDA-30115 Revision 1.0 Page 41 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...

Page 42 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Check Out 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...

NDA-30115 Revision 1.0 Page 43 Property Management System - Communication Interface Message Formats Check In 2 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. If the extension number is less than six ...

Page 44 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Check In 3 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. If the extension number is less than six ...

Page 46 NDA-30115 Revision 1.0 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 ...

NDA-30115 Revision 1.0 Page 47 Property Management System - Communication Interface Message Formats • Cleaning Status-- Cleaning status. The possible combinations with room status are listed below: • Key -- Room key status: • 0 -- Key is in the key rack. • 1 -- Key is not in the key rack. • VIP -- V...

Page 50 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface • Cleaning Status -- Cleaning status. The possible combinations with room status are listed below: • Key -- Room key status: • 0 -- Key is in the key rack. • 1 -- Key is not in the key rack. Room Chan...

NDA-30115 Revision 1.0 Page 53 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 U...

Page 54 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Wake Up Cancellation (NEAX) 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 fi...

NDA-30115 Revision 1.0 Page 55 Property Management System - Communication Interface Message Formats Wake Up Execution Result 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...

Page 56 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Wake Up Setting (PMS) 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 remai...

NDA-30115 Revision 1.0 Page 57 Property Management System - Communication Interface Message Formats Wake Up Cancellation (PMS) 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...

Page 58 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Group Announcement Setting (NEAX) 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 num...

NDA-30115 Revision 1.0 Page 59 Property Management System - Communication Interface Message Formats Group Announcement Cancellation (NEAX) 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 ju...

Page 60 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Group Announcement Execution Result Figure 4-32 Group Announcement Execution Result Message fields are: • Extension -- Extension number. If the extension number is less than six digits, left justify t...

NDA-30115 Revision 1.0 Page 63 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 ...

Page 64 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Room Data Change This message group uses multiple Feature Codes. The code pairs are as follows (first number is the Feature Code, second number is the Function Code): • 21-1 -- Room Data Change 60 (Mo...

NDA-30115 Revision 1.0 Page 65 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 -- La...

NDA-30115 Revision 1.0 Page 67 Property Management System - Communication Interface Message Formats Guest Name Change 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 byt...

Page 70 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Room Key Status Change 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 rem...

NDA-30115 Revision 1.0 Page 71 Property Management System - Communication Interface Message Formats Extension Assignment Report 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 fi...

NDA-30115 Revision 1.0 Page 73 Property Management System - Communication Interface Message Formats Room Image Set 1 Figure 4-47 Room Image Set 1 The message fields are: • FC -- Function Codes that use this message format are: (FTC-FC) • 17-1 -- Room Image Set 1 (Normal Request from PMS) • 17-2 -- R...

Page 74 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Room Image Set 2 Figure 4-48 Room Image Set 2 The message fields are: • FC -- Function Codes that use this message format are: (FTC-FC) • 17-5 -- Room Image Set 2 (Normal Request from PMS) • 17-6 -- R...

NDA-30115 Revision 1.0 Page 75 Property Management System - Communication Interface Message Formats • Stay -- Room stay. The possible values are listed below: • Reserve -- Reserve flag. Possible values are: • 0 -- Room is not reserved • 1 -- Room is reserved. • Language -- Language category for the ...

Page 76 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Room Image Set 3 Figure 4-49 Room Image Set 3 The message fields are: • FC -- Function Codes that use this message format are: (FTC-FC) • 17-9 -- Room Image Set 3 (Normal Request from PMS) • 17-A -- R...

Page 78 NDA-30115 Revision 1.0 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 sen...

Page 80 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Guest Room Secretary Telephone 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 ...

Page 82 NDA-30115 Revision 1.0 Message Formats Property Management System - Communication Interface Wake Up 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 (2...

NDA-30115 Revision 1.0 Page 83 Property Management System - Communication Interface Message Formats Direct Data Entry 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) ...

NDA-30115 Revision 1.0 Page 85 Property Management System - Communication Interface Message Formats Connecting Room Set 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 numb...

NDA-30115 Revision 1.0 Page 87 Property Management System - Communication Interface References Chapter 5 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.0 Page 89 Property Management System - Communication Interface Glossary Chapter 6 Glossary BCC 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. EI Entry Index. Always ‘L’ for ...

NDA-30115 Revision 1.0 Page A-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 cal...

Page A-2 NDA-30115 Revision 1.0 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, ...

NDA-30115 Revision 1.0 Page A-3 Property Management System - Communication Interface Room Status Inspection End 3 2 1 Cleaning Start, Cleaning End and Inspection End each have separate featureaccess codes to be dialed. Room Status and Cleaning Status When the status of the room is sent to the NEAX f...

NDA-30115 Revision 1.0 Page B-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 t...

Page B-2 NDA-30115 Revision 1.0 PMS Line Failure Printouts Property Management System - Communication Interface Abnormal Events When the NEAX receives a message from the PMS, and the received data is abnormal or it cannot be processed by the NEAX, the message is printed out. Figure B-3 Abnormal Even...

NDA-30115 Revision 1.0 Page B-3 Property Management System - Communication Interface PMS Line Failure Printouts Figure B-5 Port State 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-read...

NDA-30115 Revision 1.0 Page B-5 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. Figure B-9 Transmission Failure Printout Entry E...

NDA-30115 Revision 1.0 Page C-1 Property Management System - Communication Interface Feature Codes Appendix C Feature Codes Feature Code Description 70 Data Link Maintenance 11, 12, 51, 52 Maid Status 13, 53 Message Waiting Lamp Control 15 Restriction Control 16 Check-In/Out (Model 60) 56 Check-In/O...

NDA-30115 Revision 1.0 Page D-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...