OXO-tc0091en-Ed05 Office Link Driver For Omnipcx Office
OXO-tc0091en-Ed05 Office Link Driver For Omnipcx Office
OXO-tc0091en-Ed05 Office Link Driver For Omnipcx Office
This document gives all necessary configuration details in order to install the Office Link Driver application.
Revision History
Legal notice:
The information presented is subject to change without notice.
ALE International assumes no responsibility for inaccuracies contained herein.
Copyright © ALE International 2015
Table of contents
1 Office Link Driver - Overview ................................................................................................................... 3
2 Office Link Driver - Operating modes ........................................................................................................ 3
3 Operating system compatibility ................................................................................................................ 4
In order to avoid a very large file, a limit of the number of Call accounting ticket stored in the xml file can be
set in the configuration file. This limit can be changed by modifying directly the configuration file (see section
9.3 Office Link driver configuration).
Each time the maximum ticket limit of the TicketCollector.xml is reached the driver automatically converts the
file into an archive file. The driver then creates a new empty TicketCollector.xml ready to accept new tickets.
All the archive files are kept in the same directory as the TicketCollector.xml (see section 9.3 Office Link driver
configuration, Metering Parameters) and are named using the following format:
- Ticketcollector_Year month day_hour min sec.xml
- e.g. TicketCollector_20060615_154138.xml
Windows Windows
2000 SP4 VISTA Windows 7 Windows 10 Windows
8 / 8.1 2012
2008 32
2000 server SP1 XP SP3 32-bit 32 / 64 32 / 64 32 / 64 server/
bits & R2
2012 R2
SP1
2003 server SP1 server
OLD OK OK OK (1) OK (2) OK (3) OK (3) OK (2) OK (3)
6 Connectivity architecture
The Office Link driver can be installed on the Front Office server along with a Hotel application or on a
separate server. The physical connections between the new O.L.D and the OmniPCX Office are via Ethernet
using TCP/IP (i.e. the same connection as used by OMC, via the CPU LAN port).
The V24 port (i.e.4093 plug ware) connection used by the original OHL driver is not used with the new O.L.D.
Instead, all Hotel messages and Hotel metering information exchanged between the OmniPCX Office and the
new O.L.D are via TCP/IP socket. The Hospitality Application interfaces to the O.L.D OHL interface port
(default port 2561) using TCP/IP.
Server
OmniPCX Office
Hotel Application
Software (PMS +CMS)
Ticketcollector.xml
OHL protocol
TCP/IP
Note The OLD is not to be installed on any Fidelio PC (nor if PC or Fidelio Server) and will not be installed by a
Micros Fidelio resource, but only by an Alcatel-Lucent or dealer resource.
Prerequisites
From OLD 2.3.12 version onwards, .Net Framework 3.5 needs to be installed in the PC, before
installing Office Link Driver.
Refer the following link for the steps to enable .Net Framework 3.5
https://msdn.microsoft.com/en-us/library/hh506443%28v=vs.110%29.aspx
However, the driver running mode can still be changed after the installation in the file called OHLdriver.conf if
really required. The file is found in the directory where you choose to install the driver.
Using a text editor (e.g. WordPad) - Simply change the line "DRIVER_RUNNING_MODE" to be either "HOTEL"
or "METERING" and save the file.
After the changes it is required to Stop and Restart the driver service using the Office Link Driver Configuration
application (Office Link Driver Configuration application is installed at the same time as the Office Link Driver
and Installed with a desk top short cut icon).
#######################################################
# AHL parameters
#######################################################
AHL_PORT=2561
CRC_PRESENCE=0
AHL_INTERFACE_LOG_LEVEL=1
#######################################################
# OXO parameters
#######################################################
OXO_PASSWORD=
Note: Changing the running mode to or from Hotel mode has no effect on the TicketCollector.xml or archive
files (i.e. All metering tickets are preserved and not effected).
To run the driver the Service must first be running. This is indicated in the Configuration tool window by the
Green light (Be sure that appliconf.exe was launched with administration's rights). The OLD Driver service is
installed as an "automatic" started windows service and so should
be running automatically as soon as the installation is finished .
The differences between the original OHL driver configuration tool and the new Office Link Driver
configuration tool are:
- Use the OXO Administrator password: kilo1987 (default)
(if the admin password is changed in the OXO then the new password must be entered into the
Office Link Driver Configuration tool "Admin password :" window then click Save).
- The Com port selection window has been removed (V24 no longer used for the metering).
Click the "Autodetect" button. This will find either the Host Name (if programmed) of the OXO and/or the CPU
IP address. Select the correct IP address or Host name using the drop down button.
Enter the OXO Admin password and Click the Save button.
If not check the physical connection and IP address to the CPU LAN port using the DOS PING command also
check your IP address and Admin Password (maybe it is not the default).
After the "TestConnection" has been performed it is possible and recommended to run the two tests offered
by the OLD Configuration tool.
The first test "Test Hotel Application->PCX" send a re-initialization frame from the O.L.D to the OXO and
returns a numerical value for the quantity of Guest rooms already checked in. (See Trouble shooting section of
this Technical communication if no value / ERROR or wrong value is displayed).
The second test "Test PCX-> Hotel Application" sends a Check-in frame to the OXO from the O.L.D
(Checked in name is: "DUPONT"). This test checks that a Wake up message is received by the O.L.D from the
OXO. "OK" is displayed for the successful test. To speed up this test it is possible to use the HOTEL key on the
operator set to access the Guest room details and cancel the wake up manually. (See Trouble shooting section
if the result of the test is not OK).
9 Configuration requirements
Noteworthy Address:
Change in Debug labels "OpeMetEna" to equal value 01
(This noteworthy address enables metering output for operator generated calls).
Hotel Parameters:
The "Print Check-In/Check-Out Ticket" checkbox must be checked.
Click "OK" to confirm your configuration.
Metering:
Select Metering printout
If metering units are required and not the costs calculated by the OmniPCX then the 3 Charge rates must be
programmed to equal 1 local currency and the 2 taxation unit thresholds to 1 unit. Therefore, the Cost field of
the metering ticket on the V24 will be equal to the metering unit received.
(i.e.: 1 unit = I euro)
The reason for this programming is because the Office Link Driver is not able to read the metering unit field of
the metering ticket, only the Cost field.
Restrictions
- This metering unit output programming prevents the use of COST display on digital Guest
Room phones which have LCD displays and prepayment cut-off.
- The deposit at check in must be a very large sum to allow calls without expiry of the deposit
(set a large default value).
Important Notes:
1. With the Office Link Driver running in Hotel mode both the OHL interface for a Hospitality
Application and metering interface, which generates the "Ticketcollector.XML" file, are available.
However, if running in Hotel mode then metering ticket are only collected if a Hotel application is in
connected state with the Office Link Driver. Unlike when using Metering mode only, then metering
information is collected by the TicketCollector .xml file as calls occur (provided the Office Link
Driver service is running and has a connected IP link to the OXO).
These configuration parameters are saved in a text file, and the password parameter will be encrypted for
security reasons. This text file can be easily set via the graphical Office Link driver configuration application.
The text file is under the main install directory and its name is "OhlDriver.conf".
However, if fine-tuning of the driver is required then it is possible to write directly into the file using a text
editor such as Microsoft "WordPad".
Technical support recommendation advise: Always stop and restart the Office Link Driver via the
Configuration application after changing and saving the configuration file, otherwise changes may not taken
into account by the driver.
AHL parameters:
CRC_PRESENCE: CRC presence parameter to allow compatibility with some applications that use CRC
presence in the TCP/IP connection and keep alive messages.
value 0 = CRC disabled (default) / value 1 = CRC enabled (used by all Fidelio PMS).
AHL_INTERFACE_LOG_LEVEL: Log level (level 1 to 4): trace level for Office Link Driver information
(Default value: 1, (see section 9.4 - Log file and level description, for definition of the 4 log levels).
OXO parameters:
OXO_PASSWORD: Administrator password of OXO for Web services access, (encrypted for security
reasons). Must be updated by the user/technician in this configuration file if changed in the OmniPCX Office.
OXO_LOG_LEVEL: Log level (up to 4): trace level for OXO information.
(Default value: 1 - (see section 9.4 - Log file and level description, for definition of the 4 log levels).
OXO_TIMEOUT: OHL inactivity connection time limit in second (default value: 30s). Modify this value only
according to Hotel Application recommendations.
OXO_IP_HOSTNAME: Hostname identifier of the OXO, this could be an IP address, or an identifier host
name (ex: IALIZE), but in this case the mapping of the host name / IP address should be entered in the
network parameter file /winnt/system32/drivers/ etc/hosts (e.g.: 192.168.92.246 IALIZE).
DRIVER_RUNNING_MODE: Defines the Office Link Driver operating mode. Can be either "Hotel" or
" Metering " (The value is defined during the installation phase of the O.L.D but can be changed at any time
via this "OHLdriver.conf" file).
Proxy parameters:
Access to OXO system can be achieved through proxy server. The parameters of this proxy server can be
configured directly into the configuration file: @IP or name, proxy port number, user account name, user
account password. By default, Office Link driver tries to connect to OXO system without using any proxy
server. To enable the use of the proxy, an IP address or host name must be configured in the driver
configuration file.
PROXY_IP_HOST_NAME: Proxy server IP address or Host name.
PROXY_PORT_NUMBER: Proxy port number.
PROXY_USER_NAME: User account name.
PROXY_USER_PASSWORD: User account password.
Metering parameters:
METERING_OVER_HTTPS: Defines the OXO Webserver services access type (Default value 1) should not
be changed.
METERING_COLLECTOR_DIR: Defines the directory were the Metering collector file is created and located.
Archive metering files are created in the same directory. No entry indicates the default O.L.D installed
directory.
METERING_COLLECTOR_MAX_TICKET: Max. size of the Metering Collector file . When this file size is
exceeded an archive metering collector ticket file is generated. (Default = 1000 metering tickets).
METERING_PORT: Not Used.
METERING_BAUDRATE: Not used.
METERING_BUFFER_MAX_SIZE: Office Link driver Metering interface message buffer size (max number of
messages). (Default value: 2000) - not to be confused with OXO metering buffer.
METERING_OVERFLOW_THRESHOLD: Metering interface overflow threshold (the metering data are
dumped into the defined in the GLOBAL_LOG_FILE entry of this file . If this overflow threshold is reached), in
percentage. This value is taking into account only if the METERING_OVERFLOW_BEHAVIOR is set to 1.
(Default value: 80)
Global parameters:
GLOBAL_LOG_FILE: Global Log file name containing all log file data. (Default log.txt)
(See section 9.4 Log file and level description, for definition of the log levels and file location).
GLOBAL_LOG_LEVEL: Trace level for global information.
(Default value: 4 - see section 9.4 Log file and level description, for definition of the 4 log levels).
LOG_FILES_MAX_SIZE: Maximum size, in bytes, of the log file (Default value: 500000).
The following is an example of a Configuration file having Log level 4 (enables all traces for debug
purposes) and a different directory for the TicketCollector.xml than the default.
The driver is running in metering mode and the OXO in Hotel and so no Hotel application will work
only Metering over IP:
#######################################################
# XXX_LOG_LEVEL,:
# - 1 = ERROR
# - 2 = ERROR and WARNING
# METERING_OVER_HTTPS
#
# METERING_COLLECTOR_DIR
#
# METERING_COLLECTOR_FILE
#
# METERING_COLLECTOR_MAX_TICKET
#
#######################################################
#######################################################
# System Version
#######################################################
OmniPCX Office Version : 3EH30368CSAA ALZFR500/030.003
OmniPCX Office Mode : Hotel
Driver version : 2.0.4
Configuration application version : 2.0.4
#######################################################
# AHL parameters
#######################################################
AHL_PORT=2561
CRC_PRESENCE=0
AHL_INTERFACE_LOG_LEVEL=4
#######################################################
# OXO parameters
#######################################################
OXO_PASSWORD=a21sbzE5ODc
OXO_LOG_LEVEL=4
OXO_TIMEOUT=30
OXO_IP_HOSTNAME=192.168.92.246
DRIVER_RUNNING_MODE=Metering
#######################################################
# PROXY parameters
#######################################################
PROXY_IP_HOST_NAME=
#######################################################
# Metering parameters
#######################################################
METERING_OVER_HTTPS=1
METERING_COLLECTOR_DIR=C:\metering_tickets
METERING_COLLECTOR_FILE=TicketCollector.xml
METERING_COLLECTOR_MAX_TICKET=5000
METERING_PORT=COM1
METERING_BAUDRATE=9600
METERING_BUFFER_MAX_SIZE=2000
METERING_OVERFLOW_THRESHOLD=80
METERING_OVERFLOW_BEHAVIOR=0
METERING_LOG_LEVEL=4
#######################################################
# Global parameters
#######################################################
GLOBAL_LOG_FILE=log.txt
GLOBAL_LOG_LEVEL=4
LOG_FILES_MAX_SIZE=500000
Note 1: LOG_LEVEL for each module (OHL_Interface, metering, OXO library and global log) represents the
degree of severity that user wants to be printed in log files.
Thus:
Note 2: The size of the log files is set in he OHLdriver.conf file. When a log file is full, it is renamed with a "1"
concatenated at the end of its name. The new log file has the same name as the old one. So there is
maximum 2 files of log outputs.
As a Multithreaded service process, the OHL driver uses separated threads during running time. The THREAD
NUMBER is the given internal system values for each of them. This value is useful in order to know for
example a service restarting or stopping.
1. The generic OmniPCX Office Release 500/030.004 is released but there is an interworking
issue with the Office Link Driver with these versions you must be aware about.
The problem is reported with XTSce79030
The problem is that the TicketCollector.xml file is not generated and the log.txt file shows all
tickets are wrong. In R500 the ticket pool format has changed and with a migration, the
previous formatted pool is restored. Then when reading the ticket, some fields are not well
intialised so that there are some bad values in some fields (control characters).
2. If the OXO system does not have "External Metering Activation IP " enabled or you have
selected External Metering Activation V24 then the O.L.D Configuration application
'TestConnection' will work but the TicketCollector.xml will not be generated.
3. Should the OXO system not have a Software key for Metering over IP then the
TicketCollector.xml will not be generated and Hotel running mode will not work.
4. If the OXO system is in Hotel mode and the O.L.D running in Hotel mode then the O.L.D
Configuration application "TestConnection" will work but the first of the TESTS (i.e. Test Hotel
Application ->PCX) will give the result "ERROR " if the OXO system does not have "External
Metering Activation IP" enabled or you have selected External Metering Activation V24.
twitter.com/ALUE_Care
facebook.com/ALECustomerCare
- END OF DOCUMENT -