3705-03 - Getting - Started - With - OXSAS (2009)

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 20

OXSAS

Spectrometer Analysis Software


Getting Started
AA83705
Product Name OXSAS Analysis Software
Manual Name Getting Started Guide
Manual N° AA83705
Revision index -03
Date May 2009

The information in this document is subject to change without notice.


We assume no responsibility for any errors that may appear in this
document.
Table of Contents

1 GETTING STARTED WITH OXSAS 1-1


INTRODUCTION 1-1
SOFTWARE INSTALLATION 1-1
About Software Installation 1-1
Case Studies 1-2
System Requirements 1-3
Install Third Party Software 1-3
SPC Option 1-3
UniQuant / OptiQuant Option 1-3
Installing OXSAS Software and its Components 1-4
Restoring the OXSAS Databases 1-5
Install the Instrument Backup software 1-5
Restore the OXSAS Databases Set Up in Factory 1-5
Restore your Backup of the OXSAS Databases 1-6
Update your OXSAS Databases 1-6
RE-INSTALLING OXSAS 1-7
Uninstall the Existing Version of OXSAS 1-7
OXSAS Re-Installation 1-7
UPDATING OXSAS SOFTWARE 1-8
Checking Current OXSAS Software Version 1-8
Login to Update Section of OXSAS Web Site 1-8
Getting Latest Update for your OXSAS Version 1-8
Install the OXSAS Update 1-8
STARTING OXSAS 1-9

2 USING OXSAS CONTEXTUAL HELP 2-1


LAUNCHING THE CONTEXTUAL HELP 2-1
USING THE CONTEXTUAL HELP 2-2
NAVIGATING THE HELP SESSION 2-3
PRINTING HELP TOPICS 2-4
GETTING STARTED GUIDE
Getting Started with OXSAS

1 GETTING STARTED WITH OXSAS

Introduction
Welcome to OXSAS, the software to operate your ARL spectrometer.
We hope that OXSAS software will meet your expectation and give you
satisfaction throughout the life of your instrument.
This document intends to guide you in your first steps with OXSAS: it
explains how to install the software for the case you did not receive it
loaded on a computer supplied from ARL factory, how to start using the
software and how to get help while you use it.
Moreover, it provides useful information regarding updating OXSAS from
Internet and other topics of interest.
We wish you a pleasant work with OXSAS!

Software Installation

About Software Installation


Proceed as follows for installing the software:
1. Check on OXSAS web site (www.oxsas.com) if a newer version of
this “Getting Started Guide” is available for download (see “Updating
OXSAS Software” section for more details).
Note: It is highly recommended to always use the last version of
this “Getting Started Guide” for installing or updating OXSAS.
2. Check if your computer complies with the minimal specifications
(see the “System Requirements” section).
3. Check on OXSAS web site if a newer version of Installation Tips is
available for download.
Note: It is highly recommended to always use the last version of
Installation Tips for installing or updating OXSAS.
4. Apply the Installation Tips settings to the computer.
5. Logon to Windows with an Administrator level account.
6. Install Third Party software, if supplied with your system (see the
“Install Third Party Software” section).
7. Install OXSAS software and its components from installation CD (see
the “Installing OXSAS Software and its Components” section).
8. Restore OXSAS databases (see “Restoring the OXSAS Databases”
section).
9. Udpate OXSAS software with latest version available from Internet
(see the “Updating OXSAS Software” section).

AA83705 Getting Started Guide 1-1


Getting Started with OXSAS
Note: Not all operations of OXSAS software installation procedure must
be achieved in all cases. Please refer to the ”Case Studies” section below
in order to know exactly what you need to perform according to your
specific case.

Case Studies
This table shows the different situation that may occur at customer site as
well as the necessary actions prior use of OXSAS.

If… and if the Then and then…


computer OXSAS
is … software
Case

supplied is already
Go directly to the
1. by Thermo installed
"Starting OXSAS"
Electron on the
section.
factory computer
• Follow the instruction
Initial
Must be in “Installing OXSAS
installation not
installed Software and its
on user site supplied
2. on-site on Components” section.
by Thermo
computer • Follow instruction in
Electron
provided “Restore the OXSAS
factory
by user Databases Set Up in
Factory” section.
• Follow the instruction
in “Re-Installing
OXSAS” section.
If it needs
3. Note: There is no
unchanged to be re-
need to restore the
Re- installed
databases as they
installation were not removed
after use on during OXSAS
site (last removal.
database
• Follow the instruction
backup shall replaced, in “Installing OXSAS
be restored) the hard Software and its
disk has Needs to Components” section.
4. been re- be re-
formatted installed • Follow the instruction
or in “Restore your
replaced Backup of the OXSAS
Databases” section.

Note: in any of the case above (original installation, re-installation, etc.)


