installation, updates and maintenance of instrument drivers (icop…€¦ · ·...

©2013 Waters Corporation 1

Installation, updates and maintenance of

instrument drivers (ICOP, ICS, ICF).

Workshop C1

Gilles Bassard / Ömer Yilmaz


Agenda

Definitions

Deployment Planning

Best Practices

Common Issues

Other Compatibility Considerations (for Empower Enterprise)

Troubleshooting


Definitions

Driver Pack (DP)

o Formerly known as an ICOP (Instrument Control Option Pack).

o The terms ICOP and DP are interchangeable

– Combined drivers for ACQUITY and other Waters related devices on

one media or download file. A collection of control software and

other applications, along with an installer


Definitions

ICS - Instrument Control Software

– Software designed to support instrument user interface that is

separate from the application software . Contains the software

necessary to control a particular instrument type, including

firmware, control panel, method editor, data systems and Console

plug-ins


Definitions

Supplemental Driver Pack

– Expedited fixes in ICS or Firmware that must be released to correct

issues in released Driver Pack (DP)


Definitions

ICF - Instrument Control Framework

– A software component that makes it faster and easier for third-

party software developers to control systems in Chromatographic

Data Systems (CDS). This provides developer with the ability to

develop one adapter (plug-in) that links all modules to their

software using standard instrument drivers provided by vendors.


Definitions

ICF - Instrument Control Framework with Agilent LC


Definitions

Firmware (FW)

– Used on hardware devices to load computer instructions and data

that reside as read-only ROM on that device. When installing a

Driver Pack the released version for each device is installed on the

local PC.

– Firmware files have a .sft file extension and are located on the

computer where the ICS has been installed

o (Empower\Instruments\Firmware or Program Files\Waters

Instruments\Firmware )


Definitions

AutoLoader Utility

Firmware loader program that automatically runs after ICS

installation . The utility will query physically connected

devices to recommend updates based on installed firmware

versions on the local PC.


Definitions

Loader Utility

– Used to install individual firmware to address explicit issues,

defects for immediate release or to be run after installation has

been completed


Definitions

Deployment Manager (DM)

– User Interface used to Install , Upgrade , Remove and Repair ICS‘s

for Waters and Third Party vendors


Definitions

ICS Companion

– Utility that is run at the end of ICS installation to reconcile .NET and other dynamically linked files (DLL) used to control instrumentation

– This can be run by selecting the DM ICS Repair feature

Windows 7 64 Bit ICS Compatibility Utility

– 64-Bit hardware is supported on some computers , this utility

enables 32-Bit ICS to be run on 64-Bit computers

o Run from Start > Programs > Empower . Must be run after installing ICS’s on Windows 7 64 Bit computers.


Installation

Where to Install ICS’s?

– Lace & Acquisition server. (all or only the needed)

– Database –No ICS’s installed

– Empower Client – All ICS’s deployed in environment except

MassSpec’s

– Raw Data file server – no ICS’s installed

– Citrix Empower Server – All ICS’s deployed in the

environment (for Install switch to install mode).


Where to load the Driver Pack with Citrix

LLaabboorraattoorryy ##11

LAC/E32

LAC/E32

Clients

CCoommppuutteerr RRoooomm

Database Server

WWoorrkk

AArreeaa

C

l

C

l

C

l

WWoorrkk

AArreeaa C

l

i

e

n

t

s

C

l

i

e

n

t

s

C

l

i

e

n

t

s

Citrix Server Clients

Clients

Clients

WWoorrkk AArreeaa

Terminals

Mac


Install/Automation

Silent Push Installation

– No interactive user interface is displayed during installation ,

used to deploy ICS to clients, Laces and Citrix servers

o Released with Empower 3 and June 2011 Driver Pack

o Installation steps are documented in the Empower 3 Installation

and Configuration Guide


Silent Installation Installed

Push installation can be done for Base software, Service Pack, Drivers (ICOP’s)

Lace32

Install

Package Parameters

File Install

Package Parameters

File Install

Package Parameters

File

Installed

Silent Installation

Silent Installation

Installed


Waters Release Note

Waters Release Note statement

– On an Empower Enterprise (Client/Server) system, install the

driver/firmware according to the preceding instructions. You must

do so on every computer (LAC/E™32 module, client, and Citrix

application server) that interacts with the instrument or device. For

consistency, install the driver/firmware on all clients, LAC/E32

modules, and Citrix application servers. You need not install the

driver/firmware on the database server unless Client software is

loaded on the server to interact with the instrument or device.

Why is this important ?


Deployment Planning Scenarios

– Can all available ICS’s be installed, even if they do not use or plan

to use some instruments ?

o Helping customers manage their network for future planning by

eliminating the need to add ICS to a validated system later is a

plus.

o Using Silent Push installations can be leveraged to perform these

requirements for ease of deployment .



– Qualification strategy when you add/update ICS’s ?

– What other additional Test?

– How are you doing?



New Instruments added to existing environment

– What is their SOP for adding hardware and software ?

o Their SOP defines the additional qualification steps to add

hardware and software .

– Does the user’s SOP support having systems with different suites

of firmware versions?

o New systems ship with latest firmware which may differ from that

current installed on existing modules

• Can they run in this mode or do all modules need to be at the

same FW level (Next Drivers Package will support different

version)



New Instruments added to existing environment

– Adding a new system may require new ICS. The new system is

only connected to one computer, where does the ICS need to be

installed ?

o See definition for Waters Release Note statement

– The new device is received with a newer version of firmware . Will

this be compatible ? can this be downgraded?

o Many Waters device can be downgraded , always check the ICS

and Firmware release notes to ensure compatibility.

o Testing is done with new firmware to ensure compatibility of

currently release version of ICS



Upgrade of ICS to support new instrumentation and/or features

– A new ICS is required to support the latest technology offerings by

Waters . Can we run this on our existing systems ?

o The ICS Release Notes will specify if the new version is compatible

with the older version

o If required the existing environment will need to be updated to

keep ICS versions at the same level



Citrix installation planning

– All Citrix servers MUST be installed with the same version of ICS

– Lace and client systems configured in this Citrix environment MUST

be at the same ICS version

o ACQUITY BSM ICS 1.40 and 1.50 cannot be installed at the same

time. You must have all the ACQUITY BSM ICS versions the same.

• You could have a mix of firmware that would be supported as

noted in release notes .

o CM-A and classic CM must all be at the same ICS version

• Firmware nomenclature different

• Classic CM uses Column Manager.sft

• CM-A uses Column Manager II.sft



Adding Third Party ICF/ICS to new or existing environment

– When installing third party ICF/ICS the previous scenarios also

apply.

– If you add another ICF/ICS after you have used the DM you may

need to remove/re-install one ICS using the DM.

– The DM ICS Repair feature should correct some issues


Qualification/Compliance

When the user’s LC system is due for re-qualification consider

updating firmware..?

– This can only be applicable if the customer’s SOP supports mixed

system firmware version


Common issues

&

Troubleshooting


Best Practices

Use the Deployment Manager to Install , Upgrade , Remove and

Repair ICS’s installed

Install the same ICS versions on all clients , Laces and Citrix

servers

Older ICS versions should be installed first , then use the

Deployment Manager to install required ICS’s last .

– If another ICS version is added at a later time it may be required

to remove then re-install one ICS that was previously installed

with the DM

– The DM ICS Repair feature can also be used

Windows 7 64 Bit ICS Compatibility utility must be run after

installing ICS’s on Windows 7 64 Bit computers.


Common Issues

Connectivity issues after installing ICS

– Run the 64 Bit ICS Compatibly utility

– Use the DM ICS Repair function to correct installation errors

– Run ICSCompanionSetup.exe ;

o Or remove then re-install ICS this will invoke this utility

– Open a DOS command window , change directory to the location where the ICSCompanionSetup.exe is located then type:

ICSCompanionSetup.exe /v"SKIP=TRUE“

.NET, C++ Run-time or ACQUITY Console terminating unexpectedly

– Run ICSCompanionSetup.exe or 64 Bit ICS Compatibility

– Run the DM ICS Repair feature

– Run the .exe with Run As Admin or set Compatibility to Always Run As Admin

o Collect Service Profile if not resolved


Run As


Common Issues

Loader or AutoLoader does not display devices

– Run the Waters DHCP Configure Server utility , reboot the PC while

all Ethernet connected devices are powered off.

Firmware file installation

– When installing any ICS a folder is created in Program Files\Waters

Instruments\Firmware or Empower\Instruments\Firmware

directory on the PC. The ICS installer will add these released .sft

files into this directory .

o NOTE: Updated firmware files will be overwritten if the original ICS

is re-installed.



..so what is compatible between old and new driver packs

1. Full and Consistent Driver Pack Update

– New module firmware with new Instrument Control Software

(ICS)

2. New module firmware with older Instrument Control Software

(ICS) on LAC/E and Server

3. Old module firmware with newer Instrument Control Software

(ICS)



4. Older firmware & older Instrument Control Software (ICS) on the

LAC/E but newer Instrument Control Software on the client

5. New Instrument Control Software on the LAC/E with newer

instrument firmware installed but older client software installed

– Options, 3,4 and 5 are currently untested, unlikely to work

o Examples ;Intelligent intake valves and/or Leak Sensors were a new

features and required firmware updates to function and required Console

diagnostics, so would have been non-functional with old software

New module firmware with OLD Instrument Control Software (ICS) has

to be supported.

o Active issue in-house “current and one version back” need exact version

that are supported for this statement

o ACQUITY UPLC Systems and modules continue to evolve and method must

be backwards compatible.

o Provide a mechanism for a staggered update for Enterprise installations


Troubleshooting

Service Profile.exe should be run from the ACQUITY Console or

from Windows Explorer (i.e. C:\Empower\Intruments\Bin) with

elevated Windows user account . This is needed to collect Windows

Event log files and other restricted files.


Troubleshooting

What info is included with a Service Profile.zip file

– Diagnostic Data for BSM, SM, and TUV…

– Application and System Event logs

– Defrag report

– Directory listing of C:\ drive

– ipconfig

– Registry settings

– List of active instruments

– Log files

– XML and HTML files for specific modules


Troubleshooting

StopAcquityProcess.cmd can be used to expedite troubleshooting .

This .cmd will stop background processes and services that are

normally closed during a reboot, this can eliminate the time needed

during a reboot or credentials to log in the computer.


Troubleshooting

DM ICS Repair feature can be used to ensure the correct files and

the registration of DLL’s and has been performed if older ICS’s

have been added


Troubleshooting

Loader.exe should be used to verify communication with devices by

scanning ethernet devices connected to the PC.

Verify the Windows OS user account used to install the DP is a

Local Administrator on the PC.

– In some case using the Windows >Run As Admin or setting the

Compatibly for the .exe to Always Run as Admin may be required

(Windows 7 and MassSpec’s)

Isolate communication issues by using external switch if required

The Waters FSE Laptops can be used to verify connectivity and

control of many if not all Ethernet based devices. This can also be

used to upgrade or downgrade firmware version in a lab

environment without needing to install a new or updated ICS on

the customers PC.


Troubleshooting Ethernet issues

Verify network cable is connected to Instrument LAN by

disconnecting cable from module. – A red X will show up with a message “network cable unplugged” for Instrument LAN

Run the Waters DHCP Server Configuration utility to ensure the

Instrument LAN has been selected for use.

– After running a reboot is required on computer

– Power off modules then once the computer has been logged in again power

on the modules

o Open Waters DHCP Configuration Wizard

o As the device are powered on they will be displayed in this window


Troubleshooting Ethernet issues

DOS command – Ping to make sure the IP address is reachable

– Ping Instrument LAN ip address first

o Then each device listed in Waters DHCP window

o A reply should be received from all devices

– No reply check Windows FireWall setting

o Check if IE has a Proxy Server defined

– Check LAN cable for connection to device

– Use laptop to rule out computer settings if possible

Verify the required ICS has been installed

– Add/Remove Programs will list ICS


Questions

installation, updates and maintenance of instrument drivers (icop…€¦ · ·...

Documents