NEC NDA-30115-001 manual

PR OPER TY MANA GEMENT SYSTEM COMMUNICA TION I NTERF A CE SPECIFI CA TION NEC A merica, Inc. ND A-3011 5-001 Re vision 1.0 J une, 19 98 Stock # 24 17 27[...]

LIAB ILITY DISCLA IMER NEC America r eserv es the righ t to change the specif ications, funct ions, or feat ures in thi s document at an y time without noti ce. NEC America has prep ared this document for u se by i ts employe es and cust omers. The informat ion conta ined herein i s the pro perty of NEC Ame rica and shal l not be re produced wi tho[...]

NDA-3011 5Revision 1.0 Page i Pr operty Ma nagement System Communication Inte rface CONTENTS TABLE OF CONTENTS Page Chapter 1 - Ove rview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Chapter 2 - Arch itecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

Page ii NDA-301 15 Revision 1.0 CONTENTS Pr operty M ana gement System Communication Interfac e Page Admin istrat ion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Message Waiting Lamp Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

NDA-3011 5Revision 1.0 Page iii Pr operty Ma nagement System Communication Inte rface CONTENTS Page Room Recovery (Model 90) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Room Data Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .[...]

Page iv NDA-301 15 Revision 1.0 CONTENTS Pr operty M ana gement System Communication Interfac e Page[...]

NDA-3011 5 Revision 1.0 Page v Prope r ty Mana ge ment System Communication Interface FIGURES LIST OF FIGURES Figure Title Pa g e 2-1 Start Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2-2 NEAX to PMS Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

Page vi N DA-30115 Revis ion 1.0 FIGURES Property Management System Comm unication Interface Figure Title Pa g e 4-40 Reser vation Cancel lation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 4-41 Guest Name Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .[...]

NDA-3011 5 Revision 1.0 Page vii Prope r ty Mana ge ment System Communication Interface T ABLES T able T itle Pa g e 2-1 Line C ontrol Charac teristi cs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2-2 Control Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .[...]

Page vi ii N DA-30115 Revision 1.0 T ABLES Pr operty Mana gement System Communication Inter face T able T itle Pa g e[...]

NDA-3011 5 Revision 1.0 Page 1 Property M anagement Sy stem - Communication In t erface Over vie w Chapter 1 Ov er view This docume nt is a des cription of the inte rface bet ween the NEC NEAX2400 IMS (here after re ferre d to as th e NEA X) and th e hote l’s Pro perty Ma nageme nt Syst em (PMS). This docume nt contains a lmost all (se e below) o[...]

Page 2 NDA-30115 Revision 1.0 Overview Pr oper ty Management Sys tem - Communication Inter face This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page 3 Property M anagement Sy stem - Communication Inte rface Arc hitec ture Chapter 2 Architecture The PMS communica tes with the NEAX over one or more seria l cables. A maximum of three li nes can be pr ovi ded as dat a li nks betwe en the NEAX and the PMS. The three l ines are designated as Line 1, Line 2 and Line 3. Lin[...]

Page 4 NDA-30115 Revision 1.0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface Asynchr onous T ransmission Line Contr ol Char acteristic s The chara cteristic s of the s ignals tran smitted ac ross the communi cations l ink are a s follo ws: T able 2- 1 Line Control Characterist ics Item Conditions Control Met hod Contentio n [...]

NDA-3011 5 Revision 1.0 Page 5 Property M anagement Sy stem - Communication Inte rface Arc hitec ture The contr ol codes u sed for the mes sage text s are: T ransmis sion Pr otocol Before a me ssage can be s ent, a start sequence ( also calle d a selecti ng sequence ) must be sent to urg e the re ceiver to rece ive the data. E very tra nsmis sion s[...]

Page 6 NDA-30115 Revision 1.0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface The message s (but not the control code s or start seq uence) sent between the NEAX and the PMS mus t have head er and trail ing sectio ns as defi ned in the fol lowing form at: T able 2- 3 Base Messag e Format The message format br eaks down as fol[...]

NDA-3011 5 Revision 1.0 Page 7 Property M anagement Sy stem - Communication Inte rface Arc hitec ture A Violati on Code message wi ll be sent to t he PMS in the fol lowing cases: • When the message cou nter does not match the n umber of char acters recei ved . • When a st ation numbe r not e xisting i n the NEAX is s pecif ied in th e message d[...]

