Manual AA Gateway Agent
Manual AA Gateway Agent
Read this manual carefully before operating the software, and retain
it for future reference.
SHIMADZU CORPORATION
ANALYTICAL INSTRUMENTS DIVISION
KYOTO, JAPAN
Before Using CLASS-Agent Software
Thank you for purchasing CLASS-Agent Software. To get the most out of this software, read this
manual carefully before use.
This instruction manual describes how to use and operate “WizAArd text gateway” programs for
CLASS-Agent Software. It assumes that the user has a basic familiarity with Windows®
95/98/NT/2000 and experience using a personal computer.
The basic terminology used in Windows® 95/98/NT/2000 is used in this instruction manual to explain
procedures for using CLASS-Agent Software. For definitions of unfamiliar words, please refer to the
Windows® 95/98/NT/2000 manual or help file.
A first-time user of Windows® 95/98/NT/2000 should first obtain a basic level of understanding of the
operating system before reading this manual.
Software Restrictions
1. This Software is the proprietary property of the Shimadzu Corporation. Shimadzu Corporation
retains all rights to this Software.
2. No part of this Software may be copied or reproduced in any form or by any means, except for
installation and routine backup. No part of this Software may be leased, assigned, transferred,
recompiled 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 damage
arising out of the use or operation of this Software.
Contents
Chapter 1 Introduction
1.1 Features ........................................................................................................................1-1
1.1.1 Features of the WizAArd gateway Program.........................................................1-1
1.1.2 Features of the CLASS-Public Automatic Agent Program .................................1-1
1.1.3 Features of Agent Manager .................................................................................1-2
1.2 Handling Precautions........................................................................................................1-3
1.2.1 Before Using CLASS-Agent Software................................................................1-3
1.2.2 About the WizAArd gateway Program ................................................................1-5
1.2.3 About the Automatic Agent Program..................................................................1-5
1.2.4 About the Agent Manager Program ....................................................................1-6
Chapter 3 Operation
3.1 Introduction..................................................................................................................3-1
3.2 Main Screen .................................................................................................................3-2
3.3 Configuration Settings .................................................................................................3-3
3.3.1 Making the WizAArd Setting..............................................................................3-3
3.3.2 Making the Public Agent Setting ........................................................................3-4
3.4 Registration ..................................................................................................................3-5
3.4.1 Automatic Registration........................................................................................3-5
3.4.2 Manual Registration ............................................................................................3-5
Appendix 1 About the database registration of WizAArd data .............................................3-7
Appendix 2 About the source code of the AAText_Gw program ..........................................3-9
Chapter 1 Introduction
1.1 Features....................................................................................................1-1
1.1.1 Features of the WizAArd gateway Program .......................................................... 1-1
1.1.2 Features of the CLASS-Public Automatic Agent Program .................................... 1-1
1.1.3 Features of Agent Manager .................................................................................... 1-2
1.2 Handling Precautions ....................................................................................1-3
1.2.1 Before Using CLASS-Agent Software................................................................... 1-3
1.2.2 About the WizAArd gateway Program .................................................................. 1-5
1.2.3 About the Automatic Agent Program..................................................................... 1-5
1.2.4 About the Agent Manager Program ....................................................................... 1-6
1 Introduction
The WizAArd gateway program processes analysis data measured with WizAArd for AA-6800 to be
registered in a CLASS Agent database using CLASS-Public Agent.
The Agent Manager software that comes with CLASS-Public Agent makes it easier to view, print or
approve stored data, add sample information, copy data to other applications and restore analysis files.
CLASS-Agent software supports GLP/GMP-compliant security capabilities and log capabilities,
making it easier to audit the operations performed by users.
1.1 Features
1.1.1 Features of the WizAArd gateway Program
The WizAArd gateway program (AA_TxtGW. EXE) imports analysis data output from
WizAArd software to be registered in an Agent database.
1-1
1 Introduction
1-2
1 Introduction
1-3
1 Introduction
ElementA ElementB
1-4
1 Introduction
1-5
1 Introduction
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 the 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.
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 you require a password, 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.
1-7
Chapter 2 Getting Started
2.1 WizAArd Gateway Program Setup .........................................................2-1
2.2 Storing Data in a Database ......................................................................2-2
2.2.1 Starting the Automatic Agent Program .................................................................. 2-2
2.2.2 Logging In to the System ....................................................................................... 2-4
2.2.3 Specifying a Database for Each Instrument ........................................................... 2-5
2.2.4 Registering Analysis Data...................................................................................... 2-8
2 Getting Started
2-1
2 Getting Started
Flowchart of Operations
2-2
2 Getting Started
Click here.
Double-click here.
Double-click here.
2-3
2 Getting Started
Type a login ID and password in the text boxes. Regardless of the characters typed, only
asterisks (*) appear in the "Password" text box. The password must be correctly entered.
Passwords are case-sensitive.
Click the [OK] button. The login ID and password are checked against the ones recorded for the
user account. If they match the stored entries, the main screen is displayed under login status.
Clicking the [Cancel] button aborts a login attempt, but the main screen is displayed. To gain
access to the system, follow the login procedure from the main screen.
Command button
Menu list
Status bar
2-4
2 Getting Started
1) Click on the <Assign database per instrument> menu item in the <Menu List> pane, The
<Assign database per instrument> sheet appears in the right-hand pane. In CLASS-Public
Automatic Agent program, a maximum of 8 instruments can be connected. In the right-hand
pane, a database is assigned to each instrument.
- The <Assign database per instrument> pane. -
2) Double-click on “Instrument 1” in the first row of the <Assign database per instrument>
pane, or click on the “Instrument 1” row and then click on the [Edit] button. The <Assign
database per instrument> dialog box appears.
1) Instrument Name
By default, the system name is Instrument1. Any system name may be specified. Do not
leave the "Instrument Name" text box blank.
2-5
2 Getting Started
2) Register data
Click on the <Register data> check box so that it is turned on, as shown in the figure. If this
check box is off, any data is not stored in a database.
3) Destination database
In the <Destination database> list box, specify a database in which to store data. Clicking on
the [Browse] button opens the <Select Database> dialog box.
- The "Select Database" dialog box -
In the <Select Database> dialog box, click on “Test1.mdb” to specify the destination
database that you want to use, and then click on the [OK] button.
4) Import folder
In the "Import folder" text box, specify the same import folder name as the one specified in
the "Data File" text box in the "Default folder" tab of the [Options] dialog box of the Balance
Gateway program. Clicking the [Browse] button opens the "Folder Select" dialog box,
where an import folder name can be selected from a listing.
- The <Browse for Folder> dialog box. -
2-6
2 Getting Started
5) User Name
In the <User Name> list box, specify a user name that accompanies data information stored
in the selected database. If the <Registering by login user name> option is selected, the name
of a user who is now logging in will be recorded with data information in the selected
database.
Click on the [OK] button in the <Assign database per instrument> dialog box to finish the
setting. The contents of the <Assign database per instrument> pane is updated, as shown
below.
- The <Assign database per instrument> pane. -
2-7
2 Getting Started
2) Click [Status Display] in the [List] menu to view the status of database registration.
3) Start the WizAArd Gateway program and retrieve an analysis text file previously exported
from WizAArd. Use the [Browse] button to select the desired filename.
4) After WizAArd analysis data text is properly displayed, click the [Agent] button.
5) The status of file compression and registration is displayed in the "Status Display" pane.
2-8
Chapter 3 Operation
3.1 Introduction .............................................................................................3-1
3.2 Main Screen .............................................................................................3-2
3.3 Configuration Settings.............................................................................3-3
3.3.1 Making the WizAArd Setting ................................................................................ 3-3
3.3.2 Making the Public Agent Setting ........................................................................... 3-4
3.4 Registration..............................................................................................3-5
3.4.1 Automatic Registration .......................................................................................... 3-5
3.4.2 Manual Registration ............................................................................................... 3-5
Appendix 1 About the database registration of AA data ....................................3-7
Appendix 2 About the source code of the AAText_Gw program ......................3-9
3 Operation
3.1 Introduction
The WizAArd Gateway program is used to import analysis text files from WizAArd and export
a converted text files to Public Agent. The converted text files (measurement results files) are
stored in a database using the automatic registration function of the CLASS Agent system.
After the WizAArd Gateway program receives an analysis text file using the auto-start function
of WizAArd, the contents of the imported text file are converted to Agent format, and the
converted text file is stored in a predetermined export path. The stored text file is retrieved and
registered in a database. View, edit or print the registered analysis results using Agent Manager.
The WizAArd Gateway program supports version 2.1 or higher of the WizAArd software.
3-1
3 Operation
Operations
1) Double-click the [WizAArd Gateway] icon to open the main window.
2) Click the [Options] button to open the "Options" dialog box to make the configuration
settings.
3-2
3 Operation
Options:
• Import Folder This text box is used to specify a path from which an analysis text file is
imported from WizAArd.
• Automatically start WizAArd Gateway at analyze.
This check box is used to toggle the auto start of WizAArd on or off.
Procedure:
1) Select the desired options and click the [Set default to WizAArd] button. This will change
the settings stored in the WizAArd configuration setting file.
2) Click the [OK] or [Apply] button to save or update the changes made.
[NOTE] If any change is made to the WizAArd, restart the WizAArd program for the change
to take effect.
3-3
3 Operation
Options:
• Instrument No. (1 to 8) This text box is used to specify an instrument number (for
example, 1) stored in the text file to be registered for Public
Agent.
• Export Folder This list box is used to specify a path to which a text file is
exported to Public Agent.
• Delete exported results file This check box is used to specify whether to delete a WizAArd
after registration. exported text file after the registration is complete. If the box is
checked, the text file is deleted. If the box is not checked, the
text file is not deleted.
Procedure:
After selecting options, click the [OK] or [Apply] button to save or update the changes made.
[NOTE] As shown in the figure below, an export path must correspond precisely with an
import path specified in the instrument setting for Public Agent.
3-4
3 Operation
3.4 Registration
WizAArd Gateway provides two options: automatic registration and manual registration. For
automatic registration, register the contents of a text file by operating from WizAArd using
command lines. For manual registration, select a desired filename using the WizAArd Gateway
program.
Procedure
Conduct an analysis with WizAArd. For automatic registration, there is no need to use the
WizAArd Gateway program.
Procedure:
1) Start the WizAArd Gateway program.
2) Retrieve an analysis text file previously exported from WizAArd. Click the [Browse] button
in the WizAArd Gateway main window to select a filename from a listing in the file
selection list.
3) The contents of the selected text file are displayed in the “table” pane.
3-5
3 Operation
4) If the contents of the selected text file are correct, click the [Agent] button to register the text
file contents. After the registration is successfully completed, “Agent was completed” is
displayed in the "Message" field.
5) After the registration is successfully completed, click the [Exit] button to exit the WizAArd
Gateway program.
To register another text file, repeat Steps 2) though 4).
3-6
3 Operation
The WizAArd gateway program requests database storage from the Agent program using the
"request text file." At this time, the block information that is designated in the sample
information table is added to the data information table as one record per block. This
specification is valid for version 2.1 of WizAArd and higher.
3-7
3 Operation
Block Information
Data name Block judgment information WizAArd output item Default
Property 1 /P1= Action Null
Property 2 /P2= Position-(R expresses it) Null
Property 3 /P3= Text output line number Error
Long Data 1 /L1= X(X=1) Null
Long Data 2 /L2= M(M=1) Null
Long Data 3 /L3= Q(Q=1) Null
Long Data 4 /L4= Dilution coat flag Null
Long Data 5 /L5= Reagent 1 coat flag Null
Long Data 6 /L6= Reagent 2 coat flag Null
Long Data 7 /L7= Reagent 3 coat flag Null
Long Data 8 to 10 /L8= to /L10= Non Null
Double Data 1 /F1= True Value Null
Double Data 2 /F2= Concentration Null
Double Data 3 /F3= Absorbance Null
Double Data 4 /F4= Background Null
Double Data 5 /F5= Sample Volume Null
Double Data 6 /F6= Diluted solution Null
Double Data 7 /F7= Reagent 1 Null
Double Data 8 /F8= Reagent 2 Null
Double Data 9 /F9= Reagent 3 Null
Double Data 10 /F10= Total Volume Null
Double Data 11 /F11= WF Null
Double Data 12 /F12= VF Null
Double Data 13 /F13= DF Null
Double Data 14 /F14= ASC DF Null
Double Data 15 /F15= CF Null
Double Data 16 /D1= Actual Conc. Null
Double Data 17 /D2= %RSD Null
Double Data 18 /D3= SD Null
Double Data 19 /D4= %R Null
Double Data 20 /D5= C# Null
String data 1 /S1= Component name (Element name) Null
String data 2 /S2= Actual Conc. Unit Null
String data 3 /S3= Measurement date Null
String data 4 /S4= Sample ID Null
String data 5 /S5= Remark Null
3-8
3 Operation
The WizAArd gateway program is a small program that transfers text information that was
output from WizAArd software to database using Public Agent. The source code is provided as a
reference to allow the use of the Public Agent program with other analysis devices.
The source code is written using Microsoft Visual Basic Version 6 and can be found in the
following directory on the CD-ROM in the directory:
\AA_TXTGW\SRC\*.*
3-9