always check that Installation Tips settings are correct on the computer.

1-2 Getting Started Guide AA83705


Getting Started with OXSAS
System Requirements
OXSAS software runs under the Microsoft® Windows® XP professional
operating system and is delivered on one CD-ROM. It requires the following
minimum computer configuration:

• Windows® XP professional service pack 2 with latest Windows


updates and hot-fixes.

• Pentium 4 processor, 2.0 GHz or with equivalent performance.

• 1 Gigabyte RAM (recommended: 2 Gigabyte for better user-


comfort).

• 10 Gigabyte hard disk free space.

• CD-ROM drive.

• 1280 x 1024 display resolution.

• Mouse.

• Keyboard.

• 1 free serial port RS-232.

• 3 free USB port (depending on options).

• 1 network interface.

Install Third Party Software


Some of OXSAS options (UniQuant/OptiQuant, SPC ) uses third party
package. These packages, if supplied with your system, must be installed
before OXSAS, except the KTM that must be installed after OXSAS.
Please refer to the documentation supplied with the third party software for
a detailed explanation on how to install these packages.

Note: Third Party software packages must be installed from an


administrator account.
SPC Option

During installation of SPC-Light software, in the “Custom File Location”


dialogue, we recommend to enter the following path in the Part Dir. field:
“[Data Path]\OXSAS_Data\SPC”.

Note: See the “Installing OXSAS Software and its Components” section
for explanation on [Data Path].

UniQuant / OptiQuant Option

After installation of UniQuant software, start it and press on Full Mode


button, then press on Path button and modify the Path of int. files to
import from parameter to "[Data path]\OXSAS_Data\UQ".

AA83705 Getting Started Guide 1-3


Getting Started with OXSAS

Installing OXSAS Software and its Components


The OXSAS software and components are supplied on a CD-ROM.

Note1: You have to install OXSAS from an administrator account.

Note2: You have to apply the Installation Tips settings to the computer
prior installing OXSAS. Some of those Installation Tips settings must be
applied after OXSAS installation.
To install OXSAS:
1. Login to your computer with administrator rights.
2. Apply Installation Tips settings.
Note: the Installation Tips file can be found on the OXSAS
installation CD-ROM as well as on the OXSAS web site.
3. Insert the CD-ROM.

• If your CD-ROM drive is configured to start automatically, OXSAS


setup will open automatically.

• Otherwise double-click on <CD-ROM drive>:\setup.exe. The


OXSAS - Installation Wizard window opens. Wait while the
Wizard prepares the setup.
4. In the 'Welcome' dialogue Click on Next to continue. The 'Select
Destination path' dialogue opens.
5. If you want to install OXSAS in another folder than the default one,
click on Change... in the “Destination Location” dialogue and
browse for the new destination.

Note: It is recommended to keep the default folder settings.


6. Click on Next to continue. “The Select DATA path” dialogue opens.
7. If you want to select another path for the OXSAS data than the
default one, click on Change and browse to the new destination.
This path also defines where scan spectra, QuantAS spectra, energy
profiles, integrated profiles, etc. are stored.

Note 1: The selected path is ignored if, at the end of the installation
process, you restore a database that contains already a path for these
data.

Note 2: It is recommended to keep the default path settings. However, if


you select another location, note that it is mandatory to use local drives
for accessing your data.

Important: Do not use the same path for the application and the
data!
8. Click on Next to continue. The wizard is ready to begin installation.
9. Click on Install to continue. A progress bar shows the progression
of the installation. Once the installation is finished, a new dialogue
1-4 Getting Started Guide AA83705
Getting Started with OXSAS
box opens, confirming that the InstallShield Wizard has successfully
installed OXSAS.
10. Click on Finish.

• If .NET FrameWork 2.0 is not present on your PC, installation is


launched now and you have to click on Next, accept the license
agreement and wait until the end of the installation.

• If CrystalReport is not present on your PC, the installation of


CrystalReport business object is launched now. Wait until the end
of the installation.
11. Click on Yes to restart the PC when prompted for.

Restoring the OXSAS Databases


Depending on the situation (see “Case Studies”), you may need to restore
the databases set up in factory or your last databases backup.

Note: When copying files from a CD-Rom to another location on a hard


disk, the copied files keep their “Read-Only” attribute. This “Read-Only”
attribute must be removed in order to allow handling the files.

Install the Instrument Backup software

Note: You have to install Instrument Backup from an administrator


account.
Instrument Backup is a software allowing performing easily the OXSAS
database’s and related files backup and restore operations.
1. On the OXSAS installation CD, double-click on “<CD-ROM Drive>\
Tools\Disk1\Backup.exe” file.
2. Follow on-screen instruction to install Instrument Backup.

Restore the OXSAS Databases Set Up in Factory