Page 8 NDA-30115 Revision 1.0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface Fr om the NEAX to the PMS Figure 2-2 NEAX to PMS Pr otocol Start Seque nce Accept Reject No Answer Contention Interrupt Abort Pause Message Accept Reject No Answer Interrupt Abort Pause End Code Wa i t 1 second Send Receive Receive Send Send retry q[...]

NDA-3011 5 Revision 1.0 Page 9 Property M anagement Sy stem - Communication Inte rface Arc hitec ture Fr om the PMS to the NEAX Figure 2-3 PMS t o NEAX protocol Start Seque nce Accept Reject Contention Interrupt Pause Message Accept Reject No Answe r Interrupt Pause End Code Wa i t 1 second Send Receive Receive Send Send retry quit Query Wa i t 1 s[...]

Page 1 0 NDA-301 15 Revision 1. 0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface Timer s The foll owing timers a re used to maintain d ata tran smission: Sender Timer Upon sendi ng a start sequence, me ssage text o r query, t his timer begi ns counting and stop s counting upo n receiving a valid answer cont rol code. This ti[...]

NDA-3011 5 Revision 1.0 Page 1 1 Property M anagement Sy stem - Communication Inte rface Arc hitec ture T able 2-5 L ine Control Characterist ics Item Conditions Control Method Contention method (point to poin t) Operating Mode Half duplex (if modems are used, set to full duplex) Synchronization Synchronous Data Rate 4800 or 9600 bits/second (bps) [...]

Page 1 2 NDA-301 15 Revision 1. 0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface The contr ol codes u sed for th e message text s are: T able 2- 6 Contr ol C o des Contr ol Code Hexadecimal Va l u e Function SYN 32 Synchronization code. STX 02 Indicates the start of a block. ETX 03 Indicates the end of a block. ENQ 2D Used a[...]

NDA-3011 5 Revision 1.0 Page 1 3 Property M anagement Sy stem - Communication Inte rface Arc hitec ture T ransmis sion Pr otocol The messag es sent between t he NEAX and the P MS must ha ve header and tra iling sectio ns as defi ned in the followin g format: Figure 2- 5 Base Messag e Format The elemen ts of the message is as follows: • P AD-L - -[...]

