Avaya Solution & Interoperability Test Lab

Application Notes for configuring Avaya Aura

Communication Manager R6.3 with TigerTMS iCharge
v50.0 - Issue 1.0

Abstract
These Application Notes describe the configuration steps required for TigerTMS iCharge v50
to interoperate with Avaya Aura Communication Manager R6.3. TigerTMS iCharge is a
hospitality package offering an external interface into the hospitality features of Avaya Aura
Communication Manager.
Information in these Application Notes has been obtained through DevConnect compliance
testing and additional technical discussions. Testing was conducted via the DevConnect
Program at the Avaya Solution and Interoperability Test Lab.

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

1 of 19
TigerPMS_CM63

1. Introduction
These Application Notes describe the compliance-tested configuration using TigerTMS iCharge
R50.0 and Avaya Aura Communication Manager R6.3. This utilises the Property Management
System (PMS) link to Avaya Aura Communication Manager.
TigerTMS iCharge is a graphical hospitality package. It is commonly used in hotels to provide a
means of controlling usage of room facilities. Information is sent and received to and from
Avaya Aura Communication Manager over the PMS link.

2. General Test Approach and Test Results

The general test approach was to validate correct operation of typical hospitality functions and
recovery from network interruption.
DevConnect Compliance Testing is conducted jointly by Avaya and DevConnect members. The
jointly-defined test plan focuses on exercising APIs and/or standards-based interfaces pertinent
to the interoperability of the tested products and their functionalities. DevConnect Compliance
Testing is not intended to substitute full product performance or feature testing performed by
DevConnect members, nor is it to be construed as an endorsement by Avaya of the suitability or
completeness of a DevConnect members solution.

2.1. Interoperability Compliance Testing

Interoperability compliance testing consisted of successful execution of the following features
and link failure scenarios.
Check-In This function is used to assign a new guest to a particular room with a
telephone. The credentials of the guest are used to update the station configuration
within Communication Manager. This includes the display name of the phone as well as
calling restrictions and Message Waiting Indicator (MWI) updates.
Update Name A facility that updates the display name of a station in Communication
Manager.
Room Transfer This allows a guest to either transfer to a different room, or to allow two
guests to swap rooms. In either case, the station configurations of the two related
telephones are swapped
Change Controlled Restriction Communication Manager allows a variety of restrictions
to be placed on room telephone usage over and above any static configuration. This
includes the capability of barring or permitting external calls
Leave Message TigerTMS iCharge allows messages to be left for guests. This function
alerts the guest to such a message using the telephone MWI.
DID Allocation This facility enables a dynamic virtual extension to be associated to the
guest extensions so it can be accessed directly from outside the hotel.
DND This facility enables the Communication Manager to prevent calls reaching the
guest extension, if so desired by the guest.

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

2 of 19
TigerPMS_CM63

Check-out Once a guest has vacated a room, this function resets the telephone to default
configuration. This typically clears the station name and sets call barring of external
calls.
Maid Status If a room status should change by activity other than the above, this
mechanism allows TigerTMS iCharge to be updated by use of Feature Access Codes
(FAC) on the room telephone. As its name implies, this is often used to indicate room
ready status following cleaning.
Link Failure/Recovery PMS over IP link test for both link failure detection and
recovery.

2.2. Test Results

All test cases passed successfully.

2.3. Support
For product support contact details at:
support@tigertms.com
+44-1425-891099

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

3 of 19
TigerPMS_CM63

3. Reference Configuration
Figure 1 shows an Avaya Aura Communication Manager R6.3 serving H323 endpoints with
an Avaya G430 Media Gateway was configured along with Avaya Aura Session Manager R6.3
hosted on an Avaya S8800 Server providing SIP endpoints. TigerTMS iCharge was configured
on the same IP network for connection to the PMS interface of Avaya Aura Communication
Manager.

Figure 1: Avaya Aura Communication Manager and Avaya Aura Session Manager
with TigerTMS iCharge Solution

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

4 of 19
TigerPMS_CM63

4. Equipment and Software Validated

The following equipment and software were used for the sample configuration provided:
Equipment/Software
Avaya Aura System Manager running on
Avaya S8800 Server
Avaya Aura Communication Manager
running on Avaya S8800 Server

Release/Version
System Manager 6.3.0 - FP2
Build No. - 6.3.0.8.5682-6.3.8.1814
Software Update Revision No:
6.3.3.5.1719
R6.3 SP1
R016x.03.0.124.0

Avaya Aura Session Manager running on Session Manager R6.3 (SP3)

