RSI can be installed as a stand alone service or combined with the DuVoice Hospitality Server (DHS) to provide VM/AA services.

Transcription

1 Room Status Interface Overview Room Status Interface (RSI) will provide a telephony interface for room status updates made by housekeeping. These updates will then be sent to the Jazz system via a network connection. RSI will provide a web-based administration interface for configuration of Rooms and User accounts. RSI can be installed as a stand alone service or combined with the DuVoice Hospitality Server (DHS) to provide VM/AA services. Requirements 1. RSI will be an IVR application hosted on the DuVoice Hospitality Server (DHS). 2. DHS will not be required to support VM/AA. 3. RSI may be configured for specific ports or accessible via the standard DHS interface. 4. The PBX may use a digital or analog interface. 5. RSI will not require caller ID support from the PBX. User Interface Administration Administration and configuration will be provided through a web based interface. This interface can be installed as a stand alone service or as an add-on to the InnDesk product. Requirements Access will be restricted using a username and password combination. Changes made will be recorded for reporting purposes. Configuration will be stored in a local database. User configuration Users accessing the system via the telephony or web interface will be required to have a user account in RSI. The administrator will have the ability to Add, Delete, and Disable accounts. Considering the varied site requirements each user account may have an unlimited number of custom fields. These fields will not be used by the telephony interface; however, they will be used for all reporting and logging. Fields: ID Unique user id. Password First name Last name

2 Language Language used for the telephony interface. Access level Level of access for this user. Disabled Used to block access for the user without removing account. Room configuration Room configuration will depend on how the system is installed: as a stand alone service or as an add-on. Independent installation The administrator will have the ability to Add and Delete rooms. Rooms will not be required to have a corresponding mailbox if the DuVoice system is providing VM/AA. Considering the varied site requirements each room may have an unlimited number of custom fields, which will be used for all reporting and logging. Room status codes will be programmable by the administrator. InnDesk add-on Rooms will be tied to the guest rooms configured in the voic system. The administrator will not have the ability to Add or Delete rooms, only the addition of custom fields. Room status codes will be programmed using the hospitality interface configuration within the VMS. Fields: Room number Description Status Reports The administration interface will supply the following reports suitable for printout. Status report Display the current state of one or more rooms. User change report Display any changes made to user accounts. This will include who, when, and which account was changed. Room change report Display any changes made to a room. This will include who, when, change type and what room was changed.

3 Telephone Interface Dial access # for RSI. Please enter your ID number, followed by the # key. Enter maid ID. # Please enter your PIN number, followed by the # key. Enter PIN #. # Enter the room number, followed by the # key. Enter room #. # Enter the status code, followed by the # key. Enter status code. # Confirmation Menu 1 To confirm your entry, press 1. Entry accepted. Post & Exit. 2 To cancel this operation, press 2. Canceled. Exit without posting. Jazz Interface The Jazz interface will be responsible for transmitting status changes made by housekeeping to Jazz. Update changes made by a user will be cached in a local database and then sent to Jazz based on the configuration options. Configuration Options 1. IP Address IP Address of the remote server that will receive the information.

4 2. Port Number Port number the remote server is listening on. 3. Maximum changes per packet. Limit the number of room updates per message. 4. Interval. Number of seconds between status changes. A value of zero will cause the server to send a status change as soon as it can. 5. Retry Interval. Number of seconds between retries in case of communication failure. 6. Maximum Attempts. Maximum number of attempts in case of communication failure. 7. Include guest room status. Should the message include guest room status information derived from DuVoice VMS. 8. Exclude custom fields. Should custom fields be excluded from the message. Message Format The message will be formatted as XML using a standard HTML POST method. This will provide for the greatest flexibility and provide positive feedback if the message was received correctly using the standard HTML response. Using XML will also allow the server to send updates for multiple rooms in a single message, unless configured not to do so. Concerns: Packet format may not be fully compatible with the Jazz system. Sequence number for packets. Currently specified as an integer which start with a value of 1 and automatically roll once the maximum size of a long has been reached (2,147,483,647). Result codes in response packet need to be clarified. Result packet may need additional information. Document Root The document root element is roomstatus. Document Root Parent Elements Entity Element <roomstatus> <room> <status> <user> </room </roomstatus> Room Element Specifies the room update element. There may be more than a single room element depending on configuration.

5 Element Attribute Mandatory/ Description Optional number M Room number. <room number= date= time= description= sequence= result= > Status Element Denotes the room status. date M Date item was posted by user. description O Room description. sequence M Unique integer message number. result O On return result. 0 = Success. 1 = Error. 2 = Resend. Element Attribute Mandatory/ Description Optional <status code= description= > code M Status code entered by user. description O Text description of status code defined by configuration. User Element Contains the information about the user making the status update. This element may contain optional entity elements containing the users first and last name. Element Attribute Mandatory/ Optional Description <user id= > id M User id. Post Sample In this example a single room status message is being sent for room 530 from a staff member with ID 2345 and includes the custom field building. It also includes optional VMS information including mailbox number, message count, and first and last name fields. POST / HTTP/1.0 Content-type: text/xml Content-Length: 422 <?xml version="1.0" encoding="iso "?> <roomstatus> <room number= 530 date= time= 14:06 sequence= 500 > <status code= 3 description= Vacant Dirty /> <user id= 2345 > <fname>jane</fname>

6 <lname>doe</lname> </user> <building>west Wing</building> <description>dbl K BAL 17</description> <fname>karen</fname> <lname>johnson</lname> <mailbox>530</mailbox> <messages voice= 2 text= 0 /> </room> </roomstatus> </xml> Response Sample HTTP/ OK Content-type: text/xml Content-Length: 422 <?xml version="1.0" encoding="iso "?> <roomstatus> <room number= 530 sequence= 500 result= 0 /> </roomstatus> </xml> Database User Table Field Description Type Length id This will be the id used to access the system, Unique integer N/A either via the web or over the telephone. password This field may be left blank in which case the Integer N/A telephony interface will not prompt for it. fname User s first name. This field will be left blank. String 20 lname Users last name. This field will be left blank. String 20 languageid Language this user speaks. This will be used to Integer N/A change the prompts for the telephony interface only. disabled Used to block access without deleting account. Integer N/A level Used to restrict access to the web interface and features with in it. Integer N/A Room Table Field Description Type Length room Room number. Unique integer N/A description Description of the room. String 20 status Current status of the room. Integer N/A received Date and time the status was last changed. DATETIME N/A posted Date and time status was successfully sent to Jazz. DATETIME N/A Status Table Field Description Type Length statusid Unique status id. Unique integer N/A description Description of the status. String 20

7