Welch Allyn Service Tool User Manual

Welch Allyn Service Tool
Install Today!
Installation and Configuration Guide
© 2012 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 is a registered trademark of Welch Allyn.
Software in this product is Copyright 2012 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 with 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 humanperceivable form. This is not a sale of the software or any copy of the software; all right, title, and ownership of the software remain with Welch Allyn or its vendors.
For information about any Welch Allyn product, call the nearest Welch Allyn representative:
USA +1 800 535 6663
+1 315 685 4560
Australia +61 2 9638 3000
Canada +1 800 561 8797 China +86 21 6327 9631
European Call Center +353 46 90 67790 France +33 1 55 69 58 49
Germany +49 695 098 5132 Japan +81 42 703 6084
Latin America +1 305 669 9003 Netherlands +31 202 061 360
Singapore +65 6419 8100 South Africa +27 11 777 7555
Sweden +46 85 853 6551 United Kingdom +44 207 365 6780
REF
103820
Material number 717342, 80016783 Ver. B
Welch Allyn, Inc. 4341 State Street Road Skaneateles Falls, NY 13153-0220 USA
www.welchallyn.com
Printed in USA
Regulatory Affairs Representative Welch Allyn Limited Navan Business Park Dublin Road Navan, County Meath Republic of Ireland
Contents
1 - Introduction .................................1
Product overview ................................1
2 - Installation ..................................4
System requirements.............................4
Network requirements ............................5
Before you begin ................................5
Installation .....................................5
3 - Operation..................................11
Starting the service tool ..........................11
Activating a feature or license .....................11
Accessing the service tool ......................15
Configuring the service tool .....................16
Running the service tool .......................17
Getting additional information .....................17
4 - Uninstalling applications .....................18

Introduction

1

Product overview

This guide describes how to install the Welch Allyn Service Tool, a software application that clinicians and technical service personnel can use to manage and maintain supported Welch Allyn products.
This guide is written for system administrators and others with a background in information technology.
Editions
The service tool is available in the following editions:
Unlicensed (Silver): Accompanies your monitor. This edition
provides basic access to device information and firmware updates.
Licensed (Gold): Required to perform complete functional
verification and calibration. This edition requires a license. For more information about acquiring this license, contact Welch Allyn.
Note
To qualify for the Gold license, you must attend a Welch Allyn technical training course or complete online training for your devices.
Welch Allyn Service Tool 2 Chapter 1 Introduction
Purpose
You can use the service tool to do the following:
Install updates and upgrades. The service tool can read the
firmware version for each module and check for available updates or upgrades.
Review monitor information. When connected to the monitor,
the service tool lists installed modules, installed firmware and hardware versions, warranty and repair information, status, and usage history.
Receive notifications when periodic maintenance is needed.
The service tool can help you manage and maintain your entire inventory of supported Welch Allyn products. Through the remote service function, the service tool can connect to Welch Allyn Customer Service. With this functionality you can automatically receive firmware updates and feature upgrades for your supported products, including software upgrades for the service tool.
Create a work list. The work list provides information about
service actions—referred to as work orders—that are waiting for you to perform on your maintained devices. Work orders may include periodic calibrations, upgrades, or license installations.
Schedule periodic maintenance. You can use the service tool to
set the service interval for each maintained device.
View and save logs. You can download and save log files from
the device for analysis to help diagnose and identify reported issues.
Create user accounts. Administrators can create user accounts
and set permission levels to control access to the features, allowing one group to perform administrative tasks and another to perform service tasks. Restricting access prevents the service tool from being used to make unauthorized changes on a connected device.
Perform functional verification. You can use the service tool to
test each component of the system to ensure that its performance meets design specifications. Functional verification is required to meet the periodic maintenance requirements. This feature is not supported for all products and requires the service tool Gold edition for each supported product.
Welch Allyn Service Tool 3 Chapter 1 Introduction
Perform calibration verification. The service tool can check any
system requiring calibration and, if necessary, calibrate the monitor to match the design specifications. Calibration verification is required to meet the periodic maintenance requirements. This feature is not supported for all products and requires the service tool, Gold edition, for each supported product.
Recover devices. In the rare case where a device can no longer
boot because of corrupted firmware, the service tool can connect the device to Welch Allyn Technical Support to reinstall the firmware.
Extensible. The service tool accepts new plug-ins to support
future Welch Allyn products.

