Connex Device Integration Suite Network Connectivity Engine software, Installation Guide

Connex Device Integration Suite Network Connectivity Engine software, Installation Guide

Connex

®

Device Integration

Suite (CDIS)

Network Connectivity Engine

-

(NCE) software

CP 50™ electrocardiograph

CP 100™ and CP 200™ electrocardiographs

Spot Vital Signs ® LXi™ vital signs device

CP 150™ electrocardiograph

Connex Vital Signs

Monitor ® 6000 series

Installation guide

Software version 5.0.X

Connex ® Spot Monitor

ii

Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

© 2015 Welch Allyn. All rights are reserved. To support the intended use of the product described in this publication, the purchaser of the product is permitted to copy this publication, for internal distribution only, from the media provided by Welch Allyn. No other use, reproduction, or distribution of this publication, or any part of it, is permitted without written permission from Welch Allyn.

Welch Allyn assumes no responsibility for any injury to anyone, or for any illegal or improper use of the product, that may result from failure to use this product in accordance with the instructions, cautions, warnings, or statement of intended use published in this manual.

Welch Allyn, CSM, CVSM, Connex, and Spot Vital Signs are registered trademarks of Welch Allyn. CP 50, CP 100, CP 150, CP 200,

CardioPerfect, and SpiroPerfect are trademarks of Welch Allyn.

Windows, Vista, and ActiveSync are registered trademarks of Microsoft Corporation in the United States and other countries. SD is a trademark of Toshiba.

Software in this product is copyrighted by Welch Allyn or its vendors. All rights are reserved. The software is protected by United

States of America copyright laws and international treaty provisions applicable worldwide. Under such laws, the licensee is entitled to use the copy of the software incorporated within this instrument as intended in the operation of the product in which it is embedded. The software may not be copied, decompiled, reverse-engineered, disassembled or otherwise reduced to human-perceivable form. This is not a sale of the software or any copy of the software; all right, title and ownership of the software remains with Welch Allyn or its vendors.

For information about any Welch Allyn product, contact Welch Allyn Technical Support: http://www.welchallyn.com/about/company/locations.htm

Revision Date:2015-02

DIR 80019821 Ver. A

Welch Allyn, Inc.

4341 State Street Road

Skaneateles Falls, NY 13153 USA www.welchallyn.com

Welch Allyn Limited

Navan Business Park

Dublin Road, Navan

County Meath, Republic of Ireland

Contents

1 - Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

General warnings and cautions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

About CDIS-NCE software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Spot LXi, Connex VSM 6000, and Connex Spot Monitor configuration examples 4

CP 50, CP 100, CP 150, and CP 200 configuration examples . . . . . . . . . . . . . . . 5

2 - Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Spot LXi, Connex VSM 6000 Series, and Connex Spot Monitor . . . . . . . . . . . . . 7

CP 50, CP 100, CP 150, or CP 200 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3 - Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Configuring the CP 50, CP 150, and CP 200 patient-match criteria

(resolving patients) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Configuring the CardioPerfect Workstation for non-Welch Allyn devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

NCE configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

File Importer configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

4 - Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

About the connectivity software modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Reassigning a server IP address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Troubleshooting chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

iii

iv

Contents Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

1

Overview

About this guide

This guide describes how to install, configure, and troubleshoot the Welch Allyn Connex

Device Integration Suite (CDIS) - Network Connectivity Engine (NCE) software.

For related procedures — for example, configuring the CP 150 electrocardiograph for connectivity, installing the wireless radio, or installing the CardioPerfect Workstation software — see separate instructions for the specific product.

For details on HL7 connectivity, contact your Welch Allyn service representative.

This guide is written for network administrators and others with a background in information technology.

General warnings and cautions

Throughout this manual, warning statements indicate conditions or practices that could lead to illness, injury, or death. Caution statements indicate conditions or practices that could damage the equipment or other property.

WARNING Reanalyzing imported ECG or spirometry data at a CardioPerfect

Workstation might affect measurement values and predicted values due to platform differences, possibly changing the automatic interpretation.

1

2

Overview Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

System requirements

Operating systems

Server Windows 2008 R2, Windows 2012 R2.

Client PC

Computer requirements

Windows 7 (x86 and x64), Windows 8 (x86 and x64), Windows

8.1 (x86 and x64).

Any computer may be used that meets the selected operating system requirements.

RAM required to support application: 16 MB (Typical); 64 MB

(Maximum)

Storage required to support application: 20 MB (Typical); 2 GB

(approximate maximum) when using debug features.

Note: The CP 200 (software version 2.6 or lower) requires an upgrade to 2.6 or higher to operate with CDIS-NCE.

Note: An Internet connection is required for installation and first time operation.

Note: .NET 3.5 is required for CP ECG and Spirometer device connectivity to the

CPWS.

Installation guide Overview

3

About CDIS-NCE software

The Welch Allyn CDIS-NCE software is a collection of software modules that enable various Welch Allyn devices to communicate with systems such as HL7 host systems and

Welch Allyn CardioPerfect Workstations.

Wireless

USB

b

Device

CP 50

WiFi Ethernet USB Media

CP 100

CP 150

CP 200

Spot LXi a, b

Connex

VSM 6000 b

Connex

Spot

Monitor b a. 802.11 b. Note: Welch Allyn supports two radio models for Spot LXi.

b. 802.11 a/b/g.

Removable media

From a connected device, you can do the following:

• Send vitals data to data systems.

• Send ECG and/or spirometry tests to a CardioPerfect database.

