Installation Guide
Installation Guide
Installation Guide
Notices Agilent Technologies, Inc.
6612 Owens Dr.
Restricted Rights Legend
Pleasanton, CA 94588-3334 If software is for use in the
Copyright © Scientific Software, performance of a U.S.
Inc 1997-2005 © Agilent Government prime contract or
Technologies, Inc. 2006-2007. subcontract, Software is
Warranty delivered and licensed as
Adobe, Acrobat, and Reader are
either registered trademarks or The material contained in this "Commercial computer
trademarks of Adobe Systems document is provided “as is,” software" as defined in DFAR
Incorporated in the United States and is subject to being changed, 252.227-7014 (June 1995), or as
and/or other countries. without notice, in future editions. a "commercial item" as defined
Further, to the maximum extent in FAR 2.101(a) or as "Restricted
Microsoft®, Active Directory®, permitted by applicable law, computer software" as defined
ActiveX®, Agilent disclaims all warranties, in FAR 52.227-19 (June 1987) or
Outlook®PowerPoint®, either express or implied, with any equivalent agency regulation
Windows®, and Windows regard to this manual and any or contract clause. Use,
Internet Explorer 7® are information contained herein, duplication or disclosure of
registered trademarks of including but not limited to the Software is subject to Agilent
Microsoft Corporation in the implied warranties of merchant- Technologies’ standard
United States and/or other ability and fitness for a particular commercial license terms, and
countries. purpose. Agilent shall not be non-DOD Departments and
No part of this manual may be liable for errors or for incidental Agencies of the U.S. Government
reproduced in any form or by any or consequential damages in will receive no greater than
means (including electronic connection with the furnishing, Restricted Rights as defined in
storage and retrieval or use, or performance of this doc- FAR 52.227-19(c)(1-2) (June
translation into a foreign ument or of any information 1987). U.S. Government users
language) without prior contained herein. Should Agilent will receive no greater than
agreement and written consent and the user have a separate Limited Rights as defined in FAR
from Agilent Technologies, Inc. written agreement with warranty 52.227-14 (June 1987) or DFAR
as governed by United States terms covering the material in 252.227-7015 (b)(2) (November
and international copyright laws. this document that conflict with 1995), as applicable in any
these terms, the warranty terms technical data.
Manual Part Number in the separate agreement shall
control.
G4650-90012
Technology Licenses
Edition The hardware and/or software
June, 2007 described in this document are
furnished under a license and
Document Revision 3.2a1
may be used or copied only in
Printed in USA accordance with such license.
Contents
1 Using This Guide .................................................................... 7
Introduction........................................................................................ 7
2 Installation .............................................................................. 9
Definitions .......................................................................................... 9
Enterprise Path............................................................................... 9
EZServers ........................................................................................ 9
Client PCs...................................................................................... 10
Installation Notes............................................................................ 11
7 Client/Server Installation....................................................31
Setup Worksheet ............................................................................ 31
9 Installation Qualification..................................................... 51
Key Program..................................................................................... 60
CIO/DIO ............................................................................................ 81
Documentation Conventions
The following conventions are used in this guide.
Convention Description
Bold Database names, table names, column
names, menus, commands, dialog box
options, and text that must be typed
exactly as shown.
Italic Placeholders for information you must
provide. For example, if you are instructed
to type ServerName, then you must type
the actual name of the server instead of
the italicized term.
Monospace Programming code samples and display
text.
ALL CAPITALS The keys you press on the keyboard. If
combined with a plus sign (+), press and
hold the first key while you press the
remaining key(s). For example, press
SHIFT+TAB.
Definitions
Enterprise Path
The Enterprise Path is a shared folder that is used to store
all of the files (methods, data, sequences, configurations,
settings, etc.) used by the software.
Enterprise Machine
The Enterprise Machine is a PC on the network that is used
to perform overall data system management tasks such as
logins to the data system and file access.
EZServers
An EZServer is a PC that is used to provide control and data
acquisition to one or more LC or GC systems. In general,
users do not interact directly with the software on
Installation 9
EZServers. Rather, Client PCs are used to connect to
EZServers and provide user control.
Client PCs
Client PCs provide the user interface and interactive
environment for users of the data system. Client PCs are
used to set up runs, monitor instrument activity, review
data and perform other interactive tasks.
10 Installation
Installation Notes
• Microsoft .NET version 2.0 must be installed prior to
installation of the EZChrom Elite software. To
install .NET 2.0, run the executable program located
on the Elite installation CD, in the Updates\Net 2.0
folder.
• Certain memory leaks are a known issue with
Microsoft XP SP2. For an available patch and
workaround, see the following Microsoft website
article:
http://support.microsoft.com/default.aspx?scid=kb;
en-us;319740.
• Make sure the Enterprise Machine is rebooted either
before or immediately after EnterpriseSetup.exe is
run to enable the Advanced File Security.
Otherwise, the postings to the Instrument Activity
log will be interrupted.
• Do not install EZChrom Elite in the \Program Files
folder. If it is installed there, only a system
administrator will be able to start EZChrom Elite.
Installation 11
12 Installation
3 Before You Begin a New Installation
To simplify installation of the data system software, it is
helpful to decide on some configuration options before you
begin the actual software installation.
Please review the points below and fill in your choices on
the Setup Checklist included in the Workstation or Client/
Server Installation sections. If you need more information,
please refer to the “Definitions” section of this manual.
! Review the Requirements for the Enterprise File Server and the
Enterprise Machine
Refer to the EZChrom Elite Hardware and Software
Requirements document to confirm that the Enterprise File
Server and the Enterprise Machine meet the system
requirements.
! Create the Domain Groups and Users Used by the Data System
If you will be using Windows Active Directory domain user
lists, this task must be performed by your domain
administrator.
If you will not be running with domain user lists, you may
skip these steps.
Note: When defining domain groups for use with the data system,
please be sure the groups are Domain Global groups and not
Domain Local groups.
4 Instrument Folders
When you install the software, instrument subfolders will be
created. These folders are used to provide a temporary
location for the data file during C/S connection. These
subfolders will be named: instrument.10XYZ, where 10XYZ
is the instrument ID.
In a new installation, these instrument folders will normally
be created in C:\Documents and Settings\All
Users\Application Data\ChromatographySystem\Recovery
Data. The folders will be used to store temporary files.
AFS Requirements
• All PCs used with EZChrom Elite AFS must be
members of a Windows Active Directory domain.
AFS Notes
• The file security model used prior to EZChrom Elite
3.1 has been discontinued and replaced by AFS. The
old security model is no longer available.
• If you are running with the old file security model,
you must run the EnterpriseSetup utility to activate
AFS. If you do not, project permissions assigned
within EZChrom Elite (using the System
Administration Wizard) will still apply to users
logging into the data system. However, the
Enterprise will not be secured to prevent access by
users running programs outside of EZChrom Elite.
• Once AFS has been activated for an Enterprise, it
cannot be turned off.
• Enterprise files may only be archived and managed
by logging in to the domain as a member of the
Enterprise Service Group.
• Once AFS has been activated for an Enterprise, any
third party User Programs will only get access to a
copy of the data file during analysis. The original
file is kept securely in the Enterprise path and is
not accessible to external programs.
Workstation Installation 21
Workstation Step 1: Setup the Enterprise Path
The files used by the data system software (methods, data,
sequences, configurations, settings, etc.) are stored in a
folder on the PC known as the Enterprise Path.
1. Create a folder on the data system PC to be the
Enterprise Path.
2. File permissions on this folder should be set to “Full
Control” for the Data System Users Group
3. Enter the folder name in the space provided for the
Enterprise Path in the Setup Worksheet.
22 Workstation Installation
Enterprise Path from the Setup Worksheet. Reboot
the computer when prompted.
6. Install any optional control software you might have
purchased after you install the EZChrom Elite
software. To install the optional software, insert the
Options CD provided. The installation menu should
start automatically. If the installation menu does not
open, browse the CD and run CDInstaller.exe. Be
sure to follow the installation instructions provided
on the Options CD for the particular software you are
installing.
7. Reboot the computer.
Note: Do not connect the USB License Key until the EZChrom Elite
software has been completely installed. Otherwise, incorrect
USB drivers may be loaded and your license will not
function.
Workstation Installation 23
When Advanced File Security (AFS) is activated, the
Windows Active Directory permissions on the entire
Enterprise Path are modified so that only members of a
special domain users group have access to the files.
Note: Once you have enabled the advanced file security by setting
an Enterprise Service Account, the change will be
permanent. All dialogs for file opening, saving, etc. will
reflect this change and will limit access to Enterprise
locations only. In addition, file permissions for the
Enterprise will be modified so that no users other than
members for the Enterprise Service Group will have access
to the contents of the Enterprise outside of the data system
software.
24 Workstation Installation
5. After the entries have been made, click OK.
6. Delete the EnterpriseSetup.exe file from the data
system installation directory.
After running EnterpriseSetup.exe, the directory structure
for the enterprise will be established. The NTFS rights will
be set so that users other than the members of the
Enterprise Service Group cannot view the project
directories from Windows Explorer. These users will be
able to access the projects and files from the data system
software if they are given those rights inside the data
system software.
Workstation Installation 25
Workstation Step 5: Configure the Enterprise
1. Run the data system software by selecting the
EZChrom Elite item from the Start>All
Programs>Chromatgraphy menu.
2. Select Tools followed by Options.
3. Click the Enterprise tab.
4. Select Stand-alone in the Instrument control mode
group box.
26 Workstation Installation
5. If you will be requiring users to log in to the data
system, check Enable instrument login and project
management.
6. If you are enabling logins, select the source of the user
lists. To use Windows Active Directory domain based
user lists, select Domain controller and specify the
name(s) of your domain(s).
7. Click OK and exit the data system software.
Workstation Installation 27
1. Run the data system software by selecting the
EZChrom Elite item from the Start>All
Programs>Chromatgraphy menu.
2. From the File menu, click New followed by Instrument.
A new icon will appear in the right pane of the main
window with the title highlighted for editing. Type a
descriptive name of the instrument.
3. Do a right mouse click on the instrument you want to
configure, and then click Configure followed by
Instrument.
28 Workstation Installation
configuration of the instrument. Please refer to the on-
line help or documentation provided for details on
completing the configuration of the specific instrument.
Workstation Installation 29
30 Workstation Installation
7 Client/Server Installation
Setup Worksheet
This worksheet is designed to guide you through the
steps required to perform a new installation of the
Client/Server version of the data system software. For
each step below, please refer to the corresponding
section in this chapter for details on the process.
For easier reference, during the course of the
installation, please fill in the following fields as they
become available:
Enterprise Path: ___________________________
Enterprise Machine: ___________________________
Please perform the following steps in this order:
" Perform the preliminary tasks outlined in the
section entitled Before You Begin
" Step 1: Setup the Enterprise Path
" Step 2: Setup the Enterprise Machine
" Step 3: Setup the Agilent Instrument Controllers
" Step 4: Setup any Data Acquisition PCs
(EZServers)
" Step 5: Setup the Client PCs
" Step 6: Install the Software Licenses
" Step 7: Activate Advanced File Security, if
desired
" Step 8: Configure the Enterprise
" Step 9: Configure Interfaces
" Step 10: Configure Instruments
" Step 11: What to Do Next
Client/Server Installation 31
The following steps describe how to install EZChrom Elite
in a Client/Server environment.
32 Client/Server Installation
privilege on the machine containing the Enterprise
Path.
2. Login into the Enterprise Machine using the name
and password of any account that has local
administration privileges. In a mixed NT and Active
Directory network environment, the Enterprise
Machine user must be an Active Directory user.
3. Install the data system software by inserting the
data system software CD and following the
directions presented. The installation menu should
start automatically. If the installation menu does
not open, browse the CD and run CDInstaller.exe.
During installation, leave the field labeled
Enterprise Machine blank, and specify the share
name from the Setup Worksheet as the Enterprise
Path. Reboot the computer when instructed.
4. Install any optional software you might have
purchased after you install the EZChrom Elite
software. To install the optional software, insert the
Options CD provided. The installation menu should
start automatically. If the installation menu does
not open, browse the CD and run CDInstaller.exe.
Be sure to follow the installation instructions
provided on the Options CD for the particular
software you are installing.
5. Reboot the computer after the installation of the
data system software and login using the name and
password of an account with local administration
privileges.
6. Run the data system software by selecting the
EZChrom Elite item from the Start>All
Programs>Chromatgraphy menu. This will create
the necessary folder structure in the Enterprise
path, as required by the data system. (Running
Key.exe will also do this.) When the main screen
appears, select the File > Exit menu item.
7. Run the program DCOMServerSettings.exe, which is
found in the main data system installation folder.
Make the following entries:
Client/Server Installation 33
• Select Auto Logon for the Run As selection
• Enter the name and password of an account that
has local Administrative privileges.
• After the entries have been made, click the Set
button.
34 Client/Server Installation
\\Manual\Optional Software Manuals\ folder of the
EZChrom Elite software distribution CD.
2. Confirm that the Enterprise Service Group has been
granted the Windows Active Directory permissions
called “Log on Locally” and “Act as Part of the
Operating System”.
Client/Server Installation 35
start automatically. If the installation menu does
not open, browse the CD and run CDInstaller.exe.
Be sure to follow the installation instructions
provided on the Options CD for the particular
software you are installing.
6. Reboot the computer after the installation of the data
system software and login using the name and
password of a local administration account.
36 Client/Server Installation
Note: For additional information about the purpose and options of
the DCOMServerSettings program, please refer to the
“DCOM Server Settings Options” section.
Client/Server Installation 37
4. Install the data system software by inserting the
software CD and following the instructions. During
installation, enter the name of the Enterprise Machine
and the share name of the Enterprise Path from the
Setup Worksheet. Reboot the computer when
prompted.
5. Install any optional software you might have
purchased after you install the EZChrom Elite
software. To install the optional software, insert the
Options CD provided. The installation menu should
start automatically. If the installation menu does
not open, browse the CD and run CDInstaller.exe.
Be sure to follow the installation instructions
provided on the Options CD for the particular
software you are installing.
6. Reboot the computer.
38 Client/Server Installation
This version of the data system software introduces a new
Enterprise security model called Advanced File Security
(AFS) to further protect files from unauthorized access. AFS
replaces the security system used in previous versions of
the software with a model that is more tightly integrated
with Windows Domain security. When AFS is activated, the
Windows Active Directory permissions on the entire
Enterprise Path are modified so that only members of a
special domain users group have access to the files.
Note: Once you have enabled the advanced file security by setting
an Enterprise Service Account, the change will be
permanent. All dialogs for file opening, saving, etc. will
reflect this change and will limit access to Enterprise
locations only. In addition, file permissions for the
Enterprise will be modified so that no users other than
members for the Enterprise Service Group will have access
to the contents of the Enterprise outside of the data system
software.
Client/Server Installation 39
4. The Enterprise Service Account Dialog will be
displayed. Make the following entries:
• Enter the name and password of the Enterprise
Service Account
• Enter the domain to which the Enterprise Service
Account belongs
• Enter the name of the Enterprise Service Group
5. After the entries have been made, click OK.
40 Client/Server Installation
6. Delete the EnterpriseSetup.exe file from the data
system installation directory.
7. After running EnterpriseSetup.exe, the NTFS rights
will be set so that users other than the Enterprise
Administrator cannot view the project directories
from Windows Explorer. These users will be able to
access the projects and files from the data system
software if they are given those rights inside the
data system software.
Client/Server Installation 41
Client/Server Step 8: Configure the Enterprise
Configuration of the Enterprise may be performed from the
Enterprise Machine or any other PC with the data system
software installed.
1. Run the data system software by selecting the
EZChrom Elite item from Windows Start>All
Programs>Chromatography.
2. In the Main Menu, click Tools followed by Options.
3. Click on the Enterprise tab.
4. Select the Client/Server option in the Instrument
control mode box.
42 Client/Server Installation
6. If you are enabling logins, select the source of the
user lists. To use Windows Active Directory domain
based user lists, select Domain controller and
specify the name(s) of your domain(s).
7. Click OK and exit the data system software.
Client/Server Installation 43
Unlike interface configuration, instrument configuration
may be performed from any PC in the Enterprise.
For each instrument, perform the following steps:
1. Run the data system software by clicking Windows
Start>All Programs>Chromatography and then
select EZChrom Elite.
2. From the File menu, click New followed by
Instrument. A new icon will appear in the right
pane of the main window with the title highlighted
for editing. Type a descriptive name of the
instrument.
44 Client/Server Installation
Select the type of instrument from the drop
down list
Server
This field must contain the UNC name of the
PC or Agilent Instrument Controller to which
the instrument is physically attached.
Clicking the button to the right of the field
will allow you to browse to the proper
location.
5. Click the Configure button. This will display a
dialog allowing you to perform model-specific
configuration of the instrument. Please refer to the
on-line help or printed documentation for details on
completing the configuration of the instrument.
Client/Server Installation 45
46 Client/Server Installation
8 Installation on a Citrix Server or Windows
Terminal Server
In a client/server installation, data system clients may be
served to end users using a Citrix MetaFrame XP Server or
Windows Terminal Server. In this scenario, the client
software is installed on the Citrix Server or Windows
Terminal Server. To use the software with Citrix MetaFrame
or Windows Terminal Server, perform the following steps:
1. Confirm the hardware requirements for running the
data system software on a Citrix MetaFrame XP Server
or Windows Terminal Server. (Refer to the EZChrom
Elite Hardware and Software Requirements
document for details.)
2. Confirm that Citrix MetaFrame XP or Windows
Terminal Server has been properly installed and
configured.
3. Confirm that the Enterprise Service Group is a member
of the Local Administrators group of the Citrix Server
or Windows Terminal Server PC.
4. Confirm that the Enterprise Service Group has been
granted the Windows Active Directory permissions
called "Log on Locally" and the Data System Users
Group has been granted the "Act as Part of the
Operating System" privilege.
5. From Explorer, check that the following DLLs in the
System32 folder have Read (RX) privileges granted to
Everyone:
oleaut32.dll
odbc32.dll
odbcint.dll
6. Login into the Citrix Server or Windows Terminal
Server PC using the name and password of an account
with local administration rights.
Note: Wait about a minute after closing Elite for the session to end.
Installation Qualification 51
To install the license, or upgrade an existing license, you
must run the key installation wizard from the Key.exe
program. This program will be located in the program folder
following software installation. The wizard will request user
information and serial number, then will provide a Request
Code. You must contact your vendor with this number to
obtain a valid Enable Code for your system. Once this code
is entered in the Key Installation Wizard, the key
installation will be completed and your software will
become fully functional.
If you require more instruments or other options than your
license allows, contact your sales representative for upgrade
information.
Note: The license diskette can only be used once to install the
license key. Therefore, it is very important that you choose
to create a License Repair Disk when prompted and store it
in a secure place.
Request Code
In order to continue installation of the software licenses,
you must supply a name to be used for system registration
(Customer Name), and the serial number of your software.
Note: You must have the disk with the .lkt file on it in order to re-
install the license or move it to another location. Keep this
disk in a safe place. You should uninstall the license if you
are going to re-name your computer, then re-install after the
computer has been re-named.
Output File
In this screen, you should select the location where you
want to have the .LKR file created. In most cases, this would
be a floppy, but you can choose another location.
File
Exit
Exit the key program.
View
Auto Refresh
This automatically updates the status of the network
key, and sets the number of seconds between
refresh.
Refresh
Use this to update the status of the network key.
Toolbar
This toggles the display of toolbar icons.
Status Bar
This will toggle the display of the Status line.
Key Status
This displays information about the key, including
current enterprise path and program directory.
Note: You can only use the License Backup File to re-install your
software license to its original location. It cannot be used to
install your license to another machine or location.
Specific User
Select this option if you are going to use the
EZServer without a keyboard and monitor as a
dedicated data acquisition machine.
Interactive User
Select this option if you are going to use the
EZServer with a keyboard, mouse, and monitor to
serve as both a data acquisition server and as a
client workstation. A user will have to log-in to
use the software.
Auto Logon
This is the recommended option for Enterprise
Machine, EZServers and Agilent Instrument
Controllers (AICs).
Select this option if you want Windows to
automatically log on when the machine is turned
on.
Citrix/Terminal Server
Select this option if you are going to use the
EZServer as a Citrix/Terminal Server. Click the Set
button to apply the selections.
CIO/DIO
Install the CIO/DIO card according to the manufacturer's
instructions. The card must be configured before it can be
used. See the CIO/DIO Boards configuration section for
details.
Hardware Installation 81
82 Hardware Installation
15 Network Printers
A network printer is a printer that is set up on clients,
EZServers, and AICs through a UNC path, not a through a
local LPT port.
When the user logged into the computer is not a local
administrator and the printer is shared with only Print
permission, the software will require the user to select the
printer every time they open an instrument. This is due to
the logged user having insufficient rights to query for
information about the printer.
To solve the problem, simply set the permissions for
Everyone to Full Control rather than Print. This is done on
the sharing computer as follows: log onto each computer as
a local administrator, select the properties for the printer,
on the Security tab click Permissions, and in the
Permissions dialog change Everyone from Print rights to
Full Control rights.