Installation

2
This chapter explains how to install the service tool and the other programs included with the service tool: Remote Service Delivery System (PartnerConnect), USB driver, and the Axeda Desktop Server.
System requirements ....................................................................4
Before you begin ...........................................................................5
Installation .....................................................................................5
Install the service tool ............................................................6
Installation continued: USB driver ..........................................7
Installation continued: PartnerConnect® (Gateway Agent) ....7
Installation continued: Axeda Desktop Server ......................10

System requirements

Supported operating systems: Windows 7 or Windows XP
with SP3.
Supporting software: .Net Framework 3.5 (included with
installation).
Processor: 400 MHz Pentium processor or equivalent
(minimum); 1GHz Pentium processor or equivalent (recommended).
RAM: 1 GB (minimum); 2 GB (recommended).
Hard disk: Up to 10 GB of available space may be required.
CD ROM drive
Display: 800 x 600, 256 colors (minimum); 1024 x 768 high color,
32-bit (recommended)
USB: 2.0
Internet connection: Required to download files.
Welch Allyn Service Tool 5 Chapter 2 Installation

Network requirements

When you use the service tool to license or download firmware, network traffic travels over non-registered ports. You must open these ports for TCP/IP and UDP traffic on your PC or network firewall:
Ports Description
5093, 5094 Welch Allyn licensing server
5920 Welch Allyn PartnerConnect server
Note
To open these ports, consult your network administrator.

Before you begin

• Verify that this computer meets the hardware and software requirements listed in System requirements.
• Verify that you have administrator rights for the computer.
• Close all programs before starting the installation.
• If you have a previous version of the service tool installed on your PC, uninstall it as described in “Uninstalling applications” on page 18.

Installation

