Difference between revisions of "Room Management System"

Latest revision as of 12:29, 20 October 2016

Room Management System

The Room Management System (RMS) is a licensed feature which allows you to specify PBX extensions as hotel guest room extensions, and manage the rooms associated with them. The application is found under Applications->Room Mgmt.
You must Enable the application to access the RMS Applet GUI, which is found by browsing to <PBX IP address>/ippbx/RMSApplet.php. The default username to log in is roomadmin, and the password is roomadmin.

General Settings

Sections/Fields	Description
Enable/Disable Application	When disabled, any settings set on this page will not have an effect.
Check in Class of Service	Class of service to apply to guests that are checked in.
Check out Class of Service	Class of service to apply to vacant rooms.
Operator / Front Desk Destination	Destination that will be dialed when pressing 0 from a guest room.

RMS Applet Settings

Sections/Fields	Description
Company Name	Company Name to be displayed on the RMS Applet GUI.
Upload a Private Label Image	Upload an image of the company logo.
Reset Admin Password to Default	Resets the RMSApplet login to roomadmin/roomadmin.

Wakeup Call Settings

Sections/Fields	Description
Ring Timer	Amount of time in seconds for a wakeup call to ring the guest extension during each wakeup call attempt.
Retry Interval	Amount of time in minutes for a wakeup call to wait before ringing the guest extension again, if the previous wakeup call attempt failed.
Attempts before Failure	Number of times a wakeup call will attempt to ring the guest extension before failing.
Use Custom Wakeup Call Prompt	Set a custom wakeup call prompt to play for the guest picking up the wakeup call. You will need to upload the file to PBX Setup->Prompts.

Guest Permissions

Sections/Fields	Description
Allow Voicemail	When checked, allows voicemail to be left at guest extensions. Here you can also set the feature code for accessing a guest extension’s personal voicemail. The default is 923. If disabled, voicemail cannot be left for guest extensions, and if a guest extension does not answer, the call fails over to the operator.
Allow Wakeup Call	When checked, allows guest extensions to set a wakeup call by dialing the feature code (the default is *55).
Allow Internal Calls	When checked, allows guest extensions to make calls to other guest extensions. When unchecked, guest extensions cannot dial other guest extensions, but they can still dial 0 for the operator.

Staff Settings

Sections/Fields	Description
Staff Menu Access Code	The access code that staff members can dial to access the Staff menu and use staff access codes to change room flags. You will be prompted for the password set below.
Staff Menu Password	Password used to access the staff menu.

Guestroom Extensions

Here you can select PBX extensions from the Available Extensions list and add them to the Selected as Guestrooms list. These selected extensions will be the guest extensions. Once the RMS Application is set to Enabled, these guest extensions will automatically be assigned the Checked Out Class of Service that you specified above.

Room Management System Applet

The RMS Applet displays the guest room extensions and enables you to check in and check out guests, edit guest information, set wakeup calls, and change room flags. It is accessed by browsing to <PBX IP address>/ippbx/RMSApplet.php. The default username to log in is roomadmin, and the password is roomadmin.

Checking In

To check in a guest, click on the room you would like to check in. A pop up will appear allowing you to enter the guest’s information. Here you can also set and update the flags for the room, if you need them to be different from the default, and you can set the wakeup call. Click the Check In button to check the guest in. A checked in guest will then have the Checked in Class of Service which you specified on the PBX under Application->Room Mgmt.

Checking Out

To check out a guest, click on the guest you wish to check out and click on the Check Out Button. The extension’s class of service will now be changed to the Checked out Class of Service.

Move Guest

To move a guest to another room, click on the guest that you wish to move, and click on the Move Guest Button. You can then select the vacant room you wish to move the guest to. This is essentially a check out event followed by a check in event. The wakeup call will be moved along with the guest, and the flags on the new room will change to reflect that the room has been checked in.

Wakeup Calls

