223-10496

CLASS-Public Agent Chem Option

Instruction Manual

Before operating the software, please read this manual carefully

and retain it for future reference.

SHIMADZU CORPORATION
ANALYTICAL & MEASURING INSTRUMENTS DIVISION
KYOTO, JAPAN
 Before Using CLASS-Agent Software
Thank you for purchasing CLASS-Agent Software. Before using this software, please read this manual
carefully to get the most out of your software.

This instruction manual describes how to use and operate CLASS-Public Agent Chem Option. It as-
sumes that you should be familiar with some features in Windows 98/NT/2000/XP; you should have
some hands-on experience with the mouse and keyboard.

In this instruction manual, basic terminology used in Windows 98/NT/2000/XP are used to explain
about how to do anything in CLASS-Agent Software. For definitions of unfamiliar words, please refer
to the Windows 98/NT/2000/XP manual.

If you are a first-time user of Windows 98/NT/2000/XP, please read the Windows 98/NT/2000/XP
manual before reading this instruction manual.

Handling Precautions
1. This Software is and remains the proprietary property of Shimadzu Corporation.
2. No part of this Software may be copied or reproduced in any form or by any means, except for in-
stallation and routine backup. No part of this Software may be leased, assigned, transferred, re-
compiled or altered in any form or by any means.
3. Shimadzu Corporation shall not be liable to the purchaser or any other person for any loss or dam-
age arising out of the use or operation of this Software.

* Windows 98/NT/2000/XP are trademarks of the Microsoft Corporation.

* ChemStation is a trademark of the Agilent Technologies.
 Contents
Preface
About CLASS-Agent Software
About the Instruction Manual
Warning Signs

Chapter 1 Introduction
1.1 Features.................................................................................................................. 1-1
1.1.1 Features of Configuration ......................................................................................... 1-2
1.1.2 Features of macro program of data collection........................................................... 1-2
1.1.3 Features of Agent Manager ....................................................................................... 1-3
1.2 Handling Precautions............................................................................................. 1-4
1.2.1 Before Using CLASS-Agent Software ..................................................................... 1-4
1.2.2 About the Agent Manager Program .......................................................................... 1-6

Chapter 2 Getting Started

2.1 Running the Program............................................................................................. 2-1
2.2 Setup files of Chem Option ................................................................................... 2-1
2.3 Setting the Export Folder....................................................................................... 2-2
2.4 Setting the registration macro folder of ChemStation ........................................... 2-2
2.5 Setting the flag of registration ............................................................................... 2-2
2.6 CLASS-Public Agent Configuration ..................................................................... 2-3
2.7 Analysis and Measurement.................................................................................... 2-5
 Preface
About CLASS-Agent Software
This software (“CLASS-Agent Software”) is database management software package designed
for creating a link between data processing application software and a database. It provides
various database management functions and capabilities. Data can be automatically stored in a
database that is created in a format used in general-purpose database applications, such as
MS-Access 97, MS SQL Server and Oracle formats. A collection of data stored in the database
can be sorted by sample/instrument/person-in-charge. This makes it much easier for the user to
sort analysis/measurement data (analysis/measurement files) that are read from any
SHIMADZU’s chromatogram-data processing devices (CLASS-VP, LabSolutions) or from any
balances.

With this software, the user can perform the task of making an analysis, without having to de-
cide where to store analysis results and what to specify them as a filename. The user is able to
analyze a collection of data stored in a database, to summarize analysis results, and to prepare
detailed printed reports like test reports, summary reports, and daily routine reports. These data
management capabilities are designed for relieving the user's burden of storing and recording
various data. This will increase efficiency of routine operations.

In this software, a database can be created and presented in format used by commercially avail-
able general-purpose database applications. The user is able to create his own database by using
such application software as MS-Access, MS-Excel, and MS-Word.

About the Instruction Manual

