Configuring Nurse Call Connector for TAP Message Splitter

TAP message splitter is a feature wherein the same message can be configured to be sent to CWE alone, only to third party, or to both CWE and third party.

This is a Windows service installed as Vocera Nurse Call Connector in the list of services.

To configure the TAP message splitter functionality:

1. Open the CWE installation folder. This is normally c:\Vocera.
2. Open the CWE\Vocera Nurse Call Connector\Config subfolder.
3. Open the Configuration.xml file.
4. Specify the third party server settings. The contents of the third party server are dependent on the interface and the nurse call system that you are using.

Scenario 1: TAP message sent only to CWE

In the below configuration, assume that the input system sends messages with pager ID 100 and 200. If you configure PagerID = 100, 200, then the TAP messages with pager ID 100 and 200 will be processed and delivered to CWE.

Although the TPPagerID value is configured as 100, it will not be processed since the value in the TPServerIP is set to 0.0.0.0. Hence no message will be processed for the third party server.

<interface>
	<name>PagerInfinity</name>
		
	<serverPort>3100</serverPort>

	<NoChecksum> true </NoChecksum>
	<NoRcvTimeout> false </NoRcvTimeout>
	<NoLogin> false </NoLogin>
	<PingInterval>10000</PingInterval>
	<PingTimeout>10000</PingTimeout>
	<ResetInterval>0</ResetInterval>
	<PagerID>100,200</PagerID>
	<clientsAllowed>127.0.0.1</clientsAllowed>

	// third party server
	<TPServerIP>0.0.0.0</TPServerIP>
	<TPServerPort>3200</TPServerPort>
	<TPConnectionRetryInterval>2</TPConnectionRetryInterval>
	<TPPagerID>100</TPPagerID>
	<TPAlarmLimitInterval>1</TPAlarmLimitInterval>
</interface>

Scenario 2: TAP message sent only to Third Party

In the below configuration, assume that the input system sends messages with pager ID 100 and 200. If you configure TPPagerID = 100, then the TAP messages with pager ID 100 will be processed and delivered to the third party server.

Note that the PagerID value is configured as 0, hence no message will be processed for CWE.

<interface>
	<name>PagerInfinity</name>
		
	<serverPort>3100</serverPort>

	<NoChecksum> true </NoChecksum>
	<NoRcvTimeout> false </NoRcvTimeout>
	<NoLogin> false </NoLogin>
	<PingInterval>10000</PingInterval>
	<PingTimeout>10000</PingTimeout>
	<ResetInterval>0</ResetInterval>
	<PagerID>0</PagerID>
	<clientsAllowed>127.0.0.1</clientsAllowed>

	// third party server
	<TPServerIP>(Third party IP address)</TPServerIP>
	<TPServerPort>3200</TPServerPort>
	<TPConnectionRetryInterval>2</TPConnectionRetryInterval>
	<TPPagerID>100</TPPagerID>
	<TPAlarmLimitInterval>1</TPAlarmLimitInterval>
</interface>

Scenario 3: TAP message sent to both CWE and Third Party

In the below configuration, assume that the input system sends messages with pager ID 100 and 200. If you configure PageID = 100, 200, then the TAP messages with pager ID 100 and 200 will be processed and delivered to CWE.

Note that the TPPagerID value is configured as 100, hence TAP message with pager ID 100 will be processed and delivered to the third party server.

<interface>
	<name>PagerInfinity</name>
		
	<serverPort>3100</serverPort>

	<NoChecksum> true </NoChecksum>
	<NoRcvTimeout> false </NoRcvTimeout>
	<NoLogin> false </NoLogin>
	<PingInterval>10000</PingInterval>
	<PingTimeout>10000</PingTimeout>
	<ResetInterval>0</ResetInterval>
	<PagerID>100,200</PagerID>
	<clientsAllowed>127.0.0.1</clientsAllowed>

	// third party server
	<TPServerIP>(third party IP address)</TPServerIP>
	<TPServerPort>3200</TPServerPort>
	<TPConnectionRetryInterval>2</TPConnectionRetryInterval>
	<TPPagerID>100</TPPagerID>
	<TPAlarmLimitInterval>1</TPAlarmLimitInterval>
</interface>

The following table describes the parameters for the third party server:

Parameter	Description
TPServerIP	The IP address of the third party server.
TPServerPort	The port at which the server will listen for the nurse call system.
TPConnectionRetryInterval	The amount of time to wait, in seconds, before connecting to the third party system. If TPConnectionRetryInterval is 2, the nurse call system will wait for 2 seconds before trying to connect to the third party system. Vocera recommends that you use the default value of 2 seconds.
TPPagerID	Pager IDs supported by the third party. Multiple pager IDs can be provided by using a comma to separate each pager ID.
TPAlarmLimitInterval	The amount of time defined to store the TAP messages during retry of connection to the third party system. If TPAlarmLimitInterval is 1, the nurse call system will store TAP messages received in the last 1 minute and send it to the third party system once the connection is restored. The default value is 1 minute.

After creating the <TPServer> tag within the <interface> tag, save the changes. This will complete the configuration for a TAP message splitter.

Notes:

• All fields are required in the configuration file.
• To add a comment to the configuration file, precede it with the // characters.
• Multiple templates and normalizers can be added for a single channel. In this case, it is best to keep the normalizer in sequence.
• In the normalizer, the tags and elements are case insensitive, and the element values are case sensitive.
• This configuration is not required within the interface if there is no third party system configured.
• Restart of service is not required after configuring the third party information.