Wakeup calls can be set for a guest room in two ways. The RMS admin can set a wakeup call by clicking on the room needing the call, clicking on Wakeup Call, and setting the time, date, and frequency of the call. Alternatively, a guest can set a wakeup call themselves by dialing the Wakeup Call access code configured on the PBX Room Mgmt page (default is *55). The guest will then be prompted to press 1 for a one-time wakeup call, 2 for a daily recurring wakeup call, or 3 to cancel an existing wakeup call. When the guest receives the wakeup call, they will be prompted to press 1 to accept the wakeup call, or 2 to snooze for 10 minutes. Snoozing causes the current number of call attempts to be reset to zero. When the configured number of call attempts have been executed and have not been answered, the wakeup call is considered as being failed. An alert in the form of an exclamation mark inside a triangle will then appear on the top of the RMSApplet page. Clicking on this alert image will display all failed wakeup calls.

RM System Configuration

Click on the gear symbol in the top right hand corner of the RMSApplet page to access the RM System Configuration page. Here you can create Alert Groups, set Alert Flags, create Check In/Check Out events, and create users for accessing the RMSApplet.

Create Alert Flags

To create a new alert, click on the Add Alert button. Give the alert a name, description, and staff code. The staff code is used when a person dials into the staff menu to toggle the alert on or off. The Default Status of the alert is the status that the alert will take on before anyone checks into the room. Red means the alert is off, and green means that it is on. For example, in the above screenshot, the ‘restocked beverages’ alert is set to be turned ON by default to indicate that the room has had the beverages restocked.

Create Alert Groups

The default alert groups are Cleaned, Inspected, and Maintenance. To add a new alert group, click the Add Group button.

Give the group a name, and add alert flags to the group from the list of Available Flags. Set an alert status for each flag. The status will determine when the alert group is turned on (green) or off (red) on the RMSApplet page. The “All Flags must match” checkbox determines whether all of the selected flags must match the chosen status for the flag in order for the alert group to be turned on. If this box is unchecked, then so long as at least one alert flag matches the status set for it, then the whole alert group will be turned on. If you want ALL of the alert flags to match the status in order for the alert group to be turned on, you must check this box.
For example, the above ‘restocked’ alert group will turn ON (green) on the RMSApplet page when BOTH ‘restocked cups’ and ‘restocked beverages’ are turned on, since “All Flags must match” is checked. When the alert group is turned ON, this indicates that the room has been ‘restocked’, and the OFF setting indicates that there is a ‘restock needed’. When a staff member changes either the ‘cups’ or ‘beverages’ alert to red (off), the alert group will turn red on the RMSApplet page.

Check in / Check Out Events

Here you can decide if you want the system to automatically toggle flags to match a certain on/off pattern when a guest is checked in or out.

Click on the event you wish to modify, and select which flags you want the system to automatically change for that event. In the above example, a Check In event causes the above four flags to be toggled ON to indicate that the room has been cleaned, inspected, and restocked.

Create Users

In this section you can add RMS users and edit the usernames/passwords. Click on Add User to add a new user. The Admin checkbox determines whether the new user has admin rights, indicated as “Admin” under the Admin column, or non-admin rights, indicated by “User” under the Admin column. Non-admin users are able to access the RMSApplet page and change basic settings such as guest information, schedule wakeup calls, and toggle alert groups on or off. Non-admin users cannot access the RM System configuration page.

@@ Line 1: / Line 1: @@
 == Room Management System ==
-The '''Room Management System (RMS)''' is a licensed feature which allows you to specify PBX extensions as hotel guest room extensions, and manage the rooms associated with them. The application is found under '''Applications->Room Mgmt'''.<br/>You must Enable the application to access the RMA Applet GUI, which is found by browsing to '''&lt;PBX IP address&gt;/ippbx/RMSApplet.php'''. The username to log in is '''roomadmin''', and the password is '''roomadmin'''.
+The '''Room Management System (RMS)''' is a licensed feature which allows you to specify PBX extensions as hotel guest room extensions, and manage the rooms associated with them. The application is found under '''Applications->Room Mgmt'''.<br/>You must Enable the application to access the RMS Applet GUI, which is found by browsing to '''&lt;PBX IP address&gt;/ippbx/RMSApplet.php'''. The default username to log in is '''roomadmin''', and the password is '''roomadmin'''.
 [[File:Rms.PNG]]