The authors have used their best efforts in preparing this document by providing up-to-date in-
formation as much as possible, but the information and software discussed in this document are
subject to change due to nonconformity. For the latest information, please read the contents
written in the README2.TXT file, a file that is saved to the program directory of this software
during an installation process.

The names of data processing software and equipment are expressed in the form of generic
names. Model names and type names are indicated as may be deemed necessary to identify any
software or equipment.

As used in this instruction manual, this software package is referred to as “CLASS-Agent Soft-
ware” where appropriate.

Warning Signs
The following warning signs are used throughout this instruction manual.

[CAUTION] indicates a potentially hazardous situation where, if not avoided, any damage to
property may be caused.

[NOTE] emphasizes additional information that is useful to increase efficiency of opera-

tions and to enlarge an understanding of topics.
 223-10496

Chapter 1 Introduction
1.1 Features············································································································· 1-1
1.1.1 Features of Configuration ···············································································1-2
1.1.2 Features of macro program of data collection ··············································1-2
1.1.3 Features of Agent Manager ············································································1-3
1.2 Handling Precautions························································································ 1-4
1.2.1 Before Using CLASS-Agent Software ·························································1-4
1.2.2 About the Agent Manager Program ······························································1-6
 1 Introduction

CLASS-Public Agent Chem Option is the software to register a result of analysis onto the share
database on the CLASS-Agent software using the macro program feature of ChemStation.
This software is composed of the macro program which watches over the analysis and re-analysis
by the sequence and creates a text file for Public Agent every time.
Public Agent registers to the Agent database. The Agent Manager software that comes with
CLASS-Public Agent makes it easier to view, print or approves stored data, add sample
information, copy data to other applications and restore analysis files.

This product is doing a macro operations check in the version of the following of
ChemStation.
ChemStation for LC Rev. A.04.01
ChemStation for LC Rev. A.06.01.J
ChemStation for LC Rev. A.08.03.J
ChemStation for GC Rev. A.09.03.J

1.1 Features
This Agent system provides the following features.

1. Stores analysis data automatically (saved to compressed archive files).

2. Keeps records of analysis results (analysis values are stored in databases).
3. Keeps analysis logs. The analysis logs contain data on registered user names,
displayed user names, and operations performed by each user.
4. Provides security management for analysis data. See Note 1.
5. Stores or views analysis data and logs on a LAN.
6. Extracts, views, sorts or prints stored data.
7. Executes approval workflow.
8. Adds sample information (lot number, sampling place, time, etc.).
9. Transfers data and chromatograms to other applications.
10. Restores analysis files and method files.
11. Sends notice of analysis completion or analysis data by e-mail. See Note 2.
12. The data making public and the reading with the intranet. See Note 3.
13. Uploads approved data to the host. See Note 4.

Note 1. C2 level security protection requires MS-Windows NT/2000.

Note 2. Analysis data is manually transferred using Agent Manager.
Note 3. Use of this feature requires the creation of a data transfer program (Optional).
Note 4. Use of this feature requires the creating of www home page and the Web server application.
(Optional).

1-1
1 Introduction

1.1.1 Features of Configuration

Collect or not-collect of the data, and the Folder of export for Public Agent is set by
automatic execution macro "User.mac".

1.1.2 Features of macro program of data collection

Data is converted based on the configuration settings. As for this macro program, the
following is registered.

[Sample information]
Instrument Name
Sample Name
Sample Type
Online or Offline
Vial No.
Operator Name
Analysis Date
Files of AIA Format
Name of Data Folder
Sequence File Name
Method File Name
Text File Name
Sample Amount
IS Amount
Dilution
Method of Calculation
Division of Calculation (Area or Height)
Multiplier
Sample Information

[Data Information]
Channel
Peak Number
ID Number
Retention Time
Concentration
Area%
Height%
Number of theoretical plate
K Prime
Resolution Table
Symmetry
Alpha
Area Ratio
Height Ratio
Area
Height
Compound Name
Baseline type
Unit

1-2
 1 Introduction

[Archive Files]
Text File
AIA Files
Sequence Files
Data Files
Method File

