Chromeleon and Agilent ICF

Quick Start Guide

Chromeleon 7
Chromatography Data System
Software Version 7.2.10 • May 2019
Chromeleon 7

Copyright
For Research Use Only. Not for use in diagnostic procedures. Copyright © 2009-2017 Thermo Fisher
Scientific Inc. All rights reserved.
Trademarks
Windows, SQL Server, and Microsoft are registered trademarks of Microsoft Corporation.
All other trademarks are property of Thermo Fisher Scientific Inc. and its subsidiaries.
Thermo Fisher Scientific Inc. provides this document to its customers with a product purchase to use
in the product operation. The document is copyright protected; any reproduction of the whole or any
part of this document is strictly prohibited, except with the written authorization of Thermo Fisher
Scientific Inc.
This manual is provided “as is”. The contents of this manual are subject to being changed, without
notice, in future revisions.
Thermo Fisher Scientific Inc. makes no representations that this document is complete, accurate, or
error-free. Thermo Fisher Scientific Inc. assumes no responsibility and will not be liable for any
errors, omissions, damage, or loss that might result from any use of this document, even if the
information in the document is followed properly.
This document is not part of any sales contract between Thermo Fisher Scientific Inc. and a
purchaser. This document shall in no way govern or modify any Terms and Conditions of Sale. The
Terms and Conditions of Sale shall govern all conflicting information between the two documents.
Document History
Revision: 1.3, original document

Chromeleon and Agilent ICF Quick Start Guide Page 2

Chromeleon 7

Table of Contents
1 Introduction and Scope ......................................................................................................... 4
2 System Requirements / Compatibility ................................................................................... 5
2.1 Supported Operating Systems ........................................................................................ 5
2.2 Required Agilent Software .............................................................................................. 5
2.3 Required Chromeleon Software ..................................................................................... 5
2.4 Chromeleon Licenses ...................................................................................................... 6
2.5 Supported Hardware....................................................................................................... 6
3 Installation ............................................................................................................................. 7
3.1 Hardware Installation...................................................................................................... 7
3.2 Installation of the ICF ...................................................................................................... 7
3.3 Testing Instrument Connection ...................................................................................... 8
3.4 Configuring the Driver in the Chromeleon Instrument Configuration ........................... 8
3.5 Software Updates ........................................................................................................... 11
3.5.1 Updating the ICF ....................................................................................................... 11
3.5.2 Updating Chromeleon .............................................................................................. 11
4 Getting Started ...................................................................................................................... 12
4.1 Direct Control of the Instrument .................................................................................... 12
4.2 Setting up an Instrument Method .................................................................................. 13
4.3 Running Injections........................................................................................................... 15
4.3.1 LC Systems ................................................................................................................ 15
4.3.2 GC Systems (HS 7697A only) .................................................................................... 15
4.4 Troubleshooting .............................................................................................................. 16
5 Known Limitations ................................................................................................................. 17
5.1 Only one CDS running ICF is supported .......................................................................... 17
5.2 Diagnostic Functions are not supported ......................................................................... 17
5.3 Software inject synchronization for non-Agilent autosamplers is not supported ......... 17
5.4 ELSD does not immediately reach idle state after aborting an injection ....................... 17
5.5 Other Limitations ............................................................................................................ 17

Chromeleon and Agilent ICF Quick Start Guide Page 3

Chromeleon 7

1 Introduction and Scope

In March 2010, Agilent Technologies introduced the Instrument Control Framework (ICF)
together with the Agilent LC Driver Package. More recently an Agilent GC Driver Package has
been added. These software components make it faster and easier for third-parties (for
example, Thermo Fisher Scientific) to enable and control Agilent liquid chromatography (LC)
systems from their chromatography data systems (for example from Thermo Scientific
Dionex Chromeleon CDS).
Thermo Fisher Scientific has developed a driver for Chromeleon™ to accommodate the
Agilent ICF. With the new approach in many cases support for new Agilent instruments can
be achieved just by installing a newer version of ICF or the LC Driver Package. In addition,
control for the Agilent 7697A Headspace Autosampler has now been included in the
Chromeleon driver.
This document describes how to install the ICF and explains the basics on how to configure
the systems and how to get started.

Note: When Agilent instruments are controlled via ICF, the communication between the
PC and the instrument is defined by Agilent, the Chromeleon software integration of the
ICF is performed by Thermo Fisher Scientific. Both companies are working closely
together. If you have any questions, please contact either Agilent or your local Thermo
Fisher Scientific representative for Dionex Chromatography Software.