@@ Line 70: / Line 70: @@
 |-
 | style="text-align: center" | '''Allow Voicemail'''<br/>
-| When checked, allows voicemail to be left at guest extensions. Here you can also set the feature code for accessing a guest extension’s personal voicemail. The default is 923.
+| When checked, allows voicemail to be left at guest extensions. Here you can also set the feature code for accessing a guest extension’s personal voicemail. The default is 923.  If disabled, voicemail cannot be left for guest extensions, and if a guest extension does not answer, the call fails over to the operator.
 |-
 | style="text-align: center" | '''Allow Wakeup Call'''<br/>
@@ Line 76: / Line 76: @@
 |-
 | style="text-align: center" | '''Allow Internal Calls'''<br/>
-| When checked, allows guest extensions to make calls to other guest extensions.
+| When checked, allows guest extensions to make calls to other guest extensions.  When unchecked, guest extensions cannot dial other guest extensions, but they can still dial 0 for the operator.
 |}
@@ Line 102: / Line 102: @@
 The RMS Applet displays the guest room extensions and enables you to check in and check out guests, edit guest information, set wakeup calls, and change room flags.  It is accessed by browsing to <b><PBX IP address>/ippbx/RMSApplet.php</b>.  The default username to log in is <b>roomadmin</b>, and the password is <b>roomadmin</b>.