Page 1 4 NDA-301 15 Revision 1. 0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface The message format br eaks down as follows: • STX -- Start of te xt block. (One byte - 0 2H.) • SA -- System A ddres s. (One byte - ‘ 1 ’ [ 31H].) • U A -- I/ O Unit Ad dress. ( One byte - ‘ ! ’ [21H].) • EI -- Ent ry Inde x. (On[...]

NDA-3011 5 Revision 1.0 Page 1 5 Property M anagement Sy stem - Communication Inte rface Arc hitec ture T ransmis sion Sequence T able 2-7 Data T rans mission Sequenc e (1 of 2) Status EN Q STX ETX, CRC A CK0 / A CK1 NAK Neutral (A) a: ACK0 -> (B) b: NAK -> (A) c: ENQ -> (D) W aiting for STX (B) (ACK last received) -> (B) -> (C) W ai[...]

Page 1 6 NDA-301 15 Revision 1. 0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface Notes: • a: Pre paratio n for re cepti on compl e te. • b: Recept ion impossi ble. • c: Reques ts for pr eparation for receptio n (the PMS shou ld not reques t this). • d: T ransmitted up to 21 times. • e: Aborted a t 22nd time. • f:[...]

NDA-3011 5 Revision 1.0 Page 1 7 Property M anagement Sy stem - Communication Inte rface Arc hitec ture Timer s and Counters Retransmissi on Counts Timer V alues T able 2- 9 Retransmiss ion Counts Meaning Count The number of retransmissions of the start sequence w hen there is no answer after tra nsmitting the start sequenc e. 7 The number of retra[...]

Page 1 8 NDA-301 15 Revision 1. 0 Ar chitecture Pr oper ty Mana gement System - Communication Inte rface Cab ling Considerations When the PMS is connected to the NEAX through a modem, t he cables should ju st be “ str aight throug h ” cables. There should be no crossing. When the PMS is directly c onnected to t he NEAX, use the fol lowing pin a[...]

NDA-3011 5 Revision 1.0 Page 1 9 Property M anagement Sy stem - Communication In terface Messag e Description s Chapter 3 Message Descr iptions There ar e several mess age groups : • Data Link Maintenance Messages • Maid Status • Message W aiti ng Lamp Control • Restricti on Control • Check In/ Check Out (Mode l 60) • Check In/ Check Ou[...]

Page 2 0 NDA-301 15 Revision 1. 0 Message Descriptions Pr oper ty Ma na gement System - Comm unication Interface • Recovery St art Rep ort -- Af ter rec e i vin g t he Nop T es t Recover Answ er mess age, th e PMS mu st download NEAX d atabas e inform ation (see “ Roo m Reco very (Model 60) ” on page 27 and “ Roo m Recov ery (Mode l 90) ”[...]

NDA-3011 5 Revision 1.0 Page 2 1 Property M anagement Sy stem - Communication In terface Messag e Description s Relea se f or Maintenance Ei ther system may reques t a tempor ary release of the dat a link fo r maintena nce purpo ses by transmitti ng a Data Link Release Reques t message to the oth er system. The recei ving system wi ll perform an y [...]

Page 2 2 NDA-301 15 Revision 1. 0 Message Descriptions Pr oper ty Ma na gement System - Comm unication Interface Maid Status These me ssages are u sed by the NEAX to co mm u nicate the a ctions of th e cleaning personne l. If th e messag e is desi gnated “ Model 90 ” then th at messa ge is onl y used by the Model 90 version. Th e other mess age[...]

NDA-3011 5 Revision 1.0 Page 2 3 Property M anagement Sy stem - Communication In terface Messag e Description s Message W aiting Lamp Control These me ssages are us ed to control the message waiti ng lamp on an e xtension. The message wai ting lamp is use d to notify a gu est about t he existe nce of text mess ages. If the message is designated “[...]

Page 2 4 NDA-301 15 Revision 1. 0 Message Descriptions Pr oper ty Ma na gement System - Comm unication Interface • Chec k Out Mes sage W a iting L amp Off Report -- This m essage is sent by th e NEAX to repo rt th at the Message Cate gory “ Fron t ” of that specif i c guest room is Off. • Chec k Out Mes sa ge W ait ing Lam p On Rep ort -- T[...]

NDA-3011 5 Revision 1.0 Page 2 5 Property M anagement Sy stem - Communication In terface Messag e Description s W ake Up/Gr oup Announcement These mess ages allo w for the manageme nt of wake up cal ls and group announcemen ts. Both the Mo del 60 a nd t he Model 90 v ersion us e th ese messages. • W ake Up Se tting (NEAX) -- This message i s sent[...]

Page 2 6 NDA-301 15 Revision 1. 0 Message Descriptions Pr oper ty Ma na gement System - Comm unication Interface Room Data Change Thes e messa g es are us ed to ch ange th e room in formatio n whil e a gues t is still checked i n. Messages d esignate d “ Model 60 ” are only used by th e Model 60 version ; “ Mode l 90 ” a re only used by the[...]

NDA-3011 5 Revision 1.0 Page 2 7 Property M anagement Sy stem - Communication In terface Messag e Description s Room Reco very (Model 6 0) Thes e messa g es are us ed by th e PMS to update the data b ase in th e Model 60 version . These messages wil l usual ly only be sent if requeste d by the NEAX us ing the Nop Tes t Recover Answer message. Howev[...]

Page 2 8 NDA-301 15 Revision 1. 0 Message Descriptions Pr oper ty Ma na gement System - Comm unication Interface Room Reco very (Model 9 0) Thes e messa g es are us ed by th e PMS to update the data b ase in th e Model 90 version after a failure re covery. Thes e messages wi ll usual ly only be sen t if request ed by the NEAX using the Nop Test Rec[...]

NDA-3011 5 Revision 1.0 Page 2 9 Property M anagement Sy stem - Communication In terface Messag e Description s Extension Connection Thes e messa ges are us ed to ass ociate ex tensio ns. This a ssoci ation will be eith er in the for m of a Boss/Se cretary or of a Master /Secondary. In either c ase, both of t he rooms to b e connected must be check[...]

Message Descriptions Pr oper ty Ma na gement System - Comm unication Interface Page 3 0 NDA-301 15 Revision 1. 0 This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page 3 1 Property M anagement Sy stem - Communication Inte rface Messag e Formats Chapte r 4 Message F or mats All message s sent bet ween the NEAX and the PMS must have header and traili ng sectio ns as defi ned in the followin g format: Figure 4- 1 Base Messag e Format The message format br eaks down as fol lows: • STX -[...]

Page 3 2 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Note 3: In the case of messag es that are al mos t identical, the FC will be marked with “**”. Also, differing FTC values will be marked with “*”. The f inal message is then constructed by simply inser ting the desir ed FC value (and, [...]

NDA-3011 5 Revision 1.0 Page 3 3 Property M anagement Sy stem - Communication Inte rface Messag e Formats The form at of all Da ta Link Ma intenanc e messages a re exactly a s follows: Figure 4-2 Data Link Maintenance Message Format The message format br eaks down as fol lows: • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FC) ?[...]

Page 3 4 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face • 51-7 -- Guest Room 7 (Model 90 ) Note: This messag e was not pr eviously def ined in NEAX2400 IMS Hotel Sys tem PMS Interface Specif i cation . • 51-8 -- Nega tiv e Answer (Model 90) • 51-9 -- Positi ve Answer (Model 90) • 52-1 -- Ad[...]

NDA-3011 5 Revision 1.0 Page 3 5 Property M anagement Sy stem - Communication Inte rface Messag e Formats Guest Room Figure 4-4 Guest Room (General) Message fields are: • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FC) • 51-1 -- Guest Room 1 (Mode l 90) • 51-2 -- Guest Room 2 (Mode l 90) • 51-3 -- Guest Room 3 (Mode l 90)[...]

Page 3 6 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room Answ er Figure 4- 5 Room Answer (Gene ral) Message fields are : • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FN) • 51-8 -- Nega ti ve Answer (Model 90) • 51-9 -- Positi ve Answer (Model 90) • Extensi on -- Exte[...]