Avaya S8800 Server
SM 6.3.3.0.633004
Avaya G430 Gateway
Avaya 9630 IP Deskphone
TigerTMS iCharge running on Generic
Server

PG; Reviewed:
SPOC 5/13/2014

R6.3

H323 S3.105S
SIP 2.6.8.4

V50.0.0.0

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

5 of 19
TigerPMS_CM63

5. Configure Avaya Aura Communication Manager

This section describes the steps for configuring the PMS link, Hospitality System Parameters,
Feature Access Code and Class of Service on Avaya Communication Manager. The steps are
performed through the System Access Terminal (SAT) interface.

5.1. Configure IP Node Names

Enter the change node-names ip command. Create a new node name and IP address for the
iCharge server. The node name configured below will be used in the ip-services form to specify
the remote node of the PMS link.
change node-names ip

Page

1 of

IP NODE NAMES
Name
aesserver63
clan
cmm
cms
default
gateway
procr
procr6
sm63sigint
tiger

IP Address
10.10.16.96
10.10.16.31
10.10.16.142
10.10.16.175
0.0.0.0
10.10.16.1
10.10.16.142
::
10.10.16.148
10.10.16.101

5.2. Configure IP Services

Enter the change ip-services command. On Page 1 of the ip-services screen, define the PMS
link by setting the Service Type to PMS. Set Local Node to procr and Remote Node to tiger as
configured in Section 5.1. The Local Port is fixed at 0 and the Remote Port may be set to a
value between 5000 and 64500, but must match the port configured on iCharge in this case 5004.
change ip-services
Service
Type
AESVCS
PMS
CDR1

PG; Reviewed:
SPOC 5/13/2014

Page

Enabled
y

Local
Node
procr
procr
procr

IP SERVICES
Local
Port
8765
0
0

1 of

Remote
Node

Remote
Port

tiger
tiger

5004
9000

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

6 of 19
TigerPMS_CM63

5.3. Configure Hospitality Parameters

Enter the command change system-parameters hospitality. Configure the following
highlighted parameters on Page 1 of the HOSPITALITY screen.
change system-parameters hospitality
HOSPITALITY

Page

Message Waiting Configuration:

Controlled Restrictions Configuration:
Housekeeper Information Configuration:
Number of Housekeeper ID Digits:
PMS Log Endpoint:
Journal/Schedule Endpoint:
Client Room Coverage Path Configuration:
Default Coverage Path for Client Rooms:
Forward PMS Messages to Intuity Lodging?

1 of

act-pms
act-pms
act-pms
0
act-nopms
n

PMS LINK PARAMETERS

PMS Endpoint: PMS
PMS Protocol Mode: transparent ASCII mode? y
Seconds before PMS Link Idle Timeout: 20
Milliseconds before PMS Link Acknowledgement Timeout: 1500
PMS Link Maximum Retransmissions: 5
PMS Link Maximum Retransmission Requests: 5
Take Down Link for Lost Messages? n

Configure the following highlighted parameters on Page 2 of the HOSPITALITY screen.

change system-parameters hospitality
HOSPITALITY
Dual Wakeups? n

Daily Wakeup? n

Page

2 of

VIP Wakeup? n

Room Activated Wakeup With Tones? n

Time of Scheduled Wakeup Activity Report:
Time of Scheduled Wakeup Summary Report:
Time of Scheduled Emergency Access Summary Report:
Announcement Type: silence
Length of Time to Remain Connected to Announcement: 30
Extension to Receive Failed Wakeup LWC Messages:
Routing Extension on Unavailable Voice Synthesis:
Display Room Information in Call Display? y
Automatic Selection of DID Numbers? y
Custom Selection of VIP DID Numbers? y
Number of Digits from PMS:
PMS Sends Prefix? n
Number of Digits in PMS Coverage Path: 3
Digit to Insert/Delete:

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

7 of 19
TigerPMS_CM63

5.4. Configure Hospitality Features

Enter change feature-access-codes command. On Page 8 of the FEATURE ACCESS CODE
(FAC) screen enter appropriate feature access code numbers as shown in the screen below. This
mode allows the PMS to be accessible from a standard telephone within a hospitality room, for
example a cleaner is able to update the status of the room by entering in the FAC from the room
telephone.
change feature-access-codes

Page

8 of

10

FEATURE ACCESS CODE (FAC)

