WG3PFO User s Guide
WG3PFO Configuration Submenu The WG3PFO module is the interface with the hotel s Front-Office. The system receives information from the Front-Office regarding check-ins, check-outs, room changes and guest name changes. When the guest logs out from the Internet session, the WG3PFO computes the associated cost, and sends it to the Front Office. The communication with the several front-office systems is done via standard protocols, namely the FIAS protocol. The WGServer s implementation of the FIAS protocol is certified by Micros Fidelio. The WGServer also has an interface with the NewHotel front-office, using a proprietary protocol. The FIAS protocol is currently used for communication with the Micros Fidelio front-office and may be used for communication with any front-office system that implements the FIAS protocol. The EasyLinq software, software for management of telephone systems, may also be used for communicating with front-office systems that do not implement the FIAS protocol. You just send the information to EasyLinq and EasyLinq will send it to the front-office. Please note that the integration of the WGServer with front-office systems generally requires that the customer acquires the Internet interface from the front-office provider. Enable: enable/disable WG3PFO. Front-office Name: select in the drop-down box the Front-Office used by the hotel unit. Front-office's IP Address: Insert the Front-Office s IP address. Front-office's Port: Insert the Front-Office s TCP port. Print Ticket: if WGTicket is present, a ticket with the login data will be printed if this checkbox is ticked. 2 14
Posting Method: There are two methods: PS Posting Simple and PR Posting Request (the most common is Posting Simple). WG3PSW: Enable/disable WG3PSW. See WGServer s configuration guide or WG3PSW configuration guide Password: Select the Password Type. There are 3 possibilities: Name: Pre-defined Table (see table in the end of document) Random: The name of the client will be the password; The password will be defined according to a pre-defined table. The system creates random passwords. Billing Algorithm: Select algorithm calculation. Three options are available: 1/24 hours 5/10 euros Activation fee Defined unit The costumer pays 5 for the first hour, and 10 for 24hours use. Each Internet session will have an activation period, corresponding to a minimum usage, just like telephone calls. Use this if you have a defined unit, for the costumers pay. In WGManager go to Billing > Define Prices Users, and then define the price that costumers have to pay. Activation Period: Use Activation Period for setting the amount of time of the activation fee. The options are: 15, 30 and 60 minutes. Pre-paid Access: The client is re-directed to a second page for choosing a period for using the Internet. Options will be: 1 hour, 2 hours, 1 day and 1 week. Print Server automatic billing: Select yes when the WGPrintServer module is enabled. If the client prints any document, the WGServer sends the printing price to the PMS (Front- Office). Configuration Example 3 14
Test setup: Required equipment: 1. WGServer connected to the Nonius testnet with IP address 10.0.0.208. 2. Laptop or desktop connected to Nonius testnet and running the WG3PFO simulator with IP address 10.0.0.5. 3. Laptop or PDA for simulating client sessions 4. One Access Point connected to the WGServer s hotspot interface, with SSID 3PFO TEST. 5. Optionally one VLAN-capable switch for testing the integration with WG3PSW 6. Optionally one ticket s printer for testing WGTicket s integration. Equipment configuration and setup: 1. Connect the WGServer to Nonius testnet; 2. Connect the PMS Server Emulator machine to Nonius testnet; 3. Connect the ticket s printer to Nonius testnet, with IP 10.0.0.108; 4. Connect the VLAN switch to the WGServer s hotspot interface (if you are testing WG3PSW); 5. Connect the Access Point to the WGServer s hotspot interface or to the switch; 6. Open port 4444 on machine that is running the PMS Server Emulator; 7. Follow the instructions above for configuring the WG3PFO in the WGServer; 4 14
8. Connect the client laptop or PDA to the 3PFO test network; Messages exchanged between WG3PFO and the Front-Office (Sent means a message sent from the WGServer to the Front-Office; Received means a message received by the WGServer, from the Front-Office): 1. Handshake Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Socket successfully created! Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Received: LS DA050928 TI182235 Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LS DA080129 TI143022 Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LD DA080129 TI143022 V#1.0 IFWW Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LR RIGI FLG#RNGSGNSF Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LR RIGC FLG#GSRNGNRO Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LR RIGO FLG#RNGSSF Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LR RIPR FLPIG#RNTADUDATIGNP# Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LR RIPL FLRNG#GNDATIP# Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LR RIPA FLASCTRNDATIP# Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Sent: LA DA080129 TI143022 Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Received: LA DA050928 TI161903 Tue Jan 29 14:30:22 WET 2008 wgserver wg3pfo: Received: LA DA050928 TI161903 2. Check-in Tue Jan 29 16:29:27 WET 2008 wgserver wg3pfo: Received: GI G#01 RN126 GSxx GNBarroso Mr. 3. Billing with posting simple (PS) (Note: 1 minute 2 ) Thu Jan 31 14:51:28 WET 2008 wgserver wg3pfo: Sent: PS RN100 TA233 DE 000110 DA080131 TI145128 P#001 4. Billing with posting inquiry (PR) (Note: 1 minute 2 ) Thu Jan 31 17:02:30 WET 2008 wgserver wg3pfo: Sent: PR PI100 DA080131 TI170229 P#1 Thu Jan 31 17:02:30 WET 2008 wgserver wg3pfo: Received: PL RN100 G#01 GNCASTRO DA050928 TI161903 P#1 5 14
Thu Jan 31 17:02:30 WET 2008 wgserver wg3pfo: Sent: PR RNR G#01 GNCASTRO TAR DUR DA080131 TI170230 P#2 Thu Jan 31 17:02:30 WET 2008 wgserver wg3pfo: Received:PA ASOK CTPOSTING OK RNR DA050928 TI161903 P#2 5. Guest room change Wed Jan 30 23:33:18 WET 2008 wgserver wg3pfo: Received: GC G#02 GSN RN427 RO426 6. Guest name change Tue Jan 29 16:33:58 WET 2008 wgserver wg3pfo: Received: GC G#01 GSxx RN100 GNBarroso Mr. 7. Check-out Thu Jan 31 00:08:04 WET 2008 wgserver wg3pfo: Received: GO G#01 GSxx RN126 8. Database synchronization Thu Jan 31 17:08:15 WET 2008 wgserver wg3pfo: database synchronization with frontoffice finished 9. LE record sent from PMS Thu Jan 31 00:15:25 WET 2008 wgserver wg3pfo: Received: LE DA050928 TI161903 10. LE record sent from WG3PFO Thu Jan 31 00:15:25 WET 2008 wgserver wg3pfo: Sent: LE DA080131 TI001525 Test procedure: 1. Handshake: a. Start the WG3PFO simulator and check the WG3PFO log in WGConfig for verifying if the handshake procedure was successful; 2. Guest check-in: a. Send check-in from the WG3PFO simulator; b. Verify in WGManager that the room is checked-in; c. If WGTicket is enabled, check if the ticket was printed. 3. Guest Change Room: a. Send Change Room from the WG3PFO simulator; b. Verify in WGManager that the room was changed. 4. Guest Change Name: a. Send Change Name from the WG3PFO simulator; b. Verify in WGManager that the name was changed. 5. Billing: a. Do a session, check if WGServer sends the correct information to PMS; b. Check if the Billing is correct (Note: if the Pre-paid Access module is active, the billing information is sent when the client chooses the usage period at login and not at logout, as usual). 6. Guest check-out: a. Send Check out from the WG3PFO simulator; b. Verify in WGManager that the room was cheked-out. 7. Front-office hangs up the connection: a. Use the 3PFO Simulator to send an LE record; b. Check in syslog if WG3PFO is trying to reconnect; c. Send an LS record from the simulator; d. Check if the communications restart normally; Interaction with Micros-Fidelio The messages exchanged, between WG3PFO and Micros-Fidelio Front-office, have a predetermined format, described by the FIAS protocol. 6 14
These messages start with a two-character message-type followed by several message-fields. A vertical bar,, separates the message type from the message fields. Each message-field consists of a two-character name followed by a value. The following table is a list of the message types and message fields that are used in the messages exchanged between WG3PFO and Micros-Fidelio. Micros-Fidelio Messages Types Message Definition Description Direction Communication and link control LS Link Start Starts the activation sequence. Bidirectional LA Link Alive Indicates that the link is active. Bidirectional LE Link End Indicates that the link is dead. Bidirectional LD Link Description Description of the established link To PMS LR Link Record Describes the records that WGServer will send, and the records that expect to receive. To PMS Guest Data GI Guest Check In Record Indicates that a guest has checked in to a From PMS room and contains guest information. GO Guest Check Out Record Indicates that a guest has checked out of a From PMS room. GC Guest Data Change Record Guest information has changed. From PMS Point of Sale PS Posting (Simple) Used to post charges to a guest room. To PMS PA Posting Answer Indicates the status of the charge posting. From PMS Database Resynchronization DR Database Resync Request Requests a database swap. To PMS DS Database Resync Start Indicates the beginning of a database swap From PMS DE Database Resync End Indicates the end of a database swap. From PMS Micros-Fidelio Message Fields Field Description Data Type Message DA Date Formatted as YYMMDD DR, DS, DE DU Duration Time Formatted as HHMMSS PS G# Guest Number Numeric character GI, GC, GO, RE, XB, XC, PA GN Guest Name Any printable ASCII character GC, GI P# Posting Sequence Number Numeric characters PA, PS RN Room Number Maximum of 8 alphanumeric characters GC, CI, CO, RE, PA, PS, XB, XC, XI, XR SF Swap Flag No Data GI, GO TI Time Formatted as HHMMSS DR, DS, DE Micros-Fidelio Answer Status Field Data Types Code Interface Type Description IA Guest related requests Invalid account OK All systems Command or request completed successfully Analyzing LOGS Thu Jan 10 11:09:00 WET 2008 wgserver wg3pfo: started Thu Jan 10 11:09:00 WET 2008 wgserver wg3pfo: working mode = client 7 14
Thu Jan 10 11:09:00 WET 2008 wgserver wg3pfo: registered successfully with MySQL WGserver has started wg3pfo, which is acting as client for the PMS, and is working with the MySQL database. Wgserver wg3pfo: Sent: LS DA080109 TI174452 WG3PFO sends Starting Link on 9 January 2008 at 17:44:52 Wgserver wg3pfo: Received: LS DA080109 TI174453 WG3PFO receives starting link on 9 January 2008 at 17:44:53 Wgserver wg3pfo: Sent: LD DA080109 TI174453 V#1.0 IFWW WG3PFO sends description for the established link on 9 January 2008 at 17:44:53, Vendor System s version 1, In-Room Internet Systems. Wgserver wg3pfo: Sent: LR RIGI FLG#RNGSGNSF WG3PFO says to load record with the record ID guest check in record the flags RN- room number, GS Share Flag, GN Guest number and SF Swap flag (part of a database swap) Wgserver wg3pfo: Sent: LR RIGC FLG#GSRNGNRO WG3PFO says to load record with the record ID guest change the flags GS Share flag, RN room number, GN Guest number and RO Old room number Wgserver wg3pfo: Sent: LR RIGO FLG#RNGSSF WG3PFO says to load record with the record ID guest check out the flags RN room number, GS Share flag and SF Swap flag (part of a database swap). Wgserver wg3pfo: Sent: LR RIPS FLRNTADUDATIPTP# WG3PFO says to load record with the record ID Post Simple the fields RN room number, TA Total posting amount, DU duration, DA Date, TI Time, PT Posting Type and P# - Posting sequence number. Wgserver wg3pfo: Sent: LR RIPA FLASCTDATIRNP# WG3PFO says to load record with the record ID Posting answer the fields AS Answer Status, CT Clear text, DA Date, TI- Time, RN Room Number and P# - Posting sequence number. Wgserver wg3pfo: Sent: LA DA080109 TI174453 WG3PFO states that the link is alive on 9 January 2008 at 17:44:53 Wgserver wg3pfo: Received: LA DA080109 TI174453 WG3PFO receives a confirmation that the link is alive on 9 January 2008 at 17:44:53. 8 14
When the handshake is done, the WG3PFO and Micros-Fidelio will work together, and the internet costs, check in, check out, etc will be done automatically. Check In record Usage : sent from Fidelio to WG3PFO upon a) guest Check-in, b) during DB Swap Example : GI G#14 RN426 GSN GNCruz Machado Mr. Explanation : Check in with reservation number 14, in room 426, share flag N, guest name Cruz Machado. Note: At WGManager, if you click on Show users, you should see that user name 426 is registered and corresponds to Mr. Cruz Machado. If the configured password type is name, the password for this user should be Cruz and if WGTicket is enabled a ticket with the corresponding login data should have been printed, Guest Information Change record Usage : sent from Fidelio to WG3PFO when guest information changes Example : GC G#14 GSN RN426 GNPedro Mr. Explanation : The guest name has changed from Cruz Machado to Pedro. Note: at WGManager you should be able to see the guest s new name and a new password should have been computed. Check Out Record Usage : sent from Fidelio to WG3PFO upon a) guest Check-out, b) during DB Swap Example : GO G#14 RN426 GSN Explanation : Check out reservation number 14, in room 426, share flag N. Note: at WGManager, the username 426 should has disappeared from the Show users menu and it will not be possible to login again with this username. Posting Request Usage : sent from vendor to WG3PFO to inquire data of a given room Example : PR PI426 P#3 DA080806 TI123154 Explanation : Post inquiry request 426, sequence number 3, in 06 August 2008 at 12:31:54 Posting List Usage : sent from Fidelio to WG3PFO to reply to a posting inquiry Example : PL RN426 G#14 GNPEDRO P#3 DA080806 TI123154 Explanation : Posting List from room number 426, reservation 14 with the guest name Pedro, the sequence number 3, in 06 August 2008 at 12:31:54 Posting request Usage : sent from WG3PFO to Fidelio to post internet charges to guest folio. Example : PR RN426 G#14 GNPEDRO S1567 D1000 T1000 TA567 P#4 DA080806 TI123 154 Explanation : Posting request room number 426 with the guest number Pedro, subtotal 1567, Discount 1000, total posting amount 567, with the sequence number 4, in 06 August 2008 at 12:31:54 Posting Answer Usage : sent from Fidelio to WG3PFO to confirm posting Example : PA ASOK CTPOSTING OK RN426 P#4 DA080806 TI123154 Explanation : Posting answer with the status OK, of room number 426, sequence 4, in 06 August 2008 at 12:31:54 9 14
Call Charge Posting (simple) Usage : sent from WG3PFO to Fidelio to post call charges to guest folio. Example : PS RN100 TA124 DU000037 DA080114 TI164244 PTC P#1 Explanation : Posting answer, Room number 100, Internet session duration 37 seconds, on 14th January 2008, at 16:42:44, post this as clear text, in first sequence. Posting Answer Usage : sent from WG3PFO to Fidelio to post call charges to guest folio. Example : PA ASOK RN100 DA080114 TI164244 P#1 Explanation : Posting answer as OK on 14th January 2008, at 16:42:44, in first sequence. This is the response to PS record with P#1. Note: For each PS record sent, a PA record with the same P# must be received! The WGServer will not send any more charging records until the previous PS record is acknowledged. Interaction with New Hotel WG3PFO configuration: 10 14
Test cases: 1. Starting WG3PFO Fri Feb 01 11:30:05 WET 2008 wgserver wg3pfo: started Fri Feb 01 11:30:05 WET 2008 wgserver wg3pfo: working mode = client Fri Feb 01 11:30:05 WET 2008 wgserver wg3pfo: registered successfully with MySQL Fri Feb 01 11:30:05 WET 2008 wgserver wg3pfo: Socket successfully created! 2. Handshake Not implemented. 3. Check-in Fri Feb 01 10:20:02 WET 2008 wgserver wg3pfo: Received:GI RN 1406 GN LASSE 4. Billing with posting simple (PS) (Note: 1 minute 2 ) Fri Feb 01 11:11:36 WET 2008 wgserver wg3pfo: Sent: PS RN 1406 TA 1010 DE 000503 DA080201 TI111136 P#001 Fri Feb 01 11:11:36 WET 2008 wgserver wg3pfo: Received:PS ACK P#001 5. Billing with posting inquiry (PR) (Note: 1 minute 2 ) Fri Feb 01 11:26:20 WET 2008 wgserver wg3pfo: Sent: PS RN 1406 TA 200 DE 000100 DA080201 TI112620 P#002 Fri Feb 01 11:26:20 WET 2008 wgserver wg3pfo: Received:PS ACK P#002 6. Guest room change Not implemented. 7. Guest name change Not implemented. 8. Check-out Fri Feb 01 10:23:00 WET 2008 wgserver wg3pfo: Received:GO RN 1406 GN LASSE Test procedure: 1. Guest check-in: a. Send check-in from the WG3PFO simulator; b. Verify in WGManager that the room is checked-in; c. If WGTicket is enabled, check if the ticket was printed. 2. Guest Change Room: a. Send Change Room from the WG3PFO simulator; b. Verify in WGManager that the room was changed. 3. Guest Change Name: a. Send Change Name from the WG3PFO simulator; b. Verify in WGManager that the name was changed. 4. Billing: c. Do a session, check if WGServer sends the correct information to PMS; d. Check if the Billing is correct. 5. Guest check-out: a. Send Check out from the WG3PFO simulator; b. Verify in WGManager that the room was cheked-out. 11 14
Messages Format Field Description Message Description GI Check In RN Room Number GN Guest Last name GO Check Out RN Room Number GC Change Room RN Last Room Number RO New Room Number RN Room Number TA Total Amount for charging PS Time: HHMMSS Post Simple DE Internet Description Data (bytes): XXXXXX (Charge Net) DA Date (Format: DD/MM/YY) TI Time (Format: HH/MM/SS) P# Message Serial number Check in: GI RN 101 GN SILVA Check out: GO RN 101 GN SILVA Change Room: GC RN 104 RO 101 GN SILVA Call Charge Posting (simple) PS RN 101 TA_1500 DE 013015 DA050729 TI151759 P#001 When NewHotel receives an PS, answer with an ACK: PS ACK P#001 Format Field Messages RN101 : Extension with size six, right lined UP completed with spaces. Ex: 101 TA1500 : Value with size 5. Ex: _1500 DE013015 : Description size 10. Ex: 012015 DA050729 : Date size 6. Ex: YYMMDD TI151759 : Hour size 6. Ex: HHMMSS P#01 : Sequential number size 3, right lined UP completed with 0 Ex:001 12 14
Command line interaction with WG3PFO Command /sbin/service wg3pfo start /sbin/service wg3pfo debug /sbin/service wg3pfo stop /sbin/service wg3pfo restart Kill -12 [WG3PFO_PID] Kill -10 [WG3PFO_PID] Kill -30 [WG3PFO_PID] Kill -31 [WG3PFO_PID] Description Starts the application in normal mode Starts the application in debug mode. The log file noniuswg3pfo.log is being written to. Stops the application. If the communication protocol is FIAS, a LE record is sent to the front-office indicating that the client is down and WG3PFO only stops after receiving another LE as response. Stops and start WG3PFO This signals that a client has chosen a prepaid period. WG3PFO queries the database and sends the corresponding PS record to the front-office. This signals that a client has printed a document. WG3PFO queries the printserver table for printed documents and sends a PS record to the front-office. Switches between normal and debug mode. The captive portal sends this signal to WG3PFO indicating that a user has logged off. WG3PFO queries the database for uncharged sessions and send a PS record to the frontoffice. 13 14
Passwords table conversion name Original letter Corresponding character a d b 8 c E d f e 3 f 4 g 6 h k i? j 5 k + l > m P n q o < p s q 9 r u s V t 7 u x v w w z x * y A Z 2 Space - 14 14