The following sections cover how to configure Envoy's PMS link for each of the supported protocols.
Link Section
| Setting | Value | Units | Notes |
| Type | client
server | N/A | Enter whichever option is appropriate based on whether the PMS is setup as server or as client, respectively. |
| Protocol | dvadv | N/A | Enter this string to select the DuVoice Advanced protocol. |
| ACKDelay | 0, 100-900 | msec | If you suspect the PMS is having a problem with Envoy sending an ACK/NAK response too quickly after receiving a packet, try setting this to a higher value. Typically, this would be set in 100 ms increments. |
| KeepAlive | 300 | sec | Controls whether Envoy sends keep alive messages. Set this value based on what the PMS expects.
Suggested minimum is 300 sec, which is 5 minutes, unless you want to disable it. To disable Envoy from sending keep alive messages, set this value to 0. |
| IdleTimeout | 60 | min | If Envoy does not receive any input at all from the PMS for at least this period of time, Envoy will assume the link is not functioning and will attempt to drop and reconnect it. |
Client Section
| Setting | Value | Format | Notes |
| Port | varies | numeric | If the PMS is acting as the server side of the TCP link, set this value to the TCP port that the PMS expects for this link. |
| ServerAddress | varies | x.x.x.x | If this PMS is acting as the server side of the TCP link, set this value to the IP address of the PMS. |
Server Section
| Setting | Value | Units | Notes |
| Port | varies | numeric | If the PMS is acting as the client side of the TCP link, set this value to the TCP port number the PMS will use to connect to Envoy. |
Protocol Section
| Setting | Value | Notes |
| AlwaysACKENQ | 0 Disabled
1 Enabled | If the PMS sends an enquiry (ENQ) byte–that is hex value 05–prior to sending a message packet, leave this value set to 1 (enabled). This is the way DuVoice Advanced protocol typically expects it to be configured. However, this feature is entirely optional and depends on the PMS. |
| EnableSendENQ | 0 Disabled
1 Enabled | If the PMS expects Envoy to send an ENQ byte (and receive an ACK response) before sending a message packet, set this to 1; otherwise, leave it set to 0. |
| SwapAtStart | 0 Disabled
1 Enabled | Set this to 1 to request a database sync at startup. Generally, this is not a good idea, especially on large, busy systems. But it can be useful during installation to get the latest data from the PMS, after which you can then disable it. |
| EnableChecksum | 0 Disabled
1 Enabled | By default, the DuVoice Advanced protocol recommends using checksums, however this is optional and you should configure it based on what the PMS expects. |
Link Section
| Setting | Value | Units | Notes |
| Type | client | N/A | Hilton OIAS PMS is assumed to be the server side of the link. |
| Protocol | oias | N/A | Enter this string to select the Hilton OIAS protocol. |
| ACKDelay | 0, 100-900 | msec | If you suspect the PMS is having a problem with Envoy sending an ACK/NAK response too quickly after receiving a packet, try setting this to a higher value. Typically, this would be set in 100 ms increments. |
| KeepAlive | 300 | sec | Controls whether Envoy sends keep alive messages. Set this value based on what the PMS expects.
Suggested minimum is 300 sec, which is 5 minutes, unless you want to disable it. To disable Envoy from sending keep alive messages, set this value to 0. |
| IdleTimeout | 60 | min | If Envoy does not receive any input at all from the PMS for at least this period of time, Envoy will assume the link is not functioning and will attempt to drop and reconnect it. |
Client Section
| Setting | Value | Format | Notes |
| Port | varies | numeric | Enter the TCP port that the PMS expects for this link. |
| ServerAddress | varies | x.x.x.x | Enter the IP address of the PMS. |
Protocol Section
| Setting | Value | Notes |
| AlwaysACKENQ | 0 Disabled | The OIAS protocol is similar to Opera FIAS and does not use ENQ over a TCP link. |
| EnableSendENQ | 0 Disabled | The OIAS protocol is similar to Opera FIAS and does not use ENQ over a TCP link. |
| SwapAtStart | 0 Disabled
1 Enabled | Set this to 1 to request a database sync at startup. Generally, this is not a good idea, especially on large, busy systems. But it can be useful during installation to get the latest data from the PMS, after which you can then disable it. |
| EnableChecksum | 0 Disabled | The OIAS protocol is assumed to not use checksum; however, this can be set to 1 if the PMS actually does expect a checksum. |
FIAS Overrides Section
As Hilton OIAS is very similar to Opera FIAS, some settings in this section may be relevant.
| Setting | Value | Notes |
| EnableDID | 0 Disabled | The OIAS protocol not support DID assignment. |
| EnableGF | 1 Disabled | Leave set to 1 if the PMS sends the GF (guest first name) and GT (guest title) fields; if it only sends GN (guest name), set the value to 0. |
Link Section
| Setting | Value | Units | Notes |
| Type | client | N/A | For the Opera FIAS protocol, the PMS is always the server side of the TCP link, so Envoy is always the client. |
| Protocol | fias | N/A | Enter this string to select the Opera FIAS 2.11 protocol. |
| ACKDelay | 0, 100-900 | msec | If you suspect the PMS is having a problem with Envoy sending an ACK/NAK response too quickly after receiving a packet, try setting this to a higher value. Typically, this would be set in 100 ms increments. |
| KeepAlive | 300 | sec | Controls whether Envoy sends keep alive messages. Set this value based on what the PMS expects.
Suggested minimum is 300 sec, which is 5 minutes, unless you want to disable it. To disable Envoy from sending keep alive messages, set this value to 0. |
| IdleTimeout | 60 | min | If Envoy does not receive any input at all from the PMS for at least this period of time, Envoy will assume the link is not functioning and will attempt to drop and reconnect it. |
Client Section
| Setting | Value | Format | Notes |
| Port | varies | numeric | Set this to the port number used by the PMS for this link. |
| ServerAddress | varies | x.x.x.x | Set this value to the IP address of the PMS. |
Protocol Section
| Setting | Value | Notes |
| AlwaysACKENQ | 0 Disabled | Opera FIAS does not use ENQ over a TCP link |
| EnableSendENQ | 0 Disabled | Opera FIAS does not use ENQ over a TCP link. |
| SwapAtStart | 0 Disabled
1 Enabled | Set this to 1 to request a database sync at startup. Generally, this is not a good idea, especially on large, busy systems. But it can be useful during installation to get the latest data from the PMS, after which you can then disable it. |
| EnableChecksum | 0 Disabled | Opera FIAS does not use checksums over a TCP link. |
FIAS Overrides Section
| Setting | Value | Notes |
| EnableDID | 0 Disabled | If the Opera PMS has the DID feature installed and enabled, you can set this value to 1; otherwise, leave it set to 0. |
| EnableGF | 1 Disabled | Leave set to 1 if the PMS sends the GF (guest first name) and GT (guest title) fields; if it only sends GN (guest name), set the value to 0. |
This is a default version of the DV2000 Envoy configuration file.
'----------------------------------------------------------------------------------------
' Protocol ID list
'----------------------------------------------------------------------------------------
' The following protocols are supported when LinkType is either 'client' or 'server':
'----------------------------------------------------------------------------------------
' dvadv = DuVoice Advanced (typically EnableChecksum should be set to 1)
'
'----------------------------------------------------------------------------------------
' The following protocols are supported ONLY when LinkType is 'client':
'----------------------------------------------------------------------------------------
' fias = Hilton OIAS (EnableChecksum should be set to 0)
' oias = Opera FIAS 2.11 (EnableChecksum should be set to 0)
'
'----------------------------------------------------------------------------------------
' Link Types
'----------------------------------------------------------------------------------------
' client - use [client] settings
' server - use [server] settings
'----------------------------------------------------------------------------------------
[Link]
Type=server
'PMS protocol to use; see list above.
Protocol=dvadv
'Number of msec to wait after receiving a packet before responding with ACK or NAK.
ACKDelay=0
'Interval for sending a keep-alive, in seconds. Set to 0 to disable.
'Default of 300 equals 5 minutes.
KeepAlive=300
'Length of time, in minutes, we can receive no input from the PMS before assuming
'the link is dead.
IdleTimeout=60
[client]
Port=5003
ServerAddress=127.0.0.1
[server]
Port=5003
[rest]
Port=5004
' Required list of user accounts allowed access to the service. Passwords are
' case-sensitive and limited to 250 characters
' Example: apiuser=23AbcDg
[users]
'----------------------------------------------------------------------------------------
' Protocol overrides common to most protocols
'----------------------------------------------------------------------------------------
[Protocol]
'If set to 1, Envoy will always respond with ACK on receipt of ENQ.
AlwaysACKENQ=1
'If set to 1, Envoy will send an ENQ and wait for an ACK before sending a packet, if the
'protocol supports it.
EnableSendENQ=0
'If set to 1, Envoy will send a 'login' message at startup, if the protocol supports it.
LoginAtStart=1
'If set to 1, Envoy will request a database swap at startup, if the protocol supports it.
'This should not be enabled in general use as database swaps can bog down the system.
SwapAtStart=0
'If set to 1, every packet sent to the PMS will have an LRC checksum appended to the
'end and those received from the PMS must also end with a checksum. This depends on
'the protocol, but can also vary by PMS as in some cases it is configurable on the
'PMS as well.
'
' DuVoice Advanced - typically should be set to 1 to use checksum.
' Hilton OIAS - typically should be set to 0 to NOT use checksum.
' Opera FIAS - should always be set to 0 as Opera does not use checksum over TCP.
EnableChecksum=1
'----------------------------------------------------------------------------------------
' Protocol overrides specific to FIAS-based protocols
'----------------------------------------------------------------------------------------
[FIAS Overrides]
'Set to 1 if connected to an Opera PMS with the DID feature installed and enabled.
EnableDID=0
'Set to 1 if the PMS is configured to send GF/GN/GT fields; set to 0 if only GN is used.
EnableGF=1