[NOTE] It is computing area %, height %, area ratio and height ratio at the Agent
registration macro program.
Depending on the number of figures display by Agent Manager, the sum
doesn't become 100 % in the area %, the height %.

1.1.3 Features of Agent Manager

The Agent Manager program (Agentman2.exe) enables a user to view analysis data in a
database from a personal computer on a local area network. This feature can be used on
all personal computers to which the Agent Manager program has been installed,
regardless of whether the Automatic Agent Program is installed. An Administrative
CLASS-Agent Software License is required.

A user can do the following:

1. View a list of databases.
2. View, extract, sort or print sample information/analysis values stored in a database.
3. View a combination of data information and sample information, and display several rows
of a data information/sample information table.
4. Copy, move, or delete information contained in a database.
5. Decompress compressed files, or restore analysis files.
6. View object link files (AIA files). More than one chromatogram can be displayed.
7. Copy displayed data or object data (chromatograph data) to the Clipboard.
8. Set an approval flag to data according to the approval flowchart.
9. Add sample tag information (lot number, sampling place, etc.) up to 10 items.
10. View or print a log of stored data.
11. Send analysis data by e-mail.
12. Create user accounts and user groups (for security protection).
13. Create new databases in MDB format (SQL format requires the use of optional programs).
14. Make backups of databases.
15. Register additional system logs.
16. Shift from a LAN environment to a local environment.
17. Link objects with filename extensions.

[NOTE] If selected in install on the ER/ES mode, the part of the above feature is
limited.

1-3
1 Introduction

1.2 Handling Precautions

When using CLASS-Agent Software, the following precautions should always be followed.

1.2.1 Before Using CLASS-Agent Software

1. Using CLASS-Agent Software on a LAN

(1) CLASS-Agent Software recognizes a network computer name as a
registered instrument name. Do not connect PCs on a LAN if they have the
same name.
(2) Use a unique name for an analysis device name that can read by the
Automatic Agent Program. The unique name should be identified in the
database.

2. About Archive Files and Object Link Files

CLASS-Agent Software supports MS-Windows' long filenames (up to 255
characters).

3. About Database Name and Subdirectories

CLASS-Agent Software automatically creates a directory where a database
is stored and subdirectories where archives files and object link files are
stored, so that these files are linked to databases. Do not change database
names and directory names using Windows Explorer. If a database name or
directory name is changed, the files cannot be found by the CLASS-Agent
software and archive files cannot be decompressed.

4. Using the Accessory Programs

CLASS-Agent Software comes with accessory programs. Do not use these
accessory programs in any other application software. Use the accessory
programs in accordance with their respective manuals.

5. Running Other Applications

Do not run CLASS-Agent Software and other applications that are not
supported by CLASS-Agent Software at the same time. Even if
CLASS-Agent Software and applications supported by CLASS-Agent
Software are used at the same time, an error may be caused due to heavy
load, depending on CPU speed, memory space and use of a LAN. Use only
the PC that meets the minimum system requirements.

6. About Database Size

• For an MDB-format database, set the maximum number of records in a sample
information table to somewhere around 10,000. If records exceed the
maximum number, create a new database so that the records can be divided
between the two databases. Use CLASS-Agent Software to create the new
database.

1-4
 1 Introduction

• For an MSDE (Microsoft Database Engine) database, the upper limit of the
database size is 2 GB. If data to be saved exceeds this, the data is saved in an
MDB-format temporary database. The administrator should check the database
size temporarily, and change the settings of the Agent system so that the data is
saved to a new database before the database size reaches 2 GB. Alternatively,
the administrator should make a backup of the database, then delete
unnecessary data to increase free space in the database. To handle databases of
2 GB or more, replace the current system with the SQL Server system (sold
separately).

7. Restriction in Character Codes Available in a Database

In the display field of a database table, codes for “|” (pipe), line feed and tab
cannot be input. If these codes are included in an element name or
comment, they are automatically replaced with a space.
Example ElementA|ElementB