The installation media (such as a CD, DVD, or flash drive) for the service tool consecutively installs the following programs:
Welch Allyn Service Tool This tool completes the full suite of functional tests.
USB driver This program allows Welch Allyn devices to connect to a PC for testing.
Welch Allyn Service Tool 6 Chapter 2 Installation
PartnerConnect This tool remotely monitors your Welch Allyn Platform systems and devices. It captures operating information (not clinical data) and periodically sends it to Welch Allyn. Welch Allyn then analyzes the information to assist in remotely troubleshooting a device or to automatically notify you about issues such as a need for equipment replacement.
Axeda Desktop Server This option allows Welch Allyn technical support to remotely access your system—only when you request—to assist in troubleshooting.
Install the service tool
If the service tool was delivered to you on physical media (such as a CD), follow these steps:
1. Insert the media in your computer. The installer automatically starts. If it does not start, do the following:
a. Start the Windows Explorer and navigate to the
installation drive.
b. Double-click the following filename:
setup.exe
The Welcome screen appears.
2. Click Next. The Service Installation Folder screen appears.
3. Click Next. This accepts the default installation location.
Caution You must use the default installation location. Failure to do so may may provide undesired results when you run the software.
Setup displays the settings you selected, providing an opportunity to ensure that the settings are correct before proceeding.
4. Click Next. Setup copies and installs the files you selected. The Installation Complete screen then appears.
5. Click Close. Service tool installation is now complete.
Welch Allyn Service Tool 7 Chapter 2 Installation
Installation continued: USB driver
The Setup program automatically starts the USB driver installation, and the Welcome screen appears.
1. Click Next. The Custom Setup screen appears.
2. Identify where you want to install the driver and click Next.The default location is as follows:
{ProgramDirectory}\Common Files\Welch Allyn\Drivers\
Note
3. Click Next. Setup displays the settings you selected, providing an opportunity to ensure that the settings are correct before proceeding.
4. Click Next. Setup copies and installs the files you selected. The InstallShield Wizard Completed screen then appears.
5. Click Finish. USB driver installation is now complete.
Your default
{ProgramDirectory}
location may differ.
Installation continued: PartnerConnect®(Gateway Agent)
The Setup program automatically starts the RSDS installation, and the Welcome screen appears.
1. Click Next. The License Agreement screen appears.
2. Accept the license agreement, and click Next. The Site Information screen appears.
Welch Allyn Service Tool 8 Chapter 2 Installation
3. Enter a serial number.
• If you have the Welch Allyn Service Tool software CD, enter
the 11-digit serial number that is located on the CD label and on the CD case.
System Requirements
This product works with Windows XP SP3 or Windows 7. Windows is a registered trademark of Microsoft Corporation in the United States and other countries.
Processor: 400 MHz Intel® Pentium® processor or equivalent (minimum), 1GHz Intel® Pentium® processor or equivalent (recommended)
System memory: 1 GB (minimum), 2 GB (recommended)
Hard disk: Up to 10 GB of available space may be required
CD ROM drive: Required
Display: 800 x 600, 256 colors (minimum); 1024 x 768 high color
USB 2.0 (required)
Virus protection
Internet connection (required in order to receive upgrades, licenses, etc.)
For more information, speak with your local Welch Allyn representative or visit www.welchallyn.com/ promotions/services.
© 2012 Welch Allyn, Inc. All rights are reserved. No one is permitted to reproduce or duplicate, in any form, this disc or any part thereof without permission from Welch Allyn.
Welch Allyn is not liable for any damage caused to your computer by installing or running this disc. Welch Allyn does not guarantee that the software contained on with your system. In addition, Welch Allyn does not provide any software support or training and assumes that the user has the software and computer expertise to integrate this software into the
s computer.
user’
elch Allyn, Inc. W 4341 State Street Road Skaneateles Falls, NY 13153 USA
.welchallyn.com
Made and printed in USA www
YYYYMMXXXXX
, 32-bit (recommended)
disc will be usable or compatible
the
Regulatory Affairs Representative
elch Allyn Limited W Navan Business Park, Dublin Road Navan, County Meath Republic of Ireland
Serial number (SN)
• If you downloaded the Welch Allyn Service Tool software, enter the serial number of any device that you plan to service using the software.
Serial number (SN) on a device label — example
Welch Allyn Service Tool 9 Chapter 2 Installation
4. Enter the rest of the information as shown in the next table. Information entered in this screen is attached to all Welch Allyn Platform product records.
Field Description
Organization/ Facility *
Location/ Department *
Address 1 and 2 Enter the street address or post office box.
City Enter the city of the organization location.
State Enter the state or province of the organization location.
Region * Select the region of the organization location.
Country * Select the country of the organization location.
* Required field.
Enter the organization (customer) name. Example: ABC Hospital System.
Enter the location code or the department name. Example: 3NW, ER, 7NTower. If HIS is used, enter the HIS location code.
5. Click Next. The Setup program displays the settings you selected, providing an opportunity to ensure that the settings are correct before proceeding.
6. Click Next. Setup copies and installs the files you selected. Setup then prompts you to specify post-install tasks.
7. (Optional) Select the Install the Axeda Desktop Server check box. This tells the system to install the Axeda Desktop Server immediately after you exit this Setup program.
This program allows Welch Allyn Technical Support to access your computer remotely—with your permission—to assist you.
8. Click Next. Setup verifies a successful installation.
9. Click Finish.
If you did not choose to install the Axeda desktop server, you are now finished.
If you selected “Install the Axeda Desktop Server,” continue to the next section.
Welch Allyn Service Tool 10 Chapter 2 Installation
Installation continued: Axeda Desktop Server
The Setup program automatically starts the Axeda Desktop Server installation, and the Welcome screen appears.
1. Click Next. The License Agreement screen appears.
2. Accept the license agreement and click Next. The Choose Install Folder screen appears.
3. Identify where you want the installation program to install the Axeda Desktop server software and click Next. The Service screen appears.
4. Check to install as a service and click Next.
5. Check to start as a service and click Next.
Note
6. Accept the devault name for the service (Axeda Desktop Server) and click Next. The program displays the settings you selected, providing an opportunity to ensure that these are the settings you want.
7. Click Install. The program installs the server. This may take several minutes. The program displays a message verifying a successful installation.
8. Click Done. Installation is now complete.
If you don’t check this, you will have to manually start the service each time you need to connect with the remote server.

