G2170-90037 OpenLABOption
G2170-90037 OpenLABOption
G2170-90037 OpenLABOption
OpenLAB Option
Concepts Guide
ChemStation OpenLAB Option Concepts Guide
Agilent Technologies
Notices
© Agilent Technologies, Inc. 2008-2009, Warranty receive no greater than Restricted Rights as
2010 defined in FAR 52.227-19(c)(1-2) (June
The material contained in this docu- 1987). U.S. Government users will receive
No part of this manual may be reproduced
ment is provided “as is,” and is sub- no greater than Limited Rights as defined in
in any form or by any means (including elec-
tronic storage and retrieval or translation
ject to being changed, without notice, FAR 52.227-14 (June 1987) or DFAR
into a foreign language) without prior agree- in future editions. Further, to the max- 252.227-7015 (b)(2) (November 1995), as
ment and written consent from Agilent imum extent permitted by applicable applicable in any technical data.
Technologies, Inc. as governed by United law, Agilent disclaims all warranties,
States and international copyright laws. either express or implied, with regard Safety Notices
to this manual and any information
Manual Part Number contained herein, including but not CAUTION
limited to the implied warranties of
G2170-90037 merchantability and fitness for a par- A CAUTION notice denotes a
ticular purpose. Agilent shall not be hazard. It calls attention to an
Edition liable for errors or for incidental or
consequential damages in connection
operating procedure, practice, or
09/2010
with the furnishing, use, or perfor- the like that, if not correctly per-
Printed in Germany
mance of this document or of any formed or adhered to, could
Agilent Technologies information contained herein. Should result in damage to the product
Hewlett-Packard-Strasse 8 Agilent and the user have a separate
76337 Waldbronn written agreement with warranty
or loss of important data. Do not
terms covering the material in this proceed beyond a CAUTION
This product may be used as a com-
document that conflict with these notice until the indicated condi-
terms, the warranty terms in the sep- tions are fully understood and
ponent of an in vitro diagnostic sys-
arate agreement shall control.
tem if the system is registered with met.
the appropriate authorities and com- Technology Licenses
plies with the relevant regulations.
Otherwise, it is intended only for gen- The hardware and/or software described in WA R N I N G
eral laboratory use. this document are furnished under a license
and may be used or copied only in accor- A WARNING notice denotes a
dance with the terms of such license. hazard. It calls attention to an
Software Revision operating procedure, practice,
Restricted Rights Legend
This guide is valid for revision B.04.03 or or the like that, if not correctly
higher of the Agilent ChemStation software. If software is for use in the performance of a
U.S. Government prime contract or subcon- performed or adhered to, could
Microsoft ® is a U.S. registered trademark tract, Software is delivered and licensed as
of Microsoft Corporation. result in personal injury or
“Commercial computer software” as
defined in DFAR 252.227-7014 (June 1995),
death. Do not proceed beyond a
or as a “commercial item” as defined in FAR WARNING notice until the indi-
2.101(a) or as “Restricted computer soft- cated conditions are fully under-
ware” as defined in FAR 52.227-19 (June
1987) or any equivalent agency regulation stood and met.
or contract clause. Use, duplication or dis-
closure of Software is subject to Agilent
Technologies’ standard commercial license
terms, and non-DOD Departments and
Agencies of the U.S. Government will
1 Introduction
This chapter introduces ECM, the implementation of OpenLAB Option in
ChemStation, and the requirements of 21 CFR Part 11.
2 Installation
This chapter describes the installation and configuration of ChemStation
OpenLAB Option.
6 Custom Fields
This chapter explains the purpose and usage of custom fields in ChemStation.
11 Troubleshooting
The chapter gives some elementary troubleshooting hints.
12 Appendix
Contents
1 Introduction 9
What is ECM? 10
Add-On Solution for ChemStation: OpenLAB Option 11
Data Storage in ECM 16
21 CFR Part 11 Compliance 17
2 Installation 19
Prerequisites 20
Compatibility 21
Support for Windows 7 with OpenLAB Option 22
Installation and Configuration Tasks on ECM Server 23
Installation Tasks on the ChemStation Computer 28
Uninstallation 37
11 Troubleshooting 147
General Problems 148
Alerts and Error Messages at ChemStation Startup 149
Error Messages in the Spooler Queue Manager 150
12 Appendix 153
ChemStation Privileges in ECM 154
ChemStation Roles in ECM 157
ECM related privileges concerning the ChemStation configuration 161
1
Introduction
What is ECM? 10
Add-On Solution for ChemStation: OpenLAB Option 11
Overview of data-related workflows 12
Overview of workflows for methods/sequence templates 14
Data Storage in ECM 16
21 CFR Part 11 Compliance 17
Agilent Technologies 9
1 Introduction
What is ECM?
What is ECM?
9ViV6 9ViV6
:8B
9ViV6 9ViV6
KZgh^dc& KZgh^dc& KZgh^dcc KZgh^dc&
KZgh^dc' KZgh^dcc &
Ldg`[adl&/ Ldg`[adl'/
AdXVa;^aZh¶HVkZcZlbZi]dY :8B¶HVkZX]Vc\ZYbZi]dY
8]ZbHiVi^dc
BZi]dY6 BZi]dY6
BZi]dY6 BZi]dY6
KZgh^dc& KZgh^dc&
KZgh^dcc &
ECM provides a four-level data storage model with the structure of Location,
Cabinet, Drawer, Folder. The Location, Cabinet, Drawer and Folder names
comprise the path name (called either LCDF path or Remote Data Path) of the
storage location. Data is stored at Folder level only.
The ECM program’s content structure is similar to rooms filled with file
cabinets. Each cabinet has multiple drawers, which then contain hanging
folders. Finally, paper files are stored in the folders. The LCDF structure can
be created using the ECM Web Client. In addition, it is possible to create
additional Locations, Cabinets, Drawers, and Folders using the ChemStation
Remote Data Path. In ChemStation, it is also possible to set predefined tokens
for the Drawers and Folders.
In the ECM tree view, locations are denoted by a house icon. Inside each
Location, Cabinets are denoted by the file cabinet icon. Inside each Cabinet,
Drawers are denoted by the drawer icon. Finally, inside each Drawer, Folders
are denoted by the folder icon. The entire content structure appears in the
Content book.
AdXVi^dc
8VW^cZi
9gVlZg
;daYZg
Uploaded objects can be stored in the lowest (i.e. Folder) level only. It is not
possible to upload data to other levels of the hierarchy.
Effective August 20, 1997, the U.S. Food and Drug Administration (FDA)
released and published a new rule to enable pharmaceutical companies to
approve their results with electronic signatures and to transfer paper-trail
documentation into electronic records. This rule is known as 21 Code of
Federal Regulations Part 11 (referred to as 21 CFR Part 11) and applies to all
industry segments regulated by the FDA.
21 CFR Part 11 includes the US Federal guidelines for storing and protecting
electronic records and applying electronic signatures. The intent of these
guidelines is to ensure that electronic records subject to these guidelines are
reliable, authentic, and maintained with high integrity.
ChemStation OpenLAB Option with ChemStation B.04.xx provides the
necessary controls for managing system access, audit trail functions,
versioning of ChemStation data, and electronic signature functions. Agilent
OpenLAB ECM ensures secure record keeping and data archival. Agilent
OpenLAB ECM is proven and has been deployed at many leading life sciences
companies to satisfy compliance mandates for 21 CFR Part 11.
2
Installation
Prerequisites 20
Compatibility 21
Support for Windows 7 with OpenLAB Option 22
Installation and Configuration Tasks on ECM Server 23
Updating the ECM Database 23
Updating roles in existing ECM Accounts 25
Configuring users, roles and privileges 26
Installation Tasks on the ChemStation Computer 28
Preparing the ECM Web Client 29
Installing a new ChemStation with ChemStation OpenLAB Option 29
Adding ChemStation OpenLAB Option to an existing ChemStation 33
Enabling users to start the ChemStation Administration Tool 34
Uninstallation 37
To uninstall Agilent ChemStation und Windows XP 37
To uninstall other ChemStation components 37
Agilent Technologies 19
2 Installation
Prerequisites
Prerequisites
Before you install Agilent ChemStation OpenLAB Option, make sure that the
following prerequisites are met:
• The ECM Server software must be installed and configured as described in
the Enterprise Content Manager Installation Guide. All server-related
prerequisites, as well as the installation and configuration details, are
described in the guide.
The ECM versions supported with ChemStation are:
• OpenLAB ECM Workgroup 3.3.1 - MS SQL Server 2005, with ECM 3.3.1
Hotfixes 1-5,
• OpenLAB ECM Enterprise with ECM 3.3.1 Hotfixes 31, 45, 47-54, 56-57,
59, and 70,
• OpenLAB ECM Workgroup 3.3.2 SP1 - MS SQL Server 2005,
• OpenLAB ECM Enterprise 3.3.2 SP1 - MS SQL Server 2005, or
• OpenLAB ECM Enterprise 3.3.2 SP1 - Oracle 10.2.0.1 or Oracle database
server 10.2.0.4 with Oracle client 10.2.0.1
• Ensure that the minimum PC and operating requirements are met for
ChemStation. Details can be found in the Installing your ChemStation
manual for your respective instrument.
• Setting up the connection from ChemStation to the ECM Server requires
the address of the ECM Server.
Compatibility
ChemStation Add-Ons
ChemStation OpenLAB Option is not supported in combination with the
following ChemStation Add-Ons and features:
• ChemStore / Security Pack
• Purify
• Easy Access
• ChemStation Unique Folder Creation OFF (item is not accessible)
Please note that the installation instructions in the following sections describe
installation of OpenLAB Option on client computers running on Winodws XP
or Windows Vista.
For ChemStation computers running on Windows 7 a different ECM API is
required and the ECM server requires an update to support the new API. For
details about Windows 7 support with ChemStation OpenLAB Option, please
refer to the ReadMe.txt file on the ChemStation B.04.03 DVD. The ReadMe.txt
is also available in the ChemStation program group after installation of the
ChemStation.
You must execute the database script for ChemStation privileges on the ECM
Server to implement ChemStation related users, roles and privileges within
OpenLAB ECM. In addition, after installing the program, you must take care of
several ECM settings.
Prerequisites
You need the login data of the following users:
• A Windows user who can connect to the ECM Database.
• An ECM Database user who is authorized to access the ECM schema and to
update the tables in this schema.
• Path and filename of the log file: An installation log file is created in the
given location.
• Password for database user: The password is not shown while typing.
• Schema/user name for ECM
• Directories where the data files, index files, and map files of the new
database schema should be stored.
5 Review the data.
• If something is wrong: press Ctrl+C to abort the installation.
6 If everything is OK: Press Enter.
The installation begins. When the installation is finished, the text Installation
finished is shown in the command window.
7 Press any key to close the command window.
8 Check the installation log file. It should only include messages about
changing the database, no warnings or errors.
6 If everything is OK: Enter the password for the database user you provided
before.
The installation begins. When the installation is finished, the text Installation
finished is shown in the command window.
7 Press any key to close the command window.
8 Check the installation log file. It should only include messages about
changing the database, no warnings or errors.
All system roles will be reset to default when performing Reset Role. If you made manual
NOTE changes to a system role, these changes will be lost!
All other roles that were created manually will be deleted!
The default ChemStation roles do not contain any ECM privileges! A ChemStation user who
NOTE wants to access ECM must additionally be assigned the required ECM roles (see
“Assigning roles” on page 27 and “ECM related privileges concerning the ChemStation
configuration” on page 161).
Once you created a new ECM user, group, or role, you can not delete it again. You can only
NOTE deactivate the unused item.
Name Description
• Starting with “:” Default ECM role. Can be restored by the Reset Roles function.
Name Description
In addition, you can create your own roles in ECM, or grant further privileges
to the default roles. For detailed information, refer to the ECM
Administrator’s Guide.
Assigning roles
Users do not need any specific role in order to log in to ECM. However, in
order for users to see a particular Location, Cabinet, Drawer, or Folder in the
user interface, they must have the :Reader role as a minimum requirement. As
a result, domain users with no global roles might not be able to view anything
in the content unless they were granted the appropriate privileges.
You should grant the users of the ChemStation OpenLAB Option the
:Contributor role. This can be done at the global level for the entire ECM
Account, or individually for specific folders (see “Roles and folders” on
page 96). The :Contributor role allows the ChemStation OpenLAB Option user to
view and add content to ECM. The :Contributor role should be enhanced with
the Content: Add Folder privilege. This allows ChemStation ECM users to add
folders to the LCDF hierarchy.
If the role does not include the Add Folder privilege, the users cannot add a new Remote
NOTE Data Path (LCDF) in ChemStation.
If a ChemStation user has no ChemStation privileges in ECM, this user is not able to work
NOTE with ChemStation OpenLAB Option!
If you use Windows Vista: Make sure the User Account Control feature is disabled before
NOTE you connect to ECM!
4 Enter User Name and Organization. Select the option to install the API for
“Anyone who uses this computer (all users)”. Click Next.
5 Select a destination folder where you want to install the ECM API (the
default folder is C:\Program Files\Agilent Technologies\ECM API\1.0.24.1). Click
Next.
6 Click Install.
7 After the installation has completed, click Finish.
To install ChemStation
1 Insert the ChemStation DVD into the DVD drive.
2 From the Start menu in the Task Bar, select Start > Run.
3 At the command line, type
[diskdrive]:\Setup For example: D:\Setup
The setup software checks if the following software components are
available:
• Microsoft .NET Framework 3.5 SP1
• PDF-XChange 4.0
4 If there are missing components, additional dialogs open to install these
components. Click Install to install the missing components. For the
Microsoft .NET Framework also read and agree to the License Agreement.
After the missing components have been installed, the Agilent ChemStation
Setup Wizard opens.
5 Click Next.
6 Select the check box to confirm the license agreement. Click Next.
7 Select a destination folder where you want to install the new ChemStation
(the default folder is C:\Chem32). Click Next.
8 Click Install.
ChemStation is now being installed. This can take several minutes.
9 Click Finish.
The Setup Wizard - Instruments dialog opens. Proceed now with adding the
instruments.
To add instruments
1 In the Setup Wizard - Instruments dialog, click the Add buttons to add the
required instruments.
2 Under General Addon products, select the ChemStation OpenLAB Option check
box.
3 Click Next.
The Setup Wizard - Licenses dialog opens.
4 Proceed now with providing the license keys.
The applicable license product and license numbers are printed on your Software
NOTE Certificate and Registration Packet.
Note that any Windows user with administrative privileges can remove the G2189BA
NOTE OpenLAB Option license and thus disable OpenLAB Option functionality from the
ChemStation. It is therefore recommended that in an regulated environment ChemStation
users work as Windows Users or Powerusers.
5 Select or clear the Mandatory Login check box, depending on whether the
ECM login should be mandatory or optional in ChemStation (the settings
will be used for all ChemStation instances that are installed on this
computer). For more details on the login functions see “User
Permissions” on page 40.
You do not need to configure the other options in this dialog during the installation. You can
NOTE configure these items anytime in ChemStation (see “ECM Preferences” on page 47 and
“Audit Trails and Logbooks” on page 88) or by using the ChemStation Administration Tool
directly (see “ChemStation Administration Tool” on page 97).
6 Click OK.
7 Click Finish.
The Configuration Editor opens.
8 Proceed now with configuring the instruments.
To configure instruments
You can configure the instruments in the Configuration Editor. For details see
the manual Installing your ChemStation.
After the successful installation, ChemStation contains the new ECM menu
and a number of other ECM interface elements (see “Overview of new
interface elements” on page 43.
7 Select or clear the check box Mandatory Login, depending on whether the
ECM login should be mandatory or optional in all ChemStation instances
on this computer.
8 Click OK.
9 Click Finish.
The Configuration Editor opens. As you have already configured the
instruments, and have now added the OpenLAB Option, you can exit the
Configuration Editor without any further actions.
10 Prepare the ECM Web Client and install the ECM API as described in
“Preparing the ECM Web Client” on page 29.
2 Right-click the group CSAdministrator and select Add to Group... from the
context menu.
The Properties dialog shows the users who are currently member of the
group.
Uninstallation
3
Basic Concepts of ChemStation
OpenLAB Option
User Permissions 40
Log In/Log Out 40
ChemStation Operator and ECM User 41
Session lock 41
OpenLAB Option User Interface in ChemStation 43
Overview of new interface elements 43
The ECM menu 44
ECM Preferences 47
Remote Data Path 48
Automatic Data Transfer Settings 50
Transfer Management Settings 52
Spooler Queue Manager 53
Remote Data Path as Sequence Parameters 57
Compressed ChemStation File Formats 59
This chapter describes how to log in to ECM in ChemStation, and explains the
ECM-related user interface items and toolbars, as well as the main preference
settings.
Agilent Technologies 39
3 Basic Concepts of ChemStation OpenLAB Option
User Permissions
User Permissions
Optional or mandatory
Depending on the configuration during the installation of ChemStation, the
ECM login can be optional or mandatory. If it is mandatory, you must log in to
ECM during the ChemStation startup. If it is optional, you can initially skip
the login and then log in to ECM later.
If you are already logged in to ECM server in the online instrument session
and start the offline session via the item Reprocessing Copy from the View
menu, the user will be automatically connected to ECM with the same login
information (silent login).
If you are not connected to ECM, all of the ECM functions are grayed out.
You can log in to ECM from the following ChemStation views:
• Method and Run Control
• Data Analysis
Once you have logged in to ECM, it is possible to upload data to ECM and
simultaneously work on the local ChemStation file system.
The login is dependent on the instrument session; only one user can be logged
in to ECM at any one time. If another user wants to log in, you must first log
out.
User credentials
The Login dialog requires you to enter a set of valid authorization details in
order to log in to ECM. The login information is ECM Server-specific and will
be provided by the ECM administrator.
You need to enter the following login details:
• Server URL: the URL of the ECM Server
• Account: you can store content to the locations assigned in the specific
account; one ECM Server may have several accounts.
• Username: the user name defined in the ECM Account, or your NT domain
user name (depending on the user configuration in ECM)
• Password: the password provided by your administrator, which can be
changed on request (for ECM ‘built-in’ users), or the password of your NT
domain account, if you are logging in using your NT domain user name.
• Log on to: the domain administrating the ECM users
Session lock
If you leave the ChemStation computer for a certain period of time, you can
lock ChemStation so that no other user can access the program. This is a
safety feature to ensure that there is no unauthorized access to ChemStation.
When you activate the session lock, you or another user must first provide a
valid ECM login before continuing to work with ChemStation.
There are the following options to activate the session lock:
• Privately (ECM > Lock Session > privately): Only the user who activated the
session lock, or a user with the CS: Break Session Lock privilege, can log in.
• Non privately (ECM > Lock Session > non privately): Any valid ECM user can
log in. This is useful, for example, if there is a shift change, and the leaving
personnel secures ChemStation until the personnel of the new shift starts
work.
• Toolbar Lock Button: The toolbar lock button can be configured to lock the
ChemStation session privately or non privately (see “Login options” on
page 98).
• Time based: Depending on the ECM Account configuration, ChemStation is
automatically locked after a given period of time without any user
interaction (see Inactivity Timeout under “Administration in ECM” on
page 93). If there is no activity in an ECM Web Client, the ECM Web Client is
also locked after the given period of time. ChemStation and ECM Web Client
are locked independently from each other.
The time based session lock can be configured to lock the ChemStation
session either privately or non privately (see “Login options” on page 98).
Sequence > Sequence Parameters, Sequence Parameters tab New fields on the See “Remote Data Path as
Sequence Sequence Parameters” on page 57
Parameters tab:
• Remote Data
Path
Sequence > Sequence Parameters, Sequence Output tab New fields on the See “Template selection in
Sequence Output Sequence Output” on page 128
tab:
• OpenLAB
Intelligence
Reporter
Template
View > Preferences New tabs in the See “ECM Preferences” on page 47
Preferences and “Audit Trails and
dialog: Logbooks” on page 88
• Transfer
Settings
• Audit Trail
ECM related details in the System Diagram in Method and Run Completely new The following details are available:
Control view (classic UI only). details view • LCDF
• Operator
• Automatic transfer after
acquisition
• Automatic transfer after
reprocessing
• Automatic transfer after any
data modification
• Automatic import after
reprocessing
• Calculate peak performance
There is no ECM menu in the Report Layout, Verification (OQ/PV), or Diagnosis view.
NOTE
User-related commands: See “User Permissions” on page 40 and “Session • Method and Run Control
lock” on page 41. • Data Analysis
Log In ...
Log out
Lock Session
Update-commands: Update all methods/sequence templates that are • Method and Run Control
Update Methods ... stored in the local file system with the current
Update Sequences Templates ... version from ECM (if existing in ECM). Local
changes are overwritten.
Cleanup Data The Cleanup Data command deletes all data or • Data Analysis
sequence containers from the local file system
that exist in ECM as well. Make sure you uploaded
the latest version to ECM before you confirm this
command. See “Cleanup Data on Shutdown” on
page 52.
Manage Queue With the Manage Queue command you can • Method and Run Control
continue any interrupted data upload to ECM. See • Data Analysis
“Manage Queue on Connect” on page 52.
See “ECM Preferences” on page 47 for more • Method and Run Control
Preferences details on the Preferences dialog. • Data Analysis
Method-related commands: See “Workflows for Methods and Sequence • Method and Run Control
Templates” on page 74 • Data Analysis
Load Method ...
Save Method
Data-related commands: See “Data-related workflows” on page 63 • Data Analysis
Commands related to the sequence See “Workflows for Methods and Sequence • Method and Run Control
template: Templates” on page 74
Commands related to OpenLAB See “Interface Components Concerning OpenLAB • Data Analysis
Intelligence Reporter: IR” on page 128
Start OpenLAB IR
ECM Preferences
The Preferences dialog contains two tabs that are relevant to ChemStation
OpenLAB Option: the Transfer Settings tab and the Audit Trail tab.
Several settings in the Transfer Settings tab and the Audit Trail tab may have been
NOTE specified for all ChemStation instances on the computer via the ChemStation
Administration Tool (see “ChemStation Administration Tool” on page 97). In this case, you
cannot change the settings in the Preferences dialog.
On the Transfer Settings tab, you must specify the following preferences in order
to automatically store ChemStation data to ECM:
• Remote Data Path
• Automatic Data Transfer Settings
• Transfer Management Settings
All of these items can be specified independently for each instrument. Offline
and online sessions are automatically synchronized.
On the Audit Trail tab, you can enable the Method Audit Trail and Results Audit
Trail. For details on audit trails see “Audit Trails and Logbooks” on page 88.
You can change these settings for all ChemStation instances on the client PC in one single
NOTE step by using the ChemStation Administration Tool (see “ChemStation Administration
Tool” on page 97).
Server/Account
In the text fields Server and Account, you can specify the ECM Server and ECM
Account that you want to use to store the ChemStation data.
At your first login from ChemStation to ECM, you must specify the server and
account information. You can either enter the information manually, or you
can click Get Server to fill the fields with the Server and Account where you are
currently logged in. ChemStation then keeps the Server and Account
information for future sessions.
If you log in to a different ECM Server later, you have to update the Server and
Account information. You can click Get Server again to fill the fields with the
current ECM Server name and the current ECM Account.
Path
To specify the Remote Data Path, you need to select a Location and Cabinet
available in the ECM Browser. Click Select Path to select the required path in
an ECM Explorer dialog.
For the Drawer and Folder, you can either keep the selected items, or you can
select predefined tokens for an automatic path creation. When you use the
predefined tokens in the Remote Data Path, the system automatically creates
the items if they do not already exist in ECM.
If you use tokens, make sure you have the required ECM privileges to create folders!
NOTE Alternatively, another user who has the required privileges can create the necessary folders
in advance.
Alternatively, the Remote Data Path can be specified as Sequence Parameter (see
“Remote Data Path as Sequence Parameters” on page 57). Uploaded objects
can be stored only at the Folder level.
If you are not logged in to ECM in ChemStation, the data cannot be automatically uploaded
NOTE to ECM as specified in the transfer settings. The data is then queued in the Spooler Queue
Manager (see “Spooler Queue Manager” on page 53).
If you perform data acquisition from the Diagnosis view or OQ/PV view, the transfer
NOTE settings are ignored. The analytical raw data is written to the ChemStation data file system
as predefined in the diagnosis or verification methods.
After Acquisition
If you select this check box the data is automatically uploaded to ECM after an
acquisition. The raw data files are written to the local ChemStation file system
while the sequence is still running. When the complete sequence is finished,
the raw data files are compressed to an SSIZip file which is then uploaded to
ECM.
For more information, please refer to “Workflow 1: Acquisition and automatic
upload” on page 63.
After Reprocessing
If you select this check box, the sequence data container is automatically
uploaded to ECM each time after you reprocessed the sequence.
For more information, please refer to “Workflow 3: Reprocessing data and
automatic upload” on page 68.
If you select the Cleanup Data on Shutdown check box, you should also select the
NOTE Automatic Data Transfer Settings After Acquisition, After Reprocessing, and After Any
Data Modification. Otherwise, if the users forget to upload the data to ECM before closing
ChemStation, data might be lost.
Consider selecting the Cleanup Data on Shutdown check box when the system shall be
NOTE compliant to 21 CFR Part 11. Using this function prevents unauthorized access to the local
data files.
Alternatively, you can open the Data Cleanup dialog at any time with the ECM >
Cleanup Data command in the Data Analysis view.
This dialog box lists all data sets related to ECM apart from the currently
loaded data. The following columns are available:
• Directory: Location of the local file
• ECM Information: ECM server, account information, and LCDF path of the file
in ECM
• Last Modified: Date/Time when the copy in ECM was last changed
• Locally Modified: Information whether the local copy has been modified
• Local Version: Version that was downloaded to the local directory
You can now manually select the data sets to be deleted from the local disk.
Alternatively, via a drop down list deselect all data sets, select all, select only
single runs, select only sequence containers, select items older than today, or
items older than a week.
After pressing OK, the local copies of the selected data sets are deleted.
Both automatic cleanup on shutdown and manual cleanup are only possible if
the following conditions are fulfilled:
• the ChemStation user is logged on to ECM
• no other instance of the ChemStation instrument is open
• the spooler queue is empty
If one of these conditions is not fulfilled, automatic cleanup will not be
performed and it is not possible to open the Data Cleanup dialog.
Delete selected item Delete the selected transfer job from the queue. The
concerned data will not be transferred to ECM.
When items are selected from the queue or saved to the local disk, an audit
trail entry will be added to Audit Trail of ECM.
When items are deleted from the queue or saved to the local disk, they have not yet been
NOTE uploaded to ECM.
The Queue Management Details dialog box is displayed when you click the
tool in the toolbar of the Queue Management dialog box. It shows the
command-specific details of the commands in the Queue Management dialog
box. The Queue Management Details tabs offer two views of the command
details:
• Summary tab
• Details tab
In either tab, the tools in the toolbar allow you to navigate through the
command details:
Summary tab
The Summary tab gives the following summary information about the selected
item:
Created The date and time when the item was added to the queue.
Changed The date and time when the item was last processed.
Last Error A description of the error that caused the item to be added to the queue.
Details tab
The Details tab gives detailed information about the selected item. You cannot
edit the information in this list. The toolbar provides the following tools:
Instead of specifying the Remote Data Path in the Preferences for all acquisition
sequences to be run (see “Remote Data Path” on page 48), the remote data
path can also be set directly in the sequence template. This allows to set up
different remote paths for each sequence without having to modify the
Preferences. The Remote Data Path for a sequence template is set up in the
Sequence Parameters tab.
Use Preferences: When this checkbox is enabled, the Remote Data Path as
specified in the Preferences will be used. Any LCDF path specified in the
Sequence Parameters will be ignored for this sequence. When this checkbox is
disabled, the Remote Data Path will be used as specified when the sequence
template is used for data acquisition.
Path: To specify the Remote Data Path, you need to select a Location and Cabinet
available in the ECM Browser. Click Select Path to select the required path in
an ECM Explorer dialog. For the Drawer and Folder, you can either keep the
selected items, or you can select predefined tokens for an automatic path
creation. When you use the predefined tokens in the Remote Data Path, the
system automatically creates the items if they do not already exist in ECM.
If you use tokens, make sure you have the required ECM privileges to create folders!
NOTE Alternatively, another user who has the required privileges can create the necessary folders
in advance.
Methods *.M.SSIZIP
4
Working With ChemStation OpenLAB
Option
Transferring Data to or from ECM 62
Data-related workflows 63
Workflow 1: Acquisition and automatic upload 63
Workflow 2: Offline review during acquisition 65
Workflow 3: Reprocessing data and automatic upload 68
Workflow 4: Import after reprocessing 72
Workflows for Methods and Sequence Templates 74
Workflow 1: Local files – Save new method 74
Workflow 2: ECM – Save changed method 76
Updating the Local Master Method or Sequence Template 80
Agilent Technologies 61
4 Working With ChemStation OpenLAB Option
Transferring Data to or from ECM
ChemStation OpenLAB Option provides the ability to open and save different
ChemStation items into their ChemStation contexts:
• Methods
• Sequence templates
• Single run data
• Sequence data
All of this data is stored in ECM as SSIZIP containers (see “Compressed
ChemStation File Formats” on page 59).
When the data is uploaded to ECM, local copies of the files still remain in the
ChemStation file system. If an item is loaded from ECM back into
ChemStation, it is automatically loaded into its original location.
Different options are available regarding the automatic upload of single
run/sequence data to ECM. Loading back stored data from ECM to
ChemStation, however, always requires a manual load action. Methods and
sequence templates require always a manual upload to ECM as well as a
manual load or update into ChemStation.
For downloading data from ECM, several load commands are available in the
ECM menu. Depending on the current view, you can load different files from
ECM. In the Data Analysis view, you can load single run data or sequence data.
These data are automatically set to the status checked out in ECM. In the
Method and Run Control view, you can load methods and sequence templates.
These items are only retrieved and not checked out.
The following workflows are examples that represent typical tasks done with
ChemStation OpenLAB Option.
Data-related workflows
9ViV6 9ViV6
:8B
9ViV6 9ViV6
KZgh^dc& KZgh^dc& KZgh^dcc KZgh^dc&
KZgh^dc' KZgh^dcc &
The workflow Acquisition and automatic upload, see Figure 9 on page 63,
illustrates how raw data is uploaded to ECM directly after the acquisition is
finished. The raw data is initially stored locally. After completing the
acquisition, the data is automatically uploaded to ECM.
To save data to ECM automatically after completion of a single run or
sequence:
1 Log in to ECM in an online ChemStation.
2 Load a sequence template.
Your ECM user name is automatically inserted as operator name into the
sequence template.
3 In the Data Analysis view, click View > Preferences.
4 On the Transfer Settings tab, configure the following settings:
• Remote Data Path: Select the ECM location that you want to use for the
sequence data upload.
• Select the After Acquisition check box.
5 Configure the sequence parameters and the sequence table.
6 Start the acquisition.
While the acquisition is running, the raw data, method definition, and a
copy of the sequence template are locally stored on the ChemStation
computer.
After the sequence is finished, all data is automatically uploaded as an
.SC.SSIZIP file to ECM to the previously defined LCDF path. The local copy
of the data remains on the ChemStation computer. The file name of the
sequence container is determined by the settings in the sequence template
(for more details on the sequence template settings, refer to the manual
Understanding Your ChemStation). After uploading the sequence
container the sequence icon in the ChemStation Navigation Pane changes
The color of the Sequence Data icon in the Navigation Pane allows to track the
NOTE modification status of the data:
: The sequence container is stored in ECM and has not been modified locally
: The sequence container is stored in ECM and has been modified locally
The upload process may take some time when large amounts of data are uploaded. During
NOTE this time ChemStation is busy and the user cannot perform tasks in ChemStation. Please
wait until the upload is completed.
9ViV6 9ViV6
:8B
9ViV6 9ViV6
KZgh^dc& KZgh^dc& KZgh^dcc KZgh^dc&
KZgh^dc' KZgh^dcc &
The workflow Offline revision during acquisition, see Figure 10 on page 65,
illustrates how raw data is reviewed while the acquisition is still running.
Directly after the acquisition is finished, the original raw data is automatically
uploaded to ECM. After the review, the changed data is again uploaded to
ECM. When the data is uploaded the second time, a new version is created.
To save data to ECM automatically after changing the data:
1 Log in to ECM in an online ChemStation.
2 Load a sequence template.
Your ECM user name is automatically inserted as operator name into the
sequence template.
3 In the Data Analysis view, click View > Preferences.
4 On the Transfer Settings tab, configure the following settings:
• Remote Data Path: Select the ECM location that you want to use for the
sequence data upload.
• Select the After Acquisition check box.
• Select the After Any Data Modification check box.
5 Start the acquisition.
While the acquisition is running, the raw data, method definition, and a
copy of the sequence template are stored locally on the ChemStation
computer.
6 Open an offline ChemStation and change some data analysis parameters for
one of the already finished samples. Save your changes locally.
7 After the acquisition has been finished, two things will happen:
• The original raw data is automatically uploaded as an .SC.SSIZIP file,
Version 1, to ECM to the previously defined LCDF location. The LCDF of
the new sequence is shown in the toolbar in the online ChemStation.
The file name of the sequence container is determined by the settings in
the sequence template (for more details on the sequence template
settings refer to the manual Understanding Your ChemStation).
For both versions (the one after acquisition and the one from the parallel offline review) the
NOTE ECM operator is the user who has run the acquisition, even if another user has performed
the review in the Offline ChemStation.
9ViV6 9ViV6
:8B
9ViV6 9ViV6
KZgh^dc& KZgh^dc& KZgh^dcc KZgh^dc&
KZgh^dc' KZgh^dcc &
&
'
If the item is checked out, it is marked with a blue or red icon (see
marker 1):
(blue icon): the item has been checked out by you (current user)
(red icon): the item has been checked out by another ECM user
You can load any checked out item. However, if an item has been checked
out by another ECM user, the other user must check in the item before you
can save it back to ECM.
To check out or check in an item, you can use the respective icons available
in the ECM Desktop Open dialog (see marker 2). You can only check out the
latest version of an item.
In order to see more details regarding the type and version of the available
items, select the Detail view (see Figure 12 on page 69, marker 3). To open
an older version of an item, select the Open Revisions command from the
Open menu (see Figure 13 on page 70). This opens the File Versions dialog,
where all available versions of the item are listed (see Figure 14 on
page 70).
9ViV6 9ViV6
:8B
9ViV6 9ViV6
KZgh^dc& KZgh^dc& KZgh^dcc KZgh^dc&
KZgh^dc' KZgh^dcc &
The workflow Import after reprocessing, see Figure 15 on page 72, illustrates
how locally saved data is reprocessed and then automatically imported in
ECM.
To save data to ECM automatically after reprocessing:
1 Log in to ECM in an offline ChemStation.
2 From the local file system, open a sequence that has never been saved to
ECM before.
3 In the Data Analysis view, click View > Preferences.
4 On the Transfer Settings tab, configure the following settings:
• Remote Data Path: Select the ECM location that you want to use for the
sequence data upload.
• Select the Import after Reprocessing check box.
5 Reprocess the sequence data.
The data will not be uploaded if you only modify it. You need to reprocess the sequence
NOTE data.
.
The local copy of the reprocessed data remains on the local file system of the
ChemStation computer.
Ldg`[adl&/ Ldg`[adl'/
AdXVa;^aZh¶HVkZcZlbZi]dY :8B¶HVkZX]Vc\ZYbZi]dY
8]ZbHiVi^dc
BZi]dY6 BZi]dY6
BZi]dY6 BZi]dY6
:8B
KZgh^dc& KZgh^dc&
KZgh^dcc &
The workflow Local files - Save new method, see Figure 16 on page 74,
illustrates how newly created or locally stored methods or sequence template
can be manually uploaded to ECM.
To upload a new method or sequence template:
1 Log in to ECM in an offline ChemStation.
2 In ChemStation, load the method/sequence template or create a new one.
3 In the Method and Run Control view, click ECM > Save Method or
ECM > Save Sequence Template, respectively.
The ECM Save dialog opens.
4 Navigate to the Remote Data Path of your choice to upload the
method/sequence template.
You can only upload items into a Folder, not into a Location, Cabinet, or
Drawer.
5 If necessary, save the item using a different name. the original name is used
by default, but you can modify the name.
6 Click Save.
The Add File dialog opens.
7 Enter a reason for the upload and click OK. The reason is then shown in the
ECM Audit Trail (see “ECM Audit Trail” on page 90).
The progress of the upload is displayed in a window until the item is
uploaded to ECM.
After finishing the upload, the SSIZIP file is available in ECM as version 1.
The file is saved to the Remote Data Path defined in the Preferences (see
“Remote Data Path” on page 48).
Ldg`[adl&/ Ldg`[adl'/
AdXVa;^aZh¶HVkZcZlbZi]dY :8B¶HVkZX]Vc\ZYbZi]dY
8]ZbHiVi^dc
BZi]dY6 BZi]dY6
BZi]dY6 BZi]dY6
:8B
KZgh^dc& KZgh^dc&
KZgh^dcc &
The workflow ECM - Save changed method, see Figure 17 on page 76,
illustrates how methods or sequence templates that are already stored in ECM
are edited and saved under the same name as a new version.
1 Log in to ECM in ChemStation.
2 Load a method or sequence template.
&
'
If the item is checked out, it is marked with a blue or red icon (see Figure 18
on page 77, marker 1):
(blue icon): the item has been checked out by you (current user)
(red icon): the item has been checked out by another ECM user
You can load any checked out item. However, if an item has been checked
out by another ECM user, the other user must check in the item before you
can save it back to ECM.
To check out or check in an item, you can use the according icons available
in the ECM Desktop Open dialog (see Figure 18 on page 77, marker 2).With
these icons, you can only check out the latest version of an item.
In order to see more details regarding the type and version of the available
items, select the Detail view (see Figure 18 on page 77, marker 3). To open
an older version of an item, select the Open Revisions command from the
Open menu (see Figure 19 on page 78, marker 1). This opens the File Versions
dialog, where all available versions of the item are listed (see Figure 20 on
page 79).
&
'
Unlike the data files, the methods and sequence templates are not automatically checked
NOTE out of ECM! In order to modify those items in ChemStation, you should check them out from
ECM manually. Otherwise, there is no guarantee that you are working on the latest version.
If you have not checked out the item before loading it from ECM, and another ECM user has
NOTE checked out the item in the meantime, you cannot proceed with the upload back to ECM. A
warning message is displayed, and it is not possible to save the item back to ECM until the
other user has released the checked out item.
6 When the Add File dialog opens, enter a reason for the upload and click OK.
The reason is then shown in the ECM Audit Trail (see “ECM Audit Trail” on
page 90).
The progress of the upload is displayed in a window until the item is
uploaded to ECM.
The .M.SSIZIP/.S file is uploaded with its original name to its original LCDF
path (the path is shown as a tooltip of the method/sequence template in
ChemStation). The version number is automatically increased by one.
• Name: Path and Name of the local copy of the method/sequence template.
• ECM Information: ECM server, account information, and LCDF path of the
file in ECM.
• Locally Modified: A check box indicating whether the local copy was
modified.
• Local Version: Version number of the local copy of the method/sequence
template.
• ECM Version: Version number of the file in ECM.
3 You can now manually select the methods that are to be updated.
Alternatively you can via the drop down list deselect all methods, select all
methods, select to those methods with a higher version number in ECM, or
select all methods that have been modified locally.
After pressing OK, the selected local methods/sequence templates are
updated with the version in ECM.
5
Administration Regarding
21 CFR Part 11 Compliance
Introduction to 21 CFR Part 11 84
21 CFR Part 11 Requirements 85
General Aspects of Data Security in Computerized Networks – Open
Versus Closed Systems 85
Overview of Configuration Steps Required for Part 11 87
Audit Trails and Logbooks 88
Method Audit Trail 88
Results Audit Trail 89
Report History 90
ECM Audit Trail 90
ECM System Log 92
Administration in ECM 93
Account configuration 93
Users/Groups/Roles 94
Administration of ChemStation Settings 97
ChemStation Administration Tool 97
Electronic Signature 100
Preparation 100
Using electronic signatures 101
This chapter explains the purpose of 21 CFR Part 11 and its implementation in
ChemStation with ChemStation OpenLAB Option.
Agilent Technologies 83
5 Administration Regarding 21 CFR Part 11 Compliance
Introduction to 21 CFR Part 11
Effective August 20, 1997, the U.S. Food and Drug Administration (FDA)
released and published a new rule to enable pharmaceutical companies to
approve their results with electronic signatures and to transfer paper-trail
documentation into electronic records. This rule is known as 21 Code of
Federal Regulations Part 11 (referred to as 21 CFR Part 11) and applies to all
industry segments regulated by the FDA.
The impact of this rule on current work practices and data handling in the
pharmaceutical industry has been much higher than expected. “The industry
wanted to have a rule on electronic signatures, but what they got was a rule
on electronic records.” (Martin Browning, former FDA inspector, during a
validation seminar in Washington D.C.)
21 CFR Part 11 places high emphasis on the implementation of all measures to
protect and secure electronic records. Notwithstanding the uncertainties and
the changes that 21 CFR Part 11 requires in the behavior of both the
pharmaceutical industry and the vendors of chemical analysis equipment, it is
well worth implementing in today’s laboratories because it can help the
industry with one of the most important issues in pharmaceutical
research-bringing new drugs on the market faster.
The major benefits of this shift towards electronic data management are in the
potential productivity increase for the industry. The industry can decrease its
data output on paper, speed up the data review and approval process, and
benefit from new automation technology based on computerized system
control, for example, in manufacturing or dissolution drug release testing.
In addition to this rule on electronic records, other general requirements for
computerized systems are brought to the auditor’s attention. These rules cover
the basic requirements of validation which are limiting data access and
ensuring data integrity and data traceability.
It is, of course, the industry that must ensure that its work practices support
the FDA rules, but most of the requirements also affect the chemical analysis
systems and suppliers of these systems.
You can also use the ChemStation Administration Tool to enable the Method Audit Trail for
NOTE all methods (see “ChemStation Administration Tool” on page 97).
To enable the Method Audit Trail only for the currently open method
You can also activate the Method Audit Trail only for one method. This might
be useful, for example, when you finished the development of new method and
want to track all further changes.
1 Select Method > Enable Audit Trail
2 On the Audit Trail tab, select Enable Method Audit Trail for all methods.
To view the Method Audit Trail for the currently open method in
ChemStation
1 Select Method > Method Audit Trail.
To view the Results Audit Trail for the loaded sample in ChemStation
1 In the Data Analysis view, select View > Current Data File Logbook.
Report History
If you create a ChemStation report, you can display the report on the screen,
send it to a printer, or save the report as a specific file (report.pdf). These
report outputs may easily be lost or overwritten, especially when you create
several reports after each other.
With ChemStation OpenLAB Option, ChemStation automatically tracks any
report that was generated. In order to reproduce an old or overwritten report,
select Report > Report History. Here, you can see all reports created for the
current data file since the installation of ChemStation OpenLAB Option. You
can also export or print this history.
If the system shall be compliant to 21 CFR Part 11, the ECM Audit Trail must be enabled.
NOTE
Administration in ECM
When you install ChemStation OpenLAB Option, you need to carry out certain
basic configuration tasks in ECM (see “Installation and Configuration Tasks
on ECM Server” on page 23). In addition, there are several other settings in
ECM that are relevant with regard to 21 CFR Part 11. These settings are
described in the following section.
Account configuration
To configure the ECM Account
1 In ECM, select the Administration page.
2 In the Navigation Pane, select the Account Administration node.
3 Double-click the Configuration item.
The Account Administration dialog opens.
Lockout If a user tries too often to log in with You should limit the number of
invalid user credentials, he is locked out allowed login attempts to
of the system and cannot log in any three.
more – not even with valid user
credentials. You can define the number
of allowed login attempts.
Inactivity Timeout If a user does not perform any action in You should specify a timeout.
ChemStation for the given period of
time, he is automatically logged out. The
same applies to the ECM Web Client.
System administrator The e-mail address you provide here will You should provide an e-mail
email automatically be notified when a user address.
was locked out after too many
unsuccessful login attempts.
Minimum Password If users change their passwords, they You should require a minimum
Length must choose a password with at least password length of at least 5
the given number of characters. The characters.
default setting is 5.
Require entry in In each ECM Audit Trail or System Log The ECM Audit Trail and
Reason fields entry the users can enter a specific System Log reasons must be
reason for the action. If this check box is mandatory.
selected, the entry is mandatory.
Users/Groups/Roles
To configure the password settings for an ECM Account according to the
password policy
Preparations If you want to assign roles at the folder level, you must first enable this feature in ECM. The setting is
valid for the complete ECM Account.
Login options
The following check boxes are relevant in case of an emergency, that is, if the
ECM Server is down:
• Mandatory Login: If you clear this check box, all ChemStation instances on
this client can be started without an ECM login. If the ECM login used to be
mandatory and the ECM Server is down, clearing this check box can be
used to make ChemStation accessible again.
Be aware that, as a consequence, the privileges of the ChemStation users are now
NOTE unlimited. The users have access to all ChemStation functions.
• Start ChemStation when ECM is unavailable: If you select this check box, the
ChemStation can be started when the ECM server is unavailable even if
Mandatory Login is enabled. The Login dialog at startup of ChemStation can
be cancelled. With this option selected, any user can continue to work in
ChemStation in case the server is down without contacting a user who has
access to the Administration Tool.
Be aware that, as a consequence, the privileges of the ChemStation users are now
NOTE unlimited. The users have access to all ChemStation functions.
• Break Session Lock: If you select this check box, a locked ChemStation can be
accessed by any user just by clicking Cancel in the Login dialog. If a
ChemStation is currently locked and the ECM Server is down, selecting this
check box is the only possibility to regain access to the current
ChemStation session.
Be aware that, as a consequence, the user who regained access to ChemStation now has
NOTE unlimited access to all ChemStation functions.
The following check boxes allow you to configure the timebased session lock
and the ChemStation toolbar Lock Button:
• Timebased session lock locks private: If you select this check box, the time
based session lock will lock the ChemStation sessions privately. Otherwise,
the timebased session lock will be non private.
• Toolbar Lock Button locks private: If you select this check box, the ChemStation
toolbar lock button will lock the ChemStation session privately. Otherwise,
a non-private lock will be applied.
Electronic Signature
Preparation
Privileges
An ECM user needs to have the privilege Content: File Signatures in order to be
able to sign electronically. This privilege is, for example, assigned to the ECM
default role: :Approver.
If you clear this check box, the users can only select one of the given default reasons.
NOTE
The other command in the context menu, Electronically Sign > Acrobat Plug-In
NOTE Signature, works only for PDF documents and only if you purchased the according plugin. It
enables you to add signatures directly inside PDF documents.
3 Enter your current location. With this information, the location from where
you provide the signature is reproducible.
4 Select a reason for the signature from the Default reason drop-down list.
- Or -
Select the User specified check box and enter a different reason into the text
field. Note that this option is only available if the ECM Account is
configured accordingly.
5 Click Sign.
The file is now signed electronically. The e-signature is shown in the file
properties in the eSig tab. The e-signature is also included in the ECM Audit
Trail.
6
Custom Fields
About Custom Fields 104
Setting Up Custom Fields 105
To define new custom fields 105
To import custom fields from an existing method 107
Specifying Custom Fields Values 108
To provide sample custom fields values 108
To provide compound custom fields values: 109
Reporting of Custom Fields 110
To display custom fields in ChemStation reports 110
Reprocessing with Custom Fields 112
This chapter explains the purpose and usage of custom fields in ChemStation.
The custom fields definition is part of the method. You can define up to ten
custom fields related to the samples, and up to ten custom fields related to the
compounds. Also, you can import the custom fields definitions from another,
existing method.
If you create sample custom fields named Project or Study, these custom fields will be
NOTE reported twice in the .acaml file: in the regular custom fields section, and also in the
projects/study mapping. This enables OpenLAB Intelligence Reporter to find all results
related to a specific project or study.
10 If required, adjust the order of the custom fields with the Up and Down
buttons.
The specific values of the predefined custom fields depend on the actual
sequence. Therefore, the values are specified in the sequence table.
4 Enter the required values for each sample and custom field.
You can only start a sequence after the mandatory fields have been completed.
NOTE
This tab is only available if compounds have been set up in the method's calibration table.
NOTE
2 Select the required compound from the drop-down list at the top, or click
, , , or to navigate to the required compound.
3 Enter the required values for each sample and custom field.
4 Select the other compounds and provide the values accordingly.
5 Click OK.
Custom fields values are always saved to ECM and are therefore always
available in OpenLAB Intelligence Reporter. However, they are not
automatically shown in ChemStation reports. If you want to display the
custom fields in your ChemStation reports, you must first adjust the report
options.
7
Treatment of ChemStation Legacy Data
and Data Migrated from ChemStore
Introduction 114
Result set Migration 115
Conversion of Data Migrated from ChemStore 117
Introduction
When ChemStation OpenLAB Option is installed, Unique Folder Creation can not
be switched off. All sequence data sets that are acquired are therefore stored
as sequence container. Please refer to the manual “Getting Started with New
ChemStation Workflow” for more details on working with Unique Folder
Creation.
The sequence container format of sequences is essential for upload to ECM.
Therefore ChemStation legacy sequence data acquired with ChemStation
prior to B.02.01 or while Unique Folder Creation was off, have to be migrated to
sequence container format before they can be uploaded to ECM.
Legacy ChemStore data that have been migrated to ECM can also be converted
to be reviewed in the Navigation Table.
Select Destination: Specify the path and name of the result set to be created. You
may select an existing folder or create a new one.
When all fields are filled in, the migration can be started.
The following steps will be performed:
• The result set directory will be created.
• The sequence template will be copied to the result set. It will also be
converted to a state where it is able to reprocess data files in Data Analysis
view.
• The methods referenced in the sequence table are copied from the specified
method path to the result set folder.
• The data files, the sequence logbook, and the batch file are copied from the
data source directory to the destination directory.
• According to the information in the sequence table, a copy of the
corresponding method is copied to each data file as DA.M.
When the result set migration is completed, a success message is displayed in
the Messages and warnings field. Otherwise a warning message indicates any
problem during migration. Details about the warning can be obtained by
double-clicking the warning message.
When ChemStore sequence data have been migrated to ECM, they are already
available in the form of .sc.ssizip files and thus ready to be downloaded into
ChemStation Data Analysis view. However, such sequence containers have to
be converted to be ready for review in the Navigation Table.
The conversion process is started automatically after downloading the data
from ECM:
1 Select ECM > Load Data and select the data set you want to view in
ChemStation.
A message is displayed that the sequence data will be reprocessed. Press Yes
to continue.
If you press No, the local copy of the data set will be deleted immediately.
NOTE
8
Interface to OpenLab Intelligence
Reporter
Introduction 120
Prerequisites 122
Typical reporting workflows 122
To create a Single Sequence OpenLAB Summary Report 127
Interface Components Concerning OpenLAB IR 128
Template selection in Sequence Output 128
Automatic Creation of OpenLAB Intelligence Report at the End of the
Sequence 129
OpenLAB IR commands in the ECM menu 129
Calculation of performance values 130
Introduction
For more detailed information on OpenLAB Intelligence Reporter, please see the OpenLAB
NOTE Intelligence Reporter documentation.
ACAML version
ChemStation stores all data in the ACAML format (ACAML = Agilent Common
Analytical Markup Language), which results in .acaml files. There is one
.acaml file for each sequence or single run. When the data is uploaded to ECM,
the .acaml file is part of the SSIZIP sequence container. OpenLAB Intelligence
Reporter uses the data provided in these .acaml files.
In ChemStation B.04.02, the ACAML schema is updated from version 1.1 to
1.2. This version 1.2. of the ACAML schema is only supported by OpenLAB
Intelligence Reporter revision A.02.01.
1 In ChemStation:
• You select a report template for the OpenLab Intelligence Reporter in the
Sequence Output.
• If the report is to created automatically at the end of the sequence, you
select Preview at end of sequence in the Sequence Output.
• You select the Automatic Data Transfer Setting After Acquisition.
• You start the sequence.
2 After the acquisition, all data is automatically transferred to ECM.
3 The result data and metadata is automatically extracted from the .acaml
files into the Reporting Database.
4 In ChemStation: You trigger the creation of the report by clicking Create
OpenLAB Intelligence Report. If Preview at end of sequence was selected in the
Sequence Output, the report is created automatically without additional
user interaction.
Prerequisites
If you want to use OpenLAB Intelligence Reporter, the following prerequisites
must be met:
• OpenLAB ECM is installed.
• OpenLAB Intelligence Reporter is installed.
• ChemStation OpenLAB Option is installed.
• The chromatographic data has been uploaded to ECM.
Only the Single Sequence Summary Report can be directly generated from ChemStation.
NOTE For the other two reporting workflows, you need to perform all tasks in OpenLAB
Intelligence Reporter. See the OpenLAB Intelligence Reporter documentation for more
details.
When printing an Intelligence Report directly in the ChemStation only a report based on the
NOTE latest version of the data can be created. For reports based on earlier versions the report
template has to be modified, or the report has to be created in the OpenLAB Intelligence
Reporter software.
Example reports
The reports generated by OpenLAB Intelligence Reporter can include a wide
variety of information, such as:
• Custom calculations (e.g. summary calculations, statistics, and complex
tests)
• Decision-based result presentation (flag outliers, automatically sort results
by pass/fail criteria, etc.)
• Search-based report content selection
• Condense information by visualizing key results (e.g. in trend charts)
In addition, interactive reports can be based upon specific parameters, such
as a date range, or the reports can contain expandable detail information.
See the following figures as an example.
(1) User parameters (here: Start Date and End Date) as selected by the user
On an ECM installation with multiple accounts, projects from all accounts are visible in the
NOTE Projects menu of OpenLAB Intelligence Reporter! Ensure that you select a project
belonging to the ECM Account you are working on.
This is not an issue when selecting a template directly from ChemStation, as you select the
template from the LCDF structure of the specific ECM Account you are working on.
You must first upload the sequence data to ECM before you create a report. Only data that
NOTE is available in ECM can be used by OpenLAB Intelligence Reporter to generate a report.
9
Attribute Extraction Services for
ChemStation Data
Attribute Extraction Services for ChemStation Data 132
ACAML Filter 135
ChemStation XML Attribute Extraction Service 136
ChemStation Filter 137
ECM Attribute Extraction Services (AES) provides the following AES for the
extraction of metadata from ChemStation data files:
• The ChemStation XML filter extracts peak, compound and result data from
the result.xml file generated by the XML export routine in ChemStation
revision A.10.02 and later.
• The ChemStation filter extracts basic sample and run data from the header
of the channel files (*.ch), *.uv and *.txt files generated by all ChemStation
revisions.
AES need to be installed by an ECM Administrator on the ECM Server; in
addition, the filters need to be enabled for the system. The keys of an AES that
are to be applied to a ChemStation file need to be selected for the respective
LCDF structure. These are ECM administration tasks, and are described in the
Enterprise Content Manager Administrator’s Guide and the ECM online help.
The metadata can be queried using various search types in ECM. The ECM
Search functionality is also available within ChemStation. When opening a file
from ECM, the ECM Open dialog allows you to search for files of interest using
the ‘magnifying glass’ icon, see Figure 33 on page 133.
Using the Quick Search, you can search through various alphanumeric fields
by entering a search key, such as an operator name. On the upcoming search
page, you select the Advanced tab where, depending on the enabled filter
packages, various keys are enabled, see Figure 34 on page 133.
In the Search dialog, you can specify the available keys, and it is possible to
define a search expression by combining two or more of the available keys
using boolean operators. For detailed information regarding the use of the
various search algorithms, refer to the online help of your ECM system or the
Enterprise Content Manager Administrator’s Guide, as well as the AES-related
manuals.
ACAML Filter
The ACAML Filter extracts information from the ACAML files that are also
used for the OpenLAB Intelligence Reporter (see “Interface to OpenLab
Intelligence Reporter” on page 119. The ACAML files are always created when
acquiring or reprocessing data when the OpenLAB Option is installed.
Please note that the ACAML filter is only available for ECM 3.3.2 SP1.
The AES for ChemStation XML extracts key information from the following
categories of the result.xml generated by ChemStation Rev. A (revision A.10.02
and later) and ChemStation Rev. B (revision B.01.01.and later) per data file.
Note that ChemStation must be configured to generate the result.xml file, see
the ChemStation XML Connectivity Guide.
• Acquisition (for example, instrument name, method information)
• Chromatogram (for example, derivative order, detector name)
• Custom
• Module
• Peaks (for example, peak name, amount, retention time, compound name)
• Sample (for example, calibration method, LIMS ID)
• Signal/noise
ChemStation Filter
The AES for ChemStation extracts attributes from *.ch, *.uv, and *.txt files
created by the 16-Bit ChemStation (Rev A.x.x) or 32-Bit ChemStation (Rev
B.x.x). It extracts key information from the header of ChemStation *.ch and
*.uv data files (for example, sample name, method file, instrument model).
From the report.txt file, it extracts key information (for example, sample
name, acquisition method, analysis method). In addition, the service extracts
information on support files from the category Content.
An ECM Scheduler Add-in for Agilent ChemStation enables the ECM
Scheduler to automatically upload data generated by ChemStation to ECM.
10
Using Print Services in ChemStation
ECM Print Services 140
Setting Up ECM Print Services 141
Installing ECM Print Services 141
Configuring ECM Print Services for use with Amyuni PDF Converter 142
To set the printer to ‘unattended mode’ 143
Configuring ECM Print Services - Adobe Distiller 144
To set the printer to ‘unattended mode’ 145
Working with ECM Print Services in ChemStation 146
This chapter gives a brief overview of how to install and configure the Print
Services. This enables you to automatically upload ChemStation reports to
ECM in a PDF format.
ECM Print Services are print management systems that transfer human
readable electronic documents to ECM. They can be used to print ChemStation
reports to ECM in PDF format.
When you add and configure a print service, it appears as an available printer
on your computer. When you print with ECM Print Services, a PDF file is
created and automatically uploaded to the ECM system. In addition, you can
also set up the system to print additional hard copies to a conventional
printer.
ECM Print Services can be installed for ECM Server revision 3.3.1 or later.
The ECM Print Service consists of two components:
• The ECM Print Service Manager, where you add and manage printers for
the ECM Print Service.
• The ECM Print Service, which monitors a folder on your local disk drive.
When a print service receives a print job, the print driver prints to a file in
the monitor folder. Then the ECM Print Service intercepts the file and
uploads it to ECM. In order for a file to be uploaded to the ECM program, it
must have the file extension *.pdf.
5 Click Apply to apply the configuration to the Print Service and leave the
dialog box with OK.
6 Depending on the Acrobat Distiller version in use, additional configuration
settings are necessary. A message requests you to perform certain tasks.
Example for Adobe Distiller Rev. 6.00:
In Start > Settings > Printers open the properties of the newly added printer.
Select Print Preferences.
• In the Adobe PDF Conversion Settings, deselect View Adobe PDF results.
• In the Adobe PDF Output Format, select the monitored path of the
ChemStation computer.
• Select Edit for the default settings. On the upcoming Adobe PDF Settings
dialog, deselect optimize for fast Web View and save the settings.
7 Exit all printer-related dialog boxes with OK.
8 In ChemStation, it is now possible to specify the newly configured printer
in the File pull-down menu under Printer set up. It is possible to select the
ECM Print Service as specific printer; if the printer has been marked as
default printer in the Windows Settings, it will be already defined as default
printer in ChemStation.
When you use the ECM Print Service in ChemStation, any report printed using
the Print Services is converted to a *.pdf file, placed in the monitored folder,
and transferred by the print service to the specified location in ECM. During
conversion to PDF, the name supplied by the system is fixed. It is defined as
follows:
• single runs: [datafile name].pdf
• sequence runs: [sequence name]_ [datafile name].pdf
• sequence summary reports: SSR_[sequencename].pdf
The maximum file length for this automatically generated report name is 30
characters; longer files names are truncated. If, due to the truncation,
filenames are the same, the existing file is overwritten.
Be aware that when you specify the sequence pattern and datafile name in the sequence
NOTE setup, the complete *.pdf file name may not exceed 30 characters.
11
Troubleshooting
General Problems 148
ECM Server is not Available 148
Alerts and Error Messages at ChemStation Startup 149
Error Messages in the Spooler Queue Manager 150
General Problems
1 The Remote Data Path is not set or is Make sure that the information on ECM Server,
incomplete. ECM Account, and a complete LCDF path is
provided in the Transfer Settings (ECM >
Preferences > Transfer Settings).
Account Mismatch
1 Account setting in Preferences differs from Correct the Transfer Settings and connect to
current connection (or offline). ECM.
Host Mismatch
1 ECM Server in Preferences differs from Correct the Transfer Settings and connect to
current connection (or offline). ECM
1 There are items in the queue that have been Process queue in the correct order. If necessary,
queued before the current item. export items that can't be resolved.
1 You do not have appropriate privileges to Ask an administrator to give you the
create the Drawer or Folder. corresponding privileges or to create the needed
directories.
1 You do not have appropriate privileges to Ask an administrator to give you the
save files to the specified location in ECM. corresponding privileges.
1 Another user has checked out the file. The other user has to check in the file before
you can upload the file.
12
Appendix
ChemStation Privileges in ECM 154
ChemStation Roles in ECM 157
ECM related privileges concerning the ChemStation configuration 161
Privilege Description
CS: Audit Trail Run: Enable the audit trail for a specific method
CS: Ion Labels Edit: Edit options for Ion Labels (LC/MS-only)
Privilege Description
CS: Manage Transfer Queue Run: Access to the following items of the
Spooler Queue Manager
• Save selected item locally
• Delete selected item
• Properties
CS: Method Properties Edit: Modify Run Time Checklist and Method
Information
CS: Retention Time Lock Edit: Access to the Retention Time Lock menu
(GC only)
CS: Retention Time Search Edit: Access to Retention Time Search menu
(GC only)
CS: System Suitability Edit: Edit noise ranges and performance limits
Privilege Description
Please note: the default ChemStation roles do not contain any ECM privileges.
CS: Control X
CS: Data X X
CS: Diagnostic X
CS. Logbook X X
CS: Method X X
CS: Sequence X
CS: Batch X
CS: Calibration X
CS: Control X
CS: Data X
CS. Logbook X
CS: Method X X
CS: Recalibration X
CS: Report X
CS: Reprocess X
CS: Run X
CS: Sequence X X
CS: Batch X
CS: Calibration X
CS: Companion X
CS: Control X
CS: Data X X
CS: Diagnostic X
CS. Logbook X X
CS: Method X X
CS: Report X
CS: Reprocess X
CS: Run X
CS: Sequence X X
CS: Tune X
CS: Verification X
CS: Control X
CS: Data X
CS: Run X
CS: Sequence X
The privileges described in the following table must be assigned to at least one
of your roles in order to become active.
Index
workflows
data related 63
data related 12
methods/sequence templates 14,
74
OpenLAB IR 122
In This Book
*G2170-90037*
*G2170-90037*
G2170-90037
Agilent Technologies