Configuring the VCS and VMP Interface

The Vocera Client Gateway provides support for SIP signaling over a TCP connection. This enables connections between the Vocera Client Gateway and Vocera Collaboration Suite clients. The Vocera Client Gateway also supports the API for the VMP Server, which enables the Vocera Client Gateway to send push notifications and escalate wakeup signals.

The following configurable parameters are included:

Table 1. VCS and VMP interface properties

Property

Description

VCGIOSClientPingInterval

The expected ping interval from a VCS iOS client. The default is 120 seconds.

The Vocera Client Gateway sends a ping request to the client when this interval expires. If the client does not send a ping back, the Vocera Client Gateway sends a request again in the ping interval specified in this property.

VCGAndroidClientPingInterval

The expected ping interval from a VCS Android client. The default is 120 seconds.

The Vocera Client Gateway sends a ping request to the client when this interval expires. If the client does not send a ping back, the Vocera Client Gateway sends a request again in the ping interval specified in this property.

VCGVMPConnectionPortNo

The connection port for the VMP API. The Vocera Client Gateway listens on this port, and the VMP Server opens a TCP connection to it. The default port is 5008.

VCGWakeupPingTimerInterval

The internal Vocera Client Gateway timer interval. This timer initiates ping pre-timeouts and escalates unanswered pings to the VMP Server, which then sends a wakeup signal using APNS or GCM. The default is 500 milliseconds.

VCGWakeupIOSPingWaitInterval

Specifies the length of time that the Vocera Client Gateway is to wait for a ping from the VMP Server after a ping request is sent to a VCS iOS client using a SIP TCP connection. The default is 1200 milliseconds.

If no ping is received, the Vocera Client Gateway sends a wakeup signal to the VMP Server.

If this property is set to 0, the Vocera Client Gateway sends an APNS wakeup signal right away, and does not wait for a ping request timeout.

VCGWakeupAndroidPingWaitInterval

Specifies the length of time that the Vocera Client Gateway is to wait for a ping from the VMP Server after a ping request is sent to a VCS Android client using a SIP TCP connection. The default is 1200 milliseconds.

If no ping is received, the Vocera Client Gateway sends a wakeup signal to the VMP Server.

If this property is set to 0, the Vocera Client Gateway sends a GCM wakeup signal right away, and does not wait for a ping request timeout.

VCGWakeupIOSCooldownInterval

The time interval during which repeated ping requests should not be sent to the same VCS iOS client. This keeps the client from being flooded with multiple ping requests. The default is 10000 milliseconds.

VCGWakeupAndroidCooldownInterval

The time interval during which repeated ping requests should not be sent to the same VCS Android client. This keeps the client from being flooded with multiple ping requests. The default is 10000 milliseconds.

VCGWakeupVerboseLogging

This option enables additional logging for troubleshooting. The default is false.