Hospitality Features
Automatic Wakeup Call
Housekeeping Status (Client Room)
Housekeeping Status (Client Room)
Housekeeping Status (Client Room)
Housekeeping Status (Client Room)
Housekeeping Status (Client Room)
Housekeeping Status (Client Room)
Housekeeping Status (Station)
Housekeeping Status (Station)
Housekeeping Status (Station)
Housekeeping Status (Station)
Verify Wakeup Announcement
Voice Do Not Disturb

PG; Reviewed:
SPOC 5/13/2014

Access
Access
Access
Access
Access
Access
Access
Access
Access
Access
Access
Access
Access

Code:
Code:
Code:
Code:
Code:
Code:
Code:
Code:
Code:
Code:
Code:
Code:
Code:

*81
*82
*83
*84
*85
*86

100

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

8 of 19
TigerPMS_CM63

5.5. Configure COS for Hospitality

In order for the hospitality feature to be fully available, all of the devices in a hospitality room
should be assigned to a Class Of Service (COS) with the Client Room option set to y, which is
required to be controlled by iCharge. During compliance testing all client rooms were configured
with a COS of 2. Enter the change cos-group 1 command, set Client Room to y for COS 2.
change cos-group 1
CLASS OF SERVICE

Page
COS Group: 1

Auto Callback
Call Fwd-All Calls
Data Privacy
Priority Calling
Console Permissions
Off-hook Alert
Client Room
Restrict Call Fwd-Off Net
Call Forwarding Busy/DA
Personal Station Access (PSA)
Extended Forwarding All
Extended Forwarding B/DA
Trk-to-Trk Transfer Override
QSIG Call Offer Originations
Contact Closure Activation

PG; Reviewed:
SPOC 5/13/2014

0
n
n
n
n
n
n
n
y
n
n
n
n
n
n
n

1
y
y
y
y
n
n
n
n
n
n
n
n
n
n
n

1 of

COS Name:
2
y
y
y
n
n
n
y
n
n
n
n
n
n
n
n

3
n
y
n
n
n
n
n
y
n
n
n
n
n
n
n

4
y
y
n
n
n
n
n
y
n
n
n
n
n
n
n

5
n
n
y
n
n
n
n
y
n
n
n
n
n
n
n

6
y
n
y
n
n
n
n
y
n
n
n
n
n
n
n

7
n
y
y
n
n
n
n
y
n
n
n
n
n
n
n

8
y
y
y
n
n
n
n
y
n
n
n
n
n
n
n

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

9 10 11 12 13 14 15
n y n y n y n
n n y y n n y
n n n n y y y
y y y y y y y
n n n n n n y
n n n n n n n
n n n n n n n
y y y y y y y
n n n n n n n
n n n n n n n
n n n n n n n
n n n n n n n
n n n n n n n
n n n n n n n
n n n n n n n

9 of 19
TigerPMS_CM63

5.6. Configure Client Room Extension

Enter the command change station x where x is a client room extension, configure the COS
field as 2.
change station 6000

Page

1 of

STATION
Extension: 6000
Type: 9630
Port: S00006
Name:

Lock Messages? n
Security Code: 1234
Coverage Path 1: 7
Coverage Path 2:
Hunt-to Station:

BCC:
TN:
COR:
COS:

0
1
1
2

STATION OPTIONS
Loss Group: 19
Speakerphone:
Display Language:
Survivable GK Node Name:
Survivable COR:
Survivable Trunk Dest?

2-way
english

Time of Day Lock Table:

Personalized Ringing Pattern:
Message Lamp Ext:
Mute Button Enabled?
Button Modules:

internal
y

1
6000
y
0

Media Complex Ext:

IP SoftPhone? n

IP Video? n
Short/Prefixed Registration Allowed: default
Customizable Labels? y

5.7. Configure XDIDVIP Stations

XDIDVIP stations are a pool of DID numbers which can be assigned to client rooms requiring
Direct Inward Dialing. This negates the requirement to have DID numbers for every client room.
Enter the command add station x where x is an extension relevant to the dial plan. Set the Type
as XDIDVIP and assign an identifying Name.
add station 6200

Page

1 of

STATION
Extension: 6200
Type: XDIDVIP

BCC:
TN:
COR:
COS:

Coverage Path 1:
Coverage Path 2:
Hunt-to Station:

Name:

0
1
1
1

Time of Day Lock Table:

Survivable COR: internal

Survivable Trunk Dest? y

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

10 of 19
TigerPMS_CM63

6. Configure TigerTMS iCharge

The configuration information provided in this section describes the steps required to set up
iCharge to interoperate with Communication Manager via a PMS link.

6.1. Configure PMS Connection Parameters

