PBX Link

Communication between the 7.00 and the PBX for the purpose of passing hospitality-related information is typically supported using a dedicated link (that is, a link separate from the one used for handling voice calls and inband signalling).

Information passed to the PBX for a given room extension may include changing the name, changing the phone's class of service, and changing its DND status; in some cases, it may include actual check in, check out and room move commands as received from the PMS. In turn, the PBX may send maid status codes to the 7.00 (which can be passed on to the PMS).

However, not all PBX systems provide such a link.

To configure the PBX Link, on a per-profile basis, follow these steps:

  1. Stop the voice service using Activity Monitor.
  2. Run System Configuration.
  3. Select Site | Profiles.
  4. Select the profile to edit and click Edit.
  5. On the Details page, use the PBX selection box to assign the desired PBX link protocol.
  6. Select the appropriate sub-page under the PBX Link heading on the left.
  7. Configure the link settings as desired. For more details, click the appropriate link in the PBX Link column in the table below.
  8. After saving your changes, close System Configuration.
  9. Restart the system using Activity Monitor.

The 7.00 supports a PBX hospitality link for the following systems:

The link type TCP server means the 7.00 is acting as the server/host and TCP client means the PBX is the server/host. If both are listed, it means the 7.00 can be configured to use either type of connection.

PBXPBX LinkLink TypeProtocol(s) UsedLog File PrefixFeatures Supported
AeonixAeonixTCP serverAeonix-supported subset of Oracle Opera FIASAEONIXCheck In
Check Out
Room Move
Name Change
Language Change
Maid Status
Controlled Restriction
DND
Alcatel OmniPCX EnterpriseAlcatel OXETCP clientAHL (edition 3)ALCATELOXE5- or 8-digit extension fields
Check In
Check Out
Name Change
Language Change
Maid Status
Controlled Restriction
DND
VIP
Alcatel OmniPCX OfficeAlcatel OXOTCP clientOHL (version R2.3.8, edition 2.1)ALCATELOXOCheck In
Check Out
Name Change
Language Change
Maid Status
Controlled Restriction
DND
Avaya ACMAvaya ACMTCP serverAvaya GuestWorks PMSI (ASCII mode only)ACMCheck In
Check Out
Room Move
Name Change
Maid Status
MWI
Controlled Restriction
Avaya IP OfficeIP OfficeTCP clientIP Office Config. Service, TAPI (for DND)IPOPBXLINKName change
Set user rights group (phone COS)
DND
Cisco CUCMCiscoTCP clientCisco AXL interfaceCISCOName change
Set user rights group (phone COS)
DND
HTTP PostHTTP PostTCP clientHTTP, HTTPSHTTPPOSTName change
Set user rights group (phone COS)
DND
IPitomyIPitomyTCP clientHTTP, HTTPSIPITOMYName change
Set user rights group (phone COS)
DND
MWI
MetaswitchMetaswitchTCP clientProprietary Metaswitch protocolMETASWITCHName change
Set user rights group (phone COS)
Mitel 3300MitelSerial, TCP clientMitel SX-2000 Light PMSIMITELCheck In
Check Out
Name Change
Maid Status
MWI
Station Restriction
NEC 3C (Univerge)Univerge 3CTCP clientNEC SOAP interfaceUNIVERGEName change
Set user rights group (phone COS)
DND
NEC SV8100 / SV9100NEC KTS-iSerial, TCP clientNEC KTS-i (5-digit)NECKTSICheck In
Check Out
Name Change
Maid Status
MWI
Station Restriction
DND
NEC SV9300 / SV9500NEC NEAX 60/90SerialNEC NEAX Model 60/90NECNEAXCheck In
Check Out
Room Move
Name Change
Maid Status
MWI
Station Restriction
Nortel / CS1000NortelSerial, RLogin clientNortel PMSINORTELCheck In
Check Out
Name Change
Maid Status
Station Restriction
DND
VIP
Panasonic KX-NS1000Panasonic KX-NS (FOSI)TCP clientPanasonic FOSIPANASONICFOSICheck In
Check Out
Room Move
Name Change
Language Change
Maid Status
Controlled Restriction
DND
Panasonic KXTDE / NSXXXN/ATAPIPanasonic TAPIPANASONICName change
Set user rights group (phone COS)
ShoreTelShoreTelTCP clientShoreTel hospitality interfaceSHORETELName change
Set user rights group (phone COS)
Siemens OpenScapeSIEMENSTCP clientSIEMENS SOAP interfaceSIEMENSName change
Set user rights group (phone COS)
DND
VodaviN/AInbandVodavi inband codesLINEn (n = line #)Station restriction

As shown in the table above, each PBX Link logs its activity to a log file named after the PBX or protocol in use. The one exception is Vodavi. Because Vodavi uses inband signalling via a notification technique, its activity is logged in the LINE log for the line that performed the given notification.

For example, the Alcatel OXO link log would be identified as ALCATELOXO. Log files use the file extension .LTT and are stored in the path C:\VS\TRACELOGS.

Each night around midnight, the log files “roll over,” meaning the current log ALCATELOXO.LTT is renamed as ALCATELOXO-YYYYMMDD0000.LTT, or something similar, where YYYYMMDD is the year, month and day of the content of the file (that is, the date that most or all of the log entries were logged). Older files are moved to the ARCHIVE sub-folder.

Log files may be viewed using the Trace Display application, shown below. Refer to the Trace Display page for more details on using this utility.

The log file contains the following fields, shown as columns in the dialog above:

ColumnDescription
LogThe base name that identifies which log the entry was logged to. This will vary based on the PBX Link.
Date-TimeThe date and time when the log entry was logged. Format is: YYYY/MM/DD-HH:MM:SS.msec.

All values are padded with leading zeros; the millisecond value is padded to three digits and all others to two digits. The hour value is always in 24-hour clock notation.
FilterFilter level. Can be ignored.
DataThe actual log statement generated by the service. Log statements can be a little cryptic and are generally intended as a debugging aid for the manufacturer's technicians and developers. Still, they can sometimes be useful even to on-site technicians to verify or troubleshoot certain issues.

In the case of a PBX Link log, you can see that the PBX has connected and that data is being sent back and forth. You can also see the raw packet information (with the exception that non-printable characters are translated to their 2-digit hexadecimal values and enclosed in angle brackets).
  • Last modified: 2023/01/07 11:45
  • by 127.0.0.1