Automated Submission for Analysis Processing (ASAP) Operator s Guide 2002 Dionex Corporation Document No. 031843 Revision 01 May 2002
2002 by Dionex Corporation All rights reserved worldwide. Printed in the United States of America. This publication is protected by federal copyright law. No part of this publication may be copied or distributed, transmitted, transcribed, stored in a retrieval system, or transmitted into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, manual, or otherwise, or disclosed to third parties without the express written permission of Dionex Corporation, 1228 Titan Way, Sunnyvale, California 94088-3603 U.S.A. DISCLAIMER OF WARRANTY AND LIMITED WARRANTY THIS PUBLICATION IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND. DIONEX CORPORATION DOES NOT WARRANT, GUARANTEE, OR MAKE ANY EXPRESS OR IMPLIED REPRESENTATIONS REGARDING THE USE, OR THE RESULTS OF THE USE, OF THIS PUBLICATION IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, CURRENTNESS, OR OTHERWISE. FURTHER, DIONEX CORPORATION RESERVES THE RIGHT TO REVISE THIS PUBLICATION AND TO MAKE CHANGES FROM TIME TO TIME IN THE CONTENT HEREINOF WITHOUT OBLIGATION OF DIONEX CORPORATION TO NOTIFY ANY PERSON OR ORGANIZATION OF SUCH REVISION OR CHANGES. TRADEMARKS CHROMELEON is a trademark and PeakNet is a registered trademark of Dionex Corporation. Windows is a trademark of Microsoft Corporation. Adobe Acrobat Reader is a registered trademark of Adobe Corporation. PRINTING HISTORY Revision 01, May 2002
Contents Starting ASAP...2 The Main ASAP Screen...3 Sample Status...3 Sample Status Details...4 Messages...4 Buttons...5 Submitting Samples for Processing...6 Logging On...6 Entering Samples...7 Enter Sample Page Details...8 Viewing and Editing the Sample List...10 Loading Samples...11 To Load Samples...11 Load Sample Page Details...12 Finishing Sample Submissions...14 Canceling Sample Submissions...14 Sample Reports...15 About ASAP Sample Processes...15 Glossary...17 Doc. 031843-01 5/02 i
ASAP Operator s Guide ii Doc. 031843-01 5/02
ASAP Operator s Guide Automated Submission for Analysis Processing (ASAP) provides a simplified user interface for running analyses on CHROMELEON or PeakNet 6 controlled instruments. ASAP lets you easily acquire and process sample data and receive reports. Knowledge of CHROMELEON or PeakNet 6 software is not required. Although ASAP s user interface is simplified, the analyses performed using ASAP can be as complex as those run directly from CHROMELEON or PeakNet 6. These analyses can include high-performance liquid chromatography, ion chromatography, mass spectrometry, or any other type supported by CHROMELEON or PeakNet 6. This guide includes instructions for submitting samples for processing, viewing the status of samples that have been submitted, and receiving reports. NOTE The Automated Submission for Analysis Processing (ASAP) Administrator s Guide (Document No. 031844) describes the tasks necessary for setting up and maintaining ASAP. Notes on using this guide: If you are viewing this guide in Adobe Acrobat Reader, you can click a cross-reference, table of contents entry, or index entry to go to the referenced page. You can also click an italicized glossary term to go to the definition of the term. Doc. 031843-01 5/02 1
ASAP Operator s Guide IMPORTANT The CHROMELEON or PeakNet 6 server must be running before ASAP is started, and it must remain running to allow continuous communication between ASAP and CHROMELEON or PeakNet 6. Check the CHROMELEON icon on the Windows status bar to determine whether the server is running. The color of the icon indicates the server status: A green icon indicates that the server is running and active. A gray icon indicates that the server is running and idle. A red X over the icon indicates that the server is stopped. If this icon appears, start the server by right-clicking the icon and selecting Start Server. If no CHROMELEON icon appears on the status bar, the Server Monitor program is not open. The Server Monitor is used to start, stop, and monitor the chromatography server. To start the Server Monitor, click the Start button on the Windows taskbar, select Programs>Chromeleon (or Programs>PeakNet), and click Server Monitor. The Server Monitor window should appear and display the server status. If the server is not running, click the Start button. After the server is running, click the Close button to close the window. The green or gray CHROMELEON icon will appear on the Windows status bar. Starting ASAP To start ASAP, first make sure the CHROMELEON or PeakNet 6 server is running (see the IMPORTANT box above). Then, click Start on the Windows taskbar and select Programs>ASAP>ASAP. This opens the main ASAP screen. 2 Doc. 031843-01 5/02
The Main ASAP Screen The Main ASAP Screen The main ASAP screen displays the status of samples submitted for processing. It also displays system and administrator messages and provides buttons for accessing all other ASAP features. NOTE If ASAP is installed on a PC without an ASAP licensing code, the main ASAP screen will show the sample status, as described below. However, all other ASAP features, including the Sample Submission and Administrator buttons, will be disabled. Selected System Sample Status The table at the top of the main ASAP screen displays the status of the samples in the sample queue. Only the sample queue for the system to which ASAP is currently connected is shown at one time. The box above the table identifies the name of the currently connected system. To see the status for another system (if more than one is available), select it from the list. In the example below, the table shows the sample status for a system named DEMO. System s Sample Queue NOTE Unless the system is reserved for ASAP use only, the sample queue will also contain samples submitted directly from CHROMELEON or PeakNet 6. The Sample ID for these samples is External ASAP Batch Job. ASAP checks sample status every two minutes and updates the list if needed. At the start of each day, the samples completed on the previous day are removed from the list. Pending samples remain until they are completed. Doc. 031843-01 5/02 3
ASAP Operator s Guide Sample Status Details Sample ID User Name Status The Sample ID uniquely identifies each sample submitted to ASAP. It consists of the sample name entered when the sample was submitted, followed by a time stamp and a unique number assigned by ASAP. The format for the time stamp is: HHMMSS. Displays the Logon ID of the operator who submitted the sample. Displays the current status of the sample in the queue. A sample can have one of the following statuses: Pending the sample is waiting to be processed Running the sample is currently being processed Finished the sample processing is completed Injected/Total Displays the number of injections that have been processed, followed by the total number of injections to be processed for the sample. Because most ASAP samples are single injections, the field typically displays 0/1 if a sample is pending, or 1/1 if a sample is running or finished. Messages System Messages Administrator Messages ASAP automatically generates these messages during operation. Each message has a date and time stamp. System messages remain on the list until midnight of the day they were posted. The ASAP administrator can post messages here to inform operators about ASAP-related issues. These messages remain on the screen until the administrator removes them. 4 Doc. 031843-01 5/02
The Main ASAP Screen Buttons Opens the ASAP Sample Wizard, which guides you through the sample submission process. This button is available only if the PC on which ASAP is installed has an ASAP licensing code and the administrator has performed the required setup steps (see the Administrator button). Opens the ASAP Administrator dialog box. An administrator logon ID and password are required. Before you can begin submitting samples to ASAP, the administrator uses the Administrator dialog box to set up ASAP and establish communication between ASAP and CHROMELEON or PeakNet 6. Details about the administrator s functions are in the ASAP Administrator s Guide (Document No. 031844). This button is enabled only if the PC on which ASAP is installed has an ASAP licensing code. Minimizes the ASAP screen. IMPORTANT: To ensure continuous communication between ASAP and CHROMELEON or PeakNet 6, ASAP should remain running even when you are not using it to submit samples or monitor sample status. Doc. 031843-01 5/02 5
ASAP Operator s Guide Submitting Samples for Processing To begin submitting samples for processing, click the Sample Submission button on the main ASAP screen. This starts the ASAP Sample Wizard, which guides you through the sample submission steps. These include: Logging On (see below) Entering Samples (see page 7) Viewing and Editing the Sample List (see page 10) Loading Samples (see page 11) Finishing Sample Submissions (see page 14) Logging On The ASAP Sample Wizard begins with the Logon Page. To log on, enter the Logon ID and password assigned to you by the ASAP administrator. If the administrator did not set up user accounts, enter your Windows user name in the Logon ID field, or if Windows security is not enabled, enter any desired user name. A password is not required. If you encounter any problems logging on, contact your ASAP administrator. Logging on prevents unauthorized users from submitting samples to ASAP. In addition, because ASAP can be customized for individual operators or groups of operators, logging on identifies the operator and allows ASAP to display the information relevant to that operator. 6 Doc. 031843-01 5/02
Submitting Samples for Processing Entering Samples The second page of the Sample Wizard (the Enter Sample Page) lets you add samples one at a time to a list of samples to be submitted for processing. 1. (Optional) Enter a project ID. 2. Enter a sample name. 3. Select a process to run. 4. Enter a parameter value (or keep the default). 5. Click to add the sample. 6. Click to view the submitted samples. NOTE The sample process and process parameter shown above are examples only. The processes and parameters available to you depend on how your administrator set up ASAP. Process parameters are not always assigned to a process. Doc. 031843-01 5/02 7
ASAP Operator s Guide Enter Sample Page Details Project ID (optional) Sample Name By the Process Called The Project ID (if entered) appears before the sample name in reports. Each sample submitted to ASAP must be given a name. The sample name appears in reports and in the status displayed on the main ASAP screen. Lists the process parameteres available for analyzing samples. See About ASAP Sample Processes on page 15 for details. The type and number of sample processes available depends on how the administrator set up ASAP. To select a process, click the double-arrow next to the By the Process Called box to cycle through the choices. As you select each process, its description is shown in the box below the process name. See the following example. to select from a drop- You can also click the down-arrow down list of processes. with the Process Parameters Add Sample Lists the parameters that can be changed for each sample. These parameters are determined by the administrator and are based on the type of analysis being performed. If the administrator does not assign process parameters, this table is empty. Initially, default values for each parameter are shown. To change a value, select it and enter the new value. Adds the sample to the list to be processed. 8 Doc. 031843-01 5/02
Submitting Samples for Processing Resubmit Sample Number of Samples Submitted View Sample List Next> Resubmits a sample that is already in the list of samples to be processed (see Viewing and Editing the Sample List on page 10). Displays the total number of samples submitted during this session of the Sample Wizard. Samples that were submitted during previous sessions of the Sample Wizard are not included in the list, even if they have not yet been processed. Opens the Sample List, which shows the samples currently waiting to be submitted for processing (see Viewing and Editing the Sample List below). Takes you to the Load Page of the Sample Wizard. This button becomes available after at least one sample has been added to the sample list. Doc. 031843-01 5/02 9
ASAP Operator s Guide Viewing and Editing the Sample List After you add one or more samples on the Enter Sample Page, you can click the View Sample List button to see the samples currently waiting to be submitted for processing. From here, you can review the list and decide whether any changes are required. To add another sample, click the Add button. This returns you to the Enter Sample Page, where the project ID, sample name, sample process, and default process parameter of the sample currently selected in the Sample List are filled in. Enter a new sample name and change any other parameters as needed. Click the Add Sample button. To change the project ID, sample name, or process parameter value(s) of a sample, select it in the list and click the Modify button. This returns you to the Enter Sample Page. Change settings as required and then click the Resubmit Sample button. To select a different process for a sample, click the Delete button to delete it from the list. Then, click the Add button and submit the sample again, selecting the correct process. 10 Doc. 031843-01 5/02
Submitting Samples for Processing To delete a sample, select it in the list and click the Delete button. Click the Close button to return to the Enter Sample Page. Loading Samples Clicking Next> on the Enter Sample Page opens the Verify and Load Page. To Load Samples 1. The Vial Positions column shows the autosampler position assigned to each sample. Note the assigned positions, or click the Print Sample Information button to print a list of the samples and their autosampler assignments. 2. Take the samples to the autosampler and load them into the assigned positions. Doc. 031843-01 5/02 11
ASAP Operator s Guide 3. After loading the samples, select the All Samples are in Autosampler check box. 4. (Optional) Click the desired e-mail option button and enter the address(es) where the e-mail should be sent. Note: E-mail options are not available in all ASAP installations. 5. Click the Next> button to go to the Finish Page. Load Sample Page Details Sample list The table at the top of the page shows the samples that will be sent for processing. The following information is given for each sample: Project ID the project ID from the Enter Sample Page. Sample Name the sample name from the Enter Sample Page. System the system on which the sample will be run. Vial Positions the position(s) assigned to the sample in the autosampler. Typically, ASAP samples are single injections and a single vial position is shown. However, in some cases (for example, calibration samples) multiple injections are processed from a sample. In this case, the field indicates the range of positions assigned to each sample s injections. 12 Doc. 031843-01 5/02
Submitting Samples for Processing Inj # table Lists the injections for the sample currently selected in the sample list, the autosampler position assigned to that injection, and the type of sample (Unknown, Standard, Blank, etc.). This table is of interest mainly for samples with multiple injections. The following example shows a standard sample, which has four injections to be processed. Notice that a separate vial position is assigned to each injection. ASAP does not process multiple injections from the same vial. All Samples are in Autosampler Print Sample Information E-mail Options <Back Next> Select this check box after you have loaded all of the samples in the autosampler. This enables the Next> button and allows you to go on to the Finish Page. Prints out the list of samples and their autosampler assignments. E-mail Notification Only sends a status report when the sample is completed. E-mail Notification with PDF sends the status report with a PDF file of the sample data results attached. Note: These options are available only if the administrator enabled e-mail functions when setting up ASAP and if Microsoft Outlook is installed and running on the PC. Returns you to the Enter Sample Page. The last values that were last entered in the Enter Sample Page are displayed. Takes you to the Finish Page. Doc. 031843-01 5/02 13
ASAP Operator s Guide Finishing Sample Submissions Click Finish> on the last page of the Sample Wizard to complete the sample submission procedure. ASAP sends the samples to CHROMELEON or PeakNet 6 for processing. When the samples are successfully sent, the Sample Wizard closes. You are then logged out of the ASAP Sample Wizard and returned to the main ASAP screen. To submit additional samples, click the Sample Submission button on the main ASAP screen. Canceling Sample Submissions You can click the Cancel button on any of the Sample Wizard pages to stop sample submission. If no samples are in the sample list, clicking Cancel immediately logs you out of the Sample Wizard and returns you to the main ASAP screen. If one or more samples have been added to the list, a message box asks whether to discard the sample list. Selecting Yes immediately logs you out of the Sample Wizard and returns you to the main ASAP screen. Samples in the list are not saved. Selecting No returns you to the Sample Wizard. NOTE To cancel a sample that is already in the system s sample queue, contact the ASAP administrator. 14 Doc. 031843-01 5/02
Sample Reports Sample Reports Results from sample processing are provided in reports that can either be printed or sent to you via e-mail. The ASAP administrator defines the content and format of the reports; these include chromatograms, mass spectra, peak identification information, calibration information, and numerous other items. For questions about a report s content, see your ASAP administrator. To receive reports via e-mail, select the E-mail Notification with PDF Attachment option on the Sample Load Page (see Loading Samples on page 11). About ASAP Sample Processes When submitting a sample for processing with ASAP, you select from one or more predefined sample processes. The ASAP administrator creates the processes and makes them available to ASAP. Each process includes commands and parameters for injecting a sample, acquiring sample data, processing the sample data, and generating reports. Specifically, a sample process includes the following main elements: System definition Each process is created for a particular set of analytical instruments (the system). When you submit a sample and select a process, ASAP assigns the sample to run on the system for which the process was created. Additionally, ASAP assigns the sample to a specific position in the system s autosampler tray or rack. Sample preparation A process can include parameters for preparing the sample before injection. For example, autosampler commands for diluting the sample can be included. Sample definition A sample definition includes the sample type (unknown, standard, validation, etc.), the volume of sample to be injected, and whether to correct data for Doc. 031843-01 5/02 15
ASAP Operator s Guide dilution or weight. The name entered from the ASAP Sample Wizard is also part of the sample definition. Analytical process definition An analytical process definition includes commands and parameters for controlling the system and acquiring the sample data. For example, process commands often include the pump flow rate, when to inject the sample, and when to start and stop data acquisition. Many other commands, specific to the type of analysis being performed, are possible. When you submit a sample, you can change the default values of certain process parameters to values appropriate for your sample. See Enter Sample Page Details on page 8. The administrator determines which parameters can be changed. Data analysis definition A data analysis definition includes parameters for identifying the substances within a sample (peak identification) and for calculating the amount or concentration of these substances in the sample (peak calibration). Report definition A report definition includes parameters for reporting the results after data is acquired and analyzed. 16 Doc. 031843-01 5/02
Glossary process parameter An operating parameter that the ASAP operator can change the value of when submitting a sample for processing. The ASAP administrator determines the process parameters, based on the type of analysis being performed. For example, for mass spectrometry analyses, a process parameter named mass can be used to specify the minimum and maximum mass-to-charge ratio (m/z) window for extraction online during data acquisition. sample process All of the commands and parameters necessary for analyzing a sample, including those for injecting a sample, acquiring sample data, processing sample data, and generating reports. sample queue system A list of samples that have been submitted to a system for processing. The queue includes samples submitted for processing by ASAP; it can also include samples submitted directly from CHROMELEON or PeakNet 6. The queue is shown on the main ASAP screen. One or more instruments set up to perform sample analyses. Instruments in the system vary, depending on the type of analysis. For example, a system for performing protein separations might include an autosampler, a pump, and a photodiode array detector. All instruments in a system are synchronized to run on a common clock. Doc. 031843-01 5/02 17
ASAP Operator s Guide 18 Doc. 031843-01 5/02
Index A Adding samples, 7, 10 Administrator messages, 4 Analytical process commands, 16 ASAP licensing, 5 ASAP Sample Wizard, 6, 7, 8, 10, 11, 12, 14 Autosampler, 11 Autosampler range, 12 Autosampler vial positions, 12 C Canceling samples, 14 Commands, 16 Completed samples, 3 D Data analysis, 16 Deleting samples, 11, 14 E E-mail, 13, 15 Enter Sample Page, 7 Entering samples, 7 I Inj #, 13 Injections, 12, 15 L Loading samples, 11 Logging on, 6 M Main ASAP screen, 3 Messages, 4 Modifying samples, 10 Multiple injections, 13 P Parameters, 8, 16 PDF report, 15 Peak identification, 16 Pending samples, 3, 4 Printing, 11, 15 Process, 8, 15 Process parameters, 8, 16 Project ID, 8, 12 R Reports, 15, 16 Running samples, 4 S Sample ID, 4 Sample list, 10, 12 Adding a sample, 8, 10 Deleting a sample, 11 Sample loading, 11 Sample name, 8, 12 Sample preparation, 15 Sample processes, 4, 15 Selecting, 8 Sample queue, 3 Sample reports, 15 Sample submission, 5, 6, 7 See also Sample Wizard Doc. 031843-01 5/02 Index-1
ASAP Operator s Guide Sample Wizard, 6 Cancelling, 14 Entering samples, 7 Finishing, 14 Loading samples, 11 Logging on, 6 Viewing the sample list, 10 Standard samples, 13, 15 Starting ASAP, 2 Status Sample processes, 4 Submitting samples, 6 System, 3, 15 System messages, 4 U Unknown samples, 13, 15 User name, 4, 6 V Viewing the sample list, 10 Index-2 Doc. 031843-01 5/02