On the iCharge server; modify the pbx_DefinityASCII.ini file in the directory
D:\tig2020\Scripts\SwitchPMS. In the [Port] section ensure the PortType field is set to IP. Set
the ClientServer option to Server and the IPPortNumber to 5004 to match the port number
configured on Communication Manager in Section 5.2.
[Port]
PortType=IP
ClientServer=Server
IPPortNumber=5004
IPPersistentSocket=1

6.2. Start PMS Connection

On the iCharge server run the batch file by clicking on Start Programs Startup Start
Interfaces. The following screen is displayed.

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

11 of 19
TigerPMS_CM63

On the iCharge server, click on the Tiger Hotel shortcut on the desktop (not shown). Click on
the Tiger Hotel 2020 screen and enter the appropriate user name and password in the dialog box
that appears. The screen below will appear.

6.3. Configure Client Rooms

In the Main Menu screen, click on System Management (F9) then Directory Definition (F6).

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

12 of 19
TigerPMS_CM63

Administered client rooms are displayed in the screenshot below.

7. Verification Steps
The following verification steps can be used to ensure that the PMS link is correctly passing data
between the various components of the solution.

7.1. Verify Status of Avaya Aura Communication Manager PMS Link

Enter the command status pms-link, verify that the Physical Link State is up.
status pms-link
PMS LINK STATUS
Physical Link State: up
Protocol State: up
Maintenance Busy? no
Data Base Swapping? no

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

13 of 19
TigerPMS_CM63

7.2. Check-In Client Room and Verify Status

Using the iCharge application, use the Check-In hospitality function, to assign a room and
extension to a guest. In the Main Menu screen, click on Check-In (F2)

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

14 of 19
TigerPMS_CM63

In the Room field, select a room number from the drop down list. Enter a descriptive name for
the Guest Details - Name field and then click on the Check-In (F10) button.

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

15 of 19
TigerPMS_CM63

In the Main Menu screen, click on Room Management (F4).

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

16 of 19
TigerPMS_CM63

In the Room Management screen, select room 6001 from the Room field drop down list. Verify
the Room state is Occupied.

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

17 of 19
TigerPMS_CM63

7.3. Verify Room Status on Avaya Aura Communication Manager

Enter the command status station n where n is the client room checked-in in Section 7.2.
Confirm that the Room Status displays Occupied.
status station 6000
Administered Type:
Connected Type:
Extension:
Port:
Call Parked?
Ring Cut Off Act?
Active Coverage Option:

9630
9630
6000
S00006
no
no
1

Page
1 of
7
GENERAL STATUS
Service State: in-service/on-hook
TCP Signal Status: connected

EC500 Status: N/A

Message Waiting: VM Server
Connected Ports:

Parameter Download: complete

SAC Activated? no
one-X Server Status: N/A
Off-PBX Service State: N/A

Limit Incoming Calls? no

User Cntrl Restr: none
Group Cntrl Restr: none

HOSPITALITY STATUS
Awaken at:
User DND: not activated
Group DND: not activated
Room Status: occupied

8. Conclusion
These Application Notes describe the required configuration steps for the TigerTMS iCharge to
execute hospitality functions via the PMS link to Avaya Aura Communication Manager. All
test cases passed successfully with observations noted in Section 2.2.

9. Additional References
This section references the product documentations that are relevant to these Application Notes.
Avaya product documentation can be found at http://support.avaya.com.
Administering Avaya Aura Communication Manager, Release 6.3, 03-300509
GuestWorks and DEFINITY Enterprise Communications Server. Property Management
System Interface Specifications. Document ID 555-231-601, Issue 4, December 2001.
TigerTMS iCharge Product information available from http://www.tigertms.com

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

18 of 19
TigerPMS_CM63

2014

Avaya Inc. All Rights Reserved.

Avaya and the Avaya Logo are trademarks of Avaya Inc. All trademarks identified by and
are registered trademarks or trademarks, respectively, of Avaya Inc. All other trademarks
are the property of their respective owners. The information provided in these Application
Notes is subject to change without notice. The configurations, technical data, and
recommendations provided in these Application Notes are believed to be accurate and
dependable, but are presented without express or implied warranty. Users are responsible for
their application of any products specified in these Application Notes.
Please e-mail any questions or comments pertaining to these Application Notes along with the
full title name and filename, located in the lower right corner, directly to the Avaya
DevConnect Program at devconnect@avaya.com.

PG; Reviewed:
SPOC 5/13/2014

Solution & Interoperability Test Lab Application Notes

2014 Avaya Inc. All Rights Reserved.

19 of 19
TigerPMS_CM63