ElementA ElementB

8. About Setting the Date

When using Class-Agent, do not set the day of the week in "Short date
style" available by choosing [Control Panel] → [Region Settings] → [Date].
Example (Valid) yy/MM/dd
(Invalid) yy/MM/dd’(ddd’)’
In Agent Ver. 2, any time in the date field of a database is stored as the GMT
(Greenwich Mean Time).
To display the local time while the database is directly accessed, adjust the
stored GMT time.

9. Changing the Password Using the Database Software

When the password of a database is changed using the database software
(MS-Access, SQL Server or Oracle), the database link setting in the Agent
Manager and the Automatic/Manual Agent should be reset.

1-5
1 Introduction

1.2.2 About the Agent Manager Program

1. About the Default System Administrator

If running CLASS-Agent Manager for the first time, log in to CLASS-Agent
Manager using the following: ID= “Admin” and Password= “” (blank).
After starting CLASS-Agent Manager, change this login ID's password. The
login ID “Admin” is the Supervisor account that has the system
administration permission for CLASS-Agent Software. The login ID
“Admin” is automatically created during installation. The user account with
login ID “Admin” is not displayed on the user information screen.

2. Sharing a Database on a LAN

To share files on a local area network (LAN), set up the network capabilities
in the "Configuration" dialog box in CLASS-Agent Manager after the
installation of CLASS-Agent Software is completed. If folders are shared on
a LAN after CLASS-Agent Manager is installed, care should be taken to
select the appropriate options, otherwise the settings for instrument
information and log information may be overwritten. After these settings are
made, create user accounts so that system resources can be shared on a
LAN.

3. Creating a User Account

Specify a login ID, user name and security level when creating a user
account. The creation of a user account is limited to users having the
Administrator permission. Each user can change his or her own password at
any time after logging in to CLASS-Agent Manager.

4. Creating a Database
In the "New MDB Database" dialog box in CLASS-Agent Manager, create
an MDB database to store analysis data. The creation of a database is
limited to users having Administrator permission. To create an MS SQL
Server formatted database or MSDE (Microsoft Database Engine) formatted
database, use the CLASS-Agent Manager accessory program for creating an
SQL database.

5. Listing and Viewing Log Databases or Temporary Databases

By default, three databases are displayed on a database list screen in
CLASS-Agent Manager. They include the system log database, temporary
data database (Temp_Dt2.mdb) and temporary log database
(Temp_Log2.mdb). They are created during installation, with passwords
assigned. These databases cannot be viewed using MS Access or any other
application. These databases can only be viewed in CLASS-Agent Manager.

1-6
 1 Introduction

6. Screen Saver
When this software is started after installation in the ER/ES mode, the
system is set so that the screen saver dedicated to the Agent system is
automatically activated. After this software is closed, the system returns to
the original setting.

For Windows NT, the screen lock is valid. If a password is required, set a
password for the screen lock in the OS.
The default value of the time until the screen saver starts is 5 minutes. To
change this value, change “common.inf2” in "Environment Setting" of the
Agent Manager. For example, to set to 10 minutes the waiting time until the
screen saver starts, add the following two lines.

[GLP]
ScreenLock=10

7. Log Types
Log information is separated into the data log for data operations and the
system log (Log2.mdb) where logs related to the system are saved.
When the contents of the database storing the data acquired from the
analysis instrument are changed, the history of such changes is stored in the
data log. When the contents of options not directly related to the data are
changed, the history of such changes is stored in the system log.
Click the log on the database tree to display the log information on the
sample information table.

8. Precautions for Multiple Users in Windows NT

• The common network settings offered by choosing [Tool] → [Configuration]
on the Agent Manager menu should be executed by a user having the NT
“Power Users” or “Administrators” permission.
• In multi-user mode of NT, all other settings should be executed for each user
ID. The Agent system administrator should login using each NT user ID, and
perform the required settings.

1-7
 Chapter 2 Getting Started
