NN42350-101 05.06 HMS400 Maintenance
NN42350-101 05.06 HMS400 Maintenance
Maintenance
Release 2.0
NN42350-101, 05.06
December 2010
© 2010 Avaya Inc. Copyright
All Rights Reserved. Except where expressly stated otherwise, no use should be made of
materials on this site, the Documentation, Software, or Hardware
Notice provided by Avaya. All content on this site, the documentation and the
Product provided by Avaya including the selection, arrangement and
While reasonable efforts have been made to ensure that the design of the content is owned either by Avaya or its licensors and is
information in this document is complete and accurate at the time of protected by copyright and other intellectual property laws including the
printing, Avaya assumes no liability for any errors. Avaya reserves the sui generis rights relating to the protection of databases. You may not
right to make changes and corrections to the information in this modify, copy, reproduce, republish, upload, post, transmit or distribute
document without the obligation to notify any person or organization of in any way any content, in whole or in part, including any code and
such changes. software unless expressly authorized by Avaya. Unauthorized
reproduction, transmission, dissemination, storage, and or use without
Documentation disclaimer the express written consent of Avaya can be a criminal, as well as a
“Documentation” means information published by Avaya in varying civil offense under the applicable law.
mediums which may include product information, operating instructions
Third-party components
and performance specifications that Avaya generally makes available
to users of its products. Documentation does not include marketing Certain software programs or portions thereof included in the Product
materials. Avaya shall not be responsible for any modifications, may contain software distributed under third party agreements (“Third
additions, or deletions to the original published version of Party Components”), which may contain terms that expand or limit
documentation unless such modifications, additions, or deletions were rights to use certain portions of the Product (“Third Party Terms”).
performed by Avaya. End User agrees to indemnify and hold harmless Information regarding distributed Linux OS source code (for those
Avaya, Avaya's agents, servants and employees against all claims, Products that have distributed the Linux OS source code), and
lawsuits, demands and judgments arising out of, or in connection with, identifying the copyright holders of the Third Party Components and the
subsequent modifications, additions or deletions to this documentation, Third Party Terms that apply to them is available on the Avaya Support
to the extent made by End User. Web site: http://support.avaya.com/Copyright.
Link disclaimer Trademarks
Avaya is not responsible for the contents or reliability of any linked Web The trademarks, logos and service marks (“Marks”) displayed in this
sites referenced within this site or documentation provided by Avaya. site, the Documentation and Product(s) provided by Avaya are the
Avaya is not responsible for the accuracy of any information, statement registered or unregistered Marks of Avaya, its affiliates, or other third
or content provided on these sites and does not necessarily endorse parties. Users are not permitted to use such Marks without prior written
the products, services, or information described or offered within them. consent from Avaya or such third party which may own the Mark.
Avaya does not guarantee that these links will work all the time and has Nothing contained in this site, the Documentation and Product(s)
no control over the availability of the linked pages. should be construed as granting, by implication, estoppel, or otherwise,
any license or right in and to the Marks without the express written
Warranty permission of Avaya or the applicable third party.
Avaya provides a limited warranty on its Hardware and Software
Avaya is a registered trademark of Avaya Inc.
(“Product(s)”). Refer to your sales agreement to establish the terms of
the limited warranty. In addition, Avaya’s standard warranty language, All non-Avaya trademarks are the property of their respective owners,
as well as information regarding support for this Product while under and “Linux” is a registered trademark of Linus Torvalds.
warranty is available to Avaya customers and other parties through the
Avaya Support Web site: http://support.avaya.com. Please note that if Downloading Documentation
you acquired the Product(s) from an authorized Avaya reseller outside
of the United States and Canada, the warranty is provided to you by For the most current versions of Documentation, see the Avaya
said Avaya reseller and not by Avaya. Support Web site: http://support.avaya.com.
Chapter 2: Introduction.............................................................................................................7
Chapter 3: Diagnostics.............................................................................................................9
Accessing the VoiceEngine module..................................................................................................................9
Job aid......................................................................................................................................................9
Accessing Orion..............................................................................................................................................10
Job aid....................................................................................................................................................10
Accessing the PMSI module...........................................................................................................................10
Job aid....................................................................................................................................................11
Customizing the PMSI module........................................................................................................................11
Functional tests...............................................................................................................................................11
Testing check in......................................................................................................................................12
Testing check out....................................................................................................................................13
Testing a room change...........................................................................................................................14
Testing guest information updates..........................................................................................................15
Testing text message update..................................................................................................................16
Testing wake up call...............................................................................................................................17
Testing connectivity................................................................................................................................18
Accessing system logs....................................................................................................................................18
The following sections detail what is new in Avaya Hospitality Messaging Server 400, NN42350-101 for
HMS 400 Release 2.0.
Navigation
• Features on page 5
• Other changes on page 5
Features
For information about new features added for Avaya HMS 400 Release 2.0, see Avaya
Hospitality Messaging Server 400 Fundamentals, NN42350-104.
Other changes
See the following sections for information about feature changes.
• Update to Avaya Customer Documentation Standards on page 5
• Backup and Restore chapter removed on page 5
• Document Updates on page 6
Document Updates
This document is up issued to reflect changes made to the following section: Service
updates on page 19.
Additional editorial changes were made.
Reorganized the following content, which was moved to separate chapters:
• SNMP traps on page 25
• Windows event logs on page 29
This guide is for administrators, technicians, and engineers who maintain the Avaya Hospitality Messaging
Server 400 (Avaya HMS 400 ) server. This guide describes how to use system tools to identify the cause of
system problems and how to install or upgrade software components.
For detailed information, see Avaya Hospitality Messaging Server 400 Fundamentals, NN42350-104.
Navigation:
• Diagnostics on page 9
• Service updates on page 19
• Common procedures on page 23
• SNMP traps on page 25
• Windows event logs on page 29
This chapter explains how to access debug pages, perform functional tests, and access system logs.
For information about traps and log files used for diagnostic activities, see SNMP traps on page 25 and
Windows event logs on page 29.
For detailed information, see Avaya Hospitality Messaging Server 400 Fundamentals, NN42350-104.
Navigation:
• Accessing the VoiceEngine module on page 9
• Accessing Orion on page 10
• Accessing the PMSI module on page 10
• Customizing the PMSI module on page 11
• Functional tests on page 11
• Accessing system logs on page 18
Job aid
The following graphic displays the VoiceEngine icon on the HMS 400 main interface and in the
Windows system tray.
Accessing Orion
Use Orion to view records sent to and received by Orion for all database-related processing.
In the Avaya Hospitality Messaging Server 400 application, click the Orion icon.
OR
In the Windows system tray, click the Orion icon.
Job aid
The following graphic displays the Orion icon on the HMS 400 main interface and in the
Windows 2003 system tray.
In the Avaya Hospitality Messaging Server 400 application, click the PMSI icon.
OR
In the Windows system tray, click the PMSI icon.
Job aid
The following graphic displays the PMSI module icon on the HMS 400 main interface and in
the Windows system tray.
Functional tests
This section explains how to test common functions to ensure they work correctly. Test results
appear in the PMSI module.
The optimal time to perform these tests is if the link between Avaya Hospitality Messaging
Server 400 and the Hotel PMS is down or experiencing problems.
The processes described here are manual processes. An automated process, described in
Avaya Hospitality Messaging Server 400 Administration, NN42350-600 is also available.
Testing check in
Manually post a check in to test functionality. The test results appear in the PMSI module.
Prerequisites:
• Ensure you have the correct room information.
• Ensure you have appropriate permission to access manual posting.
Important:
The Group Code box dims if the feature is unavailable (determined by the
keycode).
9. In the COS list, click a class of service.
10. Review the information to ensure it is accurate, and then click Post.
11. Check the PMSI module to ensure the posting was successfully sent.
Variable Definitions
Variable Value
First name Enter the first name of the guest; maximum 20 characters
(alphanumeric).
Important:
When combined with the last name, the maximum is 27
characters.
Group Code If activated (by keycode) and if applicable, and then enter
the five-digit group code to which the guest belongs.
Last Name Enter the last name of the guest; maximum 20 characters
(alphanumeric).
Important:
When combined with the first name, the maximum is 27
characters.
Room No Enter the room number of the guest to be checked in.
Click the ellipsis (…) button next to the Room No box, select a room check box,
and then click OK.
5. Optionally, in the Guest Name box, type the name of the guest.
6. Review the information to ensure it is accurate, and then click Post.
7. Check the PMSI module to ensure the posting was successfully sent.
Variable Definitions
Variable Value
Guest Name Optional. Type the exact name of the guest for the room to
check out.
Room No Enter the room number of the guest to check out, or click
the ellipsis button to select from a listing.
Important:
If you do not require a Group Code, type 0 in the Group Code box.
Group Code information is not sent to the Avaya Communication Server 1000
(CS 1000). If you enter a COS/VIP code, the code is translated to VI ON and is
sent to the CS 1000. If you do not enter a COS/VIP code, a VI OF is sent to the
CS 1000.
If you select the Reset MWL Status check box, no action is taken. If you do select
the Reset MWL Status check box, the system sends the appropriate command
to either activate or deactivate the MWL of that room based on the current
database information.
7. Click Update.
A warning box appears, with the message "Packet sent for processing. It might take
some time to update the database. Please click Display or Show All button when
the page is loaded to obtain most current values."
8. Review the warning, and then click OK.
9. Check the PMSI module to ensure the posting was successfully sent.
Variable Definitions
Variable Value
Group Code If activated (by keycode) and if applicable, and then enter
the five-digit group code to which the guest belongs.
Guest Name Enter the name of the guest to update; maximum 30
characters; however, the CS 1000 accepts 27 characters
only.
Room No Enter the room number of the guest; maximum 10 digits.
OR
From the Text MWL Status list, select No.
6. Click Update.
7. If the window does not display the new Text MWL Status, in the navigation pane,
select Manual Posting > Text MWL Control again.
Variable Definitions
Variable Value
No Turn off the Message Waiting Lamp.
Yes Turn on the Message Waiting Lamp.
Important:
With the calendar icon, you can configure a wake up call for any day from the
current day.
10. In the AWU Time lists, click the list items that represent the correct wake-up call
time.
11. Click Submit.
Testing connectivity
Use the PMS Link and PBX Link to verify whether the connection to the Hotel PMS or PBX is
running. The test results appear in the PMSI module.
Prerequisites:
Access the PMSI module. For more information, see Accessing the PMSI module on
page 10.
1. From the Connectivity Test menu, select either PMS Link or PBX Link, depending
on which you want to test.
2. In the Connectivity Test window, click Connect.
The test results appear in the Link Test box.
3. Check the PMSI module to ensure the posting was successfully sent.
This chapter describes how to obtain and install patches and enhancement packages to the Avaya
Hospitality Messaging Server 400.
For detailed information, see Avaya Hospitality Messaging Server 400 Fundamentals, NN42350-104.
Navigation:
• Acquiring SUs from the ESPL site on page 19
• Uninstalling an SU on page 20
• Installing Service Updates on page 21
• Displaying installed SUs on page 22
Prerequisites:
Before beginning the SU:
• Make sure all files in c:\HMS400v2 are not set to read-only
• In Internet Explorer, set the Settings > Internet Options > Privacy setting bar to Medium or lower.
• Ensure there is a recent backup available before installing the SU. Avaya recommends that a backup
be performed just before performing any server maintenance activity to ensure the most recent
customer data is available if a restore is required
• Although the SU installation process only takes a few minutes, Avaya recommends planning to
perform the installation during low-traffic periods, since communication with PMS and CS 1000 is
stopped when the HMS 400 2.0 application is shut down to install the SU.
Important:
If there is an existing SU, it must be uninstalled before the new SU is installed. The SU Installer
(Installation Wizard) prompts if a previous SU is installed. For more information on un-installing a
previous SU, see Uninstalling an SU on page 20
Important:
The Enterprise Solutions PEP Library is a secure Web site and requires a user name and a
password to log on. You can register online for a user ID and password at http://
support.avaya.com/espl. It can take up to 72 hours to process your account request.
Uninstalling an SU
Follow this procedure to uninstall an SU.
1. Shut down (Exit) the HMS 400 application, including the browser HMS Web UI.
For more information about shutting down the HMS 400 application, see Avaya
Hospitality Messaging Server 400 Installation and Commissioning, NN42350-301.
Important:
Do not shut down the server. Shut down only the Avaya HMS 400 application.
2. Right-click the VoiceEngine icon in Windows system tray.
3. When you receive the prompt to shut down the VoiceEngine, click Yes.
4. Stop (File > Exit) the PMSI module. Enter password 000.
5. When you receive the prompt to confirm the shut down of PMSI, click Yes.
6. From the Windows Start menu, choose Control Panel > Add/Remove Programs.
7. Look for the installed SU (for example – HMS200G016R2), and click Change/
Remove.
8. At the prompt, click Yes.
9. Follow the instructions to uninstall the update.
10. After the SU has been uninstalled, proceed with the steps for installing a SU. See
Installing Service Updates on page 21.
1. Browse to the Avaya web site location to find the SU, or run the SU from the DVD/
CD if one is provided..
2. Copy the SU file (for example, HMS200G018.exe) into a \Temp folder. Skip this step
if launched from the DVD/CD.
3. Stop (Exit) the HMS400 2.0 application, including the browser HMS Web UI, if it is
opened.
For more information about shutting down the HMS 400, see Avaya Hospitality
Messaging Server 400 Installation and Commissioning, NN42350-301.
Important:
Do not shut down the server. Shut down the Avaya HMS 400 software only.
4. Click File > Exit to stop the PMSI module. Enter password (000) and click Yes to
confirm.
5. Open and review the readme files for specific installation instructions.
6. Double-click the SU .exe (for example, HMS200G018.exe).
7. Click OK.
The Installation Wizard appears.
8. Follow the installation instructions in the Installation Wizard.
Important:
If the Installation Wizard detects a previous SU, the installation stops and you are
prompted to un-install the old version before you continue. For steps to remove
a previous SU, see Uninstalling an SU on page 20.
9. Restart the HMS 400 software, if directed by installation instructions. The HMS 400
Release 2.0 software application can be re-started through the Desktop icon or
through the Windows Start Menu.
Important:
In isolated cases, if users find the MWI is not working in a SIP environment, go
to WebUI > SIP Setting, enter the current CS 1000 Node IP address, and click
Save. This re-populates the related INI setting with the correct values.
1. Click Start > Programs > Avaya HMS > Patch Utility.
The HMS 400 Patch Utility window appears, showing the list of installed and
uninstalled updates.
2. In the HMS 400 Patch Utility window, double-click an SU to view the details:
• file names
• new version and file creation date
• remarks
This chapter describes common procedures that you use to maintain the HMS 400.
• Starting the Avaya Hospitality Messaging Server 400 server on page 23
• Stopping or restarting the Avaya Hospitality Messaging Server 400 on page 23
Important:
The Avaya HMS 400 cannot answer calls until the VoiceEngine shows that channels are
ready. When Channels appear in the VoiceEngine window, the Avaya HMS 400 is ready to
accept calls.
Prerequisites:
For more information, see Avaya Hospitality Messaging Server 400 Fundamentals,
NN42350-104.
Several traps are thrown as part of the Avaya Hospitality Messaging Server 400 operations, including both
Dialogic and system traps.
Navigation:
• Dialogic SNMP traps on page 25
• System SNMP traps on page 25
Important:
Different triggers produce different messages.
1. SUCCESSFUL CONNECTION
• HMS400 PMSI connected to PBX via TCP/IP connection
• HMS400 PMSI connected to PMS via TCP/IP connection
2. FAILED/ERROR IN CONNECTION
• PMSI cannot connect to the PBX Server. Please check the status of the PBX
Server.
• PMSI cannot connect to the PMS Server. Please check the status of the PMS
Server.
• HMS400v2 PMSI experiences socket error for PBX TCP/IP connection.
Please check your PBX connection.
• HMS400 Restoration Process Failed. HMS400 Restore cannot find the backup
file BACKUPFILENAME.ZIP
• HMS400 Restoration Process Failed. Restoration cancelled due to a copy file
error. Files successfully copied cannot be reverted to their original copies
• HMS400 Restoration Process Failed. An error occurred while extracting files
from the backup file. The file may be corrupted or unreadable
• HMS400 Backup Restore Module cannot find the MySQL files
• HMS400 AutoBackup Module cannot find the MySQL files
• HMS400 AutoBackup Failed. AutoBackup:Writing to zip file error! The
autobackup process will not continue
• HMS400 AutoBackup encountered an error during database backup. The
autobackup process proceeded with the rest of the files
Windows event logs include both applications events and system events.
Navigation
• Application events on page 29
• System events on page 34
Application events
1. When HMS400 is launched – VoiceEngine module is started
System events
1. When VoiceEngine is started/closed