Empower AutoArchive
Software
Installation and Configuration Guide
NOTICE
The information in this document is subject to change without notice and should not be construed as a commitment by Waters Corporation. Waters Corporation assumes no responsibility for any errors that may appear in this document. This document is believed to be complete and accurate at the time of publication. In no event shall Waters
Corporation be liable for incidental or consequential damages in connection with, or arising from, the use of this document.
© 2002 WATERS CORPORATION. PRINTED IN THE UNITED STATES OF AMERICA. ALL RIGHTS RESERVED. THIS DOCUMENT OR PARTS THEREOF MAY NOT BE REPRODUCED IN ANY FORM WITHOUT THE WRITTEN PERMISSION OF THE PUBLISHER.
Millennium and Waters are registered trademarks, and Empower is a trademark of Waters Corporation.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
Table of Contents 3
Preface
... 8
Chapter 1
AutoArchive and Information Tracking ... 13
Chapter 2
Installing AutoArchive ... 14
2.1 Hardware and Software Requirements ... 14
2.2 Installing the AutoArchive Option ... 15
Chapter 3
Archiving Projects ... 17
3.1 Choosing a Database ... 17
3.2 Logging In ... 18
3.3 Setting AutoArchive Properties ... 20
3.3.1 Selecting Projects to Track... 21
3.3.2 Specifying the Storage Location of Archived
Files ... 22
3.3.3 Tracking Custom Fields... 25
3.4 Creating Sample Archives... 28
3.5 AutoArchive Cycle ... 29
3.6 Performing an Archive... 30
3.6.1 Using the Windows Scheduler ... 30
3.6.2 Manually Archiving a Project ... 36
3.7 System Audit Trail Entries, Error Messages, and
AutoArchive Status Codes ... 37
Table of Contents 4
3.7.1 System Audit Trail Entries ... 37
3.7.2 Error Messages ... 38
3.7.3 AutoArchive Status Codes ... 39
Chapter 4
Restoring Archived Projects Using the Wizard ... 43
Chapter 5
Archiving, Restoring, and Removing Records ... 48
5.1 Archiving Project and/or Sample Archive Records ... 48
5.2 Archiving and Removing Project and/or Sample
Archive Records ... 49
5.3 Restoring Archived Records ... 50
5.4 Removing Offline Records from the Table View... 51
Appendix A
List of Figures 5
2-1
Setup Executable... 16
2-2
Empower Option Setup Dialog Box ... 16
3-1
Select the Archival Database Dialog Box ... 17
3-2
Empower Login Dialog Box... 18
3-3
Empower Pro Window ... 19
3-4
Configuration Manager ... 20
3-5
AutoArchive Properties Dialog Box... 21
3-6
Archival Media Tab... 23
3-7
Login New Archive Media Dialog Box ... 24
3-8
Archive Media Tab with Label and Comments... 25
3-9
Custom Fields Tab ... 26
3-10
Add Custom Field to be Tracked Dialog Box... 27
3-11
Custom Field Test Results Dialog Box... 28
3-12
Create Sample Archives ... 29
3-13
Sample Life Cycle Chart ... 30
3-14
Scheduled Task Wizard ... 31
3-15
Scheduled Task Wizard - Second Page... 31
3-16
Select Program to Schedule Dialog Box... 32
3-17
Name and Frequency Page ... 33
3-18
Time and Day Page ... 33
3-19
Name and Password Page ... 34
3-20
Finish Page ... 35
3-21
Scheduled Tasks in Windows Explorer ... 35
3-22
Manual AutoArchive... 36
3-23
System Audit Trail ... 37
3-24
Message Center ... 38
3-25
View Filter Editor... 40
List of Figures 6
3-27
View Filter Editor - Sample Archives... 42
4-1
Restore Archive Wizard - Archive List Page ... 44
4-2
Project Name List Page ... 45
4-3
Media Page... 46
4-4
Progress Page ... 47
5-1
Save As Dialog Box ... 49
5-2
Archive and Remove Project/Sample Archive Dialog Box ... 50
List of Tables 7
2-1
Requirements for AutoArchive Client ... 14
3-1
AutoArchive Options ... 22
3-2
Project AutoArchive Status Codes ... 39
8
Preface
The Empower AutoArchive Software Installation and Configuration Guide is intended for system administrators or anyone who will be archiving projects or samples. This guide describes the basics of how to use the Empower™ AutoArchive software option. Using a standard set of data, this guide takes you through the steps of logging in, scheduling an archive, configuring AutoArchive parameters, archiving data, and restoring archived data.
Organization
This guide contains the following:
Chapter 1 provides an overview of the Empower AutoArchive software option and defines information tracking.
Chapter 2 describes how to install the AutoArchive option and defines hardware requirements and installation options.
Chapter 3 describes the AutoArchive process, including selecting an archival
database, configuring AutoArchive properties, scheduling an archive, and performing a manual archive.
Chapter 4 describes the AutoArchive retrieval process using the wizard. Chapter 5 describes archiving, removing, and restoring records. Appendix A describes sample and custom field tracking.
Related Documentation
Waters Licenses, Warranties, and Support: Provides software license and
warranty information, describes training and extended support, and tells how Waters handles shipments, damages, claims, and returns.
Online Documentation
Empower Help: Describes all Empower windows, menus, menu selections, and
dialog boxes for the base software and software options. Also includes reference information and procedures for performing all tasks required to use Empower software. Included as part of the Empower software.
Empower Read Me File: Describes product features and enhancements, helpful tips,
9
Empower LIMS Help: Describes how to use the Empower LIMS Interface to export
results and import worklists.
Empower Toolkit Professional Help: Describes how to use the common-object-
model, message-based protocol to communicate with the Empower software from a third-party application.
Printed Documentation for Base Product
Empower Software Getting Started Guide: Provides an introduction to the Empower
software. Describes the basics of how to use Empower software to acquire data, develop a processing method, review results, and print a report. Also covers basic information for managing projects and configuring systems.
Empower Software Data Acquisition and Processing Theory Guide: Provides
theories pertaining to data acquisition, peak detection and integration, and quantitation of sample components.
Empower System Installation and Configuration Guide: Describes Empower
software installation, including the stand-alone Personal workstation, Workgroup configuration, and the Enterprise client/server system. Discusses how to configure the computer and chromatographic instruments as part of the Empower System. Also covers the installation, configuration, and use of acquisition servers such as the LAC/E32 module, the busLAC/E™ card, and interface cards used to communicate with serial instruments.
Empower System Upgrade and Configuration Guide: Describes how to add
hardware and upgrade the Empower software using an import-and-export upgrade method.
Empower Software System Administrator’s Guide: Describes how to administer
the Empower Enterprise client/server system and Workgroup configuration.
Empower Software Release Notes: Contains last-minute information about the
product. Also provides supplementary information about specific Empower software releases.
Printed Documentation for Software Options
Empower System Suitability Quick Reference Guide: Describes the basics of
the Empower System Suitability option and describes the equations used by the System Suitability software.
10
Empower GC Software Getting Started Guide: Describes how to use the Empower GC option to develop a GC processing method and to review GC results.
Empower GPC Software Getting Started Guide: Describes how to use the Empower GPC option to develop a GPC processing method and to review GPC results.
Empower GPCV Software Getting Started Guide: Describes how to use the Empower GPCV option to develop a GPCV processing method and to review GPCV results.
Empower Light Scattering Software Getting Started Guide: Describes how to use the Empower Light Scattering option to develop a light scattering processing method and to review light scattering results.
Empower ZQ Mass Detector Software Getting Started Guide: Describes installation, configuration, calibration, and tuning methods, as well as how to operate the ZQ Mass Detector with Empower software.
Empower Chromatographic Pattern Matching Software Getting Started Guide: Describes how to use the Chromatographic Pattern Matching option to develop
a pattern matching processing method and to review pattern matching results.
Empower Dissolution System Software Quick Start Guide: Describes how to
operate the Alliance® Dissolution System using Empower software.
Empower Toolkit Programmer’s Reference Guide: Describes how to use the
common-object-model, message-based protocol to communicate with Empower software from a third-party application.
Waters Integrity System Getting Started Guide: Describes features of the Waters
Integrity® System and provides step-by-step tutorials that guide a user through the use of the Empower Mass Spectrometry (MS) option.
Empower AutoArchive Software Installation and Configuration Guide:
Describes how to install and configure the Empower AutoArchive option.
Documentation on the Web
Related product information and documentation can be found on the World Wide Web. Our address is http://www.waters.com.
Related Adobe Acrobat Reader Documentation
11
Printing This Electronic Document
Adobe Acrobat Reader lets you easily print pages, page ranges, or the entire document by selecting File > Print. For optimum print quantity, Waters recommends that you specify a PostScript® printer driver for your printer. Ideally, use a printer that supports 600 dpi print resolution.
Documentation Conventions
The following conventions can be used in this guide:
Convention Usage
Purple Purple text indicates user action such as keys to press, menu selec-tions, and commands. For example, “Click Next to go to the next page.”
Italic Italic indicates information that you supply such as variables. It also indicates emphasis and document titles. For example, “Replace file_name with the actual name of your file.”
Courier Courier indicates examples of source code and system output. For example, “The SVRMGR> prompt appears.”
Courier Bold Courier bold indicates characters that you type or keys you press in examples of source code. For example, “At the LSNRCTL> prompt, enter set password oracle to access Oracle.”
Underlined Blue Indicates hypertext cross-references to a specific chapter, section, subsection, or sidehead. Clicking this topic using the hand symbol brings you to this topic within the document. Right-clicking and selecting Go Back from the shortcut menu returns you to the origi-nating topic. For example, “Archived files can be stored on either a network drive or on some type of archive media as described in Section 3.3.2, Specifying the Storage Location of Archived Files.” Keys The word key refers to a computer key on the keypad or keyboard.
Screen keys refer to the keys on the instrument located immedi-ately below the screen. For example, “The A/B screen key on the 2414 Detector displays the selected channel.”
… Three periods indicate that more of the same type of item can optionally follow. For example, “You can store filename1, filename2, … in each folder.”
12
Notes
Notes call out information that is helpful to the operator. For example:
Note: Record your result before you proceed to the next step.
Attentions
Attentions provide information about preventing damage to the system or equipment. For example:
Cautions
Cautions provide information essential to the safety of the operator. For example:
STOP
Attention: To avoid damaging the detector flow cell, do not touch the flow cell window.
Caution: To avoid burns, turn off the lamp at least 30 minutes before removing it for replacement or adjustment.
Caution: To avoid electrical shock and injury, turn off the detector and unplug the power cord before performing maintenance procedures.
13
1
Chapter 1
AutoArchive and Information
Tracking
Empower™ AutoArchive software automates the project backup process and provides a mechanism to locate samples after they have been archived. You can easily retrieve archived data because samples are logged when they are generated and their location is tracked as they move through their life cycle. To simplify the search and retrieval process, additional project and sample archive views were added to Configuration Manager allowing tracking, searching, and retrieval of projects and their samples. You can either manually archive a project and samples, or schedule an archive task using the Windows® Scheduler.
AutoArchive is a separate option for Empower software and it is available for Empower Personal, Workgroup, and Enterprise configurations.
AutoArchive allows you to track project information, sample information, and sample custom fields. Tracking samples is the primary purpose of AutoArchive.
If archived samples are retrieved, the entire project is retrieved including: • All associated channels
• Injections • Methods
• A complete sample set • All results
• All result sets
Hardware and Software Requirements 14
2
Chapter 2
Installing AutoArchive
This chapter lists the hardware and software requirements for the AutoArchive option, and describes the software installation process.
Note: Before you install the AutoArchive option, ensure that the Empower software is installed.
2.1 Hardware and Software Requirements
Table 2-1 describes the AutoArchive client minimum hardware and software configuration. Table 2-1 Requirements for AutoArchive Client
Component Minimum
Computer with keyboard and mouse
Windows XP Professional: Intel
®Pentium
®II
(or equivalent), 333 MHz or Windows 2000
Professional
Random access memory (RAM)
256 MB
Hard disk drive
4 GB
Disk drive
3.5 inch, 1.44 MB
CD-ROM drive
Required
Monitor
Required
Graphics capability
Minimum: 800
×
600, 256 colors
Recommended: 1024
×
768, 64K colors
Printer
Any printer supported by Windows XP
Profes-sional or Windows 2000 ProfesProfes-sional
Operating system and graphical user
interface
Windows XP Professional or Windows 2000
Professional with Service Pack 2
Application software
Empower software
Installing AutoArchive 15
2
Drive
The client must support at least one read/write drive that is designated as the AutoArchive drive. The AutoArchive program uses this drive to store the archived data. You can retrieve archived data from any read/write or read-only drive capable of reading the archive media except tape drives.
Archive Client Database Support
An archive client supports autoarchives for only one database. If you have more than one database, you must purchase a separate AutoArchive option.
2.2 Installing the AutoArchive Option
The AutoArchive option is on a disk.
To install the Empower AutoArchive option:
1. Insert the Empower AutoArchive disk into the disk drive. In Windows Explorer, the Setup executable appears (Figure 2-1).
STOP
Installing the AutoArchive Option 16
2
Figure 2-1 Setup Executable
2. Double-click the Setup file. As the Setup executable runs, a message informs you that the option is initializing. The Empower Option Setup dialog box appears (Figure 2-2).
Figure 2-2 Empower Option Setup Dialog Box
3. Select the database that the AutoArchive client will support. For Empower Personal configurations, select Local, then click OK. For Empower Enterprise configurations, select the AutoArchive database, then click OK. A success message appears and the AutoArchive option is now installed on the designated AutoArchive client.
Choosing a Database 17
3
Chapter 3
Archiving Projects
This chapter describes how to configure the AutoArchive option and archive a project and sample. It also explains the archive cycle.
3.1 Choosing a Database
You must first choose the database that the AutoArchive client will support. To choose the AutoArchive database:
1. Select Start > Programs > Empower > SetArchive Database. The Select the Archival Database dialog box appears (Figure 3-1).
Figure 3-1 Select the Archival Database Dialog Box
2. From the Database list, select the database where your project and sample data reside. For an Empower Personal workstation, select Local.
Archiving Projects 18
3
3. Select the Password Protect this Dialog check box.
4. Enter a password (minimum four characters).
5. Reenter the password for confirmation, then click OK.
The next time you run the Set Archive Database executable, the Please Enter Password dialog box appears and prompts you to enter a password.
3.2 Logging In
Note: This guide uses the Empower Pro interface. If you do not have access to this interface, see your system administrator.
To log in to Empower software:
1. Start Empower software, by selecting Start > Programs (for Windows XP, All Programs) > Empower > Empower Login. The Empower Login dialog box appears (Figure 3-2).
Figure 3-2 Empower Login Dialog Box
2. Enter your user name and password. If you do not know your user name or password, see your system administrator.
3. If you are using an Empower Enterprise or Workgroup system, select the correct database from the Database list. This list appears only when you are connected to an Enterprise or Workgroup system.
4. Click Advanced and verify that the Requested Interface field is set to Pro. If you cannot select the Empower Pro interface, see your system administrator.
STOP
Attention: Waters recommends that you password protect the Select the Archival Database dialog box. Password protection ensures that only one person designates the archival database.
Logging In 19
3
5. Click OK. The Empower Pro window appears (Figure 3-3).
Figure 3-3 Empower Pro Window
Archiving Projects 20
3
Figure 3-4 Configuration Manager
Note: Four new views are added to Configuration Manager when the AutoArchive option is installed: Project Archives, Sample Archives, Offline Project Archives, and Offline Sample Archives. See Chapter 5, Archiving, Restoring, and Removing Records, for more information about these views.
3.3 Setting AutoArchive Properties
Before you can archive projects and samples, you must set these AutoArchive properties in the AutoArchive Properties dialog box:
• How to select projects to be tracked
Setting AutoArchive Properties 21
3
When a project is archived, the information stored on the archive media is the same information that is stored in an Empower project backup. The archive media contains a raw data tree that is similar to the Empower raw data tree, but contains a separate directory for each project archive performed on that media. When AutoArchive runs, the system performs the archive cycle as specified in the AutoArchive Properties dialog box, General Tab. AutoArchive archives the following files:
• .exp (a file copy of the database for a project)
• .inf file (the setup information required to restore a project back into the database) • .dat files (sample raw data files; e.g., d10004.dat, where 1004 is the channel ID)
Note: Not all projects contain raw data files.
The AutoArchive Properties dialog box has three tabs: General, Archival Media, and Custom Fields (Figure 3-5). To view this dialog box, in Configuration Manager, select View > AutoArchive Properties.
3.3.1 Selecting Projects to Track
The General tab (Figure 3-5) consists of a check box to turn AutoArchive on or off and the AutoArchive Options section.
Archiving Projects 22
3
Enabling AutoArchive
To enable AutoArchive, select the Enable AutoArchive check box. If you clear this check
box and schedule an AutoArchive through the Windows Scheduler, the AutoArchive will not be performed. You must select this check box to perform both scheduled and manual archives.
Specifying AutoArchive Options
The AutoArchive Options section allows you to specify which projects are archived and how often they are archived. Table 3-1 describes each scenario.
Selecting Multiple Projects to AutoArchive
Note: Select the Enable AutoArchive check box to perform AutoArchives. You can perform AutoArchive on multiple projects by:
1. In Projects view of Configuration Manager, select the AutoArchive check box for the first project that you want to AutoArchive.
2. Press Ctrl-D, all projects below the selected row in the Projects table are selected for AutoArchive.
Note: To select multiple continuous rows of data, click the first row in the block, press Shift, then click the last row in the block. All rows in the block are highlighted. To select multiple noncontinuous rows of data, press Ctrl while clicking the number of each row. Each row is highlighted.
3.3.2 Specifying the Storage Location of Archived Files
Use the Archival Media tab (Figure 3-6) to designate the storage location of the archived data files. Archived files can be stored on either a network drive or on some type of archive media. If you store the archived project and samples file on local media, you should supply a volume label.
Table 3-1 AutoArchive Options
Archive Setting
Archive Projects
Setting Result
All Always Archives every project in that database.
Setting AutoArchive Properties 23
3
Figure 3-6 Archival Media Tab
To select the storage location for archived projects and samples:
1. From the Drive list, select the drive where the data will be stored. The Drive field identifies:
• The drive letter
• The type of device: media, local, or remote network location • The volume label
If you choose a media drive, and there is no media in the drive, the selection appears as “not ready” (e.g., E:\CD-RW not ready means the CD Read/Write drive on drive E is not ready because a CD is not in the disk drive).
Note: If you insert an unformatted CD into the disk drive, the drive does not appear in the list. Format the CD, insert it into the drive, and the drive will appear in the list. When you select a drive, the current volume label appears in two places: as part of the Drive path and in the Current Volume Label field (Figure 3-7). As the system reads the current volume label, it determines the space available on the media for writing and displays it as a percentage in the progress indicator.
Archiving Projects 24
3
Figure 3-7 Login New Archive Media Dialog Box
Note: If the Current Volume Label field does not appear, the volume was not labeled. If archives have not been written to a media type archive drive and you want to label the volume, you can enter the new label in the Current Volume Label field. If you want to label the volume and this is not a media drive, you can label it using Windows Explorer. Select the drive, right-click Properties, and enter the volume label in the Label field.
3. Enter a current volume comment to describe the archived projects on the media (e.g., Aug. 02 Dissolution Projects).
Note: You must provide a comment for archive media. The volume label and comment cannot be changed in this dialog box after archives are written to the media.
4. Click OK. The Logged in Volume Label now matches the current volume label and the volume now contains a comment (Figure 3-8).
STOP
Setting AutoArchive Properties 25
3
‘
Figure 3-8 Archive Media Tab with Label and Comments
Archive Media and Progress Indicator
When you log in new media, the amount of free space is determined and displayed in the progress indicator. At the beginning of each project archive, the AutoArchive executable determines the amount of free space available on the archive media. If there is enough free space on the media for this project, (10 MB is added to the estimated requirement to ensure success), this project is AutoArchived. If there is not enough space on the media, the AutoArchive process for this project stops and a message is sent to the System Audit Trail. The AutoArchive process then continues and archives any project that fits on the archive media.
Refresh
If you click Refresh, the system rereads and redisplays the current volume comment, volume label, and the size.
3.3.3 Tracking Custom Fields
Archiving Projects 26
3
Figure 3-9 Custom Fields Tab
Projects can contain sample custom fields. A sample custom field can be used in multiple projects and tracked. The Custom Fields tab shows all sample custom fields that are currently being tracked.
In this tab, you can add, remove, and test a custom field that is being tracked.
Note: You cannot remove the SampleName custom field from the list. To add a custom field:
Setting AutoArchive Properties 27
3
Figure 3-10 Add Custom Field to be Tracked Dialog Box
2. Select a project from the Project list. All sample custom fields associated with the project you specified appear.
3. Select a custom field from the Custom Fields in Selected Project list.
4. Click OK. The AutoArchive Properties dialog box reappears with the custom field you just added.
5. Click OK to close the AutoArchive Properties dialog box. The sample custom field will now be tracked and can be added to your customized Sample Archives view filter.
Archiving Projects 28
3
Figure 3-11 Custom Field Test Results Dialog Box To remove a custom field and prevent it from being tracked:
1. In the Custom Fields tab of the AutoArchive Properties dialog box, select the custom field from the Custom Fields Being Tracked list.
2. Click Remove. It will no longer be tracked in the Sample Archives table.
3.4 Creating Sample Archives
After you install AutoArchive, samples that are created or processed will automatically appear in the Sample Archives view of Configuration Manager. You must capture the samples that were on your system before you installed AutoArchive by using Create Sample Archives.
To create sample archives:
1. From Configuration Manager, select the Projects view, then select the project(s) for which sample archives should be created.
AutoArchive Cycle 29
3
Figure 3-12 Create Sample Archives
3.5 AutoArchive Cycle
In an AutoArchive cycle, the system makes one pass to determine if a project requires archiving. When a project is archived, information is stored in a new subdirectory on the archive media. This subdirectory contains a database export file, a project information file, and raw data files.
Archiving Projects 30
3
changes to archived. The sample’s data can be retrieved based on the information stored during the last archive. Figure 3-13 shows the life cycle of a sample.
Figure 3-13 Sample Life Cycle Chart
3.6 Performing an Archive
Two ways to perform an archive are:
• Scheduled, using a task in the Windows Scheduler • Manually, using the Manual Archive option
3.6.1 Using the Windows Scheduler
To access the Scheduler:
1. Select Settings > Control Panel > Scheduled Tasks > Add Scheduled Tasks. The Scheduled Task Wizard appears (Figure 3-14).
Performing an Archive 31
3
Figure 3-14 Scheduled Task Wizard
2. Click Next. The second page of the Scheduled Task Wizard appears (Figure 3-15).
Archiving Projects 32
3
3. Click Browse and browse to the path that contains the Empower\Bin directory. The Select Program to Schedule dialog box appears (Figure 3-16).
Figure 3-16 Select Program to Schedule Dialog Box
Performing an Archive 33
3
Figure 3-17 Name and Frequency Page
5. Enter autoarchive as the name of the task to be performed. Click the frequency (daily, weekly, monthly, etc.) that you want to run the AutoArchive executable, then click Next. The Time and Day page appears (Figure 3-18).
Archiving Projects 34
3
6. Specify the Start time, how often to run the AutoArchive executable, and the day(s) of the week (depending on the frequency you chose on the previous page). Click
Next. The Name and Password page appears (Figure 3-19).
Figure 3-19 Name and Password Page
Performing an Archive 35
3
Figure 3-20 Finish Page
8. Click Finish. The Windows Scheduler adds the AutoArchive task, which can be viewed in Windows Explorer (Figure 3-21).
Archiving Projects 36
3
3.6.2 Manually Archiving a Project
You can manually archive a project at any time. To manually archive a project:
1. From Configuration Manager, select Projects, then click the row number to select the projects that you want to archive.
Note: To select multiple continuous rows of data, click the first row in the block, press Shift, then click the last row in the block. All rows in the block are highlighted. To select multiple noncontinuous rows of data, click the first row, press Ctrl, then click the next row. Continue Ctrl-clicking until the desired rows are selected. Selected rows are highlighted.
2. Right-click and select Manual Archive. AutoArchive archives the selected project(s) (Figure 3-22).
Note: To perform manual archives, you must have the Backup Projects privilege.
Figure 3-22 Manual AutoArchive
STOP
Attention: Before you perform a manual archive, ensure the archive media is properly logged in and available in the archive media drive. See
System Audit Trail Entries, Error Messages, and AutoArchive Status Codes 37
3
3.7 System Audit Trail Entries, Error Messages, and
AutoArchive Status Codes
Every action in the archive process is audited: the start of the archive process, status of each project archive, and the end of the process. If the archive process fails, an error message does not appear during the archive process to inform you that something has gone wrong. To determine the success or failure of the archive process, check the System Audit Trail and Message Center.
3.7.1 System Audit Trail Entries
To determine if your archive was successful, from Configuration Manager, select System Audit Trail (Figure 3-23).
Figure 3-23 System Audit Trail
Each time AutoArchive is run, the system documents every action of the process. If the AutoArchive process succeeds, these messages appear in the System Audit Trail:
• Started AutoArchive Process
Archiving Projects 38
3
Unsuccessful messages include these: • Unmatched Volume Labels • AutoArchive turned off
• User cancelled archive process • And so on
3.7.2 Error Messages
To determine if there was an error with the AutoArchive process, check the Message Center.
The Message Center starts, and appears as a blue icon in the system tray whenever an Empower application, such as QuickStart or Configuration Manager, starts.
Note: If an error message was logged, the color of the message Center icon will be red. To access the Message Center, double-click the Message Center icon in the system tray at the bottom of the window (Figure 3-24).
Figure 3-24 Message Center
System Audit Trail Entries, Error Messages, and AutoArchive Status Codes 39
3
3.7.3 AutoArchive Status Codes
The codes in Table 3-2 describe the success or failure of the AutoArchive process. The Archive Status column is available in the Project Archives and Sample Archive views.
Table 3-3 describes the sample life cycle during the archive process.
View Filters
View filters allow you to control the display and sorting of information in a Configuration Manager view.
Installing the AutoArchive option provides access to new fields in the Projects view filter. To monitor the archival process, you must create a customized view filter for the Projects view. The default view filter in Configuration Manager does not show the archive status or any archival information.
To create a customized view filter, click Edit View in Configuration Manager while in the Projects view. The View Filter Editor appears (Figure 3-25).
Table 3-2 Project AutoArchive Status Codes
Status Code Definition
Completed
Successfully
An AutoArchive cycle completed successfully.
User Cancelled
During the AutoArchive cycle, the user selected Cancel.
Completed with
Errors
The AutoArchive cycle completed with errors which may be
listed in the System Audit Trail or in the Message Center.
In Process
An AutoArchive is currently in process.
Table 3-3 Sample Life Cycle Status Codes
Archive Status Definition
On-Line
The project containing this sample is currently online.
On-Line/Archived
The project containing this sample is currently online and has
gone through an AutoArchive cycle.
Archiving Projects 40
3
Figure 3-25 View Filter Editor
The Type list has five view filter types that contain AutoArchival fields: Projects, Project Archives, Sample Archives, Offline Project Archives, and Offline Sample Archives. When you create a customized view filter, the fields you choose appear in Configuration Manager. Create a customized view filter for the Projects view to monitor the archival process. Project Archives and Sample Archives have a default view filter and do not require customizing.
For information about creating view filters, see the Empower Help.
System Audit Trail Entries, Error Messages, and AutoArchive Status Codes 41
3
Figure 3-26 Last7Days View Filter
The Last7Days view filter displays projects archived within the last seven days in the Project Archives view and samples acquired (not archived) in the last seven days in the Samples Archives view. Last7Days view filter is an example of how to customize view filters by using conditions. For more information about creating conditions in a view filter, see Empower Help.
Archiving Projects 42
3
43
4
Chapter 4
Restoring Archived Projects
Using the Wizard
After archiving a project, you can retrieve it whether or not it is an active project. A project must have an archive status (Project Archives view in Configuration Manager) of
Completed Successfully to be completely restored.
Samples associated with a project(s) can have the following archive status: • On-Line (before Archive)
• On-Line/Archived (after Archive) • Archived (project deleted)
If a sample has an Archive ID, it is an archived sample. You cannot archive and restore individual samples. You archive samples by archiving the project which archives all individual samples associated with the project. When you restore a project or sample, all individual samples from that project are also restored.
Note: You must have the Restore Archives privilege to restore archived projects or samples.
To restore archived projects or samples using the wizard:
1. From Configuration Manager, select the Project Archives or Sample Archives
view, then select the projects or samples to restore. Right-click and select Restore Project(s) from Archive or Restore Sample(s) from Archive. The Restore Archive Wizard - Archive List page appears and lists all stored media you will need in order to restore the selected data (Figure 4-1).
Restoring Archived Projects Using the Wizard 44
4
Figure 4-1 Restore Archive Wizard - Archive List Page
45
4
3. Ensure that you have the archive media containing the projects and samples that you want to restore, then click Next. The Project Name List page appears (Figure 4-2).
Figure 4-2 Project Name List Page
This page allows you to rename the Retrieved Project Name. To rename the retrieved archive name, delete the current name and enter a new one.
Restoring Archived Projects Using the Wizard 46
4
4. Click Next. The Media page appears (Figure 4-3).
Figure 4-3 Media Page
The volume label and comment of the project you are restoring must match the volume label and comment on the current archival media. If the volume label and comment do not match, you cannot restore the project or samples until the proper media is selected and available.
47
4
6. Click Next. The Progress page appears (Figure 4-4). This page displays the progress of each project restoration.
Figure 4-4 Progress Page
7. Click Finish when the process is complete. If there are more projects scheduled for retrieval, the remainder of the projects on this media are retrieved. If another drive or media is required, the Restore Archive Wizard - Media page appears to verify the next archive source and the restoration process continues. The projects are now available and can be viewed in the Projects view in Configuration Manager.
STOP
Attention: For a multiple-project restoration, AutoArchive retrieves each project one at time and displays which project it currently has open
Archiving Project and/or Sample Archive Records 48
5
Chapter 5
Archiving, Restoring, and
Removing Records
The AutoArchive option creates these four Configuration Manager views: Project Archives, Sample Archives, Offline Project Archives, and Offline Sample Archives. The Records menu in Configuration Manager contains these commands:
• Project/Sample Archive > Archive
• Project/Sample Archive > Archive and Remove • Offline Project/Sample Archives > Clear
• Offline Project/Sample Archives > Restore Offline Archives
Using the Project/Sample Archive command, you can archive or archive and remove records. Over time the Sample Archives table can become quite lengthy with archived records. To clear the Project Archives and Sample Archives views, you can archive or archive and remove project and sample archives. Archiving backs up records in the project and sample archive views in a binary or text format. The Archive and Remove command removes project and sample records that were previously deleted from the database by a specified archive date.
From the Offline Project/Sample Archives command, you can clear or restore offline records. If you create an archive file of project and sample records in binary format, you can restore the archived records and view them in Offline Project Archives or Offline Sample Archives view in Configuration Manager. The records are offline because they are a snapshot of the records that were archived; they are not updated. Clearing offline records removes all entries from both the Offline Project Archives or Sample Archives view simultaneously.
5.1 Archiving Project and/or Sample Archive Records
Note: You must have the Remove Sample Archives privilege to perform this function. To archive project and/or sample archive records:
1. From Configuration Manager, select Records > Project/Sample Archive > Archive. Or in the Project Archives or Sample Archives view, right-click and select
Archiving, Restoring, and Removing Records 49
5
backed up archives as text files, select Text. The Save As dialog box appears (Figure 5-1).
Figure 5-1 Save As Dialog Box
Note: Only records stored in binary format can be restored to the Offline Project Archives and Offline Sample Archive view in Configuration Manager. Text files cannot be restored. Binary format is recommended.
2. Select the folder for the archived file. The default folder is Empower > Restore. Empower software supplies a file name for your archived file that includes today’s date. You can change this file name, but you cannot change the file extension. 3. Click Save.
5.2 Archiving and Removing Project and/or Sample
Archive Records
The Archive and Remove command removes project and sample records that were previously deleted from the database by a specified archive date.
Note: You need the Remove Sample Archives privilege to perform this function. To archive and remove project and sample archive records:
Restoring Archived Records 50
5
Figure 5-2 Archive and Remove Project/Sample Archive Dialog Box
2. Select the type of file to create when archiving and removing the records: Binary or Text.
3. Specify the date to archive in order for the system to remove all records created before that date.
4. Click OK to access the Save As dialog box.
5. Select the folder for the archived file. Empower software supplies a file name for your archived file that includes today’s date. You can change this file name, but you cannot change the file extension.
6. Click Save. If you choose to save the archived records as text files, a message informs you that you should archive the text file information to a secure location. 7. Click OK.
5.3 Restoring Archived Records
Note: You need the Clear/Restore Offline Archives privilege to perform this function. To restore a project and sample archive records from a binary file:
Archiving, Restoring, and Removing Records 51
5
Figure 5-3 Restore Offline Project Archives Dialog Box 2. Select the archived files that you want to restore, then click Open.
3. The offline archive file is restored and can be viewed in the Offline Project Archives or Offline Sample Archives view.
Note: You can restore a project from the Offline Project Archives or Offline Sample Archives view. Select project(s) or sample(s) from the Offline Project Archives or Offline Sample Archives table, right-click and select Restore Projects or Sample(s) from Archive. The Restore Archive wizard appears and allows you to restore the projects and samples, (see Chapter 4, Restoring Archived Projects Using the Wizard).
5.4 Removing Offline Records from the Table View
Note: You need the Clear/Restore Offline Archives privilege to perform this function. To remove all entries from the Offline Project Archives or Offline Sample Archives view:
1. From Configuration Manager, select Records > Offline Project/Sample Archives > Clear. Or in either the Offline Project Archives or Offline Sample Archives view, right-click and select Clear.
Tracking Samples and Custom Fields 52
A
Appendix A
Tracking Samples and
Custom Fields
This appendix further describes the sample and custom fields tracking process in AutoArchive.
Samples
AutoArchive tracks samples, not injections, as they move through their life cycle. If you delete an injection from a sample set that contains multiple injections with the same name, the status of the sample appears as both Online/Archived and Archived. Normally the status of a sample would not be Archived until the sample is deleted. If you want to restore the deleted injection, you must restore the last autoarchive of the project.
Custom Fields
When you select a custom field to be tracked and later remove the custom field from the project, it will appear in the Sample Archives table until you remove it from the Custom Fields to be Tracked dialog box.
Changes to Custom Fields
Index 53
I
N
D
E
X
A
Adding custom fields
26 Archival Media tab
22
progress indicator
25 Archive cycles
29 Archive media
current volume label
23 free space available
25 logging in new media
23 selecting
23 Archive process progress indicator
25 status codes
43 Archived samples definition
13 restoring
43 Archiving manually
36
project or sample archive records
48 using Windows 2000 Scheduler
30 AutoArchive custom fields
25 cycles
29 database
15 drive requirements
15 error messages
38 files archived
21 hardware requirements
14 information tracking
13 installing
14
,
15 logging in18 options
22 process
17 properties
20 restoring projects
43 scheduling an archive
30 status codes
39 views
20
,
48AutoArchive option, installing
15 AutoArchive properties
Index 54
I
I
N
D
E
X
D
Database AutoArchive15 choosing
17 Documentation conventions
11 related
8 Drive requirements
15
E
Empower Login dialog box
19 Empower Pro window
19 Enabling AutoArchive
22 Error messages
AutoArchive
38 System Audit Trail
37
H
Hardware requirements, AutoArchive client
14
I
Information tracking13 Installing AutoArchive
14
,
15 AutoArchive option15
L
Life Cycle chart
30
Logging in to AutoArchive
18 Login defaults
18
Login New Archive Media dialog box
23
M
Manually archiving projects
36 enabling
22
Message Center messages
37 Multiple projects, restoring
43 Multiple samples, restoring
43
O
Offline files, restoring
49 Options, AutoArchive
22
P
Password protection18 Password, default
18 Progress indicator
25 Projects restoring
43 restoring multiple
43 Properties, AutoArchive
20
R
Refreshing the display
25 Related documentation
8 Removing
custom fields
28
projects or sample archives
49 Requirements
hardware
14 software
14
Restore Archive Wizard
43 Restoring
Index 55
I
I
N
D
E
X
S
Sample archives, creating
28 Sample Life Cycle chart
30 Samples
restoring multiple
43 status
43
Scheduled archives
22 Scheduled Task Wizard
30 Selecting
archive media
23 database
17 Software
installing AutoArchive option
15 requirements
14
Space, available
25 Status codes
archive process
43 AutoArchive
39
System Audit Trail messages
37 System password
18
T
Tasks, scheduling
30 Testing custom fields
27
Tracking sample custom fields