NDA-3011 5 Revision 1.0 Page 3 7 Property M anagement Sy stem - Communication Inte rface Messag e Formats Administration Figure 4- 6 Administration (General) Message fields are: • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FC) • 52-1 -- Administra tion 1 (Model 90 ) • 52-2 -- Administra tion 2 (Model 90 ) • 52-3 -- Admin[...]

Page 3 8 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Message W aiting Lamp Control These messa ges are use d to control th e message wait ing lamps on all of the phones. Messages se nt by the PMS are commands to t urn a message waiti ng lamp on or off. Mess ages se nt by th e NEAX ar e notif ica[...]

NDA-3011 5 Revision 1.0 Page 3 9 Property M anagement Sy stem - Communication Inte rface Messag e Formats MWL Status Figure 4-8 MWL Status Message fields are: • Extensi on -- Exten sion number . If the e xtensi on number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space (2 0H) charact ers. • Status[...]

Page 4 0 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Restricti on Co ntr ol Ther e are two message s. They are iden tical, e xcept th at messa ge 15-1 is sent fro m the PMS to the NEAX, and message 15- 2 is sent by t he NEAX to the PMS. The se messages s imply communic ate a new rest rictio n co[...]

NDA-3011 5 Revision 1.0 Page 4 1 Property M anagement Sy stem - Communication Inte rface Messag e Formats Chec k In/Chec k Out (Model 60) These messag es do not represent unique feature s as such, but are a conven ient tool for act ivating a sequence of f unctions commonly perfor med when a guest checks in or out of a room. These messages are excl [...]

Page 4 2 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Check Out Figure 4-11 Check Out The only mes sage field i s the extens ion number who is being chec ked out. If the extensi on number is less tha n six digits , left j ustify the n umber and fi ll the remainin g bytes with space (20H) c haract[...]

NDA-3011 5 Revision 1.0 Page 4 3 Property M anagement Sy stem - Communication Inte rface Messag e Formats Chec k In 2 Figure 4-13 Check In 2 This caus es the Room Stat us to be set t o Stay and canc els Room Cut-Off . Message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e num[...]

Page 4 4 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Chec k In 3 Figure 4-14 Check In 3 This caus es the Room Stat us to be set t o Stay and canc els Room Cut-Off . Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e n[...]

NDA-3011 5 Revision 1.0 Page 4 5 Property M anagement Sy stem - Communication Inte rface Messag e Formats Check Out Outgoing Call Repor t Figure 4-15 Check Out Out going Call Repor t 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 f ill the remaini[...]

Page 4 6 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Chec k In/Chec k Out (Model 90) The message s in this gr oup are used ex clusively by the Model 90 version. In additi on to t he foll owing mes sages, the Check Out Outgoin g Call Re port mes sage (16-C) i s also used by the Model 90 ver sion.[...]