Chromeleon and Agilent ICF Quick Start Guide Page 4

Chromeleon 7

2 System Requirements / Compatibility

2.1 Supported Operating Systems

The choice of operating system depends on both the requirements of the Chromeleon
software (including Service Releases) and the requirements of the Agilent ICF. The current
version of the Agilent ICF has been validated to work with Chromeleon running on:
• Microsoft® Windows® 7, 32 Bit and 64 Bit
For further details on operating systems, please refer to the Chromeleon Release Notes and
Agilent’s compatibility statement which can be found here:
http://www.agilent.com/chem/icf.

2.2 Required Agilent Software

The Instrument Control Framework (ICF), the Agilent LC Driver Package and the Agilent GC
Driver Package must be installed on the PC before installing Chromeleon.

Note: The required software (version A.02.05) is provided on the Chromeleon disk for
your convenience.

Note: Please refer to section 3, Installation, for detailed information about installing the
Agilent ICF in combination with Chromeleon

After installation, Agilent product versions can be checked using the Agilent Installation
Qualification Tool (IQT) by running:
• C:\Program Files\Agilent Technologies\Instrument Control
Framework\IQTWizard\ICFIQT.bat
• C:\Program Files\Agilent Technologies\Instrument Control
Framework\IQTWizard\ICFLCDriversIQT.bat

Note: On 64-bit operating systems the folder will start with C:\Program Files (x86)

CM IQ will also report the version numbers of the ICF packages.

2.3 Required Chromeleon Software

To operate Chromeleon 7 with the Agilent ICF, the minimum supported Chromeleon 7
versions are:
• Chromeleon 7.1 (A.01.02)
• Chromeleon 7.1 SR1 (A.01.03)
• Chromeleon 7.1 SR2 (A.01.03)
• Chromeleon 7.1 SR2 MUb (A.01.05)
• Chromeleon 7.2 (A.01.05 SP1)

Chromeleon and Agilent ICF Quick Start Guide Page 5

Chromeleon 7
• Chromeleon 7.2 SR1 (A.02.01)
• Chromeleon 7.2 SR4 (A.02.03 DU1 Hotfix 2)
• Chromeleon 7.2 SR5 (A.02.04)
• Chromeleon 7.2.10 (A.02.05)

2.4 Chromeleon Licenses

To control an Agilent LC system through ICF, the following Chromeleon licenses are required:
• Instrument Class 3
Optional licenses are:
• 3D Data Acquisition (to allow acquisition of 3D data from Diode Array and Fluorescence
Detectors)
To control an Agilent 7697A Headspace Sampler through ICF, the following Chromeleon
licenses are required:
• Instrument Class 2

2.5 Supported Hardware

All LC modules supported by the Agilent Instrument Control Framework (ICF) and the Agilent
LC Driver Package (version A.02.05) are also supported by Chromeleon. For a complete list of
modules and firmware requirements see the List of Supported Instruments for Chromeleon
CDS.
The 7697A Headspace Sampler is supported in both the GC ICF and within Chromeleon. This
support is only available with Chromeleon 7.2 SR4 and subsequent releases.

Note: It is not possible to configure GC (other than the 7697A HS) instruments using the
ICF within Chromeleon.

Note: If your system does not comply with the modules and minimum firmware
requirements listed on the Agilent web page, you are not able to use Chromeleon's
Agilent LC System /Agilent GC System drivers. In this case, Thermo Fisher Scientific
recommends to upgrade the firmware(s) accordingly.

Note: The firmware versions listed in the table are the minimum requirements. In
general, Thermo Fisher Scientific recommends using the latest firmware versions.

Note: Agilent modules must run ICF-compatible firmware versions and firmware
versions that are compatible with each other and – if required – are compatible with
any handheld controller G1323/G4280.

Note: When using Fraction Collection with the ICF, only configurations containing
exclusively Agilent instruments will function correctly.

Chromeleon and Agilent ICF Quick Start Guide Page 6

Chromeleon 7

3 Installation
This chapter describes the installation steps required for installing the Agilent Instrument
Control Framework with Chromeleon.

Attention: Make sure that the installation operator has full local Windows administrator
privileges.

3.1 Hardware Installation

Before installing the software, please make sure all hardware is installed. Connect the
individual Agilent modules via CAN. Connect the whole instrument to the PC via LAN, use the
LAN card in the Agilent module that produces the largest amount of data (DAD > FLD > MWD
> VWD > RID). After setting up the instrument, follow the steps described under section 3.2,
Installation of the ICF.