2.1 Running the Program························································································ 2-1
2.2 Setup files of Chem Option ·············································································· 2-1
2.3 Setting the Export Folder·················································································· 2-2
2.4 Setting the registration macro folder of ChemStation ······································ 2-2
2.5 Setting the flag of registration ·········································································· 2-2
2.6 CLASS-Public Agent Configuration································································· 2-3
2.7 Analysis and Measurement··············································································· 2-5
 2 Getting Started

Registering Results in the Database

The flowchart below shows the procedure for automatic registration of the analysis
results into the database.
<Operation Flowchart>

Register user, create database with Agent Manager

Set import folders in CLASS-Public Agent

Set “user.mac”, if required

Do sequence of ChemStation

2.1 Running the Program

Before first use

The program must be configured before it is used. Register the users and create the
database with the Agent Manager software.

2.2 Setup files of Chem Option

Chem Option setting is changed by the contents of the "User.mac" macro file. "User.mac"
is installed in the CORE folder (generally C:\HPCHEM) of the installation of
ChemStation. "User.mac" is a text file, and it edits with such as the notepad of the
Windows.

2-1
2 Getting Started

2.3 Setting the Export Folder

The folder which is set to the ChemFilePath$ sentence in "User.mac" is to output the
result of analysis from the macro program. The initial setting is in "C:\Agent2\Import1"
and it is in the import folder when installing Agent as the initial setting. If changing the
installation folder of Agent, change this setting.

2.4 Setting the registration macro folder of ChemStation

The folder which is set to the AppPath$ sentence in "User.mac" is in the installation
folder of the macro program for Chem Option. The initial setting is in "C:\Agent2\Macro"
and it is in the install folder when installing Agent as the initial setting. If changing the
installation folder of Agent, change this setting.

2.5 Setting the flag of registration

By the value which is set to the RegAgentFlag sentence in "User.mac", it is fixed by
register or not register the result of analysis to Agent database.
RegAgentFlag = 1 Register to Agent database
RegAgentFlag = 0 Not register to Agent database
The initial value is "register to Agent". If there is not a special reason, this setting doesn't
touch.

2-2
 2 Getting Started

2.6 CLASS-Public Agent Configuration

Public Agent Configuration sets the import folder and the database to which the data is
registered.

1) Double-click the Public Agent icon in the task tray while the Public Agent service is
running. Public Agent Configuration starts in the logged off status. Log on to Public
Agent Configuration as a user with operating authority.

2) Display the "Assign database per instrument" screen.

3) Double-click Instrument 1 line, or click the line to highlight it and then press [Edit]
to display a dialog box to edit the settings for Instrument 1.

[NOTE] Chem Option can only use the Instrument 1 import folder.

2-3
2 Getting Started

1 Instrument name
The instrument name can be changed to any name.

2 Register data
Click this checkbox to enable the setting. No data is registered to the database if
this setting is disabled. The checkbox must be checked, as shown in the
diagram.

3 Destination database
Designates the database to which the data is registered. Click [Browse] and
select the database from the dialog box.

Select the database to which the data is to be registered and click [OK]. See
the Public Agent instruction manual for details about adding or deleting a
database in this list.

2-4
 2 Getting Started

4 Import folder
Sets the folder in which Public Agent monitors text files.
If the export folder was changed in the macro program of the ChemStation,
change this Import Folder setting to the same folder.

5 User name
Sets the user name registered in the database when data is registered.
If this item is set to "Register by login username," the user name currently
logged in to Public Agent is registered in the database when data is registered.

Click [OK] in the Assign Database per Instrument dialog box to complete the settings.
The Public Agent Configuration screen then appears as follows.

4) Click [Close] to close the Public Agent Configuration screen.

2.7 Analysis and Measurement

1) Create a sequence in ChemStation and analyze (or re-analyze). The result of analysis
is registered to the database of Agent at above setting.

2) Run Agent Manager and check the details of the registered data. See the Agent
Manager instruction manual for details.

2-5