NDA-3011 5 Revision 1.0 Page 4 7 Property M anagement Sy stem - Communication Inte rface Messag e Formats • Cleaning Stat us-- Clean ing s tatu s. The possi ble combina tions with room stat us are lis ted bel o w: • K ey -- Room ke y status: • 0 -- Key is in the k ey rac k . • 1 -- Key is not in the key rac k . • VIP -- VIP categor y: •[...]

Page 4 8 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Check Out Figure 4-18 Check Out When Cleani ng Status is s et to 0, 1, or 2 , Room Cut Off is ca ncelled. Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number [...]

NDA-3011 5 Revision 1.0 Page 4 9 Property M anagement Sy stem - Communication Inte rface Messag e Formats Check In Cancellation Figure 4- 19 Check In Cancellatio n The only mes sage f ield is the exten sion nu mber that wa s previ ously checke d in. If the ex tensio n number is less tha n six di gi ts, left justify the numb er and f ill the remaini[...]

Page 5 0 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face • Cleaning Stat us -- Cleaning st atus. The possible combi nations with roo m st atus are list ed belo w: • K ey -- Room ke y status: • 0 -- Key is in the k ey rac k . • 1 -- Key is not in the key rack . Room Change Figure 4-21 Room Ch[...]

NDA-3011 5 Revision 1.0 Page 5 1 Property M anagement Sy stem - Communication Inte rface Messag e Formats • K ey -- Old room k ey stat us: • 0 -- Key is in the k ey rac k . • 1 -- Key is not in the key rac k . • Ne w Extensio n -- Ne w ext ension number . If the e xtension numbe r is less t han six dig its, le ft j ust if y the numbe r and [...]

Page 5 2 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Pr ov isional Chec k Out Figure 4-23 Provisional Chec k out The only mes sage field i s the ext ension number t hat has be en provision ally checked out . If the exte nsion numbe r is les s than si x digit s, left justi fy the nu mber and fil [...]