-[[File:Rms_2.PNG]]
+[[File:Rms_2.png]]
+=== Checking In ===
+To check in a guest, click on the room you would like to check in.  A pop up will appear allowing you to enter the guest’s information.  Here you can also set and update the flags for the room, if you need them to be different from the default, and you can set the wakeup call.  Click the Check In button to check the guest in.  A checked in guest will then have the Checked in Class of Service which you specified on the PBX under Application->Room Mgmt.
+[[File:Rms_3_2.png]]
+=== Checking Out ===
+To check out a guest, click on the guest you wish to check out and click on the Check Out Button.  The extension’s class of service will now be changed to the Checked out Class of Service.
+[[File:Rms_4_2.png]]
+=== Move Guest ===
-=== Configuring Office 1 ===
+To move a guest to another room, click on the guest that you wish to move, and click on the Move Guest Button.  You can then select the vacant room you wish to move the guest to.  This is essentially a check out event followed by a check in event.  The wakeup call will be moved along with the guest, and the flags on the new room will change to reflect that the room has been checked in.
-'''STEPS:'''
+=== Wakeup Calls ===
-#Click on '''Destinations->Branch Offices'''. The '''Branch Offices''' page is displayed.
+Wakeup calls can be set for a guest room in two ways.  The RMS admin can set a wakeup call by clicking on the room needing the call, clicking on Wakeup Call, and setting the time, date, and frequency of the call.
-#Click on the '''ADD office''' button. The '''Edit Branch Office''' page appears.
+Alternatively, a guest can set a wakeup call themselves by dialing the Wakeup Call access code configured on the PBX Room Mgmt page (default is *55).  The guest will then be prompted to press 1 for a one-time wakeup call, 2 for a daily recurring wakeup call, or 3 to cancel an existing wakeup call.
-#Give a unique '''NAME''' for the connection. The name should only contain alpha-numeric characters and no spaces. It should be '''ONE WORD ONLY'''.
+When the guest receives the wakeup call, they will be prompted to press 1 to accept the wakeup call, or 2 to snooze for 10 minutes.  Snoozing causes the current number of call attempts to be reset to zero.  When the configured number of call attempts have been executed and have not been answered, the wakeup call is considered as being failed.  An alert in the form of an exclamation mark inside a triangle will then appear on the top of the RMSApplet page.  Clicking on this alert image will display all failed wakeup calls.
-#Enter the '''External IP''' of the PBX in the '''Host''' field.
-#Enter a unique '''DIALING PREFIX''' of an asterisk followed by two numbers.
-#Give a unique '''PASSWORD''' for the connection.
-#Select '''NO''' for '''REGISTER '''(Note: that registration is not required if host is known).
-#Configure '''Enable Trunking '''as needed.
-#Configure '''Enable Multisite Manager Connection''' as needed.
-#Set '''QUALIFY''' at '''0'''.
-#Configure '''Enable IAX2 Trunking''' as needed.
-#Click the [[File:Savechanges.png]] button to save the changes.
-#Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database
-=== Configuring Office 2 ===
+[[File:Rms_10_2.png]]
-'''STEPS:'''
+== RM System Configuration ==
-#Click on '''Destinations->Branch Offices'''. The '''Branch Offices''' page is displayed.
+Click on the gear symbol in the top right hand corner of the RMSApplet page to access the RM System Configuration page.  Here you can create Alert Groups, set Alert Flags, create Check In/Check Out events, and create users for accessing the RMSApplet.
-#Click on the '''ADD Office''' button. The '''Edit Branch Office''' page appears.
-#Enter a name in the '''NAME''' field that matches that given to the Office 1 PBX. The name should only contain alpha-numeric characters and no spaces. It should be '''ONE WORD ONLY'''.
-#Enter an '''external''' '''IP address''' or '''domain''' corresponding to the IP of the main office PBX in the '''HOST''' field.
-#Enter a '''UNIQUE''' dialing prefix for the extensions connected to the Office 2 PBX.
-#The '''PASSWORD''' for Branch Office 2 needs to be the '''same''' as the one assigned in the Branch Office 1 PBX.
-#Select '''NO''' for '''REGISTER'''.
-#Configure '''Enable Trunking '''as needed.
-#Configure '''Enable Multisite Manager Connection''' as needed.
-#Set '''QUALIFY''' at '''0'''.
-#Configure '''Enable IAX2 Trunking''' as needed.
-#Click the [[File:Savechanges.png]] button to save the changes.
-#Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database
-To setup additional Branch Offices in the PBX, use the steps outlined above. Keep in mind to use the same logic (pattern) and make sure that the dialing prefix is unique to each office.
+[[File:Rms_5_2.png]]
-=== Edit Branch Office<br/> ===
+=== Create Alert Flags ===
-'''STEPS:'''
+[[File:Rms_6_2.png]]
-#From the '''Destinations->Branch Office '''page, locate the schedule name that you want to edit.
+To create a new alert, click on the Add Alert button.  Give the alert a name, description, and staff code.  The staff code is used when a person dials into the staff menu to toggle the alert on or off.  The Default Status of the alert is the status that the alert will take on before anyone checks into the room.  <b>Red</b> means the alert is <b>off</b>, and <b>green</b> means that it is <b>on</b>.  For example, in the above screenshot, the ‘restocked beverages’ alert is set to be turned ON by default to indicate that the room has had the beverages restocked.
-#Click on [[File:Penciledit.png]] icon to the right of the '''Name '''of the Branch Office you want to update. The '''Edit Branch Office '''page appears.
-#Edit the necessary parameters to configure the branch office.
-#Click the [[File:Savechanges.png]] button to save the changes.
-#Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database
-=== Delete Branch Office<br/> ===
+=== Create Alert Groups ===
-'''STEPS:'''
+The default alert groups are Cleaned, Inspected, and Maintenance.  To add a new alert group, click the Add Group button.
-#From the '''Destinations->Branch Offices '''page, locate to the '''Name''' from the Branch Office listing that you want to remove.
+[[File:Rms_7_2.png]]
-#Click on [[File:Deleteselected.png]] icon to the right of the '''Name '''of the '''Branch Office''' you want to delete. The Branch Office is removed from the listing page.
-#Click the [[File:Savechanges.png]] button to save the changes.
-#Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database
-=== '''Branch Extensions'''<br/> ===
+Give the group a name, and add alert flags to the group from the list of Available Flags.  Set an alert status for each flag.  The status will determine when the alert group is turned on (green) or off (red) on the RMSApplet page.  The <b>“All Flags must match”</b> checkbox determines whether all of the selected flags must match the chosen status for the flag in order for the alert group to be turned on.  If this box is unchecked, then so long as at least one alert flag matches the status set for it, then the whole alert group will be turned on.  If you want ALL of the alert flags to match the status in order for the alert group to be turned on, you must check this box.
+<br>
+For example, the above ‘restocked’ alert group will turn ON (green) on the RMSApplet page when BOTH ‘restocked cups’ and ‘restocked beverages’ are turned on, since “All Flags must match” is checked.  When the alert group is turned ON, this indicates that the room has been ‘restocked’, and the OFF setting indicates that there is a ‘restock needed’.  When a staff member changes either the ‘cups’ or ‘beverages’ alert to red (off), the alert group will turn red on the RMSApplet page.
-Branch Extensions are created through the add extension field at the bottom of the branch office edit page. Branch extensions can be dialed directly without a prefix, provided that these extensions are properly configured on the PBX for which the branch extensions are defined. Branch extensions will appear in call routing drop down lists throughout the system after they are created. If needed, you can add Ring Group and Menu numbers as Branch Extensions.
+=== Check in / Check Out Events ===
-==== Configuring Office 2 with Branch Extensions<br/> ====
+Here you can decide if you want the system to automatically toggle flags to match a certain on/off pattern when a guest is checked in or out.
-[[File:Branchextensions.png]] '''STEPS:'''
+[[File:Rms_8_2.png]]
-#Click on '''Destinations->Branch Offices. '''The Branch Offices page appears.
+Click on the event you wish to modify, and select which flags you want the system to automatically change for that event.  In the above example, a Check In event causes the above four flags to be toggled ON to indicate that the room has been cleaned, inspected, and restocked.
-#Click on the '''Branch Office''' connection ('''Name''') assigned to Office 1.
-#Assuming Office 1 has extension numbers 100 thru 110, enter the numbers 100 to 110 in the field above the Add button then click '''ADD'''. You will enter (add) each extension one at a time. '''Note: Using the format X-Y will add all extensions in the specified range.'''
-#If the extension number is valid (not already in use), the new extension will appear in the list of Branch Extensions.
-#Click the [[File:Savechanges.png]] button to save the changes.
-#Click the '''Apply Changes''' link located at the top right hand corner of the page, to commit the changes to the database.
-#Verify the new extension by calling the number from phones located (registered) at Branch Office 2.
-To place a call from one Branch Office to another simply dial the prefix that was assigned to that locations PBX + the extension of the user trying to be reached at the other office. This same easy concept works for transferring calls from one Branch Office to another. Or, if you have the extension configured as a Branch Extension on your PBX, you can simply dial the extension number and it will be automatically routed to the branch.
+=== Create Users ===
-==== View Branch Office Extensions<br/> ====
+[[File:Rms_9_2.png]]
-[[File:Showextensionspage.png]]<br/>'''STEPS:'''
+In this section you can add RMS users and edit the usernames/passwords.  Click on Add User to add a new user.  The Admin checkbox determines whether the new user has admin rights, indicated as “Admin” under the Admin column, or non-admin rights, indicated by “User” under the Admin column.  Non-admin users are able to access the RMSApplet page and change basic settings such as guest information, schedule wakeup calls, and toggle alert groups on or off.  Non-admin users cannot access the RM System configuration page.
-#From the '''Destinations'''->'''Branch Office '''page, click on the '''Show Extensions''' button located at the top of the Branch Office list page.
-#A popup window appears displaying all the extension information for each Branch Office that is currently in the system.
-#Click on the “'''X'''” to close the popup window.
-==== Parking at a Branch ====
-In order to Park and retrieve parked calls at a Branch Office, you will have to do a little bit of programming.
-'''Parking'''
-*Create a Phantom Extension at the remote end PBX
-*Add this as a Branch Extension in the local PBX
-*Unconditionally Forward this ext to PSTN number ##700#
-*When a user wants to park a call at the Branch Office, have them transfer the call to the Branch Extension
-'''Retrieving Park'''
-*Note the Branch Prefix Code
-*To retrieve a call Parked at a branch, dial the prefix code plus the slot the call is parked in
-**eg. With a Branch Prefix Code of *28 and a call Parked in 702, the user will dial *28702 to retrieve the call