UHLL Interface

From Pbxnsip Wiki

Universal Hospitality Language Layer (UHLL) is now the industry standard messaging language that enables communication between UHLL-compliant Property Management Systems (PMS) and Guest Service System (GSS) devices, such as a UHLL compliant PBX.

UHLL is developed by Comtrol.

pbxnsip Inc, supports UHLL messages related to PBX on the TCP/IP interface.

---

Contents 1 How to setup pbxnsip Inc.’s UHLL software? 2 UHLL Messages for PBX 3 Check In Room 4 Check Out Room 5 Maid Codes 6 Restrict Phone

How to setup pbxnsip Inc.’s UHLL software?

1. Download UHLL software and extract it to a convenient location under the Windows file system.
2. The file uhllinstall.zip contains uhlld.exe, uhll.xml files.
3. Extract the files.
4. Edit uhll.xml and modify the following parameters
   1. ip_pbx_port – IP address and the port number of your PBX (Ex: 127.0.0.1:80 when uhlld.exe running on the same system as your PBX).
   2. ip_pms_port – IP address and port number of the PMS system. (Ex: 10.0.1.10:55667)
   3. ip_local_port – Local port for the uhll.exe (Ex: 6100. If this port is being used by other applications, then use a different port)

Note: Other parameters in the file are not being used now. Future releases may use them.

1. Copy the uhll.xml to c:\windows\system32 folder.
2. Open a command window.
3. Type in 'uhlld.exe /install'.

This will install uhlld service on your computer. You can open the service manager and start/stop the service as and when you need. The uhlld service is how in displayed below as show in the ms-windows 'services'.

The log file uhlld.log will be created under c:\windows\system32 folder by default and will contain the logging information. Note: You may have to run the installation as administrator. To do this you can open the command window as administrator and execute the installation.

UHLL Messages for PBX

There are several messages need to be supported by a UHLL compliant PBX.

Some important messages are -

1. Check In Room
2. Check Out Room
3. Maid Codes
4. Room Move*
5. Do Not Disturb
6. Check In Guest*
7. Check Out Guest*
8. Swap*
9. Credit Limit*
10. Restrict Phone
11. Language
12. VIP*

Note: '*' indicates that these messages are not processed by the PBX yet.

For more information on the messages, please refer UHLL Specification Document defined by Comtrol.

Check In Room

During the "Check In Room", PBX sets up the first name, display name for the extension. It also enables the voice mail box for that extension. Then PBX sends a message to the phone asking for a soft-reboot. This will force the phone get the latest changes made to that extension. Note: soft-reboot works only on the snom phones.

Check Out Room

During the "Check out Room", PBX resets the information about the previous guest. It also, disables the voice mail and clears any of the message waiting indicators for that extension. Similar to the "Check In Room", PBX soft-reboots the snom phone.

Maid Codes

This section describes how to configure and use the maid codes on PBX.

Maid codes are sent from the PBX to the PMS system. In order to successfully process the maid code request, the PBX has to be setup properly. Here are the steps to follow:

1. Create an IVR Node under PBX.
2. Under “Settings” select wav file to play when user dials IVR number “555”. Note: use the appropriate IVR number for your installation.
3. Set the DTMF match list. The one shown in the diagram lets you press any maid code from the Maid Code List and press the ‘#’ key.
4. Setup the SOAP URL based on the IP address and the port number of the UHLL server. Typically, if you run the uhll server on the PBX system (PC). So you can use address shown in the diagram below.
5. Hit “Save”.

Restrict Phone

This section shows how to configure PBX for handling the 'Restrict Phone' message.

“Restrict Phone” message is sent by the PMS system to the PBX. In order to successfully process this message, we have to set up few ‘named’ dial plans on the PBX. These dial plan names are fixed and cannot be changed. These names are based on the Call Restriction List defined by UHLL specifications. The diagram below shows the created dial plans.