NDA-3011 5 Revision 1.0 Page 5 3 Property M anagement Sy stem - Communication Inte rface Messag e Formats W ake Up/Gr oup Announcement The Functi on Codes ar e as follows: • 19-1 -- W ake Up Sett in g (Sen t b y N EAX) • 19-2 -- W ak e Up Cancellatio n (Sent by NEAX) • 19-3 -- W ak e Up Exe cution Result • 19-4 -- W ake Up Sett in g (Sen t [...]

Page 5 4 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Wa k e U p Cancellation (NEAX) Figure 4-26 W a ke Up Cance llation (NEAX) Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes [...]

NDA-3011 5 Revision 1.0 Page 5 5 Property M anagement Sy stem - Communication Inte rface Messag e Formats Wa k e U p Execution Result Figure 4- 27 W ake Up Executio n Result Message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th sp[...]

Page 5 6 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Wa k e U p S e t t i n g (PMS) Figure 4 -28 W a ke Up Setting ( PMS) Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th[...]

NDA-3011 5 Revision 1.0 Page 5 7 Property M anagement Sy stem - Communication Inte rface Messag e Formats Wa k e U p Cancella tion (PMS) Figure 4- 29 W ake Up Canc ellation (PMS) Message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi [...]

Page 5 8 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Gr oup Announcement Sett ing (NEA X) Figure 4-30 Gr oup Announcement Setting (NEAX) Message fields are : • Group ID - - Group number t o set. If the group number is less t han six digi ts, left justi fy the nu mber an d fill the rem a ining [...]

NDA-3011 5 Revision 1.0 Page 5 9 Property M anagement Sy stem - Communication Inte rface Messag e Formats Gr oup Announcement Cancellation (NEAX) Figure 4-31 Gr oup Announcement Cancellation (NEAX) Message fields are: • Group ID -- Gro up number to cancel . If t he group number is l ess than six dig its, left j ustify th e number and fi ll the re[...]

Page 6 0 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Gr oup Announcement Execution Result Figure 4-32 Gr oup Announcement Execution Result Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema i[...]

NDA-3011 5 Revision 1.0 Page 6 1 Property M anagement Sy stem - Communication Inte rface Messag e Formats Gr oup Announcement Setting (PMS) Figure 4-33 Gr oup Announcement Setting ( PM S) Message fields are: • Group ID - - Group number t o set. If the group number is less t han six digi ts, left justi fy the nu mber a n d fill the re m aining byt[...]

Page 6 2 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Gr oup Announcement Cancella tion (PMS) Figure 4-34 Gr oup Announcement Cancellation (PMS) Message fields are : • Group ID -- Gro up number to cancel . If t he group number is l ess than six digit s, left j ustify th e number and fi ll the r[...]

NDA-3011 5 Revision 1.0 Page 6 3 Property M anagement Sy stem - Communication Inte rface Messag e Formats Room Mo ve/Swap/Cop y (Model 60) This messa ge group is used exclusi vely by the Mode l 60 versi on. The Function Code s are: • 20-1 -- Room Mov e • 20-2 -- Room Swap • 20-5 -- Room Copy Room Move leave s the sec ond extension ’ s ma id[...]

Page 6 4 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room Data Change This messa ge group us es multiple Feat ure Codes. The cod e pairs a re as follows (firs t number is th e Feature Co de, second number is the Fun ction Code): • 21-1 -- Room Data Change 60 ( Model 60) • 21-2 -- Group Fo rm[...]

NDA-3011 5 Revision 1.0 Page 6 5 Property M anagement Sy stem - Communication Inte rface Messag e Formats Message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space (2 0H) charact ers. • Language - - Language cat egor y for the[...]

Page 6 6 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Gr oup Cancellation Figure 4-38 Group Cancellation Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space (2 0H) char[...]

NDA-3011 5 Revision 1.0 Page 6 7 Property M anagement Sy stem - Communication Inte rface Messag e Formats Guest Name Change Figure 4- 41 Guest Name Chan ge Message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space (2 0H) charact[...]

Page 6 8 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face • Room Status -- Room st atus. Th is flag is us ed in c onjunct ion wit h the c leani ng status flag to dete rmine the status of th e room. • Cleaning Stat us -- Cleaning st atus. The possible combi nations with roo m st atus are list ed b[...]

NDA-3011 5 Revision 1.0 Page 6 9 Property M anagement Sy stem - Communication Inte rface Messag e Formats Room Status Change Figure 4- 43 Room Stat u s Change If Ro om Sta tus is set to ‘ 0 ’ and Cleaning Sta tus is set to eith er ‘ 3 ’ or ‘ 4 ’ , the room data is cleared. If Roo m Stat us is set t o ‘ 0 ’ and the pre vious Room St [...]

Page 7 0 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room K ey Status Change Figure 4-44 Room Ke y Status Chang e Message fields are : • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space ([...]

NDA-3011 5 Revision 1.0 Page 7 1 Property M anagement Sy stem - Communication Inte rface Messag e Formats Extension Assignmen t Repor t Figure 4-46 Extension Assignment Report Message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th [...]

Page 7 2 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room Reco very (Model 6 0) Thes e messa g es are us ed by th e PMS to update the data b ase in th e Model 60 version of the NEAX. Fir st a Recovery Start Report (70-3) is s ent. Then, one or more set s of Room Image me ssages are sent. Finall [...]

NDA-3011 5 Revision 1.0 Page 7 3 Property M anagement Sy stem - Communication Inte rface Messag e Formats Room Image Set 1 Figure 4-47 Room Image Set 1 The message fields are: • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FC) • 17-1 -- Room Image Set 1 (Normal Request from PMS) • 17-2 -- Room Image Set 1 (Normal Answer from[...]

Page 7 4 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room Image Set 2 Figure 4-48 Room Image Set 2 The message fields are: • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FC) • 17-5 -- Room Image Set 2 (Normal Request from PMS) • 17-6 -- Room Image Set 2 (Normal Answer fro[...]

NDA-3011 5 Revision 1.0 Page 7 5 Property M anagement Sy stem - Communication Inte rface Messag e Formats • Stay -- Room stay . The possible v alues are lis ted belo w: • Rese rve -- Re se rve flag . Possi ble values ar e: • 0 -- Room is not reserv ed • 1 -- Room is reserv ed. • Language - - Language cat egor y for the gues t. The possi b[...]

Page 7 6 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room Image Set 3 Figure 4-49 Room Image Set 3 The message fields are: • FC -- Funct ion Codes that use this mess age format ar e: (FTC-FC) • 17-9 -- Room Image Set 3 (Normal Request from PMS) • 17-A -- Roo m Image Set 3 ( Normal Answer f[...]

NDA-3011 5 Revision 1.0 Page 7 7 Property M anagement Sy stem - Communication Inte rface Messag e Formats • Stay -- Room stay . The possible v alues are lis ted belo w: • Rese rve -- Re se rve flag . Possi ble values ar e: • 0 -- Room is not reserv ed • 1 -- Room is reserv ed. • Language - - Language cat egor y for the gues t. The possi b[...]

Page 7 8 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Room Reco very (Model 9 0) These mess ages are onl y used by the Model 90. Whe n the PMS re ceives a Nop Test Recover Ans wer (70-2) messag e, it sends one Ro om Data Report messag e for eac h room. Pri or to sen ding any rec overy messages , [...]

NDA-3011 5 Revision 1.0 Page 7 9 Property M anagement Sy stem - Communication Inte rface Messag e Formats • Cleaning Stat us -- Cleaning st atus. The possible combi nations with roo m st atus are lis ted bel o w: • K ey -- Room ke y status: • 0 -- Key is in the k ey rac k . • 1 -- Key is not in the key rac k . • VIP -- VIP categor y: • [...]

Page 8 0 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Guest Room Secr etary T elephone Figure 4-51 Guest Room Secretary T elephone The message fields are: • Boss -- Ex tension numb er of the bos s. If the e xtension nu mber is le ss than six digits , left ju stify the nu mber and f ill the rema[...]

NDA-3011 5 Revision 1.0 Page 8 1 Property M anagement Sy stem - Communication Inte rface Messag e Formats Messag e Status Repor t Figur e 4-53 Messag e Status Repor t The message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space[...]

Page 8 2 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Wa k e U p Figure 4- 54 W ake Up The message fields are: • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space (2 0H) charact ers. • T [...]

NDA-3011 5 Revision 1.0 Page 8 3 Property M anagement Sy stem - Communication Inte rface Messag e Formats Direct Data Entr y Figu re 4- 55 Dir ect Da ta Ent ry • Extensi on -- Extensi on number . If the exte nsion number is less tha n six digits , left j ustify th e number and fi ll the rema ining b ytes wi th space (2 0H) charact ers. • Nume r[...]

Page 8 4 NDA-301 15 Revision 1. 0 Message Formats Pr oper ty Management Sys tem - Communication Inter face Extension Connection Thes e messa ges are us ed to ass ociate ex tensio ns. This a ssoci ation will be eith er in the for m of a Boss/Se cretary or of a Master /Secondary. In either c ase, both of t he rooms to b e connected must be checked in[...]

NDA-3011 5 Revision 1.0 Page 8 5 Property M anagement Sy stem - Communication Inte rface Messag e Formats Connecting Room Set Figure 4-58 Connecting Room Set The message fields are: • Master -- Ex tension number of t he master exten sion. If the e xtension number i s less th an six d igits, left just ify the n umber an d f ill the re m aining byt[...]

Message Formats Pr oper ty Management Sys tem - Communication Inter face Page 8 6 NDA-301 15 Revision 1. 0 This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page 8 7 Prope r ty Mana ge ment System - Communication Interfac e References Chapter 5 Ref eren ces The foll owing document was used to pr epare thi s specific ation: • NEAX2400 IMS Hotel System PMS Interf ace Speci ficat ion (4252/425 3/5250 Feature Packa ge), ND-90265 (E)[...]

Reference s Pr oper ty Ma na gement System - Comm unication Inte rface Page 8 8 NDA-301 15 Revision 1. 0 This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page 8 9 Property M anagement Sy stem - Communication In t erface Glossar y Chapter 6 Glossar y BCC Block Check Code. Co mputed by an e xclusive OR of the message f rom the SA field t o the ETX char acter , inclusi ve. This is used to as sist in erro r control. EI Entry I ndex. Always ‘ L ’ f or the PMS in terfac e. ETX [...]

Glossary Pr oper t y Management System - Comm unication Interface Page 9 0 NDA-301 15 Revision 1. 0 This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page A- 1 Pr ope r ty Mana gement System - Communication Interfac e Room Status Appendix A Room Status Normally, r oom status in formation is managed i n the PMS. Whatev er the room status may be, the NEAX opera tes accordi ng to the d irection pr ovided from the PMS. The N EAX pro cesses calls within th e rang e show n in F[...]

Page A- 2 NDA-301 15 Revision 1. 0 Room Status Pr oper ty Management Syste m - Communication Interfa ce Updating Room Stat us Inf ormation in the NEAX The message s containing room statu s informatio n, sent from th e PMS, are as follo ws: Check In: 16-1, 16-A, 16-B, 56-1 Check Out: 16-2, 56-2 Room Chan ge: 20- 1, 56 -6 Room Data Image: 17-3, 17-7,[...]

NDA-3011 5 Revision 1.0 Page A- 3 Pr ope r ty Mana gement System - Communication Interfac e Room Status Inspect ion End 3 2 1 Cleaning Start, Cleaning End and I nspection End each have separa te feature access codes to be dialed. Room Status and Cleaning Status When the status of the room is sent to the NEAX from the PMS, the possible Room Status a[...]

Page A- 4 NDA-301 15 Revision 1. 0 Room Status Pr oper ty Management Syste m - Communication Interfa ce[...]

NDA-3011 5 Revision 1.0 Page B- 1 Pr opert y Mana gement System - Communicat ion Interface PMS Line F ailure Printouts Appendix B PMS Line F ailu re Pr intouts Normal T ext This d ata is p rinted ou t on the H ospitali ty print er when the gue st room in formati on of the NEAX i s processed acco rding to a message from th e PMS. More spec ifically [...]

Page B- 2 NDA-301 15 Revision 1. 0 PMS Line Fa ilure Printouts Prope r ty Management Sys tem - Communication Interfa ce Abnormal Events When the NEAX re ceives a me ssage from the PMS, and the re ceived data i s abnormal o r it cannot be process ed by the NEAX, the mes sage is p rinted out. Figure B-3 Abnormal Events Printout Abnormal P or t If an [...]

NDA-3011 5 Revision 1.0 Page B- 3 Pr opert y Mana gement System - Communicat ion Interface PMS Line F ailure Printouts Figur e B-5 P or t Stat e T a b le B-3 T ypes of Failure Failure T ype 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 switc hed of f during transm[...]

Page B- 4 NDA-301 15 Revision 1. 0 PMS Line Fa ilure Printouts Prope r ty Management Sys tem - Communication Interfa ce Figure B-6 I/O P ort Status Figure B-7 FIFO Status Scan Data Figure B-8 I/O P ort Status Scan Data 0/1 : R TS s ignal OFF/ON 0/1 : CTS signal OFF/ON 0/1 : DR signal OFF/ON 0/1 : CI signal OFF/ON 0/1 : For transmission FIFO FULL/bl[...]

NDA-3011 5 Revision 1.0 Page B- 5 Pr opert y Mana gement System - Communicat ion Interface PMS Line F ailure Printouts T ransmission F ailure When a mes sage has fai led to be tra nsferred fr om the NEAX to the PMS, t he followi ng error messa ge will be pri nted out. Figure B-9 T ransmission Failure Printout Entry Error: [XX-X] TRANSFER ERR XXXXXX[...]

PMS Line Fa ilure Printouts Prope r ty Management Sys tem - Communication Interfa ce Page B- 6 NDA-301 15 Revision 1. 0 This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page C-1 Pr ope r ty Mana gement System - Communication Interfac e Feature Codes Appendix C F eature Cod es Feature Code Description 70 Data Link Maintenance 1 1, 12, 51, 52 Maid Status 13, 53 Message W aiting Lamp Control 15 Restriction Control 16 Check-In/Out (Model 60) 56 Check-In/Out (Model 90) 17 Extension Report 17 Roo[...]

Feature Codes Pr ope r ty Management Sys tem - Communication Inter face Page C -2 NDA-301 15 Revision 1. 0 This P age Left Bla nk.[...]

NDA-3011 5 Revision 1.0 Page D-1 Pr ope r ty Mana gement System - Communication Interfa ce Function Codes Appendix D Function C odes FTC FC Description Sour ce Model 70 0 Nop T e st Normal Answer NEAX ALL 70 2 Nop T e st 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/NE[...]

Page D -2 NDA-301 15 Revision 1. 0 Function Codes Property Management System - Comm unication Interface 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 6[...]

NDA-3011 5 Revision 1.0 Page D-3 Pr ope r ty Mana gement System - Communication Interfa ce Function Codes 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 - Secreta ry T elephone PMS 90 57 4 Recovery - C[...]

Page D -4 NDA-301 15 Revision 1. 0 Function Codes Property Management System - Comm unication Interface 59 9 Direct Data Ent ry Positive Answer PMS 90 62 1 Guest Room Secretary T elephone PMS 90 62 2 Guest Room Secretary T e l ephone NEAX 90 62 3 Connecting Room Set PMS 90 62 4 Connecting Room Cancel PMS 90 FTC FC Description Sour ce Model[...]