• Recall patient information from a CardioPerfect database (CP 50 and CP 150 only).

• Retrieve patient lists from an EMR/HIS using a Welch Allyn HL7 interface, sold separately (Connex VSM, CP 50, and CP 150 only).

Even without a connection, users of CP 50, CP 100, CP 150 and CP 200 electrocardiographs can transfer tests to a CardioPerfect database via removable media

(SD memory cards or USB storage devices).

4

Overview Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Spot LXi, Connex VSM 6000, and Connex Spot Monitor configuration examples

Client-server network configuration, wireless or Ethernet

Server

Installation menu option:

“Server”

Functional diagram:

“Software modules in a simple network configuration, wireless or Ethernet” on page 36

Client-server configuration

USB cable

Functional diagram:

“Software modules in a USB configuration” on page 36

Workstation (client)

Installation menu option:

“Client”

Installation guide Overview

5

CP 50, CP 100, CP 150, and CP 200 configuration examples

Standalone configuration, removable media or USB

or

USB cable

CardioPerfect Workstation

Installation menu option: “Server”

Functional diagram:

“Software modules in a standalone CardioPerfect Workstation, removable media or USB” on page 34

Client-server configuration, removable media or USB

Server

Installation menu option:

“Server” or

USB cable

Workstation (client)

Installation menu option: “Client”

Functional diagram:

“Software modules in a client-server configuration, removable media or USB” on page 35

6

Overview Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Ethernet network configuration

Server

Installation menu option:

“Server”

CardioPerfect Workstation (client)

No connectivity software installed

Functional diagram:

“Software modules in a client-server and Ethernet network configuration” on page 35

2

Installation

Spot LXi, Connex VSM 6000 Series, and Connex Spot

Monitor

Before you install the Welch Allyn CDIS-NCE software do the following:

• Verify that the connectivity settings in the device software are properly configured.

For details, see the device’s directions for use.

• If using wireless communications, check the device’s settings. Verify that these settings match the access point settings.

• Close all programs before starting the installation.

To install the Welch Allyn CDIS-NCE software

Before you begin the process of installing the CDIS-NCE software, run the wizard as administrator:

• Select the "Command Prompt" program, select "Run as administrator".

• Run the "Connectivity Install.hta" installation program from the "Command

Prompt".

1.

Start the CDIS-NCE Installation Program. This screen appears:

7

8

Installation Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

2.

Select SPOT LXi or CVSM / Connex Spot Monitor.

3.

Select Next to continue. This screen appears:

4.

Choose either Server or Client based on your configuration.

For illustrations, see

“Spot LXi, Connex VSM 6000, and Connex Spot Monitor configuration examples” on page 4.

5.

Select Finish to complete the installation.

Installation guide Installation

9

To uninstall the Welch Allyn CDIS-NCE software

Before you begin the process of uninstalling the CDIS-NCE software, run the wizard as administrator:

• Select the "Command Prompt" program and select "Run as administrator".

• Run the "Connectivity Install.hta" installation program from the "Command

Prompt".

1.

Start the CDIS-NCE Installation Program. This screen appears:

2.

Select the Uninstall button.

3.

Follow the instructions on the screen:

• Select Yes to continue.

• Select OK to close the uninstall wizard.

• Select Cancel to complete the process.

• Select Close to exit the application.

10

Installation Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

CP 50, CP 100, CP 150, or CP 200

Before you install the Welch Allyn CDIS-NCE software do the following:

• If connecting to a CardioPerfect Workstation, do the following:

• Verify that the CardioPerfect Workstation software and database have both been upgraded to version 1.6.0 or higher. If necessary, upgrade the software and database now.

• When using a stand-alone CardioPerfect Workstation system, please install the server software on the stand-alone CardioPerfect Workstation system

• When using a client/server configuration, please install the server software on the

CardioPerfect Workstation database server before installing the clients.

• Configure the ECG/Spirometry device for DOB setting (not age) so that the ECG will be properly imported into the CardioPerfect Workstation.

• Verify that the connectivity settings in the software are properly configured. For details, see the electrocardiograph directions for use.

• Make sure .NET 3.5 is installed on the computer.

• Go to the control panel and add NET 3.5 as an OS feature.

• Close all programs before starting the installation.

Note

The CP products must be configured to use DOB (not age) to properly transfer data from the CP products to CPWS.

To install the Welch Allyn CDIS-NCE software

Before you begin the process of installing the CDIS-NCE software, run the wizard as administrator:

• Select the "Command Prompt" program, select "Run as administrator".

• Run the "Connectivity Install.hta" installation program from the "Command

Prompt".

1.

Start the CDIS-NCE Installation Program. This screen appears:

Installation guide

2.

Select CP50/100/150/200. This screen appears:

Installation

11

3.

Select Next to continue. This screen appears:

4.

Choose either Server or Client based on your configuration.

For illustrations, see

“CP 50, CP 100, CP 150, and CP 200 configuration examples” on page 5

.

5.

Select Finish to complete the installation.

12

Installation Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

To uninstall the Welch Allyn CDIS-NCE software

Before you begin the process of uninstalling the CDIS-NCE software, run the wizard as administrator:

• Select the "Command Prompt" program and select "Run as administrator".

• Run the "Connectivity Install.hta" installation program from the "Command

Prompt".

1.

Start the CDIS-NCE Installation Program. This screen appears:

2.

Select the Uninstall button.

3.

Follow the instructions on the screen:

• Select Yes to continue.

• Select OK to close the uninstall wizard.