Attention: Make sure that the modules installed in your system (including their
firmware) are compatible for use with the ICF.

Note: It is only possible to connect the LC hardware via LAN. Instrument control via
GPIB is not possible.

Note: For more hardware installation details, refer to the instrument/module manual.

3.2 Installation of the ICF

The ICF software and driver packages should be installed using the Advanced Options
available when installing Chromeleon. This is described in more detail in the installation
guide which is provided in printed form and also on the disk in the Documents folder.
The ICF usually installs into C:\Program Files\Agilent Technologies\Instrument Control
Framework\.

Note: Installation IQ is available for all packages under:

C:\Program Files\Agilent Technologies\Instrument Control Framework\IQTWizard.

Note: When controlling an Agilent instrument (editing methods, view status) or when
changing the Chromeleon server configuration containing the Agilent LC Driver/Agilent
GC Driver from a remote client, make sure to install all packages on the remote client
PC too. Make sure to install the same version of the ICF on all PCs.

Note: For unattended setup, please refer to the Response File section of the
Chromeleon Installation Guide.

Chromeleon and Agilent ICF Quick Start Guide Page 7

Chromeleon 7

3.3 Testing Instrument Connection

Before continuing the installation of Chromeleon it is recommended to test the ICF
installation using the Agilent.InstrumentControl.TestApp.exe test application provided by
Agilent. The test helps you to identify network related issues at an early stage. The
application is part of the Instrument Control Framework and typically installed under
C:\Program Files\Agilent Technologies\Instrument Control Framework. To run the test:
• Open a command window (Start>Run>Cmd). Use the ping <IP address> command to
verify that the installed modules can be addressed. TCP/IP settings are correct if replies
are received from the instrument.
• Double-click the Agilent.InstrumentControl.TestApp.exe to start the test application.
• Click Configure to configure a new instrument.
• Click Auto Configure and enter the IP address of the instrument.

Tip: Instead of typing long numerical IP addresses (such as 192.168.254.11), you can
assign a host name to your instrument.

Open C:\WINDOWS\system32\drivers\etc\hosts with a text editor such as Notepad and

add a line containing the numerical IP address and a hostname (in the example below
"LC11") at the end of the file, e.g.:

192.168.254.11 LC11

You may use any string of alphanumerical characters to specify the host name.

When setting up the configuration, you can then use the host name, here "LC11",
rather than the numerical IP address.

• When auto configuration is completed, exit the configuration dialog.

• Click Open to display the Agilent Instrument Status window. Click Initialize in the upper
left corner to connect the modules. The installation is correct if the status information
(e.g., Ready, NotReady) for each individual module is provided.

3.4 Configuring the Driver in the Chromeleon Instrument

Configuration
After the ICF installation has been completed and the instrument connection has been
successfully tested, install Chromeleon.
ICF control in Chromeleon is provided by the Agilent LC System resp. Agilent GC System
module. To install the module in Chromeleon, follow the steps below:
• First, turn on all modules of the LC or GC system.
• Start the Chromeleon Instrument Controller.
• Start the Instrument Configuration Manager application.
• Add the LC System resp. GC System module (Manufacturers = Agilent) to an instrument:

Chromeleon and Agilent ICF Quick Start Guide Page 8

Chromeleon 7

Note: When configuring a GC system, it is recommended to configure the GC itself first,

and then add the GC System module for controlling the headspace autosampler.

When you add the driver to the instrument, the Agilent System Configuration dialog opens
automatically where you can add and configure modules. The left panel of the dialog box
lists all the modules that are currently supported by the ICF. The right panel lists the
modules that are currently configured. Click the Help button or press F1 for detailed
information on instrument configuration.

• Click Auto Configure and enter the IP address of the instrument.

• After configuration, click OK to close the module configuration dialog. Incorrect entries,
for example, an invalid module name, are marked by a red error icon displayed next to
the Configure Agilent ICF Instrument button on the General tab page. A tooltip provides
more details about the error.

Chromeleon and Agilent ICF Quick Start Guide Page 9

Chromeleon 7

Note: If Chromeleon complains about an invalid device name, select the respective
module in the right pane of the Agilent LC System Configuration dialog and click
Configure. This brings up an additional dialog where the device name can be changed to
something Chromeleon accepts. This should only be needed for new modules not yet
known to Chromeleon (after an update of ICF to a newer version) or when more than
one module of the same type is present. Then, manually editing the names is needed to
make them unique.