Note: Perform this operation in the installation case 2 (see the “Case
Studies” section).
1. Insert the OXSAS database backup CD-ROM supplied with your
instrument.
2. Start Instrument Backup.
3. Press on the “Restore” button.
4. In the “List of available backup” dialog, press on the “…” button.
5. In the “Browse for folder” dialog, select the “<CD-Rom
Drive>\<Computer Name>\<Date>” folder then press OK button.
6. Back in the “List of available backup” dialog, select the zip file
containing the backup done in QA.

Note: The QA backup file is always named according to following


scheme: “Computer name_yyyymmdd_hhmmss.zip”.

AA83705 Getting Started Guide 1-5


Getting Started with OXSAS
7. Press on “Restore” button then on “OK” button in the confirmation
dialog box.
8. At the end of the restore, a message box is displayed; press on “OK”
button.
9. Press on “Quit” button then on “Exit” button.
10. Start OXSAS application as described in the "Starting OXSAS"
section.
11. Once OXSAS is started, check the parameters that define the paths
for some data file of OXSAS (scan spectra, QuantAS spectra, energy
profiles, integrated profiles, etc.). Select the menu Tools - System
Options - System Preferences. Adapt the path definitions if
required. Call the Contextual Help for instructions (press ! key).

Restore your Backup of the OXSAS Databases

Note: Perform this operation in the installation case 4 (see the “Case
Studies” section).
Perform the same operations as for the restoration of the factory database
but take note that:
• You need to use your own backup media instead of the backup CD
supplied with your instrument.
• If needed, copy the backup files of Scan Spectra, QuantAS Spectra,
Energy Profiles, Integrated Profiles, etc. from your backup location.
The name of target directories can be different if you changed them.

Update your OXSAS Databases


In some cases, typically in the installation case 2 or after the installation of
an OXSAS update, the version of the OXSAS software that you have
installed can be newer than the version corresponding to the OXSAS
databases (either the ones set up in the factory, or your own backup).
In such a case, you might be prompted to update your OXSAS databases
after Starting OXSAS. You need to confirm each database update by
pressing on the Yes button when the “Confirm” dialogue is prompted. The
update of the databases is then done automatically.

Note 1: The database update process can take several minutes to


complete for each databases. Do not interrupt the process as long as
the mouse pointer is showing the hourglass shape.

Note 2: The “Confirm” dialogue is prompted only for the databases


requiring an update.

Note 3: The databases update (if required) is done as following:


1. OXSAS_DB (main configuration database).
2. ANAPOOL (recent analyses results database).
3. ARCHIVE (long time storage results database).
4. LngMgtOXSAS (Texts translation database).

1-6 Getting Started Guide AA83705


Getting Started with OXSAS

Re-Installing OXSAS

Note: Before starting the re-installation of OXSAS, you need to backup


your Configuration, Result databases (ANAPOOL and ARCHIVE
databases) and the OXSAS Language database if you customized or
translated the OXSAS software texts.

Uninstall the Existing Version of OXSAS


Prior to re-install the OXSAS software you have to uninstall the existing
version. Proceed as follows:
1. Open the Control Panel.
2. Double-click on Add/Remove Programs.
3. Choose the OXSAS item.
4. Click on Change/Remove.
5. Confirm the message to remove definitively the program and all
items.
6. Delete “C:\Program Files\Thermo” folder and sub-folders.

OXSAS Re-Installation
1. Reboot the computer.
2. Apply the last Installation Tips settings
Note: check on OXSAS web site if a newer version of Installation
Tips is available for download.
3. Insert the OXSAS CD-ROM and proceed with the installation of the
OXSAS Software as explained in “Installing OXSAS Software and its
Components” section.
4. Download and install the last update for OXSAS as described in the
“Updating OXSAS Software” section.

Note: This step must be performed before to start using OXSAS software
since the version of your current database is most probably no longer
compatible with the OXSAS software version supplied with the CD-ROM.
In some cases, you might be asked to update your databases after
starting OXSAS. In such a case, proceed as explained in section “Update
your OXSAS Databases.

AA83705 Getting Started Guide 1-7


Getting Started with OXSAS

Updating OXSAS Software


You can update your OXSAS software by downloading and installing
updates from our OXSAS Support Web site at http://www.oxsas.com/
If your OXSAS version is older than the maintenance version available on
the OXSAS Support Web site it is worth updating your system. Updates
primarily addresses known issues and frequently offers new functions.

Note: Check also in the “Getting Started” section of the OXSAS web site
if a newer version of this “Getting Started Guide” is available for
download.

Checking Current OXSAS Software Version


In OXSAS, select Help - About. Read the "Application Software Version"
number. It is composed of a four digit code: M.m.s.b
M, m are the major and minor version number. s is the support version
number. b is an internal code number for Thermo use only.

