54
Agilent OpenLAB Instrument Control Manager Administrators Guide

Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Embed Size (px)

Citation preview

Page 1: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Agilent OpenLAB Instrument Control Manager Administrator�s Guide

Page 2: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Notices

© Agilent Technologies, Inc. 2007.

No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Agilent Technologies, Inc. as governed by United States and international copyright laws.

Edition July, 2007

Document Revision 3.3 B

Printed in USA

Agilent Technologies, Inc. 6612 Owens Dr. Pleasanton, CA 94588-3334

Warranty The material contained in this document is provided �as is,� and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by

applicable law, Agilent disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchant-ability and fitness for a particular purpose. Agilent shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Agilent and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control.

Technology Licenses The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with such license.

Restricted Rights Legend If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and licensed as "Commercial computer software" as defined in DFAR 252.227-7014 (June 1995), or as a "commercial item" as defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR 52.227-19 (June 1987) or any equivalent agency regulation or contract clause. Use, duplication or disclosure of Software is subject to Agilent Technologies� standard commercial license terms, and non-DOD Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as defined in FAR 52.227-19(c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in FAR 52.227-14 (June 1987) or DFAR 252.227-7015 (b)(2) (November 1995), as applicable in any technical data.

Page 3: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Contents

1 Using This Guide ................................................................................. 7

Introduction ............................................................................................................7

Who Should Read This Guide?............................................................................7

How This Guide is Organized ..............................................................................7

2 OpenLAB Instrument Control Manager Overview .......................... 9

Instrumentation .............................................................................................9

Content Management.................................................................................10

3 Administrator Tasks.......................................................................... 10

4 Setting OpenLAB ICM Privileges .................................................... 10

OpenLAB ICM Built-in Roles .............................................................................11

Instrument Administrator role ..................................................................12

Project Administrator role .........................................................................13

Instrument User role...................................................................................13

Instrument Operator role ...........................................................................13

Instrument Supervisor role ........................................................................14

OpenLAB Administrator Privileges...................................................................16

Location Privileges ..............................................................................................16

Project Privileges .................................................................................................17

Instrument Privileges..........................................................................................18

Instrument Window Privileges..........................................................................19

Change the Page Appearance...........................................................................25

OpenLAB ICM Administrator's Guide iii

Page 4: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

View Instrument Task Status............................................................................25

5 Setting up Agilent Instrument Controllers..................................... 26

About Agilent Instrument Controllers..............................................................26

Install an Agilent Instrument Controller..........................................................26

Configure the AIC User.......................................................................................26

Configure an Agilent Instrument Controller ...................................................27

How to set up an Agilent Instrument Controller ...........................................29

General Agilent Instrument Controller Settings ............................................30

Add components to an Agilent Instrument Controller .................................31

Configure an SS420x...........................................................................................32

Display a list of instruments for an Agilent Instrument Controller ............33

View Agilent Instrument Controller audit trail ...............................................33

Advanced Agilent Instrument Controller tasks..............................................34

Perform a diagnostic test for the AIC ..............................................................35

6 Adding and Configuring Instruments.............................................. 36

About the Instruments Tab................................................................................37

Add a location ......................................................................................................37

Add an instrument...............................................................................................38

Configure Instruments ........................................................................................38

Configuring an Analog Detector ...............................................................40

Configuring External Events ......................................................................41

Enable Optional Analysis Software..........................................................42

About E-mail Notifications.................................................................................42

Set up e-mail notifications.................................................................................42

OpenLAB ICM Administrator's Guide iv

Page 5: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Close an Instrument Connection ......................................................................43

Select a project ....................................................................................................43

7 Opening Instruments......................................................................... 43

About Instrument Status....................................................................................43

Instrument Properties .........................................................................................44

The Instrument Navigation Pane......................................................................45

8 Defining a Maintenance Task.......................................................... 47

Maintenance Log.................................................................................................48

9 Working with Projects ..................................................................... 49

Projects Tab..........................................................................................................49

Enable audit trail for all projects.......................................................................49

Add a project ........................................................................................................50

Set Instrument Defaults .....................................................................................50

10 Index ................................................................................................... 52

OpenLAB ICM Administrator's Guide v

Page 6: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display
Page 7: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

1 Using This Guide

Introduction This guide contains system administration and configuration information for the Agilent OpenLAB Instrument Control Manager (ICM) software.

Who Should Read This Guide? This guide should be read by system and instrument administrators for the Agilent OpenLAB ICM software.

How This Guide is Organized The following table presents a brief description of each chapter in this guide.

In this chapter You�ll find

1 � Using This Guide Introduction and manual organization.

2 � Agilent OpenLAB Instrument Control Manager Overview

Overview of the Instrument Control Manager

3 � Administrator Tasks Describes the tasks that system administers perform.

4 � Setting OpenLAB ICM Privileges Describes OpenLAB ICM Privileges and Roles

5 � Setting up Agilent Instrument Controllers

Describes how to set up an Agilent Instrument Controller once it has been installed.

6 � Adding and Configuring Instruments Describes adding and configuring instruments.

7 � Opening Instruments Describes how to open an instrument, view its properties and its status.

8 � Defining a maintenance task Describes how to use OpenLAB BPM to define instrument maintenance tasks.

OpenLAB ICM Administrator's Guide 7

Page 8: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

8 � Working with Projects Describes how to add projects and assign the instrument default project.

OpenLAB ICM Administrator's Guide 8

Page 9: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

2 OpenLAB Instrument Control Manager Overview The Agilent OpenLAB Instrument Control Manager (ICM) is a highly scalable system based on integrating laboratory instruments and legacy systems into a framework that can manage the electronic information for users. Based on the .NET technology from Microsoft and the technologies Agilent Technologies has developed for instrument control and content management, OpenLAB ICM is designed to provide the laboratory a completely new way to make information secure and sharable, while providing users with new levels of automation and efficiency.

The OpenLAB Instrument Control Manager is installed after installation of the OpenLAB Enterprise Content Manager (ECM) has been installed, and adds the ability to control and acquire data from laboratory instruments and analyze and report the results. All results are saved in the Enterprise Content Manager and can be archived, searched, and controlled along with other Enterprise content.

Instrumentation Laboratory instruments interface into the OpenLAB ICM in a number of ways. Intelligent and controllable instruments, which are called �OpenLAB Instruments� are those which can be controlled through the OpenLAB instrument management software. These instruments connect to the standard Ethernet network by means of a special Network Appliance known as the Agilent Instrument Controller. OpenLAB instruments on the Instrument Controllers are network accessible and can be addressed by OpenLAB clients on the network.

Agilent maintains an active development program of writing instrument control drivers for laboratory instruments, most notably LCs and GCs. At present, there are more than 260 different HPLC and GC instruments and modules from over 25 different manufacturers that are supported by OpenLAB with direct instrument control. This means that users can deploy instrumentation from different vendors in the OpenLAB framework and use the same software to control the instrument. This results in a much easier system to use and a simpler system to validate for different instrumentation. OpenLAB instruments are managed by the OpenLAB Instrument Server and their data is processed by the OpenLAB Analysis Server.

OpenLAB ICM Administrator's Guide 9

Page 10: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Other instruments and even other data systems can also interface to OpenLAB.

Content Management All electronic results or content from OpenLAB instruments, other instrumentation and data systems can be automatically posted into the OpenLAB Content Manager. These electronic results or content are managed in a way that they become fully protected and searchable.

Client PCs or OpenLAB clients are the means by which end users can create software methods to control instruments, create data processing methods, review results, perform database searches, etc. These clients perform content management operations as a web client.

3 Administrator Tasks In order to use the Agilent OpenLAB Instrument Control Manager to acquire and analyze data from instruments, make sure the following procedures have been completed:

1. Install the required software, including instrument control options, according to the OpenLAB ICM Installation Guide.

2. Make sure all Instrument Controllers have been correctly installed and configured and all instruments are properly connected, following the instruction in the Agilent OpenLAB ICM Instrument Controller Installation Guide.

3. Create projects and data locations for the instruments you intend to use.

4. Assign appropriate Roles and Privileges for all OpenLAB ICM users.

5. Add the instrument(s) to the instruments tab.

6. Configure each instrument.

4 Setting OpenLAB ICM Privileges Privileges are the specific rights that control whether a user can access portions of the Agilent OpenLAB program or can perform certain tasks. Privileges are granted as part of the definition of roles. Roles are then assigned to users or groups of users.

OpenLAB ICM Administrator's Guide 10

Page 11: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Note: When configuring restricted access for OpenLAB instruments and projects it is necessary to assign view rights to the appropriate top node for all users that require access to the instrument and/or project tree views.

Note: Within the ICM user interface, a user that has project rights to save methods and/or sequences (Project: Sequence:Add or Project: Method:Add) will be able to save them in any ECM content location that they can view within the specified project. These add rights will supersede any restrictions specified by ECM privileges.

Permissions to interact with Agilent OpenLAB instruments must be assigned in several places for a user to have access to the system.

• Location / Instrument permissions: The user must be assigned permissions to view / edit the organizational structure of the configured Instruments and the Instrument portals.

• Project privileges: When a user launches the instrument control window for a specific instrument, they do so in the context of a project. It is the permissions that the user has within that project that govern the features that the user will be able to access inside the instrument window.

• Content privileges: A user must have view permissions for folders and files within the Content paths where they will open and save data generated with the instruments.

Note: Privileges are displayed with a prefix that indicates where they can be assigned. For example, a permission prefixed "Project:" can be assigned at the system level or on the Project tab to be functional. Those prefixed System: can only be assigned at the system level.

OpenLAB ICM Built-in Roles This topic provides a list of privileges in the following built-in roles:

• Instrument Administrator

• Project Administrator

• Instrument User

OpenLAB ICM Administrator's Guide 11

Page 12: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

• Instrument Operator

• Instrument Supervisor

These roles can be used as-is, or you can change a role.

Note: When configuring restricted access for OpenLAB instruments and projects it is necessary to assign view rights to the appropriate top node for all users that require access to the instrument and/or project tree views.

Instrument Administrator role This role gives the user the ability to manage instruments on the Instruments tab.

Note: This role must be assigned system-wide or on the Instruments tab.

The following table describes the privileges included in this role.

Included privileges

Location � View, Add, Edit, Delete Location Move � Run Location� Access � View, Edit Location� Printer � Edit Instrument � View, Edit, Add, Delete Instrument Access � View, Edit Instrument Maintenance � View, Add, Edit, Delete Instrument Printer - Edit Instrument Printer Configuration� Edit AIC Configuration � View, Add, Edit, Delete System: Users/Groups Configuration - View

OpenLAB ICM Administrator's Guide 12

Page 13: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Project Administrator role This role gives the user the ability to define and configure projects on the Projects Tab.

Note: This role must be assigned system wide or on the project access tab.

The following table describes the privileges included in this role.

Included privileges

Project � View, Add, Edit, Delete Project Access� View, Edit System: Users/Groups Configuration - View

Instrument User role This role gives the user the ability to browse instruments on the Instruments Tab.

Note: This role must be assigned system-wide or on the instrument Access tab.

The following table describes the privileges included in this role.

Included privileges

Location � View Instrument � View Instrument Maintenance - View AIC Configuration - View

Instrument Operator role This role gives the user permissions within the instrument window to run an instrument, collect data, and calibrate a method.

OpenLAB ICM Administrator's Guide 13

Page 14: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Note: This role must be assigned system-wide or on a project access tab. This role also requires that the user have the following permissions in Content. These permissions must be assigned in the project paths for each project in which the user has permissions to work.

Folder � View

File � View

Included privileges

Project � View Method Calibrate � Edit Data � Add Preview � Run Sequence Run � Run Single Run - Run Manual Control (Idle only) � Edit

Instrument Supervisor role This role gives the user permissions within the instrument window to all functions within the Instrument window.

Note: This role must be assigned system-wide or on a project access tab. This role also requires that the user have the following permissions in Content. These permissions must be assigned in the project paths for each project in which the user has permissions to work.

Folder � View

File - View

Included privileges

Project � View Method � Add Method Properties � Edit

OpenLAB ICM Administrator's Guide 14

Page 15: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Method Instrument Setup � Edit Method Integration Events � Edit Method Peaks / Groups �Edit Method Advanced � Edit Method Report � Edit Method System Suitability � Edit Method Review Calibration � Edit Method Calibrate � Edit Data � Add Data Properties � Edit Data Manual Integration Fixes � Edit Data eSig � Edit, Delete Sequence � Add Sequence Process � Run Sequence Properties � Edit Advanced Report � Add Standard Report Template - Add Preview � Run Single Run � Run Sequence Run � Run Manual Control (Idle Only) � Edit Manual Control � Edit Pretreatment � Add Pretreatment Properties � Edit Monitor all data � Run Abort any run � Run AIC Configuration - View, Edit, Add, Delete

OpenLAB ICM Administrator's Guide 15

Page 16: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

OpenLAB Administrator Privileges The following privileges are necessary for administration of the Agilent OpenLAB Instrument Control Manager.

To Grant these privileges

Administer printers Instrument Printer Configuration - View, Edit

Configure Agilent Instrument Controller network appliances

AIC Configuration - View, Run

Location Privileges This table lists the privileges necessary to interact with Locations on the Instrument Tab. When these privileges are assigned at the Location level, they apply to that Location only. When these privileges are assigned at the system level, they grant privileges to all locations on the Instrument tab.

To Grant these privileges

View Locations Location - View

Add Location Location � View Location � Add

Delete Location Location � View Location � Delete

Move Location Location Move � Run Location � View These privileges must be present on both the parent source location and the destination.

Edit the Location Properties Description

Location - View Location - Edit

OpenLAB ICM Administrator's Guide 16

Page 17: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

View Location Properties Location � View

Edit the information on the Location/ Instrument Properties � Access tab

Location � View Location Access � View, Edit Users / Groups Configuration � View Roles Configuration - View

Edit the information on the Location � Printers tab

Location � View Location Printer � View, Edit

Project Privileges The following table lists the privileges necessary to interact with the Projects tab. When these permissions are assigned at the system level, the user has the assigned privileges on all projects. When these privileges are assigned on the Project � the user has the assigned privilege on that one Project only.

To Grant these privileges

View Projects Project� View

Configure templates for a project Project � View Project - Edit

Add a Project Project � View Project � Add

Delete a Project Project � View Project - Delete

Project Properties Project � View

Project Properties - Access Project � View Project Access � View, Edit Users / Groups Configuration � View

OpenLAB ICM Administrator's Guide 17

Page 18: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Roles Configuration - View

Instrument Privileges The following table lists the privileges necessary to interact with the Instruments as they appear on the Instrument tab. These privileges assigned at the Location / Instrument level apply only to the specific instrument or Location children. When assigned at the system level, the privileges apply to all instruments.

To Grant these privileges

View Instruments Location � View Instrument - View

Add Instrument Location � View Instrument � View Instrument � Add

Delete Instrument Location � View Instrument � View Instrument � Delete

Move Instrument Location � View Location Move - Run Instrument - View, Edit

Edit the Instrument Properties Description

Location � View Instrument - Edit, View

View Instrument Properties Location � View Instrument � View

Edit the information on the Instrument Properties � Access tab

Location � View Instrument � View Instrument Access � View, Edit Users / Groups Configuration � View

OpenLAB ICM Administrator's Guide 18

Page 19: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Roles Configuration - View

Edit the information on the Instrument Properties � Maintenance tab

Location � View Instrument � View Instrument Maintenance � View, Edit

Edit the information on the Instrument Properties � Printers tab

Location � View Instrument � View Instrument Printer � View, Edit

Configure an Instrument � AIC � Hardware � Options

Location � View Instrument � View Instrument -Edit AIC Configuration - View, Edit

Instrument Window Privileges The following functions are performed inside the instrument window. Access to the associated menu item is assigned via privilege.

Method functions

• Data functions

• Sequence functions

• Control functions

• Pretreatment functions

• Report functions

The following privileges must be assigned at either the System level, or on a Project � except those in red. Those in red must be assigned at either the system level, or in Content.

In addition to the privileges listed below, the user must have the ability to browse to at least one Instrument on the Instrument tab of the application.

OpenLAB ICM Administrator's Guide 19

Page 20: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Note: The Save permissions for the various file types used within the Agilent OpenLAB instrument window do NOT additionally require the File � Add permission in Content.

Function Description Privileges required

Method

Open method Enables the user to open a method.

Folder � View File - View

Save method Enables a user to save a method.

Method � Add Folder � View File � View

Properties Enables the user to configure the properties (inside the method � not the properties inside Content) for a method.

Method Properties � Edit

Instrument setup Enables the user to configure the Instrument Setup for a method.

Method Instrument Setup � Edit

Integration events Enables the user to configure the integration events for a method.

Method Integration Events � Edit

Peaks/Groups Enables the user to configure the Peaks/Groups tables for a method.

Method Peaks / Groups � Edit

Advanced

Enables the user to configure the Advanced Options for a method.

Method Advanced � Edit

OpenLAB ICM Administrator's Guide 20

Page 21: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Custom Report

Enables the user to configure the Custom Reports for a method.

Method Standard Report � Edit

System suitability

Enables the user to configure the System Suitability for a method.

Method System Suitability � Edit

Review Calibration

Enables the user to have access to the Review Calibration Window.

Method Review Calibration � Edit

Calibrate

Enables the user to run a calibration sample to update the method calibration. Note: In order to create or modify the calibration parameters in a method, the user must have the Save Method privilege assigned.

Method Calibrate � Edit

Data

Open Data

Enables the user to open a data file.

Folder � View File - View

Save Data Enables the user to save a data file.

Data � Add Folder � View File � View

Properties (description)

Enables the user to modify the properties (inside the method � not the properties inside Content) of a data file.

Data Properties � Edit

OpenLAB ICM Administrator's Guide 21

Page 22: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Manual Integration Fixes

Enables the user to configure and execute Manual Integration Fixes for a data file.

OpenLAB Data Manual Integration Fixes � Edit

Electronic signature

Enables the user to electronically sign a data file.

Data eSignature - Edit

Revoke Signatures

Enables the user to revoke the signature on an electronically signed data file.

Data eSignature - Delete

Sequences

Open sequence

Enables the user to open a sequence file.

Folder � View File - view

Save sequence Enables the user to save a sequence.

Sequence � Add Folder � View File � View

Process .

Enables the user to process a sequence file.

Sequence Process � Run

Properties

Enables the user to modify the properties (inside the method � not the properties inside Content) of a sequence file.

Sequence Properties � Edit

Summary

Enables the user to modify the summary for a sequence file.

Sequence Summary � Edit

OpenLAB ICM Administrator's Guide 22

Page 23: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Custom report

Enables the user to create/edit a custom report.

Sequence Standard Report � Edit

Control

Preview Run

Enables the user to access Preview a Run.

Preview � Run

Single run

Enables the user to initiate a Single Run.

Single Run � Run

Sequence run

Enables the user to initiate a Sequence Run.

Sequence Run � Run

Instrument Printer Configuration

Enables the user to set up a printer.

Instrument Printer Configuration � View, Edit

Manual Control (Idle Only)

Provides direct control access only when instrument is idle.

Manual Control (Idle Only) � Edit

Manual Control

Provides access to direct control when instrument is running or idle.

Manual Control � Edit

Monitor Run

Allows the user to monitor the instrument during data collection submitted by any user

Monitor all data � Run

Abort any runs

Allows the user to abort any run / sequence submitted by any user

Abort any runs - Run

Pretreatment

OpenLAB ICM Administrator's Guide 23

Page 24: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Open pretreatment

Enables the user to open an autosampler pretreatment file.

Folder � View File - View

Save pretreatment

Enables the user to open an autosampler pretreatment file.

Pretreatment � Add Folder � View File � View

Properties

Enables the user to modify the properties (inside the method � not the properties inside Content) of an autosampler pretreatment file

Pretreatment Properties � Edit

Reports

Open advanced report

Enables the user to open an advanced report.

Folder � View File - View

Save advanced report template

Enables the user to save an advanced report.

Advanced Report Template� Add Folder � View File � View

Open standard report

Enables the user to open a standard report.

Folder � View File � View

Save standard report template

Enables the user to save a standard report.

Standard Report Template� Add Folder � View File � View

OpenLAB ICM Administrator's Guide 24

Page 25: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Change the Page Appearance You can change the "look and feel" of the Agilent OpenLAB projects and instruments functional areas by displaying a file or picture in the internal page area of the tab. To change the file to be displayed in this area,

1. Select the Projects or Instruments tab.

2. Right-click on the top-level of the Instruments or Projects tree, and then select Properties.

3. Select the General tab, and then enter a URL or HTML file to be displayed in the page area.

Note: You can use a non-HTML file in this area. However, how the file is displayed will depend on the user's browser settings. (For example, if the file can run a script or macro, the user will be prompted to save or open that file.)

View Instrument Task Status To view the current status of instrument tasks,

1. Click the Administration tab, followed by Global Administration and then select Task Messageboard. This opens the Instrument Task Status dialog box where you can view the status of instrument tasks.

2. On the Tasks tab, the Status and Total number of the tasks will be shown. Select the boxes at the bottom of the dialog box for the types of status information you wish to display.

3. Click + next to a status to expand the selection to view the Task Type, Total number of this type, Instrument Path, and Category.

4. Click the Refresh button to update the displayed list of tasks.

5. Click a task to highlight it, and then click the Resubmit button to resubmit the task.

6. Click a task to highlight it, and then click the Delete button to delete the task.

OpenLAB ICM Administrator's Guide 25

Page 26: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

5 Setting up Agilent Instrument Controllers

About Agilent Instrument Controllers The Agilent Instrument Controller (AIC) is a network appliance that controls instruments and acquires data digitally. Each Agilent Instrument Controller can control and acquire digital data from instruments.

Before using an AIC with Agilent OpenLAB ICM, the AIC must be properly installed, according to the instructions contained in the Agilent OpenLAB Instrument Controller Installation Guide..

Once the AIC has been installed, you should perform the following tasks.

• Configure the AIC User

• Configure the AIC

• Perform the AIC Setup

If the AIC will be using an SS420X, you need to configure it before use.

Install an Agilent Instrument Controller To install an Agilent Instrument Controller (AIC), see the Agilent OpenLAB Instrument Controller Installation Guide provided with the AIC. This manual is also located in the \Documents folder of the Agilent OpenLAB ICM software distribution CD. Make sure to follow the instructions for the version of Agilent Instrument Controller you are installing.

Configure the AIC User Before setting up or configuring any Agilent Instrument Controllers, you must create and configure the AIC User, as follows.

1. Create an �AIC User� account. (See Add a New User in the online help for how to do this.) This should be a unique user with full administrator rights (call this user �aicuser� for example).

2. From the Administration tab, click Global Administration, and then in the Navigation Pane do a right mouse click on Agilent Instrument Controller. In the General tab of the Properties dialog box, enter the AIC user account name and password, along with the account and domain for the user.

OpenLAB ICM Administrator's Guide 26

Page 27: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

This will be used by the AICs to communicate with the Agilent OpenLAB server. Click OK to close the dialog box.

Configure an Agilent Instrument Controller To configure a new Agilent Instrument Controller,

1. From the configuration computer, open Internet Explorer and go to the address http://192.168.1.1/iconsetup/login.aspx. If you have a proxy server configured in Internet Explorer, you will need to disable it.

2. Log in as Admin with no password. (Admin is case-sensitive.)

3. On the General tab, enter the following information:

Name: Enter a name for addressing the Agilent Instrument Controller on the network.

Location: Enter the physical location where the Agilent Instrument Controller will operate.

Comment: Type any additional comment you want to make.

OpenLAB server URL: Enter the Server URL; for example http://aspen. Be sure to use a fully-qualified host name or address.

4. Click Submit.

5. On the Hardware tab, click Configure to the right of Intel® PRO/100 VE Network, and make the following selections:

6. Select either Obtain an IP address automatically (DHCP) or Use the following IP address. If you choose Use the following IP address, you must designate the IP address, and Subnet mask to be used. You may enter a Default gateway or you may leave this blank.

Note: If you leave the Default gateway blank, the IP address will be used as the gateway value.

7. Select either Obtain DNS server address automatically or Use the following DNS server addresses. If you select Use the

OpenLAB ICM Administrator's Guide 27

Page 28: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

following DNS server addresses, you must also enter the Preferred DNS server and Alternate DNS server.

8. If you want to use a Connection specific DNS suffix, enter the suffix to be used and the software will append this suffix to server names when attempting to locate them on the network.

Note: If Static IP and DNS are used, they must be within the same subnet range as the web server.

9. Click Submit.

10. From the Advanced tab on the computer, click Initialize.

11. Click Yes to confirm you want to initialize the Agilent Instrument Controller. You may need to scroll down to see this button. A dialog box appears asking you if you want to close the window. Click Yes.

12. Immediately disconnect the crossover cable from the Agilent Instrument Controller and connect the laboratory network. The AIC gives a short two-tone beep when initialization is complete. If initialization fails, the AIC gives one or more single longer beeps.

To verify the initialization was completed, log into OpenLAB as a user with administrator privileges. From the Administration tab, click Global Administration followed by Agilent Instrument Controller.

Verify that the AIC appears. If it does not appear, wait 5 minutes, click on another node (such as Account Administration), and then click Agilent Instrument Controller again. If the AIC still does not appear, there are several possibilities, given below. Once you have resolved the problem, go back to the beginning of this section and repeat the steps to set up the AIC.

1. The address for the OpenLAB server was entered incorrectly. On some networks, it may be necessary to enter a fully-qualified name (for example http://aspen.agilent.com).

2. The laboratory network cable was not connected soon enough after clicking Initialize (see step 7-9, above).

OpenLAB ICM Administrator's Guide 28

Page 29: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

How to set up an Agilent Instrument Controller The Agilent Instrument Controller (AIC) Network Appliances are used to control instruments and acquire data digitally. Each Agilent Instrument Controller can control and acquire digital data from up to 4 GC or LC instruments, or up to 16 analog channels of data (SS420x required), up to 2 photodiode array detectors (PDA) or combinations of the above. Once an Agilent Instrument Controller is installed and configured, you must define several types of parameters in order for it to communicate properly.

Note: Before setting up an Agilent Instrument Controller, it must be installed according to the instructions found in the "Agilent Instrument Controller Installation Guide" provided with the Instrument Controller. This document is also located in the \Documents folder of the Agilent OpenLAB ICM software distribution CD.

To view or change the set up for an Agilent Instrument Controller,

1. From the OpenLAB Instrument Control Manager, select the Administration tab and then click Global Administration, followed by Agilent Instrument Controller.

2. Double-click the name of the Agilent Instrument Controller you wish to set up from the available AICs shown.

3. From the Agilent Instrument Controller Setup window, select each of the following tabs and set the parameters for this Agilent Instrument Controller:

Tab Description

General Name, location, and general information

Components Select instrument components for this Agilent Instrument Controller

Instruments Display a list of instruments using this Agilent Instrument Controller

Hardware Configure Network adapters and A/D Boards

OpenLAB ICM Administrator's Guide 29

Page 30: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Audit trail View and print audit trail for this Agilent Instrument Controller

Advanced Restart, view log, perform advanced tasks for this Agilent Instrument Controller

Diagnostics Perform various diagnostic tests for the AIC.

Note: In order for the AIC to appear during configuration of an instrument, it is necessary to assign the Instrument Administrator and/or Instrument User role to the AIC in Global Administration. This access can be set from the properties for the AIC or given globally.

General Agilent Instrument Controller Settings To view or change the General Agilent Instrument Controller settings,

1. From the Agilent OpenLAB program, select the Administration tab and then click Global Administration, followed by Agilent Instrument Controller.

2. Double-click on the Agilent Instrument Controller of interest.

3. Click the General tab.

Use this tab to enter general information about the Agilent Instrument Controller.

Name

Enter a name for this Agilent Instrument Controller (AIC) that will help distinguish it from the other AICs on the system. This name will be displayed in the list of Agilent Instrument Controller Network Appliances shown in Global Administration.

Location

Enter a description of the location for this Agilent Instrument Controller. This name is for information purposes, and will be displayed in the list of Agilent Instrument Controller Network Appliances shown in Global Administration.

OpenLAB ICM Administrator's Guide 30

Page 31: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Comment

Enter a comment, if desired. This comment is for information purposes, and will be displayed in the list of Agilent Instrument Controller Network Appliances shown in Global Administration.

OpenLAB server URL

Enter the URL of the Agilent OpenLAB server where this Agilent Instrument Controller is attached.

When you are finished, click Submit to save the information, or Close to exit without saving.

Add components to an Agilent Instrument Controller After you have installed an Agilent Instrument Controller and Instruments, you must designate what instruments are attached.

To add components to an Agilent Instrument Controller,

1. From Agilent OpenLAB ICM, select the Administration tab and then click Global Administration, followed by Agilent Instrument Controller Network appliance. Wait until you see a �Ready� status before proceeding.

2. Double-click the name of the Agilent Instrument Controller where the SS420x is connected and then select the Components tab.

3. Select each hardware component for this Agilent Instrument Controller by clicking the box adjacent to the component name. You may select as many components as you wish. If you are using analog acquisition with an SS420x, select Generic System.

4. Press the Submit button to finish. If this is the first installation, after selecting the components and clicking Submit, click the Install Now button. You will be prompted to confirm the installation. If this is not the first installation, go to the Advanced tab and click Restart. The system will display the �Installing� message. The AIC will �beep� when the installation is complete. Wait until the "Ready� message is displayed to continue.

Note: You must configure the SS420x before you can use it.

OpenLAB ICM Administrator's Guide 31

Page 32: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Configure an SS420x If you will be using an SS420x attached to the Agilent Instrument Controller (required for analog acquisition), it will need to be configured using the Agilent OpenLAB software, as described below. If you are not using an SS420x, you may skip this section.

Note: Before configuring an SS420x, it must be properly installed according to the directions provided in the Agilent Instrument Controller Installation Guide" provided with the Agilent Instrument Controller. This manual is also located in the \Documents folder of the Agilent OpenLAB ICM software distribution CD.

1. From Agilent OpenLAB ICM, select the Administration tab and then click Global Administration followed by Agilent Instrument Controller.

2. Double-click the name of the Agilent Instrument Controller where the SS420x is connected and then select the Hardware tab.

3. Locate SS420x under Boards and then click Configure.

4. From the SS420x configuration dialog, select the Serial port to which the SS420x is connected and then check the Installed box to enable the configuration of the interface. Then proceed to select the appropriate settings for the interface.

Baud Rate

The communication baud rate is displayed. To change the baud rate, click the Set Baud Rate button.

Base Frequency

Select the base frequency. The default setting for the SS420x is 10 Hz, which gives optimal signal to noise, and can be used in countries using either 50Hz or 60Hz. The base frequencies available will depend on the baud rate chosen. If the baud rate is less than 38400bps, the base frequencies 100 and 120 will not be available. If you choose a higher base frequency, you must select a base frequency that can be evenly divided into your line frequency (i.e. 30 for 60Hz countries and 25 for 50Hz countries). If selected incorrectly, you may see line frequency noise on your chromatogram. For best performance, select a

OpenLAB ICM Administrator's Guide 32

Page 33: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

base frequency close to the maximum sampling frequency you will be using to acquire data.

Sampling frequencies available in the Acquisition Setup portion of the method will reflect the Base Frequency selected.

Range

For each channel used, select the button next to the signal range for the detector connected to that channel.

Information

This area is for information only. It contains manufacturing information about the interface box that may be required in service situations. If the box is not recognized, the �Connection Status� field will display �Not Connected�.

When the dialog is completed, click Submit. To read the current settings for the SS420x, click the Read SS420x Settings button. To abort the operation without changing any settings, click Cancel.

Display a list of instruments for an Agilent Instrument Controller To display a list of the instruments connected to an Agilent Instrument Controller Network Appliance,

1. From the Agilent OpenLAB program, select the Administration tab and then click Global Administration, followed by Agilent Instrument Controller.

2. Double-click on the Agilent Instrument Controller of interest.

3. Click the Instruments tab. A list of the instruments currently attached to this Agilent Instrument Controller, along with their locations, will be displayed.

View Agilent Instrument Controller audit trail To view an AIC audit trail,

1. Go to the Administration tab.

2. Select Global Administration from the Agilent OpenLAB Explorer.

OpenLAB ICM Administrator's Guide 33

Page 34: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

3. Select Agilent Instrument Controller. A list of the available AICs will be displayed.

4. Double-click on the AIC of interest.

5. From the AIC Setup window, click the AuditTrail tab.

6. A table of audit trail information for this AIC will appear. Included are Date/Time, User, Description, and Reason for events in the audit trail.

7. To print the audit trail, click the Print button.

8. To close the Setup window, click the Close button, or select another tab.

Advanced Agilent Instrument Controller tasks This tab enables an administrator to perform advanced tasks for the Agilent Instrument Controller by clicking the displayed buttons.

Button Description

View log View Agilent Instrument Controller's startup log.

Restart Restart Agilent Instrument Controller. WARNING: If instruments are running, data will be lost.

Shutdown Shutdown Agilent Instrument Controller. WARNING: If instruments are running, data will be lost.

Reset Restore Agilent Instrument Controller to factory setting. WARNING: This will erase all configuration and installed components.

Change login Change Agilent Instrument Controller login information.

IQ Report View Agilent Instrument Controller's IQ report.

OpenLAB ICM Administrator's Guide 34

Page 35: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Perform a diagnostic test for the AIC Occasionally, your Agilent support specialist may ask you to send results from certain tests when troubleshooting connectivity problems. To perform diagnostic tests for the AIC,

1. Go to the Administration tab.

2. From the OpenLAB Explorer, select Global Administration.

3. Select Agilent Instrument Controller. A list of the available AICs is displayed.

4. Double-click on the AIC of interest.

5. From the AIC Setup window, click the Diagnostics tab.

6. From this tab, you can perform the following diagnostic tests.

Diagnostic User input Use

IP Config /all switch may be entered.

Renews and releases leases obtained from a Dynamic Host Configuration Protocol (DHCP) server, and display IP settings. NOTE: The only allowed switch from diagnostics page is �/all�.

Trace Route Click for instructions. This route-tracing utility is used to determine the network path to a destination using the TCP / IP protocol.

Ping Click for instructions. Provides basic network testing functions for LAN or the Internet. It calculates how long it takes to transfer a

OpenLAB ICM Administrator's Guide 35

Page 36: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

packet of information from origin to destination and back again. NOTE: �t� switch is not permitted from diagnostics.

Path Ping Click for instructions. Combines the Ping and Trace Route commands. Path Ping can tell you whether you're experiencing data loss at one or more router hops on the way to a target host.

NS Lookup Enter the IP address. A command-line administrative tool for testing and troubleshooting DNS servers.

ARP No input required. Displays and modifies the IP-to-Physical address translation tables used by address resolution protocol (ARP).

6 Adding and Configuring Instruments In order to control and acquire data from an instrument, it must first be physically installed, making sure all connections are made properly. Then, the instrument must be �added� to the OpenLAB ICM system and configured.

OpenLAB ICM Administrator's Guide 36

Page 37: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

About the Instruments Tab The Instruments tab is where setup and control of instrumentation occurs. This includes instrument configuration, setup, method development, data acquisition, analysis, and reporting. The following table lists the functions that can be performed in the Instruments section, when you click on an instrument icon.

Topic Description

Add a location Describes how to add a location to which instruments will be added.

Add an instrument Describes how to add an instrument to a location.

Configure an instrument Describes how to configure an instrument.

Show Instrument Describes the instrument window, where control, data acquisition, analysis, and reporting occur.

Email Notifications Describes how email notifications are set up for events.

Select Project Describes how to select a project and what projects are.

Close an Instrument Connection

Describes how to close an instrument hardware connection to an AIC.

Add a location Locations are organizational placeholders that enable you to create a data system view that matches your laboratory or company setup. A location can be a laboratory name, building, or even a person's name. You can continue adding locations or groups to the instruments area until the data system configuration matches that of your company or group.

To add a location

1. Click on the Instruments tab.

2. In the navigation pane, do a right-hand mouse click on the Instruments icon, and then select New Location...

OpenLAB ICM Administrator's Guide 37

Page 38: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

3. Type the name of the new location in the Name box.

4. Enter a text description of the location, if desired.

5. When finished, click the OK button. The new location will appear in the list of Instrument locations.

Add an instrument After you have physically connected an instrument, you must add it to the data system and then configure it.

To add an instrument to your instrument list

1. Do a right-hand mouse click on the location where you want to add the instrument, and then select either New OpenLAB Instrument... or New Third Party Instrument... An OpenLAB instrument is one that is supported either as an analog-only data acquisition instrument or as a digital instrument controlled using one of the Agilent OpenLAB instrument control options. A Third Party Instrument is one that is not directly controlled by the Agilent OpenLAB software, but rather through an external URL or executable code.

2. In the Name box, type the name of the instrument. If this is an Agilent OpenLAB instrument, type an optional description. If this is a Third Party instrument, click the URL button and then enter the URL address to be used to control the instrument or click the EXE button and then click the folder button to select the executable file to be used for this instrument.

3. When finished, click OK. A new instrument icon will appear in the location.

Configure Instruments Configuration is the process by which you tell the Agilent OpenLAB software about the installed detectors, injectors, or other components for an instrument. Each instrument must be configured before the Agilent OpenLAB program can be used to acquire data from it.

Note: Before you can configure an instrument, it must be added to the enterprise location. See the Add an instrument section.

To configure an instrument

OpenLAB ICM Administrator's Guide 38

Page 39: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

1. Select the instrument's location. Icons for all instruments in that location will appear.

2. Click on the instrument's icon. An instrument status screen will appear in the right-hand pane.

3. Select Configure Instrument in the Select Task section. The instrument configuration dialog box will appear.

4. In the Instrument name box, type the name of the instrument (for identification only), and then select the Instrument type for this instrument.

5. Click the Agilent Instrument Controller button and then select the Agilent Instrument Controller box to which this instrument is attached from the list displayed, followed by the OK button.

6. Click the Configure button.

7. A configuration window will appear with Available modules in the left pane and Configured modules in the right pane. The modules that appear will be specific for the type of instrument you are configuring. Select a module to be configured and move it to the Configured modules pane by clicking the green arrow.

8. Once all the modules you wish to configure have been moved to the Configured modules pane, you must configure each one by double-clicking its icon and then completing the appropriate configuration dialog.

Note: Details on how to configure an instrument module is available by clicking the Help button when you open a module for configuration. These details are also available in the manual for the instrument you are configuring (available on the OpenLAB ICM Options installation CD).

9. If an Auto Configuration button appears, the data system can read the configuration of the modules installed by clicking this button.

10. The Options button is used to enable optional analysis programs for this instrument.

11. When you have completed the configuration of all modules for the instrument, click the OK button.

OpenLAB ICM Administrator's Guide 39

Page 40: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Configuring an Analog Detector

For EACH analog detector in the Configured Modules window, double click the icon and complete the configuration dialog for every channel of the detector. You must also complete the Acquisition Source configuration by clicking the adjacent button before leaving the Detector Configuration dialog.

Detector Name

Enter a descriptive name for the detector, such as FID or TCD.

Detector Model

Select the type of detector from the drop-down list.

Acquisition Source

Select the type of A/D board or device you are using from the drop-down list. Then click the adjacent button to configure it.

Y-Axis Units

Type in the units to be displayed on the Y-Axis of your chromatogram. For example, type microvolts or AU, depending on the detector units of measurement. Your analog signal is acquired and and stored in microvolts. If you want to display the signal in different units, you must use the correct multiplier. Consult the table below for commonly used Y-axis labels and corresponding multipliers.

Y-Axis Multiplier

The chromatogram is usually displayed in volts. If you wish to display another unit, enter the conversion factor to be applied. The following table shows commonly used Y-axis labels and corresponding multipliers.

Y-Axis Label Y-Axis Multiplier

Volts 0.000001

Millivolts 0.001

Microvolts 1

Other Enter a number such that when

OpenLAB ICM Administrator's Guide 40

Page 41: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

multiplied by microvolts, gives you the desired units. For example, if you want the label to be Units, and each Unit corresponds to 5 microvolts of signal, enter 1/5=0.2.

When you have completed configuration for all detectors of this instrument, your System Configuration dialog will display each detector�s name and type. Click OK to exit the configuration.

Configuring External Events

Events include instrument triggers, valves, and other user-defined external events. To configure events for an instrument,

1. In the system Configuration window, locate the Events icon in the Available modules pane and double-click the icon to move it to the Configured modules pane.

2. In the Configured modules pane, double-click the Events icon.

3. Complete the spreadsheet to define all events for this instrument, and then click OK to finish.

Name

If you are configuring a Trigger or Ready line, click the button in the Name field and select either Trigger or Ready from the list. If you are configuring a valve or other external event, simply click on the Name field and then type in the name of your event.

Source

In the Source field, click the button and select the source of the event (the hardware from which the event comes).

Setup

Click the button in the Setup field. A dialog will appear where you set up the appropriate information for the operation of this event.

OpenLAB ICM Administrator's Guide 41

Page 42: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Note: The external events tab in Instrument Setup will not be available unless you have configured your instrument with one or more external events. It is possible to assign the same event to more than one instrument. Be careful to assign events such that conflicts between instruments will not happen.

Enable Optional Analysis Software

To enable optional analysis software, such as System Suitability or Baseline Check,

1. Open the configuration dialog for a selected instrument.

2. In the Configured Modules dialog box, click Options.

3. A list of available analysis options will be presented.

4. Click the box(es) to select the optional software or features you want to enable for this instrument. When finished, click OK.

About E-mail Notifications From the instruments tab, you can set up e-mail notifications for designated events that might happen while using an instrument. When such an event happens, (hardware failure, for example) an e-mail will be generated and sent to selected recipients. The e-mail can include a customized message.

Set up e-mail notifications Use the following procedure to set up email notifications for an instrument.

To set up e-mail notification

1. Click on the Instruments tab to view the instruments attached to the system.

2. In the Navigation Pane, click on the instrument for which you want to set up e-mail notification.

3. Click on E-mail notifications.

4. Complete the dialog to set up the desired e-mail notifications.

5. In the Event field, select the event from the drop-down list. If this event occurs during a run, an e-mail message will be sent to the recipient(s) designated.

OpenLAB ICM Administrator's Guide 42

Page 43: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

6. In the E-mail recipients, specify what recipients will be entered in the "To" field of the message. This must be an SMTP compliant e-mail address of a valid user. Multiple addresses may be entered, if separated by a semi-colon.

7. In the Custom message field, you may enter an optional custom text message for this event.

Close an Instrument Connection When you click on an instrument icon in the Instruments tab, one of the available Tasks is Close Connection. This function causes the instrument server on the AIC for that instrument to end. This function should be used only if you want to shut down the instrument hardware, or if the instrument is not planned for use in the near future. Once you have closed a connection, the connection will be re-established when you Monitor or submit a run to that instrument.

Select a project Projects are used in the OpenLAB Instrument Control Manager to organize related groups of data, methods, sequences, and results. Select the project to be used for an instrument from the drop-down list of available projects.

The project selected determines the default file locations for the instrument and the permissions the user will have within the instrument window. You are required to select a project before launching the instrument window.

7 Opening Instruments The Instruments Tab of OpenLAB is where all instruments and instrument locations can be viewed and accessed. To open an instrument, select the instrument in the Navigation Pane. When you select Show Instrument from the Select Task area, an Instrument window will open. This window is where you perform all functions related to method setup, instrument control, calibration, data acquisition, analysis, and reporting for that instrument.

About Instrument Status When you select an instrument in the Instruments tab, a Status section appears at the bottom containing the current status of the instrument.

OpenLAB ICM Administrator's Guide 43

Page 44: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

If the instrument is not idle, information will include:

Instrument Status: This status is the current activity of the instrument modules, for example, downloading method, running pretreatment.

Sample ID: The sample ID for the current run.

Data file name: This is the *.dat file name for the current run.

Method File: This is the name of the method that the instrument is currently running

Sequence Name: This is the name of the sequence file that the instrument is running

Result File: This is the name of the SSIZIP file that will be produced as a result of the sequence running.

Run Queue: All items currently in the Run Queue are displayed in a table with the following headers. The first item in the list is the sequence currently running.

Sequence Name: This is the name of the sequence file that has been submitted to run.

Result File: This is the name of the result file that will be generated by the sequence.

Status: This is the status of the line of the run queue. Possible values are Processing, Priority, and Pending.

User: This is the name of the user who submitted the sequence to the queue.

Start Time: This is the estimated start time for the sequence. The possible values are Processing, Immediate, or in the case of a sequence scheduled to start in the future, the scheduled date / time or the number of minutes in the future (for example, +30 mins.) If that time has occurred, the status will be pending.

Instrument Properties The Instrument Properties window provides access to tabs that contain information about this instrument. To view the instrument properties, in the Navigation pane, do a right mouse click on the instrument of interest, and then select Properties...

OpenLAB ICM Administrator's Guide 44

Page 45: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Tab Description

General Details on when instrument was created.

Access Lists users/groups and their instrument roles.

Audit Trail Displays instrument audit trail.

Maintenance Displays maintenance schedule. Gives access to adding maintenance tasks.

Printers Displays available printers and lets you select one for this instrument.

The Instrument Navigation Pane When you open an instrument, a Navigation pane is displayed at the left. This view enables you to quickly switch between the major functions of the instrument window. For each section, icons will appear for the various functions available for that instrument. These icons also appear on the toolbar, and coincide with the commands available on the pull-down menu at the top of the window. A functional area can also be accessed by clicking on one of the function bars located at the bottom of the navigation pane.

OpenLAB ICM Administrator's Guide 45

Page 46: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

To turn the Navigation pane on

1. Select View followed by the Navigation pane command.

OpenLAB ICM Administrator's Guide 46

Page 47: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

To turn the Navigation pane off

1. Click the x button at the top of the Navigation pane.

You can also "park" the Navigation pane at the left of the Instrument window, which provides additional work space. Once the Navigation pane is parked, you can view it again by simply moving your mouse over the Navigation tab that appears at the left. The pane will disappear when you move your mouse back into the work space.

To "park" the Navigation pane

1. Click the push-pin button at the top of the Navigation pane.

8 Defining a Maintenance Task Instrument Maintenance allows users to schedule tasks that ensure the successful operation of instrumentation over time. These tasks may be instrument driven � for example a module may have an early warning system that alerts users when a detector lamp has exceeded 1000 hours use; or they may be user driven � for example the user may want to confirm the pump flow rate each 3 months. These tasks can be programmed, managed and tracked through the Instrument Maintenance function.

The task template must be created prior to defining the task, using the BPM (business process management) module. Each maintenance task starts a workflow designed in the BPM module. To be used as a Maintenance Task, the process must include the "Maintenance Complete" activity.

To define a Maintenance Task,

1. Open the Instrument Properties Maintenance tab by doing a right mouse click on the instrument, select Properties, and then select the Maintenance tab.

2. Right-click in the Maintenance window, and select Add to open the Maintenance Task dialog box.

3. Enter a description for the task.

4. Enter the BPM template file (including path), or search for and select the BPM template file to be used from the content folders available.

5. Enter an initial date and time for the activity. If the entered date is in the past, the task will immediately become due when

OpenLAB ICM Administrator's Guide 47

Page 48: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

the dialog is completed. This is the time that the BPM process associated with the task initiates. The time reflects the time zone of the user defining the task � not the time zone where the instrument is located. When the task start time occurs, whether at the initial start time or any recurrence time, the instrument status changes to "Maintenance Due".

6. Select the Task must be completed in X days and Y hours box if the task must be performed within a particular time frame. Enter the days an hours to define the time period required.

• If this option is NOT selected, the instrument will remain in a "Maintenance Due" status until the task is completed, regardless of the amount of time that has passed.

• When this option is selected, the instrument status will be "Maintenance Due" during the specified time period, and the instrument will still accept new tasks.

• When this option is selected and the time specified is exceeded, the instrument status will change to "Maintenance Overdue." If the Lock down device if task overdue box is not selected, the instrument will continue to accept new tasks.

7. If the Task must be completed in X days and Y hours box is selected, the Lock down device if task overdue check box will be available. If selected, the instrument will be locked when the task becomes overdue, and no other tasks can be submitted to the instrument until the overdue task is completed.

8. Select the Recurrence box to designate how often the task is to recur: daily, weekly, monthly, or yearly.

9. When you have finished defining the task, click OK to save the task and exit.

Note: When a Maintenance Task is executed that uses "Initiating User", the initiating user will be the BPM Web Server user configured in administration.

Maintenance Log The Maintenance Log displays a history of the maintenance tasks associated with this instrument, including the process used to complete the

OpenLAB ICM Administrator's Guide 48

Page 49: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

task, the name of the user who completed the task, and the date and time the task was completed.

If you click on a task to select it, the View Documents button lets you view the files associated with this process (if any) and open them.

9 Working with Projects

Projects Tab The projects tab is where you define default settings for instruments. This includes user access as well as paths for files and templates.

Topic Description

Add a project Describes how to add a project.

Setting instrument defaults

Describes how to set the instrument defaults for a project.

Setting default audit trail options

Describes how to set the default instrument audit trail options.

Enable audit trail for all projects The audit trail options for files used within the instrument window can be set globally though the Projects tab, per project, or per individual file.

Within the Projects tab you can set audit trail options for all instrument-related files. When set at this level, any file saved from any instrument window launched in the context of any project � including the default project � will have the audit trail automatically enabled.

To enable the audit trail for all projects, do a right mouse click on the top Projects location, and select the General tab. Then select Enable audit trail for all projects. Note that once enabled, the audit trail for all projects cannot be turned off.

To set audit trail options for an individual project (audit trail for all projects NOT enabled), see the Set Instrument Defaults topic.

OpenLAB ICM Administrator's Guide 49

Page 50: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

To set audit trail options for an individual file within a project, (audit trail for all projects NOT enabled) see the File Properties topic.

Add a project To add a project

1. Click on the Projects tab.

2. Right-click on the Projects location, and then select New Project...

3. From the New Project dialog box, enter a unique Name for the project, and a Description, if desired. The description will appear when the project Properties are displayed. Click OK to exit the dialog box.

4. Continue to set up the Instrument Defaults.

Set Instrument Defaults When you click on the Instrument Defaults location, you will see the current instrument defaults for the selected project. These will be the defaults for any instrument using this project.

Paths

Type the full path or click on the folder button to browse and select the desired folder.

Default project path

Type or select the path where the project is located. When a user logs into an instrument and project, the paths for files will be set to the LCDF specified.

Default templates folder

Select or type the path to a Content folder that contains the templates to be used for the project. The files in this folder will be displayed when a user selects New (method or sequence, for example) from the instrument window, based on their extensions.

Users can select other folders

When this box is checked, the user can choose other folders than the default folders specified for the project.

OpenLAB ICM Administrator's Guide 50

Page 51: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

Default Audit Trail Options

This sets the default audit trail options for files saved in this project. If the audit trail has been turned ON for all projects, you will not be able to set these options at the individual project level.

Enable audit trail

When this box is selected, audit trail will be enabled for all instrument-related files for this project. Once this is set, all instrument-related files saved from this project will have these options applied. (Applies to method, sequence, pretreatment, spectral libraries, or data files.)

Note: Once the audit trail has been enabled, it cannot be disabled for this project.

Prompt for reason at every change

When this is selected, the user will be prompted to enter a reason for every change made.

Prompt for reason when saving

When this is selected, the user will be prompted to enter a reason when saving a file.

Do not prompt for reason

When this is selected, the user will not be prompted to enter a reason for changes.

OpenLAB ICM Administrator's Guide 51

Page 52: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

10 Index A

About Agilent OpenLAB ICM...9

About OpenLAB Privileges.........10

About the Instruments Tab..........................37

Add a location ....37

Add a project ......50

Add an instrument..........................38

Add components to an Agilent Instrument Controller........31

Administration...25

Administrator Privileges.........16

Advanced Instrument Controller tasks..........................34

Agilent Instrument Controller.27, 29, 30, 31, 33

AIC Hardware Tab..........................27

Audit trail ...........49

C

Configuration

Detectors ........... 40

External Events . 41

Configuration......38

Configuration......40

Configuration Options ............42

Configure an Agilent Instrument Controller ........27

Configure an Analog Detector..........................40

Configure an instrument.......38

Configure an SS420X.............32

Configure External Events ..............41

Configure the AIC User..................26

D

Defining a Maintenance Task..................47

Detector Configuration..40

Diagnostics..........35

E

Email....................42

Email notifications..........................42

Enable audit trail for all projects.49

Enable Baseline Check ...............42

Enable Optional Software ..........42

Enable PDA analysis ............42

Enable SEC..........42

Enable System Suitability ........42

Event Configuration..41

G

General Configuration Options ............42

General Properties..........................25

OpenLAB ICM Administrator's Guide 52

Page 53: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

H

How to view the Agilent Instrument Controller audit trail ..................33

I

Install an Agilent Instrument Controller........26

Instrument Defaults ...........50

Instrument files audit trail ........49

Instrument Privileges.........18

Instrument Properties........44

Instrument Status..........................43

Instrument Window Privileges.........19

Instruments .37, 38, 42, 43

L

Location ..............37

Location Privileges..........................16

M

Maintenance Log 48

Maintenance Tasks................... 47, 48

N

New project.........50

O

OpenLAB Administrator Privileges.........16

OpenLAB Overview............................9

P

Perform a diagnostic test for the AIC.......35

Privileges10, 16, 17, 18, 19

Privileges, Instrument ......18

Privileges, Instrument Window............19

Privileges, Project..........................17

Project..................43

Project Privileges17

Projects......... 49, 50

Projects Tab ........49

R

Roles

Built-in Roles .... 11

Instrument Administrator Role ............... 12

Instrument Operator Role 13

Instrument Supervisor Role...................... 14

Instrument User Role ............... 13

Project Administrator Role ............... 13

Roles.....................11

S

Select project ......43

Set Instrument Defaults............50

Set up an Agilent Instrument Controller ........29

Set up email notifications ....42

Setting up Agilent Instrument Controllers ......26

SS420X.................32

Status ...................43

T

Task Messageboard..........................25

OpenLAB ICM Administrator's Guide 53

Page 54: Agilent OpenLAB Instrument Control Manager Agilent Instrument Controller Settings.....30 Add components to an Agilent Instrument Controller.....31 Configure an SS420x.....32 Display

V View Instrument Task Status......25

OpenLAB ICM Administrator's Guide 54