Operation

3
This chapter describes how to operate the service tool.
Starting the service tool ...............................................................11
Activating a feature or license ......................................................11
Accessing the service tool ...........................................................15
Configuring the service tool .........................................................15
Running the service tool ..............................................................17
Getting additional information ......................................................17

Starting the service tool

To start the service tool, go to the Windows Start menu, and select All Programs > Welch Allyn > Welch Allyn Service Tool. Either the simple user interface screen (page 12 ) or the main screen (page
13 ) appears, depending on the configuration.

Activating a feature or license

When you purchase a licensed upgrade or option for a supported product, you also receive an authorization code from Welch Allyn. Use this code to activate the new feature(s). You can activate features through the simple user interface or through the Administration menu.
Before you begin, make sure you have the following:
• Computer (see System requirements).
• Welch Allyn medical device requiring a license upgrade.
• USB 2.0/5-pin Mini-B cable, gold, 6 feet.
Welch Allyn Service Tool 12 Chapter 3 Operation
Activate through the simple user interface
1. Go to the Windows Start menu, and select All Programs > Welch Allyn > Welch Allyn Service Tool. The simple user
interface appears:
Simply activate device features (with a device license).
Access the full
service tool
application (or activate a Gold license).
Note
If this is not the screen you see, go to “Activate through
the Administration menu” on page 13.
2. Click Add new features.
3. Follow the instructions on the screen. If activation fails, see“Troubleshoot the activation” on page 14.
4. When activation is complete, disconnect the USB cable from the device, and power down the device as described in its documentation.
Welch Allyn Service Tool 13 Chapter 3 Operation
Activate through the Administration menu
1. Go to the Windows Start menu, and select All Programs > Welch Allyn > Welch Allyn Service Tool. The main screen
appears.
Note
2. If prompted, log on. For details, see “Log on for the first time” on page 15.
3. Click Administration > Install license. The Install license screen appears.
4. Select Medical device license.
5. Connect the USB cable to the mini-B USB port on the Welch Allyn device and the opposite end of the USB cable to the PC.
6. If the device is powered down, power it up.
7. If more than one device is connected, select the device you want to license from the list.
8. Under Connected and maintained devices, click the device and then click Select.
If this is not the screen you see, go to “Activate through
the simple user interface” on page 12.
Welch Allyn Service Tool 14 Chapter 3 Operation
9. Enter the authorization code and then click Activate. The service tool displays a message verifying a successful activation.
If activation fails, see“Troubleshoot the activation” on page 14.
10. Power down the device as described in its documentation.
Troubleshoot the activation
If the activation does not succeed, check the following, and try again:
• Make sure that you rebooted the device. A new license takes effect only after the device reboots.
• Confirm that you entered the correct authorization code.
• Check your Internet connection.
• Verify that the proper ports are open, as described in “Network
requirements” on page 5.
If activation still does not succeed, contact Welch Allyn Technical Support for assistance.
Welch Allyn Service Tool 15 Chapter 3 Operation

Accessing the service tool