Login to Update Section of OXSAS Web Site


Enter username and password that has been provided with your system or
follow instructions on the OXSAS Support Web site to request it.

Note: The password is case sensitive.

Getting Latest Update for your OXSAS Version


1. In the Update section, click on the “OXSAS Version Update” article.
2. Make sure that M.m.s part of the version number is higher than
your current application software version.
3. Click on the “OXSAS_Update_M.m.s.b.exe” attachment to download
it on your computer.

Note: the “About” dialogue of OXSAS indicates the “Licensed version”;


that version corresponds to the M part of the version, which is the one
delivered with the instrument or through our Upgrade department.

Install the OXSAS Update


Follow instructions of the Update section on the OXSAS web site in order
to update your OXSAS version then start OXSAS.
If you are prompted to update your databases, proceed as explained in
the “Update your OXSAS Databases” section.

1-8 Getting Started Guide AA83705


Getting Started with OXSAS

Starting OXSAS

Note: Before the first start of OXSAS software, we recommend you to


check if there is a newer OXSAS version available for download. See the
“Updating OXSAS Software” section).
By default, there are two ways to start OXSAS from Windows:
1. Double click on the OXSAS shortcut icon on the desktop.
OR
From the Windows Start menu, select Programs - Thermo -
OXSAS and click on OXSAS.
At the end of the startup of OXSAS, the Login dialogue will be
displayed. At installation the software is automatically set up with a
!MANAGER! and a !USER! account. By default these two accounts
have no password.
2. In the 'User Name' field, enter !MANAGER!.
3. Click on OK. You are now logged in OXSAS.

Important: For security reasons, we strongly recommend you to provide


real passwords for these default accounts and to create dedicated
accounts for your staff. Please refer to the Contextual Help for more
details.

AA83705 Getting Started Guide 1-9


Using OXSAS Contextual Help

2 USING OXSAS CONTEXTUAL HELP

Launching the Contextual Help


OXSAS is supplied with an integrated Contextual Help.
To launch the Contextual Help:

• From the main menu, select Help - Help. The help opens on the
'Welcome' page.
OR

• From any dialogue in OXSAS, press the ! key. This opens the
topic of the currently active window or open dialogue box.
To get the maximum benefit from the Contextual Help, it is good to
familiarize yourself with the different ways to use the help to get answers
to your questions.

Note: There is no printed user manual for this product. The contents you
might look for in a user guide book, as for example, explanations,
descriptions and procedures are included in books of the Contextual Help.
Each Help topic may be printed individually (see the “Printing Help
Topics” section).

AA83705 Getting Started Guide 2-1


Using OXSAS Contextual Help

Using the Contextual Help


The Contextual Help is designed to be context-sensitive. This means that
when pressing the ! key from any dialogue of the software, you call the
corresponding help topic.
However, the Contextual Help contains several features that help you
becoming familiar with OXSAS and finding information on a special subject:
Contents tab:
Basically, the order of help topics follows the OXSAS menu structure. To
open a book, click on its title or on the + sign to the left of the book. A
book contains either further books or help topics. To show the content of a
help topic, click on the corresponding title.
Shortcuts for navigating in the table of contents:
Shortcut Description
Enter Open the selected item.
Up and Down arrows Select the previous or next element.
Left and Right arrows Expand or collapse the selected item.

Search tab:
This tab allows searching for a special keyword. As a result, a list of topics
containing the searched keyword is displayed. To display a topic from the
list, double-click on it or select it and click on Display.
Browse Sequences:
The Contextual Help contains several browse sequences that serve as
tutorials. You will find step-by-step procedures for accomplishing different
tasks with OXSAS.

2-2 Getting Started Guide AA83705


Using OXSAS Contextual Help

Navigating the Help Session


The Help system maintains a history of your Help session so that you can
go back and forth quickly among the topics you open.

• You can use the Back arrow button on the Help toolbar to return
to topics you opened earlier in your Help session.

• Right-click anywhere in a topic. A contextual menu opens. Click


on Back to return to topics you opened earlier in your Help
session.
Click on Forward to move forward again in your Help session
history.

When you close the Help, you end your Help session. This deletes your Help
history.

AA83705 Getting Started Guide 2-3


Using OXSAS Contextual Help

Printing Help Topics


You can print any individual topic from the Contextual Help.

Note: Each topic must be printed individually. You cannot print multiple
topics at a time or entire help sections from the Help window.
To print a Help topic:
1. Open the Help topic that you want to print.

2. In the Help toolbar, click on Print.

OR
Right-click anywhere in the topic to open the contextual menu and
select Print.... The 'Print' dialogue opens, allowing to select a
printer and the number of copies.
3. Click on Print in order to start printing.

2-4 Getting Started Guide AA83705

You might also like