NEC NDA-30115-001 manual Room Recovery Model

Page 37

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.

NDA-30115 Revision 1.0

Page 27

Image 37

Contents NEC America, Inc Property Management SystemLiability Disclaimer Table of Contents NDA-30115 Revision Contents Contents List of Figures FIGURESProperty Management System Communication Interface Tables Title Chapter Overview This Page Left Blank Chapter Architecture Asynchronous Transmission CharacteristicsLine Control ‘1’ ‘!’ 05H Transmission ProtocolMessage Count Range Block Check Code Range 02H ‘1’ ‘!’ ‘L’ 03HTransmission Sequence Sequence From the Neax to the PMSFrom the PMS to the Neax Sender Timer TimersCabling Considerations Receiver Timer Bisynchronous BSC TransmissionEbcdic STX SYNETX ACK0Protocol TransmissionNDA-30115 Revision STX B Neutral a ACK0 NAK ENQ Waiting for ACK lastReceived Waiting for NAK ACK0/1 ETX, CRC25 sec EOT Waiting for EOT a Neutral a ENQ D Waiting for NAK EOT aTimer Values Timers Retransmission Counts CountersCabling Considerations Pin No Signal Cable 20 ER 24 ST1ST2 ST1 Message Descriptions Data Link MaintenanceNDA-30115 Revision NDA-30115 Revision Maid Status Restriction Control Message Waiting Lamp ControlCheck In/Check Out Model Check In/Check Out Model Room Move/Swap/Copy Model Wake Up/Group AnnouncementExtension Report Room Data ChangeRoom Recovery Model Direct Data Entry Model Extension Connection This Page Left Blank Message Formats Data Link Maintenance Multiple Function Codes use this message. See below 02H ‘1’ ‘!’ ‘L’ ‘7’ ‘0’ ‘0’ ‘7’ Blank 03H02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ Extension Maid 03H Cleaning02H ‘1’ ‘!’ ‘L’ ‘5’ ‘1’ ‘2’ ‘3’ Extension Maid Guest RoomLEN Room Answer Room Status Cleaning 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘1’ ‘2’ ‘0’ Extension Request02H ‘1’ ‘!’ ‘L’ ‘5’ ‘2’ ‘2’ ‘3’ Extension Maid Administration02H ‘1’ ‘!’ ‘L’ ‘3’ ‘1’ ‘1’ Extension 03H MWL Control02H ‘1’ ‘!’ ‘L’ ‘5’ ‘3’ ‘1’ ‘5’ ‘1’ Extension Status MWL StatusOption VMCBlank 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘5’ ‘1’ ‘4’ Extension Code02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ Extension 03H Check02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ ‘2’ Extension 03H Check OutCheck Out Message Report VIP Language Stay Display Name 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘3’ ‘4’ ‘B’ Extension Group ID02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘1’ ‘C’ Extension 03H Check Out Outgoing Call ReportCheck Out Message Waiting Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘6’ ‘1’ ‘3’ ‘D’ Extension StatusLanguage Display Name Data a Data B 03H Cleaning Status KeyNDA-30115 Revision 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘4’ ‘2’ Extension Room Status Cleaning Status Key 03HCheck Out Cancellation Check CancellationRoom Status Cleaning Key 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘4’ Extension 03HRoom Change Key New Extension Room Status Cleaning Status 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘7’ Extension 03H Provisional Check02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘1’ ‘8’ Extension 03H Provisional Check Out02H ‘1’ ‘!’ ‘L’ ‘5’ ‘6’ ‘1’ ‘5’ ‘9’ Extension Status 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘1’ Extension Time Wake Up Setting NeaxSource 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘2’ Extension Blank Wake Up Cancellation Neax02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘3’ Extension Time Wake Up Execution ResultResult 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘4’ Extension Time Wake Up Setting PMS02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘5’ Extension Blank Wake Up Cancellation PMS02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘7’ ‘6’ Group ID Time Group Announcement Setting NeaxSource Type 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘7’ Group ID Blank Group Announcement Cancellation Neax02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘2’ ‘3’ ‘8’ Extension Group ID Group Announcement Execution ResultTime Result Type 03H 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘7’ ‘9’ Group ID Time Group Announcement Setting PMS02H ‘1’ ‘!’ ‘L’ ‘1’ ‘9’ ‘1’ ‘6’ ‘A’ Group ID Blank Group Announcement Cancellation PMS35 Room Move/Swap/Copy Message fields are02H ‘1’ ‘!’ ‘L’ ‘2’ ‘1’ ‘1’ ‘3’ ‘1’ Extension Language Room Data Change02H ‘1’ ‘!’ ‘L’ ‘2’ ‘1’ ‘1’ ‘7’ Extension Group ID 03H Group FormationReservation Setting Group CancellationReservation Cancellation 41 Guest Name Change Guest Name ChangeNDA-30115 Revision Room Status Change Cleaning Status 03H02H ‘1’ ‘!’ ‘L’ ‘6’ ‘1’ ‘1’ ‘3’ ‘3’ Extension Room Status 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘1’ ‘1’ ‘2’ ‘4’ Extension Key 03H Room Key Status ChangeExtension Delete Report 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘1’ ‘3’ ‘E’ Extension Blank 03H02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘1’ ‘3’ ‘F’ Extension Def Extension Assignment ReportClass 03H Room Recovery Model 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ ‘8’ Extension Vacancy Room Image SetStatus Code Blank 03H 48 Room Image Set 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘2’ ‘3’ Extension Vacancy StatusVIP 49 Room Image Set 02H ‘1’ ‘!’ ‘L’ ‘1’ ‘7’ ‘3’ ‘8’ Extension VacancyVIP 50 Room Data Report Room Data ReportNDA-30115 Revision Guest Room Secretary Telephone Connecting Room02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘7’ ‘3’ Boss Secty 03H 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘7’ ‘4’ Master Secondary 03H02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘5’ ‘5’ Extension Status Message Status Report02H ‘1’ ‘!’ ‘L’ ‘5’ ‘7’ ‘1’ ‘6’ ‘6’ Extension Time Wake Up02H ‘1’ ‘!’ ‘L’ ‘5’ ‘9’ ‘4’ ‘7’ ‘1’ Extension Numeric Input Direct Data EntryDirect Data Entry Answer 02H ‘1’ ‘!’ ‘L’ ‘5’ ‘9’ ‘1’ ‘7’ Extension57 Guest Room Secretary Telephone 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘7’ Boss Secty 03HConnecting Room Cancel Connecting Room Set02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘7’ ‘3’ Master Secondary 03H 02H ‘1’ ‘!’ ‘L’ ‘6’ ‘2’ ‘1’ ‘1’ ‘4’ Master 03HThis Page Left Blank Chapter References This Page Left Blank BCC Chapter GlossaryGlossary Property Management System Communication Interface Appendix a Room Status Clearing Room Data Updating Room Status Information in the NeaxDial Steps for Maid Status Room Data Setting and Clearing in the Neax Room Status and Cleaning StatusStatus of Check Out A-4 NDA-30115 Revision Normal Text Appendix B PMS Line Failure PrintoutsAbnormal Port Abnormal EventsPKG not Ready Line SUP. TimeoutDR OFF/TX not RDY Sinq STOP/S-120Figure B-6 I/O Port Status FC of message Message Data Current Time Transmission FailureB-6 NDA-30115 Revision Data Link Maintenance Appendix C Feature CodesC-2 NDA-30115 Revision Neax ALL Appendix D Function CodesPMS ALL PMS/NEAX ALLCheck Out Cancellation Check In CancellationRoom Image Set 1 Recovery Request Room Image Set 1 Recovery AnswerRoom Image Set 3 Recovery Answer Room Image Set 3 Recovery RequestRecovery Room Data Report Recovery Secretary TelephoneConnecting Room Cancel Connecting Room SetDirect Data Entry Positive Answer Guest Room Secretary Telephone