Log on for the first time
1. Go to the Windows Start menu and select All Programs > Welch Allyn > Welch Allyn Service Tool.
2. Click Service. The Login dialog displays, with ADMIN as the user ID. No password is required for the initial logon.
3. Click Log on.
4. Set a password for the ADMIN account:
a. From the drop-down menu, select Administration >
Manage accounts.
b. Select ADMIN and click Edit.
c. Click Change password. The Change password dialog
displays.
d. Enter a password in the Enter new password box, then
confirm the password by entering it again in the Re-enter
password box.
Note
e. Click Save.
You can now use the service tool. For information about creating more user accounts, select Help > Service Tool help > Menu options > Administration menu.
Record your password and save it in a safe place.
Welch Allyn Service Tool 16 Chapter 3 Operation

Configuring the service tool

Disable the simple user interface
You can configure the service tool to bypass the simple user interface when starting. If this interface is disabled, users must activate licenses from the Administration menu.
To disable the simple user interface, do one of these:
• On the simple user interface, select the Do not show this screen again check box.
• On the service tool’s main screen, select Administration > Settings, and clear the Simple user interface check box.
Enable clinician access without logon
You can configure the service tool to allow Clinician functionality without logging on. (Biomed and Admin functionality always requires a log on.)
1. Log on as ADMIN.
2. Go to the service tool’s main screen.
3. Select Administration > Settings.
4. Select the Admin tab.
5. Clear the Require clinical log on check box.
6. Click Save.
7. Restart the service tool.
Note
This setting takes effect only after the service tool restarts.
Welch Allyn Service Tool 17 Chapter 3 Operation

Running the service tool

Before you begin, make sure you have your user ID and password.
Note
1. Go to the Windows Start menu and select All Programs >
2. (Optional) Click Service. The Login dialog displays.
3. Enter your user ID and password, and then click Log on.
The system administrator responsible for the service tool can provide the user ID and password. If you don’t have an account, the administrator can create one.
Your account may not require a log in. Accessing Admin or Biomed functions always require a log in.
Welch Allyn > Welch Allyn Service Tool.
• Unlicensed (Silver) edition features are now available.
• Licensed (Gold) edition features are available, provided you
have the following:
• An installed Gold license.
• A user account with the Biomed attribute.

Getting additional information

The service tool includes help that you can use to learn more about the tool’s features and functionality.
To access help, log in and select Help > Service Tool help.

Uninstalling applications

4
This chapter explains how to uninstall the service tool and the other programs included with the service tool
To remove the service tool and the other programs included with the service tool—PartnerConnect (RSDS), Welch Allyn USB driver, and the Axeda Desktop Server:
1. Open the Control Panel using one of these methods:
Windows 7: Select > Control Panel.
Windows XP: Select Start > Settings > Control Panel.
The Control Panel appears.
2. Open the Add or Remove Programs dialog using one of these methods:
Windows 7: Select Uninstall a program in the Programs
section.
Windows XP: Select Add or remove programs.
Windows lists the programs on this computer.
3. Scroll to the following Welch Allyn programs.
Welch Allyn Service Tool 19 Chapter 4 Uninstalling applications
4. Remove the programs, starting with Welch Allyn RSDS. For each program:
a. Select the program.
b. Click the uninstall option.
Windows launches the uninstall program.
c. Follow the prompts to remove the program.
Note:Accept the default values on the following screen.
Welch Allyn Service Tool 20 Chapter 4 Uninstalling applications
The Axeda Desktop Server uninstall program will prompt you to reboot the computer. You can reboot at a later time, but you must reboot to complete the uninstall.
To verify that the programs you deleted are removed:
1. Navigate to the uninstall screen.
Windows lists the programs on this computer.
2. Visually inspect to make sure that the programs you deleted no longer appear in the list of programs.
If the programs are not in the program list, the PartnerConnect (RSDS) and Axeda Desktop Server programs are now removed from your computer.
If the programs still appear in the program list, contact your IT department or workstation support and ask if there is anything on the network that prevents program removal.
In certain situations, programs external to Welch Allyn software may block uninstallation. If this is a possibility in your IT environment, contact your IT department to verify whether additional steps are required.
REF
103820 Rev. B
Loading...