• Select Cancel to complete the process.

• Select Close to exit the application.

3

Configuration

Configuring the CP 50, CP 150, and CP 200 patient-match criteria

(resolving patients)

When a test is imported into the CardioPerfect database, the patient data submitted with the test may or may not match patient data already stored in the database. The software tries to match, or resolve, the incoming data against the stored data. Tests are entered either for an existing patient or for a new patient, depending on the patient-match criteria.

MRN (medical record number) is a unique piece of text that identifies a patient. It is usually a number, but it sometimes includes other information, such as social security number or last name.

If the criteria are only partially satisfied, a suspect record may be created (.SUSPECT is appended to the MRN).

The file named CPWS.Operations.CPWSImportTest provides a method of inserting a test into the database. If the test already exists, it is replaced with the new test. Either the patient indicated in the test is matched to a patient already in the database, or a new patient is created. The criteria are controlled by the PatientMatchCriteria appSetting in

App.config (which compiles into CPWS.Service.exe.config).

To configure the patient-match criteria

1.

Open this file: C:\Program Files\Welch Allyn\CPSAPI\CPWS.Service.exe.config.

Note

On 64-bit systems, the file path is C:\Program Files (x86)\Welch

Allyn\CPSAPI\CPWS.Service.exe.config.

Windows 7 users: Open this file as an administrator, as follows: a.

Click the Start button. Select All Programs > Accessories.

b.

Right-click Notepad. Select Run as Administrator. Notepad opens.

c.

Click File > Open. Open CPWS.Service.exe.config.

2.

Replace the key attribute with the desired PatientMatchCriteria value in this line:

<add key="PatientMatchCriteria" value="MATCH_MRN"/>

13

14

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

PatientMatchCriteria Description

MATCH_MRN

MATCH_MRN_DOB_

GENDER

This is the default setting. The MRN must match exactly. If the MRN is empty, the record is marked suspect.

The MRN, date of birth and gender must match exactly. If this fails but the MRN matches or is empty, the record is marked suspect.

MATCH_MRN_DOB_

GENDER_LASTNAME

MATCH_DOB_

LASTNAME_FIRSTNAME

The MRN, date of birth, gender and last name must match exactly (case-insensitive).

If this fails but the MRN matches or is empty, the record is marked suspect.

The first name and last name must match exactly, and the date of birth must be on the same day.

• If there is no match, but the MRN conflicts with another entry, the record is marked suspect.

• If there is no match and the MRN is blank, the MRN is set to a period, the patient’s last name, a period, and a unique number.

This is the only setting that allows a blank MRN, which gets automatically generated.

3.

Save the file.

4.

Restart the CPSAPI service. (Go to Control Panel > Administrative Tools >

Services. Right-click CardioPerfect Services. Select Restart.)

Installation guide Configuration

15

Configuring the CardioPerfect Workstation for non-Welch Allyn devices

CardioPerfect Workstation uses the SCP-ECG plug-in, which is a standard communications protocol for computer-assisted electrocardiography (EC71 or EN1064).

This plug-in, which works with the CPSAPI software module, enables you to configure the

CardioPerfect Workstation software to import resting ECG tests from non-Welch Allyn devices and to export ECG tests to non-Welch Allyn record management systems using a format translator, for example Datamed (sold separately).

To configure CPSAPI plug-ins, you modify an XML configuration file, and then restart the

CardioPerfect Services service.

The plug-in file, named CPSAPI.config, is stored in the local folder with the CPSAPI service executable. By default, this folder is C:\Program Files\Welch Allyn\CPSAPI. On 64bit operating systems, the path is C:\Program Files (x86)\Welch Allyn\CPSAPI.

For a description of the CPSAPI module, see

“Configuring the CP 50, CP 150, and CP 200 patient-match criteria (resolving patients)” on page 13.

To configure the plug-in for automatic ECG exporting

This procedure configures the CardioPerfect program to export ECG tests from the

CardioPerfect database automatically when they are captured and saved in the specified folder.

1.

Find the SCP-ECG Collector entry in CPSAPI.config.

Example:

<ResultCollector name=”SCP-ECG Collector” enabled=”1” standalone=”1” type=”CPWS.Plugins.ResultCollector.SCPECGCollector,CPWS.Plugins” values=”” destinationfolder=”specify export folder here” />

2.

Modify the enabled and destinationfolder attributes as desired.

Attribute

enabled

Description

Specifies whether CPSAPI should load and execute the plug-in.

destinationfolder Specifies the output folder where SCP-ECG files will be created.

Caution: The destination and source (export and import) folder names must be unique. If these folder names are identical, the system will not operate properly.

Possible Values

0 (Off), 1 (On)

Any valid Windows path

3.

Restart the CPSAPI service.

a.

Go to Control Panel > Administrative Tools > Services.

b.

Right-click CardioPerfect Services.

c.

Select Restart.

16

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

To configure the plug-in for automatic ECG importing

This procedure configures the CardioPerfect program to import ECG tests into the

CardioPerfect database automatically when new SCP files appear in the specified folder.

1.

Find the TestFileImporter entry in CPSAPI.config.

Example:

<TestFileImporter name=”SCP-ECG Test Importer” enabled=”1” type=”CPWS.Plugins.TestFileImporter.SCPECGTestFileImporter,CPWS.Plugins” sourcefolder=”specify import folder here”

/>

2.

Modify the enabled and sourcefolder attributes as desired.

Attribute

enabled

Description

Specifies whether CPSAPI should load and execute the plug-in.