• On the Signals (2D) and Spectra (3D) configuration tab pages, verify that all settings are
correct. Edit / correct settings, if necessary.

• Click OK to add the Agilent LC System driver to the instrument.

• Save the Chromeleon Instrument Configuration.

Chromeleon and Agilent ICF Quick Start Guide Page 10

Chromeleon 7

Note: When the instrument’s modules have changed, make sure to reconfigure in the
Chromeleon Instrument Configuration. Open the properties of the Agilent LC System
module and click Configure Agilent ICF Instrument on the General tab.

3.5 Software Updates

The best practice is to always use the recommended and validated combination of ICF and
Chromeleon. However, it is sometimes necessary to update the software independently,
albeit with limitations.

3.5.1 Updating the ICF

It is possible to update the ICF without updating Chromeleon, e.g. to fix ICF issues.
Limitations: New instruments and/or features in the ICF will not be necessarily supported
and/or working error free.

3.5.2 Updating Chromeleon

It is possible to update Chromeleon without updating the ICF, e.g. to fix Chromeleon issues.
Limitations: New features designed to work with later ICF versions will not work.

Chromeleon and Agilent ICF Quick Start Guide Page 11

Chromeleon 7

4 Getting Started
Throughout most of this section, the LC System is used as an example. Section 4.3 provides
key information for GC users.

4.1 Direct Control of the Instrument

To control the LC System select the instrument in the Instruments category of the
Chromeleon Console. The Agilent status window is embedded in the ePanel for this
instrument.

Note: The Agilent Instrument Status window offers full access to all method
parameters, all module configuration parameters and direct commands (e.g. lamp on,
autozero). All this is accessible via the context menu.

Make sure to wake up all modules from standby and clear any errors by clicking the
corresponding button.

Alternatively, perform this action for all modules at the same time using the buttons at the
lower right.

Chromeleon and Agilent ICF Quick Start Guide Page 12

Chromeleon 7

To execute commands hover over a module and select the context menu (right mouse
button). Note that it is not possible to issue manual commands while a sequence is running.

Note: The Chromeleon Injection Audit Trail documents all method settings for each
injection.

4.2 Setting up an Instrument Method

An Instrument Method can be created using the Chromeleon Instrument Method Wizard.
Follow the steps below.
• Start the Chromeleon Instrument Method Wizard.
• Enter a run time for the Chromeleon Instrument Method and select whether you want to
record any auxiliary signals. Click Next.

Note: Currently there is no check against the run time of the Agilent method, so make
sure to specify the same run time or longer.

• The next page contains the Agilent Instrument Method Editor, with a default method.

Chromeleon and Agilent ICF Quick Start Guide Page 13

Chromeleon 7
• Edit the Agilent method.
 Pay special attention to each module’s run time (Stoptime) setting - either set the
same time for each module, or set time for pump and set As Pump, for all others.

 Set Posttime to Off for all modules

 Specify which chromatographic signals (DAD, VWM, MWD, FLD, …) to record by
checking the Use Signal checkboxes.
 Set the Lamps on required settings as desired.
• Click Next.
• The next page contains the Agilent ICF pretreatment settings. If non-standard injection
procedures are required, edit the Pretreatment steps accordingly. Click Next.

• Enter a comment and description as required and finish the wizard.

• In the script, verify that there is an Acquisition On (AcqOn) command for each auxiliary
and chromatographic signal.

Chromeleon and Agilent ICF Quick Start Guide Page 14

Chromeleon 7

Note: When you define a method in the Agilent method editor, Chromeleon does not
perform a consistency check for Agilent methods, i.e. whether the settings in the
method are useful or correct. If you specify method conditions that cannot be met by
the instrument, the run start will time out. Therefore, always make sure that the
method settings in the Agilent method editor comply with the actual device status; for
example, verify that the lamps are on if option "Lamp on required for acquisition" is
selected for the detector, or the oven temperature is within the specified range when
option "Enable analysis when temperature is within..." is selected.

4.3 Running Injections

4.3.1 LC Systems
Prior to starting a Chromeleon sequence, make sure to set the LCSystem.Overlapping
property as desired, either by adding the command to the Chromeleon Instrument Method,
via the Chromeleon Command dialog, or directly on the ePanel tab. When overlapping is
enabled, all injections must use the same method, and all injections will enter the Preparing
state once the sequence is started. Whether the sampler performs any overlapping is
defined in the Agilent method, as the options are sampler type dependent.
Create and start the sequence as usual. It is only possible to start the queue when the
Agilent instrument is Idle.