sourcefolder Specifies the import folder for incoming SCP-ECG files.

Caution: The destination and source (export and import) folder names must be unique. If these folder names are identical, the system will not operate properly.

Possible Values

0 (Off), 1 (On)

Any valid Windows path

3.

Restart the CPSAPI service.

a.

Go to Control Panel > Administrative Tools > Services.

b.

Right-click CardioPerfect Services.

c.

Select Restart.

Installation guide Configuration

17

NCE configuration

The NCE application acts as a gateway between devices and external information hosts.

The configuration interface is described in the following section.

Note

This interface is for advanced users only. The software installation configures NCE for the configuration selected during the installation. Only use this when an advanced, non-standard configuration is required.

Configuration interface

As part of the configuration interface, a system tray icon is included.

The following sections show and describe elements of the configuration interface.

Opening panel

1

2

1 Settings categories

2 Status bar

Lists the configuration sub-categories for NCE. By clicking on an option, the panel on the right will be populated with the related settings.

Describes the last action performed during configuration to provide feedback about your actions.

18

Configuration

General settings

Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

4

7

8

9

5

6

1

2

3

10

11

1 Start button

2 Stop button

3 Log Verbosity

4 Automatic configuration

Selecting this starts the device server portion of NCE.

Selecting this stops the device server portion of NCE. All state information pertaining to currently pending information host messages will also be reset.

The verbosity setting can be set between 1-10, but currently only three settings are supported (3, 6, and 9). Any time NCE is configured to something other than these three settings, NCE will reset to the closest available setting. The least verbose setting (1-4) will only write errors that occur within NCE. The middle verbose setting (5-7) will include any errors, device connection information, and top level WACP information. The most verbose setting (8-10) will include everything described before as well as internal information about how the NCE components are communicating with each other.

This option allows you to fully configure NCE using an existing configuration file. This will copy the specified file to the NCE directory, rename the file to “NCEConfig.xml,”and force the application to restart to reload the new configuration.

Note: This will disconnect any current devices in the same way the Stop button works.

This will also restart the Web interface portion of the application to employ any user interface changes.

5 Local Data Cache directory

NCE provides the option to save all device data sent through the system to a local directory. This data is the unaltered data, directly from the device. This configuration option specifies the directory where the cached device data files should be stored, relative to the application directory.

6 Local Data Cache file types

This option allows you to specify what types of data files should be cached locally. You can choose to save the pure binary data from the device, an XML form of the data, or both.

Each file is uniquely named using a combination of the device source ID, the current system time, and a randomly generated number.

Installation guide Configuration

19

7 Days to Keep

8 Max Files

NCE will monitor the Saved Copies folder and do some cleanup in order to keep the number of files in that folder at a manageable level. There is a configurable limit on the age of files saved, with a default set to 7 days. All files older than the configurable number of days will be automatically deleted.

There is a configurable limit on the number of files that are allowed at once in the Saved

Copies folder. The default will be 5000 files; once that number is reached, the oldest files will be removed when new files are created.

Both limits do not need to be reached before NCE will remove files. Once an hour NCE will check both limits and remove files as necessary.

9 Local Failed Data

Cache directory

This option only applies to messages that have failed to respond to the device. If there is an error that cannot complete its round trip, a copy of the original message will be stored here.

10 Local Failed Data

Cache file types

This option allows you to specify what types of failed message data files should be cached locally. You can choose to save the pure binary data from the device, an XML form of the data, or both. Each file is named using a combination of the device source ID, the current system time, and a randomly generated number.

11 Save settings Selecting this commits any changes made to the configuration settings. This will update the application settings on the fly, and save the changes to the “NCEConfig.xml” file.

20

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Device network settings

1

2

3

4

1 Device transmission timeout

2 Definition cache

3 Connection types

This value represents the maximum time, in seconds, that a device can be connected to NCE with no communication before the device is disconnected.

This value represents the local or path to the directory where cached definitions are stored.

Note: Cached definitions are only loaded when NCE starts, so any additions or updates to these files will not be recognized until the application restarts.

These checkboxes represent the supported connection types for the device server portion of

NCE.

TCP: Port - The TCP Port value is the port number the NCE software will open and listen to connections from devices.

UDP: Port - The UDP Port value is the port number the NCE software will open and listen to connections from devices.

Note: The “Serial” option available applies to both normal serial connections, and USB

Serial Host Driver connections (for example CP 200 USB).

Note: Changes to this option will not be reflected by NCE until the application is restarted.

Installation guide Configuration

21

4 Device heartbeats

This value represents the interval (in seconds) at which heartbeat pings will be sent to known client devices. This is a standard ICMP ping echo request, sent to a networking client.

When set to “0,” heartbeat pings are disabled.

When a client device connects, it will be marked as a known client and flagged as active.

Once the interval has elapsed, a ping request will be sent to each known client in parallel.

Once a client responds to the request with an echo response, the client will be flagged as active. If any clients have not responded after one second, a retry request will be sent to those clients. Up to four retries will be attempted, and any clients that have not responded after the fourth attempt will be flagged as inactive.

Once the retries have completed, the list of active and inactive device clients will be forwarded to the host system. Once the list is sent, all inactive clients are removed from the device list.

22

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Information network settings

12

13

14

15

1

3

5

7

9

11

2

4

6

8

10

1 Data transmission timeout

This value represents the maximum time, in seconds, that a connection will be maintained with an external information host. If no response is received from an information host within this time interval, for a specific message context from a device, NCE will send a NACK to the relative device and close the connection to the information host.

2 Multiple external host management

This option allows NCE to act as a message branch, and forward device messages to multiple external host systems. Each message received from a device will be duplicated and sent to each host specified in this list. Each host has its own related configuration page and information, and can specify separate IP addresses, payload options, and transform sheets.

The Add/Remove buttons are used to add new, blank host information pages, and remove currently selected host information pages based on the displayed index.

Since a single device message can be branched to multiple host information systems, the

“Host Authority” option (XREF) allows you to specify how the responses from these hosts should be used to determine the success state of the transmission.

3 Host authority This option identifies whether the currently selected external host should be used to determine the success state of a data transmission or not. This is primarily used when multiple external hosts are configured for NCE.

4 File output This option specifies whether the output should be written to file instead of forwarded to an external host, and to what directory the output file should be written.

Installation guide Configuration

23

5 Automatic host resolution

6 Host type

7 Host address

8 Host port

In certain system configurations, the IP address of the external host is either not known at configuration time, or not static. In these cases, the IP address of the host cannot be determined ahead of time, and must be resolved at the time that connections to the host are attempted. This feature uses an integrated DCP client to find hosts automatically when devices send messages to NCE.

When this option is enabled, the “Host IP Address” and “Host Port” fields are disabled, as this setting overrides those options. Also, the “Host Type” option becomes enabled, and lets you choose which hosts they would like to find automatically when messages are routed through the system.

When the “Automatic Host Resolution” option is enabled, this option becomes available. It lets you choose which external host types to look for when finding automatic hosts.

There are two fields associated with this option – a manually edited numeric field, and a dropdown box of predefined selections. If no host types are known that match the index, a value of “Unknown” is displayed.

This is the IPv4, dot-separated address, or DNS lookup name for the external information host where device data will be forwarded.

Note: The connection established with the information host is a standard TCP connection.

This is the application port value available on the external information host where NCE will connect.

9 Reuse connections

10 SSL option

This option enables of disables the connection reuse algorithm. When this option is enabled, messages from all devices to a single information host will be routed through a single, established connection, synchronously. If no connection is available, a new connection is established.

When this option is disabled, a new asynchronous TCP connection is established every time a new data message is forwarded to an information host.

This option enables or disables the use of SSL (Secure Sockets Layer) encryption when communicating with an information host.

When this option is enabled, an SSL session is established whenever a connection is made to the configured information host. All messages that are transmitted to the information host are then encrypted with the SSL algorithms.

When this option is disabled, a standard, un-encrypted TCP connection is used.

11 Payload type

12 XSLT Clear

This option determines if NCE will forward WACP-formatted XML data, or binary data to external information hosts.

Note: If an outbound XSLT file is specified, the WACP-formatted XML is translated using that file and then sent. If no file is specified, the XML is sent directly without translation.

These buttons will clear the selected XSLT file for the associated field. This will not delete the XSLT files from the related directory. It will only remove the assignment of that XSLT file for message processing in NCE.

13 Outbound XSLT The outbound XSLT field is used to specify the location of an .xsl file that will be used to translate data from a device to the format accepted by the information host. You can browse for an .xsl file, which will be copied and saved to NCE’s own local storage directory.

All data collected from devices is translated from the native binary format from the device to the XML format. At that point, the XML data is then transformed using the provided outbound XSLT sheet, and forwarded to the specified external information host. This allows an administrator to provide a specialized transformation sheet designed for the information host that will format the data to fit the needs of the information host’s interface.

24

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

14 Host response

XSLT

15 Device response XSLT

The Host Response XSLT field is used to specify the location of an .xsl file that will be used to verify responses from an external information host. Whenever XML data, or translated data, is sent to an information host, the data message is saved as part of the message context. If a Host Response XSLT file is specified, it is used to translate that original outbound message into an expected response. This expected response is then compared against the actual response from an information host.

If no Host Response XSLT is specified, then any response from an information host, regardless of content, will result in an ACK back to the device.

If an appropriate, matching host response is received from an external information host, and a Device Response XSLT is present, then NCE generates a specific response for the device using this XSLT. This response can include elements saved from the Host Response comparison (using set-variable and get-variable), it can use custom generated binary data

(using binary-stream), and it can conditionally decide whether an ACK, NACK, or custom message id should be sent to the original device. This allows the XSLT developer a large amount of flexibility in controlling the response to the device, above and beyond the generic

ACK/NACK responses.

Configure SSL for mutual authentication

Certificates

Follow the Generate a Root Authority only if the the instance does not already exist. If your vendor provides a Root Authority skip to the "RootCATest".

Generate a Root Authority

Follow these steps: makecert –sv RootCATest.pvk –r –n “CN=FakeServerName” RootCATest.cer makecert –ic RootCATest.cer –iv RootCATest.pvk –n “CN=FakeServerName” –sv

TempCert.pvk –pe –sky exchange TempCert.cer

Import RootCATest.cer into your Computer store's Trusted Root Certification Authorities

(on both the server and client).

Notice that the certificate is issued to FakeServerName. This must match the server name that the SslTcpClient expects: sslStream.AuthenticateAsClient(serverName), where serverName is the value of the second argument passed to SslTcpClient.exe.

Generate client and server certificates

makecert -crl -n "CN=FakeServerName" -r -sv RootCATest.pvk RootCATest.crl makecert –pe –n “CN=FakeClientName” –a sha1 –sky exchange –ic