4.3.2 GC Systems (HS 7697A only)

Prior to starting a Chromeleon sequence, make sure to set the GCSystem.Overlapping
property as desired, either by adding the command to the Chromeleon Instrument Method,
via the Chromeleon Command dialog, or directly on the ePanel tab. It is possible for

Chromeleon and Agilent ICF Quick Start Guide Page 15

Chromeleon 7
injections to use different methods, and for vial numbers not to be sequential. When
overlapping is enabled the entire sequence will be locked once the sequence is started. In
order to ensure that the autosampler is in synch with Chromeleon, it will need to receive a
Ready signal from the GC, and the GC expects a Start signal from the autosampler.
Create and start the sequence as usual. It is only possible to start the queue when the
Agilent instrument is Idle.

4.4 Troubleshooting
In case of errors:
• Click AbortRun, and/or

• Click to recover.

Chromeleon and Agilent ICF Quick Start Guide Page 16

Chromeleon 7

5 Known Limitations
The following limitations apply to the Agilent ICF in the current version.

5.1 Only one CDS running ICF is supported

Only one CDS or other application using ICF is supported per computer. This means that to
use another CDS with the ICF, a different PC is required.

5.2 Diagnostic Functions are not supported

ICF does not provide functionality to access EMF counters or to perform
diagnostics/maintenance operations on the individual modules. Therefore Chromeleon
cannot offer any functionality for diagnostics. The Agilent Lab Advisor software is required to
perform diagnostics operations.

Note: Modules equipped with older LAN cards are not able to communicate with
Chromeleon and the Lab Advisor simultaneously.

5.3 Software inject synchronization for non-Agilent autosamplers

is not supported
For instruments using autosamplers that are not part of the Agilent instrument (e.g.,
UltiMate 3000 WPS plus Agilent ICF DAD), inject synchronization via hardware (e.g. WPS
inject out to DAD remote start in) is mandatory. Agilent ICF does not provide real time
functionality to start the instrument run via software in a timely manner.

5.4 ELSD does not immediately reach idle state after aborting an
injection
If an injection is aborted and the currently running method contains a defined temperature
set point for an Evaporative Light Scattering Detector (ELSD) that has not been reached, the
detector does not become idle until the temperature has returned to the initial set point. It
is not possible to start a new injection until the detector is idle. When trying to start an
analysis the ready check will issue an appropriate message.

5.5 Other Limitations

• Only one injector is allowed per instrument (applies to both GC and LC systems).
• Manual injection is not supported.
• Missing vials are handled slightly differently from Thermo Scientific Dionex instruments.
Either the method continues to run without injection or the running queue is aborted.
The behavior can be controlled via the setting Ignore Missing Vessel, available from the
Agilent status window in the ePanel. Select Control… from the sampler’s context menu to
access this setting.

Chromeleon and Agilent ICF Quick Start Guide Page 17

Chromeleon 7
• Visual display of the rack layout is not available for Agilent LC systems. The tray positions
of the Agilent LC System driver only show a list of subsequent positions but no valid tray
geometry, as this is not exposed by the Agilent ICF.
• Data from ad-hoc runs (started via the handheld controller) are not collected.
• Agilent instruments use built-in emergency methods, therefore emergency and power
failure programs in the Chromeleon queue cannot be used. Instead these methods must
be specified using the context menu in the Agilent instrument status window. Refer to
the Chromeleon online help for details.
• The following commands are not available with the ICF: Hold, Continue, StopFlow, Wait
and Message.
• When using Fraction Collection with the ICF, only configurations containing exclusively
Agilent instruments will function correctly.
• For the High Dynamic Range Dad Cluster (HDR DAD, 2xG4212A/B) application,
Chromeleon 7 only supports 2D data acquisition; 3D data cannot be acquired. The signal
configuration for the 2D signals must be set up manually in Instrument Configuration
Manager.
• Configuration changes made via ePanel in the Agilent LC Configuration Control will only
be applied/visible in Chromeleon after updating the configuration in the Chromeleon
Instrument Configuration Manager. This applies to configuration changes such as:
 Changing the temperature mode of a sampler,
 Adding or removing an external tray,
 Reconfiguring the Multisampler capillaries,
 Applying new maximum injection volumes after loop or capillary configuration
changes.

Chromeleon and Agilent ICF Quick Start Guide Page 18

www.thermofisher.com

© 2009-2017 Thermo Fisher Scientific Inc. All rights reserved.

Thermo Fisher Scientific Inc.

168 Third Avenue
Waltham, MA 02451
USA