RootCATest.cer –iv RootCATest.pvk –sv ClientCert.pvk ClientCert.cer openssl rsa –inform DER –in ClientCert.cer –out ClientCert.crt openssl pkcs12 –in ClientCert.pfx –nocerts –nodes –out ClientCert.key

Then open the ClientCert.key file and remove everything before ----BEGIN

PRIVATE KEY-----

When your client connects, the server presents a certificate that tells the client "I'm

FakeServerName". The client will accept this claim if the client machine trusts the CA that issued the certificate, which is achieved by importing RootCATest.cer into the client's

Trusted Root Certification Authorities.

Import the Certificate Revocation List (RootCATest.crl) on the Server and Client machines.

Installation guide Configuration

25

Import the private key that the server is going to use into the server machine's Personal store.

Note

This step is important because it addresses the server mode. SSL must use a certificate with the associated private key. This is achieved by importing the .pfx

file generated earlier.

Make sure that you change the file type filter to "all files" so that you can see the .pfx file that you generated:

26

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Client Side (NCE)

NCE uses the

ClientCert.crt

and

ClientCert.key

files using

SSL_use_PrivateKey_file and

SSL_use_certificate_file

.

These files are set by browsing to the certificate located in the “Certificate file used for two-way (mutual) SSL authentication” section. The Key file is not required, but can be loaded in the “Key file for two-way (mutual) SSL authentication”.

Server Side (C# App)

SslTcpServer:

TcpListener listener = new TcpListener ( IPAddress .

Any , 8080 );

SslTcpClient:

TcpClient client = new TcpClient (machineName, 8080 );

Installation guide

Output:

Launch your server:

SslTcpServer .exe TempCert .cer

Connect from the client:

SslTcpClient .exe <ip to your server> FakeServerName

Configuration

27

28

Configuration

User interface settings

Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

1

2

1 Web port The port value that will host the Web interface for NCE.

Note: Any changes to the web port value will force the web-interface portion of NCE to restart. This means you must close the interface and re-open it to continue configuration.

2 Interface enabled This option enables or disables the Web interface. If this is enabled, the application can be configured as normal through the configuration interface. If this is disabled, you will not be able to access the configuration interface.

Note: The only way the interface can be re-enabled after being disabled is to stop the application, manually edit the “NCEConfig.xml” file to enable the interface, and restart the application.

Installation guide Configuration

29

Data logs

To provide assistance in monitoring messages that are processed by NCE, specifically ones that fail to complete their round-trip delivery, a Data Log option is available on the left side of the configuration interface. This option will open a new window and display a list of data messages that have been received from devices by NCE, but for some reason have not completed their process successfully.

This log displays information contained within the data messages themselves (for example Patient ID, Date/Time, Serial Number of the device, etc) to help determine if the error was a result of improper device data, or if it was from an internal processing error.

For the Data Log option to work, NCE must have the Failed Data Cache option enabled

(see “Local Failed Data Cache directory” on page 19), and must have XML formatted data enabled for this option (see “Local Failed Data Cache file types” on page 19). If either of these options are missing or not enabled, the Data Logs will not be available.

Debug logs

The NCE application generates a running log with debug information as it executes. It maintains two logs (“DebugLog1.txt” and “DebugLog2.txt”) that store this information, and writes to the two files in a circular manner. When the application starts, it opens

“DebugLog1.txt” to write first, and continues to write information to this file until it reaches the specified capacity (10 Megabytes). Once this limit has been reached, the application opens “DebugLog2.txt” and continues writing until once again the capacity limit has been reached. Then, the application reopens “DebugLog1.txt”, clears all data from the file, and continues writing.

30

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

File Importer configuration

File Importer is a software program that allows you to transfer patient vitals from an external media drive into CardioPerfect.

Options tab

The options tab allows you to change your configuration settings.

4

5

6

1

2

3

1 Outgoing file folder This is the folder containing a copy of the files sent to the Information Host.

2 Failed file folder

3 External media drive

Folder containing a copy of the files that failed to send to the Information Host.

Disk drive representing the removable media where the tests are stored.

4 External media folder

Folder on the removable media containing the tests to be imported.

5 File types to import File types (extensions) that the software will look for in the External Media Folder on the

External Media Drive to import.

6 Information host address

Web address of the web service where the files are to be sent. The only part that could be configured is the “localhost:9247.”

Installation guide Configuration

31

Logs tab

The Logs tab allows you to read logged messages to either confirm a test was imported correctly or determine why an import failed.

Import failures tab

This tab shows a list of files (tests) that were not able to be imported.

1 Delete

2 Retry

1

2

Allows you to remove this file from the system.

Allow you to correct the problem and retry to send the file.

32

Configuration Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

4

Troubleshooting

About the connectivity software modules

The Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software comprises a set of modules that are installed separately as needed. The connectivity modules are listed here:

Module Full name

CPSAPI CardioPerfect

Server

Application

Programming

Interface

NCE

DCP

Network

Connectivity

Engine

Device

Communication

Protocol

FI File Importer

Description Installation location

This is the database connectivity module. It plays a central role, directing communications between various software modules and the server software.

One CPSAPI per site

This module receives data from the device(s).

This module listens for device(s) that are connected wirelessly, and it tells them which IP address to communicate with.

This module receives tests from removable media

(SD memory cards or USB storage devices).

One NCE per CPSAPI installation and per Workstation that supports wired-USB

One DCP per subnet

One FI per Workstation receiving tests via removable media

Firewall settings

If you are using a firewall between any PCs in your configuration, the following ports or application files are required to gain access through the firewall. Software installation automatically opens these ports.

Software module Port

CPSAPI

DCP

9247

44435

DCP

NCE

CP 200

7711

281

ICMP

Type

TCP

UDP

Application file

CPWS.Service.exe

DCP.exe

UDP

TCP

DCP.exe

NCE.exe

Allow incoming echo requests Ping test

33

34

Troubleshooting Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Functional diagrams

Software modules in a standalone CardioPerfect Workstation, removable media or USB

FI or

USB cable

DC

CardioPerfect application

CPSAPI

CardioPerfect database

CardioPerfect Workstation (standalone)

Related illustration:

“Standalone configuration, removable media or USB” on page 5

Software modules in an Ethernet network configuration

DCP

CardioPerfect database

DC

CardioPerfect application

CPSAPI

CardioPerfect Workstation (standalone)

Installation guide Troubleshooting

35

Software modules in a client-server configuration, removable media or USB

FI or

USB cable

DC

CardioPerfect application

CardioPerfect Workstation (client)

Related illustration:

“Client-server configuration, removable media or USB” on page 5

CPSAPI

CardioPerfect database

CardioPerfect database server

Software modules in a client-server and Ethernet network configuration

DCP

DC

CPSAPI

CardioPerfect database

CardioPerfect application

CardioPerfect Workstation (client)

Related illustration:

“Client-server network configuration, wireless or Ethernet” on page 4

36

Troubleshooting Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Software modules in a simple network configuration, wireless or Ethernet

DCP

DC

HL7

Related illustration:

“Client-server network configuration, wireless or Ethernet” on page 4

Server

Software modules in a USB configuration

USB cable

DC

Workstation

HL7

(Optional)

Related illustration:

“Client-server configuration” on page 4

Server

Installation guide Troubleshooting

37

Reassigning a server IP address

Who needs this procedure?

Users with a client-server configuration wired to the client PC(s) or communicating via removable media.

When do you need this procedure?

Anytime your server IP address changes.

What does this procedure accomplish?

It enables the software to pick up a newly assigned server IP address.

How do you do this procedure?

Restart the computer’s DCP daemon Windows service.

a.

Go to Control Panel > Administrative Tools > Services.

b.

Right-click DCP.

c.

Select Restart.

No action is required at the client PC(s).

38

Troubleshooting Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Troubleshooting chart

Conditions

1. View Available

Networks screen does not return any available networks

(CP 150).

Causes

Outside range of all wireless networks.

There are no wireless networks available.

Device radio is not connected.

Device configuration.

The device cannot connect to the network.

2. Ping operation failed. Wrong IP address entered.

Actions

Move within the wireless network.

Verify that the wireless network router(s) are powered up and properly configured.

Connect CP 150 radio. Verify that the CP 150 radio lights are blinking or solid to indicate action.

Check the CP 150 network settings and connectivity mode. Verify that these settings match the access point settings.

Check wireless settings and ensure that they match the access point settings.

Check other computer's IP address.

The device cannot properly connect to the network.

Firewall settings.

Device configuration.

Wireless:

Check wireless settings and ensure that they match the access point settings.

Ethernet:

1. Connect the network cable.

2. Wait a few seconds.

3. Navigate to the network setting screen and verify that the device has a valid IP address.

The firewall needs to be set to “Allow echo requests.” (See “Firewall settings” on page 33.)

Check the device network settings and connectivity mode. Verify that these settings match the access point settings.

3. Server test operation failed.

The device cannot properly connect to the network.

Wireless:

Check wireless settings and ensure that they match the access point settings.

Ethernet:

1. Connect the network cable.

2. Wait a few seconds.

3. Navigate to the network setting screen and verify that the device has a valid IP address.

Install CDIS-NCE on the same computer as CardioPerfect database.

Connectivity software not installed on a computer on the network.

DCP module is not running.

Firewall settings.

Check the services to verify that the DCP daemon service is running.

Check firewall to ensure that exceptions are set. (See “Firewall settings” on page 33.)

Device configuration Check the device network settings and connectivity mode. Verify that these settings match the access point settings.

The server IP address has changed.

See

“Reassigning a server IP address” on page 37.

Multiple subnets.

Unknown

Check your network router settings; enable multicasting across subnets.

1. Determine the IP address of the PC running NCE.

2. Perform a ping test to this IP address. If the ping test passes, the network connection is OK.

3. Perform a server test, if the server test fails then either DCP or NCE is not running or in error state.

4. Restart the DCP or NCE, and try the server test again.

Installation guide Troubleshooting

39

Conditions (continued) Causes (continued)

4. Test send (or patient search) failed

- wireless or ethernet.

No patient order found or patient search contained no results

The device cannot properly connect to the network.

Actions (continued)

Server does not contain any patients that match the search criteria.

Outside range of all wireless networks.

There are no wireless networks available.

Device radio is not connected (CP

150 only).

Connectivity software not installed on a computer on the network.

DCP module is not running.

NCE is not running.

NCE is not receiving files.

Wireless:

Check wireless settings and ensure that they match the access point settings.

Ethernet:

1. Connect the network cable.

2. Wait a few seconds.

3. Navigate to the network setting screen and verify that the device has a valid IP address.

Move within the wireless network.

Verify that the wireless network router is powered up and properly configured.

Connect CP 150 radio. Verify that the radio lights are blinking or solid to indicate action.

Install CDIS-NCE on the same computer as CardioPerfect database.

Check the services to verify that the DCP daemon service is running.

Check the services to verify that the NCE service is running.

Verify that the C:\Program Files\Welch Allyn\NCE\SavedCopies folder has new files with a date/time stamp about when you sent it and that the folder updates as you send more tests.

• If yes, NCE is getting files. Check CPSAPI.

• If no, NCE is not working. Reinstall server software or check firewall.

CardioPerfect services (CPSAPI) is not running.

CP 150 configuration.

NCE is not receiving files

Verify that the CardioPerfect Services service is running.

Ensure that Connectivity Mode is set to Wireless.

The server IP address has changed.

See

“Reassigning a server IP address” on page 37.

Firewall settings.

Check firewall to ensure that exceptions are set. (See page 33.)

“Firewall settings” on

Unknown 1. Determine the IP address of the PC running NCE.

2. Perform a ping test to this IP address. If the ping test passes, the network connection is OK.

3. Perform a server test, if the server test fails then either DCP or NCE is not running or in error state.

4. Restart the DCP or NCE, and try the server test again.

Check to make sure the proper device connection type is enabled:

1. Open the NCE configuration page through the system tray icon. Click on

Device Network on the left.

2. Check Supported Connection Types to make sure the proper channels are enabled.

Note: WiFi connections from devices require TCP to be enabled. USB connections from the CP200 require Serial to be enabled.

3. Click Save Settings to save your changes

4. If using WiFi wireless connectivity, verify that the device wireless settings (SSID, etc.) matches the network settings.

40

Troubleshooting Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Conditions (continued) Causes (continued)

5. Test send

(or search) failed

- USB cable.

Cables not connected.

Connectivity software not installed.

Actions (continued)

Make sure USB cable is connected on both ends (device and PC).

Install Server Connectivity option on the computer containing the database, and install the Client option on the USB computer. Ensure that the device is connected and the PC driver is loaded.

CP 200 configuration.

Ensure that Configuration Mode is set to Wired.

NCE is not running.

NCE is not receiving files.

Check the services to verify that the NCE service is running.

Verify that the C:\Program Files\Welch Allyn\SavedCopies folder has new files.

• If yes, NCE is getting files. Check CPSAPI.

• If no, NCE is not working. Reinstall Client software or check firewall.

6. Test send failed removable media

CardioPerfect services (CPSAPI) is not running.

Verify that the CardioPerfect Services service is running on the computer containing the database.

The server IP address has changed.

See

“Reassigning a server IP address” on page 37.

Firewall settings.

Incorrect cable.

Check firewall to ensure that exceptions are set. (See “Firewall settings” on page 33.)

CP 50 and CP 150: Verify that you are using an A-to-mini-B USB cable.

CP 200: Verify that you are using an A-to-A USB cable.

NCE is not receiving files Check to make sure the proper device connection type is enabled:

1. Open the NCE configuration page through the system tray icon. Click on

Device Network on the left.

2. Check Supported Connection Types to make sure the proper channels are enabled.

Note: WiFi connections from devices require TCP to be enabled. USB connections from the CP200 require Serial to be enabled.

3. Click Save Settings to save your changes

4. If using WiFi wireless connectivity, verify that the device wireless settings (SSID, etc.) matches the network settings.

Connectivity software not installed.

Install Server Connectivity option on the server containing the database, and install the Client option on the USB computer. Ensure that the device is connected and the PC driver is loaded.

Client software is not installed on the computer intended to be the transfer station.

Tests not on removable media.

Install the Client software option on the computer intended to be the transfer station.

Refer to the device’s directions for use for details on sending tests to memory card.

File Importer is configured for

“Auto,” but it ignores drives A and B.

Set File Importer to select the proper external media drive.

File Importer reports a failure.

Verify that client and server have connectivity and that CPSAPI is running, then retry: Right-click the File Importer tray icon, select “Import Failures,” select the failed file(s), and press Retry.

File Importer has been manually disabled.

Right-click the File Importer tray icon, and uncheck the “Disable” menu.

The server IP address has changed.

See

“Reassigning a server IP address” on page 37.

Installation guide Troubleshooting

41

Conditions (continued) Causes (continued)

7. NCE configuration page is inaccessible

The configuration web-interface has been disabled

Actions (continued)

1. Open NCEConfig.xml (located in the NCE installation directory) with a text editor.

2. Search for “InterfaceEnabled.” On the line following this term, find the section that reads “<![CDATA[0]]>”.

3. Edit the file and replace the 0 with a 1, so the entry reads:

“<![CDATA[1]]>”.

Note: If the entry already reads “<![CDATA[1]]>”, then the web-interface is enabled and something else is causing the access issue.

There is another application already running on the PC which is using the port the web-interface would normally use.

The CP 200 patient-match criteria is only partially satisfied.

1. Open NCEConfig.xml (located in the NCE installation directory) with a text editor.

2. Search for “ListenPort.” On the line following this term, find the section that reads “<![CDATA[8000]]>.” The 8000 may be another numerical value, if the web-interface port was changed in the past.

3. Edit the file to replace the 8000 with a new port value, one that you know no other application is currently using.

See

“Configuring the CP 50, CP 150, and CP 200 patient-match criteria

(resolving patients)” on page 13.

8. CPWS patient number has

.SUSPECT appended to the patient number

9. Datamed interface is not working

The plug-in is not enabled.

See

“Configuring the CardioPerfect Workstation for non-Welch Allyn devices” on page 15.

42

Troubleshooting Welch Allyn Connex® Device Integration Suite (CDIS) Network Connectivity Engine (NCE) software

Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project