Professional Documents
Culture Documents
Trademarks
Copyright © Waters Corporation 2012-2015 All Rights Reserved.
This document contains information that is proprietary to Waters Corporation.
The original recipient of this document may duplicate this document in whole or
in part for internal business purposes only, provided that this entire notice
appears in all copies. In duplicating any part of this document, the recipient
agrees to make every reasonable effort to prevent the unauthorized use and
distribution of the proprietary information.
The information in this guide 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 Help system.
This Help system 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.
ACQUITY, ACQUITY UPLC, Empower, MassLynx, UNIFI, UPLC, and Xevo,
“THE SCIENCE OF WHAT’S POSSIBLE.”, and Waters are registered trademarks
of Waters Corporation.
Microsoft, Internet Explorer, Windows, and Windows 7 are registered trademarks
of Microsoft Corporation in the United States and/or other countries.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Watson and Integration Manager are trademarks of Thermo Fisher Scientific
Corporation.
Other trademarks or registered trademarks are the sole property of their
respective owners.
Contacting Waters
Contact Waters® with enhancement requests or technical questions regarding the
use, transportation, removal, or disposal of any Waters product. You can reach us
via the Internet, telephone, or conventional mail.
Internet The Waters Web site includes contact information for Waters
locations worldwide.
Visit www.waters.com
Telephone From the USA or Canada, phone 800 252-4752, or fax 508 872
and fax 1990.
For other locations worldwide, phone and fax numbers appear in
the Waters Web site.
Conventional Waters Corporation
mail 34 Maple Street
Milford, MA 01757
USA
Updated information
Refer to the Waters web site (Service & Support > Support > Support Library) for
any updates to this guide.
Trademarks iii
Customer comments iv
Contacting Waters iv
Preface v
1 Introduction 13
System overview 13
Workstation system 13
UNIFI Network system 14
System administration 17
System administrator qualifications 17
Deleting an LND 38
Network considerations 41
Server software 42
Server software 42
Windows Server operating systems 42
Oracle database ASM 42
10 Troubleshooting 89
Additional help 89
Waters Technical Support 89
Isolating problems 90
Recommendations 90
Reporting problems 90
Resolving issues 93
Resetting a device 95
Replacing an LND 95
A Log Forms 97
System overview
There are two types of UNIFI® systems: workstation and a UNIFI network.
Workstation system
The Waters UNIFI workstation system consists of the following components:
Workstation Purpose
components
UNIFI Control instruments and devices to acquire, analyze, process, and
software report data, and to perform other information management
functions.
Database Stores the metadata or descriptive information about the samples
run (processed results, sample identifiers, methods, and reports), in
a relational database management system (RDBMS). Raw data are
also stored in the database. When you install or upgrade software,
the Waters Database Manager (WDM) application is automatically
installed. The application, which runs in a browser, helps you
manage the database by viewing database backups, managing
database storage, and viewing alert notifications.
Workstation Standalone computer that runs on the Microsoft® Windows® 7
Professional or Enterprise SP 1, 64-bit operating system (OS).
Workstation Purpose
components
Waters Groups of chromatographic instruments and mass spectrometers
instrument that you create to form an instrument system. These systems,
systems which connect to a workstation, perform chromatographic (LC) and
mass spectrometric (MS) analyses.
For example, a UNIFI instrument system based on Waters UPLC
technology can include solvent manager, sample manager, column
manager, one or more detectors, chromatographic columns, and an
e-SAT/IN module. For MS analyses, its configuration can include a
Xevo mass spectrometer.
A single UNIFI workstation can support one or two instrument
systems, depending on the type of detector used. It can support one
instrument system that includes a quadrupole mass spectrometer
or a time-of-flight (TOF) mass spectrometer. A workstation can
support two instrument systems when each system includes an
optical detector, such as a PDA or TUV detector.
UNIFI Purpose
Network
components
UNIFI Controls instruments and devices to acquire, analyze, process, and
software report data, and to perform other information management
functions.
Application Hosts the UNIFI software application and the database. The
database server runs on Windows 2012 Standard Server R2, 64-bit
server operating system.
Stores the metadata or descriptive information about the samples
run (processed results, sample identifiers, methods, and reports)
in a relational database management system (RDBMS). Raw data
are also stored in the database. When you install or upgrade
software, the Waters Database Manager software is automatically
installed. Waters Database Manager is a database application that
runs in a browser and helps you manage the database by viewing
database backups, managing database storage, and viewing alert
notifications.
UNIFI software utilizes Oracle® Automatic Storage Management
(ASM) feature as part of the embedded solution for disk
management (data files, redo logs, control files) on physical
internal or external disks like a storage area network (SAN) disk.
The Fast Recovery Area is a file-based system that is a repository
for database backup and recovery files.
Virtualization Deploy a UNIFI application/database server on a VMware vSphere
support virtualization platform. You must configure the virtualized
application/database server to mimic a physical server.
Utilizing a virtualized UNIFI application/database server
improves the efficiency and availability of resources and
applications within your workplace.
Laboratory Collects all data acquired by Waters instrument systems, running
network on the Microsoft Windows 7® Professional or Enterprise SP 1, 64-
devices bit operating system (OS).
Recommendation: Procure a pre-configured LND from Waters. If
you use an LND that is validated and supported by Waters
Corporation, you need not test, validate, and configure your own
custom LND.
A single LND can support one or two instrument systems,
depending on type of detector used. It can support one instrument
system that includes a quadrupole mass spectrometer or a time-of-
flight (TOF) mass spectrometer. An LND can support two
instrument systems when each system includes an optical
detector, such as a PDA or TUV detector.
UNIFI Purpose
Network
components
Waters Groups of chromatographic instruments and mass spectrometers
instrument that you create to form an instrument system. These systems,
systems which connect to laboratory network devices, perform
chromatographic (LC) and mass spectrometric (MS) analyses.
For example, a UNIFI instrument system based on Waters UPLC
technology can include solvent manager, sample manager, column
manager, one or more detectors, chromatographic columns, and an
e-SAT/IN module. For MS analyses, its configuration can include
a Xevo mass spectrometer.
The number of instrument systems supported by a UNIFI
Network depends on the type of detector included in the
instrument system. Your instrument systems can include a
combination of mass spectrometers and optical detectors, such as
PDAs or TUVs, but cannot include a combination of quadrupole
and time-of-flight (TOF) mass spectrometers.
A single UNIFI network can support two instrument systems that
include a time-of-flight (TOF) mass spectrometer. It can support
four instrument systems that each include a quadruple mass
spectrometer. A UNIFI network can support six instrument
systems that each include an optical detector, such as a PDA or
TUV detector.
Client Access UNIFI software installed on the application/database
computers server. Runs on the Microsoft Windows 7 Professional or
Enterprise SP 1, 64-bit operating system (OS).
Local area Interconnects all devices that comprise a UNIFI Network. You
network cannot use a WAN (wide area network) configuration.
(LAN)
Network and UNIFI roles and permissions provide network security.
System administration
Managing the UNIFI systems involves maintaining all the hardware components,
operating-system software, networking software, and application programs that
make up the UNIFI software. It also requires system administrators to know the
system’s workload so that they can anticipate changes, problems, and growth.
Hardware:
Hardware Reference
Waters workstation UNIFI Installation and Configuration Guide
Waters UNIFI server UNIFI Installation and Configuration Guide
Waters UNIFI laboratory UNIFI Installation and Configuration Guide and
network device the UNIFI online Help
Hardware Reference
UNIFI clients UNIFI Installation and Configuration Guide and
the UNIFI online Help
PCs and printers PC and printer manufacturer’s documentation
Software:
Software Reference
UNIFI Software UNIFI Installation and Configuration Guide
and the UNIFI online Help
Windows 7 Professional 64-bit with Microsoft Windows documentation
SP 1 operating system
Windows Server 2012 R2 64-bit with Microsoft Windows documentation
SP 1 operating system
Routine tasks
Routine system administration tasks are those that you perform regularly: once
daily, once each shift (every 8 hours), or once a week. These tasks apply to both
the UNIFI workstation and the UNIFI Network.
Weekly tasks:
Task Reference
Ensure that scheduled database backups ran correctly. "Viewing database
backup" on page 75
Copy the database backup folders daily to a network "Backing up the UNIFI
share or storage array. database " on page 69
Tip: Using a backup agent or script, you can create an
automated task to perform this function.
Restart the workstation and application/database
server.
Monthly tasks:
Task Procedure
Archive the The Listener log is located in <install
Oracle drive>:\Waters\oracle\ASM\log\diag\tnslsnr directory on an
Listener Log application/database server and on <install
drive>:\Waters\oracle\diag\tnslsnr\<workstation
name>\listener\trace directory on a workstation.
To archive the listener log:
1. Click Start > All Programs > Accessories.
2. Right-click Command prompt, and then click Run as
administrator.
3. In the Command prompt window, change the directory to the
location of the batch file; for example, cd <install
drive>:\Waters\oracle\InstallSupport.
4. Type MaintainListenerLogs.bat and then press Enter.
5. Once complete, close the Command prompt window.
Result: The batch file creates a new listener log file. The old
listener log file is zipped and stored in the same location.
Archive the To archive the Alert UNIFI log, move the log from <install
Alert UNIFI drive>:\Waters\Oracle\diag\rdbms\UNIFI\UNIFI\Trace to your
Log storage location. Once you move the alert log, a new one is
recreated automatically.
Delete older Delete Wat Service Host and Portal logs that are older than one
Wat Service month. These logs are located in C:\ProgramData\Waters\Logs
Host and directory.
Portal logs
Task Procedure
Confirm Confirm that there is more than 20% free space on the operating
there is system hard drive. Check the Temp directories and delete
sufficient extraneous temporary files as needed.
disk free Use Waters Database Manager to monitor the size of the database.
space If additional space is required, you may need to archive data to free
space in the database according to your company’s requirements.
See also:"Managing database storage" on page 56
Apply When you apply Microsoft and anti-virus software updates, restart
Microsoft workstation and application/database, if necessary.
and Anti- Ensure no users are logged in or acquiring data before applying the
virus software updates. You can apply Microsoft and Anti-virus software
software updates to clients and LNDs at the same time.
updates
Drive Contents
<OS drive>:\ProgramData\Waters Diagnostic logs
(hidden)
<INSTALL DRIVE>:\Program MS instrument control software
Files\Waters\UNIFI
<INSTALL DRIVE>:\Program Files LC instrument control software
(x86)\Waters
<INSTALL DRIVE>:\Waters Oracle database software as part of Waters'
embedded solution
Qualification licenses:
To register licenses:
1. Log on to UNIFI software, and then click Administration.
2. From the Administration page, click Licensing.
Internet Action
access
Yes Click the hyperlink to connect to the Waters License Activation
Center web site.
No Move the software registration file that you just created to a
computer with Internet access, and then access
http://www.waters.com/activate/licenseintro.htm. Follow the
instructions to activate your licenses. After you receive the
activation file, move the file to the computer on which UNIFI
software is installed.
6. When you obtain a license activation file, return to the licensing home page,
and click Activate Licenses.
7. On the Activate Licenses page, select the license activation file that you
downloaded from the Waters License Activation Center Web site, and then
click Next.
8. On the Activate Licenses - License Activation Complete page, click Finish.
Tip: If you are activating the base license, log out, and then log back on to UNIFI
software, to access the software's complete functionality.
Service Definition
Waters Service Host A process, deployed as a Windows
service, designed to host generic
services like WCF services, ASP
services and Waters Internal services
Waters DHCP Server Detect IP instruments and returns
information such as type and serial
number
Waters.Acquisition.FileService Required for mass spectrometers
Waters Database Manager Required services for the Waters
Listener Database Manager. RESTful listener
facilitates communication with APEX
for the Waters Database Manager
application
OracleServiceUNIFI Required services for the database
OracleJobSchedulerUNIFI Required services for the database
OracleVSSWriterUNIFI Required services for the database
Tip: The Waters DHCP Server and the Waters.Acquisition.FileService services are
installed on the workstation, but they do not affect functionality.
Requirements:
l When you are finished maintaining the database or workstation, you must
reset the Startup Type of the Waters Service Host to Automatic (delayed
start).
l Before you can log on to UNIFI software, you must wait until all the Waters
Service Host processes restart.
Files Description
[install drive]:\Waters\UNIFI\client\bin UNIFI client software
[install drive]:\Waters\UNIFI\clientService\bin UNIFI client software
[os-drive]:\Windows\WatersInstallationSummary.txt UNIFI installation log
[os-drive]:\ProgramData\Waters\Logs Log files
[os-drive]:\ProgramData\Waters\UNIFI Installation logs
The software installs a Windows Service called WatClientServiceHost, which runs
under the “Local System” account, starts automatically at Windows Startup, and
registers the client with the server.
4. On the Edit Plan Settings page, click "Change advanced power settings".
5. In the Power Options dialog box, perform the following tasks, and then click
OK.
Decommissioning a client
When a client is no longer needed, and you want to remove it from a UNIFI
network configuration, you must decommission it. You decommission a client by
changing its status from online to decommission. Once decommissioned, users
cannot log on to the client, and you can delete it from the UNIFI network
configuration.
Files Description
[install drive]:\Program Files\Waters\UNIFI \Server LND software
[install drive]:\Program Oracle instant client
Files\Waters\UNIFI\OracleClient
[install drive]:\Program UNIFI database
Files\Waters\UNIFI\OracleClient\tnsnames.ora connection information
[os-drive]:\Program Files (x86) UNIFI instrument
\Waters\UNIFI\Instruments driver software
[os-drive]:\ProgramData\Waters\Acquisition\Jobs Queued acquisition
lists
[os- Local buffer for data
drive]:\ProgramData\Waters\Acquisition\RawDataFiles acquired from
instruments. The data
are deleted from this
folder after they are
successfully
transferred to the
database.
[os-drive]:\ProgramData\Waters\Logs Log files
[os-drive]:\ProgramData\Waters\UNIFI Installation logs
Service Definition
Waters Service Host A process, deployed as a Windows
service, designed to host generic
services like WCF services, ASP
services and Waters Internal services
Waters DHCP Server Detect IP instruments and returns
information such as type and serial
number
Waters.Acquisition.FileService Required for mass spectrometers
Deleting an LND
You can delete an LND from a UNIFI network configuration.
Restrictions:
l You cannot take a laboratory network device offline if samples are being
acquired and runs are scheduled in the sample queue. You must be able to
take the LND offline, before you can delete it.
l If a laboratory network device contains qualification or maintenance records,
you cannot delete it until the compliance records are exported and deleted
from the Qualification Center page.
Requirement: You must uninstall UNIFI software from the LND, to permanently
delete the LND. If you delete an LND, and then restart Waters Service Host
service on the LND, the LND appears in Device Management again.
Prerequisite:
Before you delete an LND, perform the following tasks in order in which they are
listed:
l Change the status of all instrument systems attached to the LND from
online to offline and then to decommissioned.
l Delete all instrument systems attached to the LND.
l Disconnect all instruments that are attached to the LND to prevent re-
detection.
l Delete all instruments and instrument drivers associated with the LND.
Requirement: Your role must include the Delete Device permission.
To delete an LND:
1. Log on to UNIFI software, and then click Administrations.
2. On the Administration page, click Device Management.
3. On the Application Server page, select the Laboratory Network Devices tab.
4. On the Laboratory Network Devices tab, select the LND, right-click Change
Status, and then select Offline.
5. Repeat the preceding step, right-click Change Status, and then select
Decommission.
6. Select the decommissioned device, and then right-click Delete Laboratory
Network Device.
Network considerations
The application/database server must operate in a domain or a corporate network.
If the server operates in a different domain than the clients or laboratory network
devices, you must ensure that the date and time-stamps are synchronized by
means of a time server. In a Windows Server 2012 R2-based domain, the domain
controllers are automatically configured as time servers for the domain.
Restriction: Do not install UNIFI software on the same computer as the domain
controller.
To maximize uptime and minimize issues related to the network environment,
follow these guidelines:
l Organize all UNIFI–related accounts, computer and user, within the same
domain.
l Configure preferences in Waters Database Manager to notify you by email
when disk space reaches a user-defined size. Doing so helps you monitor
database space usage. See the Waters Database Manager Online Help.
l When you add an application/database server, laboratory network device, or
client to a domain, ensure that the network discovery functionality is turned
on for these computers.
l If you are using real-time virus scanning, exclude all UNIFI–related folders
and their subdirectories. Some real-time virus scanners mistake normal
UNIFI software functionality for virus activity, causing data buffering
problems. Ensure that scheduled anti-virus scans do not occur during data
acquisition.
Server software
Implemented UNIFI systems require installation of certain software components.
Server software
The server software consists of these components:
l Microsoft® Windows® Server 2012 R2 Standard Edition SP1 (64-bit)
l Oracle Enterprise Edition version 12.1.0.2
l UNIFI server software
The application/database server configuration can connect with multiple UNIFI
clients and instrument systems. The UNIFI network supports up to 25 licensed
users and an unlimited number of laboratory network devices (LNDs). A single
LND can support one or two instrument systems, depending on type of detector
used. It can support one instrument system that includes a quadrupole mass
spectrometer or a time-of-flight (TOF) mass spectrometer. An LND can support
two instrument systems when each system includes an optical detector, such as a
PDA or TUV detector.
ASM operates using disk groups, which are collections of disks managed as a unit
for storing data files. The content of files stored in a disk group is evenly
distributed, or striped. Thus they eliminate "hot spots" and ensure the disks
perform uniformly, comparable to the performance of raw devices.
You can add or remove disks from a disk group while a database continues to
access files from the group. When you do so, ASM automatically redistributes file
contents, eliminating the need for downtime.
The ASM volume manager functionality provides flexible server-based mirroring
options. The ASM normal and high redundancy disk groups enable two-way and
three-way mirroring respectively. You can use external redundancy to enable a
Redundant Array of Inexpensive Disks (RAID) storage subsystem to perform the
mirroring protection function.
Qualification licenses:
l If you are activating the base license, log out and then log back on to UNIFI
software to access the software's complete functionality.
l When you create an instrument system and bring it online, an instrument
system license is automatically assigned it. You cannot bring instrument
systems online if there are no instrument system licenses available.
To register licenses:
1. Log on to UNIFI software, and then click Administration.
2. From the Administration page, click Licensing.
3. On the Licensing Home page, click Register Software.
4. On the Request Software page, perform these tasks, and then click Next:
l Type a new name for the software registration file, or allow the default
name to remain unchanged. The names of all registration files must
include the *.lic extension.
l Select the location of the license registration file. This file stores your
license registration information.
5. When the Register Software page reappears, perform one of the actions in
the following table, depending on whether your computer has Internet access:
Internet Action
access
Yes Click the hyperlink to connect to the Waters License Activation
Center web site.
No Move the software registration file that you just created to a
computer with Internet access, and then access
http://www.waters.com/activate/licenseintro.htm. Follow the
instructions to activate your licenses. After you receive the
activation file, move the file to the computer on which UNIFI
software is installed.
6. When you obtain a license activation file, return to the licensing home page,
and click Activate Licenses.
7. On the Activate Licenses page, select the license activation file that you
downloaded from the Waters License Activation Center Web site, and then
click Next.
8. On the Activate Licenses - License Activation Complete page, click Finish.
Tip: If you are activating the base license, log out, and then log back on to UNIFI
software, to access the software's complete functionality.
To turn on the network discovery and file and printer sharing functions:
1. From the Start menu, open Control Panel > Network and Internet >
Network and Sharing Center.
2. Click "Change advanced sharing settings", and turn on these functions:
l Network discovery
l File and printer sharing
Drive Files
[install drive]: The UNIFI software
\Program Files\Waters\UNIFI executable files.
[os-drive]: UNIFI installation log
\Windows\WatersInstallationSummary.txt
[os-drive]:\ProgramData\Waters\Logs\ Log files such as
[os-drive]:\ProgramData\Waters\Logs\Portal WatServicehost.log and
Waters.Portal.log.
(year-month-day-time)
Tip: You can select the
Tip: [os-drive]:\ProgramData folder is hidden by default.
level of detail that is
recorded in the Waters
Service Host and
Waters.Portal log files
for all devices that
comprises your UNIFI
system by defining
diagnostic log settings.
For more information,
refer to the "Define
diagnostic log settings"
topic in the UNIFI
Help.
[install drive]: The Oracle server
\Waters\Oracle\Oracle11g software
[install drive]: Oracle ASM software
\Waters\oracle\ASM
[install drive]: Copy of ASM parameter
\Waters\oracle\ASM\database\INIT+asm.ORA file
[install drive]: Oracle listener
\Waters\oracle\ASM\NETWORK\ADMIN\listener.ora configuration file
[install drive]: Copy of UNIFI
\Waters\oracle\Oracle11g\database\initUNIFI.ora parameter file
Drive Files
[install drive]: UNIFI database
\Waters\oracle\Oracle11g\NETWORK\ADMIN\tnsnames.ora connection information
[install drive]: Oracle ASM alert log,
\Waters\oracle\diag\asm\+asm\+asm\trace\alert_+asm.log which contains
information regarding
the ASM activity
[install drive]: Oracle Server alert log,
\Waters\oracle\diag\rdbms\unifi\unifi\trace\alert_unifi.log which contains
information regarding
database activity
[install drive]: Database connections
\Waters\oracle\ASM\log\diag\tnslsnr\listener.log information
[install drive]: Database backup and
\Waters\oracle\scripts\BackupRecoveryScripts recovery scripts
[install drive]: Database backup and
\Waters\tmp\scripts\logs recovery logs
Service Definition
Waters Service Host A process, deployed as a Windows service,
designed to host generic services like WCF
services, ASP services and Waters Internal
services
Waters DHCP Server Detect IP instruments and returns information
such as type and serial number
Waters.Acquisition.FileService Required for mass spectrometers
Waters Database Manager Required services for the Waters Database
Listener Manager. RESTful listener facilitates
communication with APEX for the Waters
Database Manager application
OracleServiceUNIFI Required services for the database instance
OracleASM12cTNSListener Required services for the database
OracleASMService+ASM Required services for the database
OracleJobSchedulerUNIFI Required services for the database
Service Definition
OracleOHService Required services for the database
OracleVssWriterUNIFI Required services for the database
Tip: The Waters DHCP Server and the Waters.Acquisition.FileService services are
installed on the application/database server, but they do not affect the ability of
the server to function.
To determine the amount of free disk space on the server using the Waters
Database Manager application:
1. From the Start menu, open the Waters Database Manager application, and
then click Server > Disk Groups.
2. On the Disk Groups page, click the name of a disk group.
3. On the Disk Group page, determine the amount of space used versus the
usable free space.
The configurations operate according to offline storage folder policies that define
these properties:
l The type of data that you want to move.
l The period that an item's binary data remains in the database before it is
removed and stored offline. For example, where the policy specifies a five-
week period, UNIFI software searches the database where the policy is
applied, folder by folder, for items whose binary data are older than five
weeks.
Tip: For items with multiple versions, such as analyses, each version is
treated as a separate item and moved to offline storage separately.
The software determines how long data have remained in the database by
ascertaining their time of creation, modification, or last restoration. The
time, defined as the retention period in the offline storage folder policy,
calculates when items are moved to offline storage:
l For items originally created in their current location, not imported or
restored, the retention period starts with the time of their last
modification.
l For imported items, their creation date and time is more recent than
the date and time of their last modification—as long as these items
were not modified after they were imported—the retention period
starts with the date and time they were created.
l For restored items, the retention period begins with the restoration
date and time — as long as they were not modified after they were
restored.
Because UNIFI software reviews all three dates and times (an item's
creation, modification, and last restoration), it does not move recently
created, acquired, imported, or restored data offline.
l The offline storage configuration, which specifies the storage location and
the schedule (how frequently folders to which the policy is assigned are
checked).
As you do with data folder policies, you apply offline storage folder policies to data
folders on UNIFI software's Access Management page, and the rules of inheritance
apply.
Once created and enabled, offline storage configurations run as a regularly
scheduled task in UNIFI software that you can view in Task Monitor. The offline
storage location must be a local drive or UNC path which is accessible from the
application/database server. You can create as many offline storage configurations
as necessary.
Account Result
Used
Sys Enables the use of Oracle SYSDBA functions or commands such as
changing the status of the database or editing non-dynamic database
parameters.
(user name = sys, default password = edmund, connect as = SYSDBA)
System Enables performance of DBA management functions such as taking a
tablespace online or offline or adding a data file to a tablespace.
(user name = system, password = edmund, connect as = normal)
Recommendation: Reset user account passwords for the Oracle database after you
install Waters software and periodically thereafter, according to your
organization's security policies and standard operating procedures.
When you install UNIFI software, an operating system (OS) user account,
OracleJobs, is automatically created. This account provides operating system
credentials to run scheduled jobs, such as backing up the database and running
database scripts for the Waters Database Manager (WDM) application. The default
password for this user account is Edmund1! (the "E" is capitalized in Edmund,
followed by the number "1", and an exclamation point "!"). If you change the
password for this account in the OS, you must also change the password for this
account in WDM.
You can manage Oracle database user accounts by locking and unlocking them
and resetting users' passwords.
2. From the Users page, select a user account, and click Edit .
3. From the Manage User page, click Lock User.
Result: The database user cannot use this account until it is unlocked.
2. From the Users page, select a user account, and click Edit .
3. From the Manage User page, click Unlock User.
2. From the Users page, select a user account, and click Edit .
3. From the Manage User page, do as follows, and then click Re-set Password.
l In the Password field, type a new password for the account.
l In the Re-enter Password field, retype the password, and then click
Reset.
Drive Files
+data/asm/asmparameterfile/ ASM parameter file
+data/unifi/CONTROLFILE/ Database control file
+data/unifi/DATAFILE/SYSAUX Oracle default datafiles
+data/unifi/DATAFILE/SYSTEM
+data/unifi/DATAFILE/UNDOTBS1
+data/unifi/DATAFILE/USERS
+data/unifi/DATAFILE/WATBLOB UNIFI datafiles:
+data/unifi/DATAFILE/ WATDATA WATBLOB – binary large objects datafile
+data/unifi/DATAFILE/ WATSTREAMBLOB – binary stream
WATINDEX objects
WATDATA – metadata datafile
WATINDEX – index datafile
+data/unifi/ONLINELOG/ Oracle redo logs
+data/unifi/PARAMETERFILE/ UNIFI parameter file
+data/unifi/TEMPFILE/TEMP Oracle temporary datafile
Drive Files
+fra/unifi/ARCHIVELOG/ Oracle archive logs
+fra/unifi/AUTOBACKUP/ Database backup files
+fra/unifi/BACKUPSET/
+fra/unifi/CONTROLFILE/ Mirrored copies of control and redo logs
+fra/unifi/ONLINELOG/
4. On the Application User page, perform these tasks, and then click Apply
Changes:
l In the E-Mail Address field, type a valid email address for the user
account.
l In the Notifications field, select Yes.
After you configure the alerts, you must perform these tasks:
l Configure SMTP server and port settings.
l Enable notifications for the users whom you want to receive the alerts.
.
4. On the Application User page, perform these tasks, and then click Apply
Changes:
l In the E-Mail Address field, type a valid email address for the user
account.
l In the Notifications field, select Yes.
A database backup generates a time-stamped log file that includes details about
individual steps of the backup process. This log file is in this location: [install
drive]:\Waters\tmp\scripts\logs.
l Do not store database backups in the same location as the database files. If
the physical drive is corrupted, you can use the other location to restore the
files.
Backup Description
Schedule
First full, level Full database backup that runs once immediately, after software
0 installation.
Full, level 0 Full database backup that runs once a week.
Increment, Incremental backup (as opposed to a full backup) that runs once
level 1 daily.
Recommendation: Although you can disable the scheduled backups, you should
not delete them.
Scheduling a backup:
Option Guideline
Name A unique name for the backup. Use underscores (_) for blank
spaces.
Example: INCR_UPDATE_LV0 describes an incremental database
backup assigned a level-0 backup.
Description A description of the scheduled backup. You can add as many details
as you desire, such as the frequency of a scheduled backup, whether
the backup is a full or incremental backup, and other details.
Example: Default UNIFI level-0 database backup.
Backup The type of database backup:
Type Copy — backup the database to a disk as an image copy.
Backup set — backup the database to a disk as a backup set. You
can create backup sets to a default device or to a disk or tape.
Compressed backup set — backup the database using a compression
algorithm that compresses database files. When you restore the
database, you need not perform additional steps to decompress the
database files.
Recommendation: Compressed backup set
What to backup
Datafiles Select this check box to include datafiles in your database backup.
Recommendation: Select this check box.
Method The type of database backup:
Full — shuts down the database and backs it up in its entirety
(cold backup).
Level 0 — full backup (hot backup). The database is fully backed
up, but the process does not shut down the database. This type of
backup is typically run once a week.
Level 1 — incremental backup (hot backup). Daily backup of the
database but the process does not shut down the database. This type
of backup is typically run once a day.
Archive log Select this check box to include the archive logs with the database
backup.
Recommendation: Select this check box.
Delete Select this check box to delete the archive logs after the database is
backed up.
Recommendation: Select this check box.
Option Guideline
Control file Select this check box to include the control files in the database
backup. A control file includes information like the database name,
location of redo logs and data files, date and time the database was
created, and other things.
Recommendation: Select this check box.
Options
Tag The keywords associated with the database backup. Selecting this
check box helps you easily search for a database backup.
Section size The size that each parallel process contains. If you specify a section
size, the database backup splits the data into chunks, so that each
process backs up one section at a time. When you specify a section
size, database backups run much faster.
Example: If a database is 200 GB and you specify a section size of
25 GB, the data is split into 8 25-GB pieces, assuming that the
parallel setting is 8 or more. If the database is smaller than 200
GB, then the parallelism reduces from 8 to 7 or less; if the database
is larger, after one of the processes is done, another begins to
process the remaining data.
Recommendation: 25 GB. For smaller databases, 200 GB is
recommended.
Crosscheck Select this check box to validate all specified backups and copies.
Delete Select this check box to remove expired backup files based on the
Expired backup retention policy settings.
Example: If the redundancy is set to a 7-day window, which backs
ups the database each day, no more than 7 backups can exist, so the
eighth is deleted.
Delete Select this check box to remove backups that are no longer needed
Obsolete for recovery purposes.
Backups become obsolete according to a retention policy based on
redundancy or a required window. All backups older than the
recovery window are obsolete.
Notes:
l When using a Fast Recovery Area for storing backups, you need
Option Guideline
Compression RMAN automatically reduces the size of the output (backup sets)
Algorithm by omitting never-used blocks. You can further reduce the size of
the backup sets by selecting a binary compression algorithm.
RMAN compression is a tuning feature.
Example: If your system CPU is not functioning at 100 %, you can
significantly reduce the size of the output (backup sets) by selecting
medium or high compression. By reducing the input/output to write
the backup set, choosing a compression option reduces the time
required to execute the backup.
The aggressiveness of the binary compression is controlled by the
following compression options:
l Use RMAN Setting — Schedule the backup using the
specify).
Start at If you choose a backup frequency of once or if you define an
interval, specify the date and time for running the scheduled
backup.
Requirement: You must close the date and time picker so that the
specified date appears in this field.
Repeat If you choose "interval", you must specify the date and time to start
every the backup and also the interval for successive runs (which can be
any number of minutes, hours, days, month or years).
Result: According to the frequency that you specified, the database backup job
runs and a confirmation message appears: "Action processed. Command file
created. Scheduler job definition created."
See also: View database backup
2. From the Backup Schedules page, click View Run details (in the Log
column) next to the backup job that you want to view.
3. To open the log file associated with a specific backup job, click View backup
log file .
Result: The Backup Run Details page lists the results of the scheduled database
backups that ran.
CPU Used The CPU usage, in seconds, for the database backup.
Second
Errors The number of errors in the log file.
Disaster recovery
If your workstation or application/database server is inoperable, you must install
UNIFI software on new hardware following the procedures outlined in the UNIFI
Installation and Configuration Guide and then restore the database. As stated in
the UNIFI Installation and Configuration Guide, Waters recommends that you
copy the database backup folders daily to a network share or storage array.
Requirement: The path indicating the location of the folder to which you copy
database backups must not contain spaces in the path name.
When you run this script, you must provide the information listed in the Restore
Full Database.bat parameters table. Upon completion, this script restores the
latest full database backup, and the incremental backups, stored in the Fast
Recovery Area (FRA).
Restore_Full_Database.bat parameters
3. When the restoration process ends, close the Command Prompt dialog box
when the prompt appears.
4. For UNIFI Network configurations, restart Waters services on the
laboratory network devices.
Tip: When the database base is recovered, Waters services are started
on the application/database server and workstation.
5. To install the necessary instrument drivers on the application/database
server, click Update drivers on the Database Driver Management tab on the
Device Management page for the application/database server.
To verify that the instrument drivers were updated correctly on the
application/database server, open Window's Programs and Features, and ensure
the installed drivers match the ones installed on the LNDs.
Prerequisites:
l From the workstation or application/database server, log on to the Waters
Database Manager application, and ensure that the Archive log mode is
inactive.
Tip: To verify the status of the Archive log mode, click Dashboard and
verify that Archive mode displays "NOARCHIVELOG" in the "Database
information" section of the dashboard.
l Ensure that no users are connected to the UNIFI portal, because the
following procedure shuts down and restarts the database.
Turning on database backups involves two procedures: shutting down the database
and turning on the default-scheduled backups.
Backup Description
Schedule
First full, Full database backup that runs once immediately, after
level 0 software installation.
Full, level 0 Full database backup that runs once a week.
Increment, Incremental backup (as opposed to a full backup) that runs
level 1 once daily.
9. On the Schedule Backup page, click Enable.
10. Repeat the prior two steps for the remaining scheduled backups.
Result: The first full backup job runs immediately and backups the database and
controls files to the specified backup location. The full and incremental backup
jobs run at their specified time. Thus, incremental backups run daily at 3:00AM;
full run weekly, on Monday at 2:59AM.
To verify that the location of the database backup files and control files were
changed:
1. Log on to the Waters Database Manager application.
2. From the Dashboard, click Manage Backups. and then View Backup
Settings.
When you change the location of the database backups, the datafiles are backed up
to the new location. The database backup files that were stored in the previous
location remain in that location. They are not moved to the new location, and they
are not deleted from the previous location.
Recommendation: Run a full backup by enabling the First Full Level 0 backup
job. When you do so, all previous full and incremental backups are deleted, and a
new, full database backup is created in the new location.
See also: "Scheduling database backups" on page 71
When the full backup job ends, verify that the backup files (.bkp) and the control
files (files that begin with the letter "C") reside in the new location. View the
backup log for error messages.
See also: "Viewing database backup" on page 75
If you changed the location of the database backups and the control file and want
to recover the database, you must enter the location of the backup files and control
files that must be restored in the recovery script. If the system is recovering from
an ASM disk failure, the database backup location can be the latest one. However,
if you are recovering the database and following disaster recovery procedures, the
database backup location can be the offline storage location where you keep copies
of the database backup files.
6. In the New password field, enter a new password, and then re-enter it in the
Confirm password field.
7. Click Save.
Additional help
For additional UNIFI system troubleshooting help, consult the following
documentation:
l UNIFI online Help
l Windows Help
l Hardware documentation shipped with your system hardware
l Operator’s guides for UPLC systems
l UNIFI software release notes
l http://www.waters.com
To contact Waters:
1. From the Waters Web site, click Services and Support, and then click the
link www.waters.com/iRequest.
2. On the iRequest Technical Service / Support page, click IRequest Phone
Support.
Isolating problems
Isolating the problem is the first step in troubleshooting. Because the necessary
procedure depends on system type, this chapter provides general instructions for
isolating a problem.
Recommendations
Keep in mind the following recommendations when attempting to isolate a
problem:
l Develop a systematic troubleshooting strategy.
l Check simple things first, such as cable connections and privileges.
l Try to reproduce a symptom, and note all steps leading to the problem.
l Change only one thing at a time.
l Software problems in the UNIFI software application can generate a UNIFI
error message. If no message appears, or if you cannot log in, the problem
can be a setup problem.
l For an instrument control problem, disconnect the device in question from
the laboratory network device. If possible, control the device from its front
panel. If the device does not respond as expected when programmed from its
front panel, the problem is within the instrument, not the UNIFI system.
l Check the UNIFI event browser for errors.
l Check the operating system’s Event Viewer for errors.
Reporting problems
Before you report the problem to Waters technical assistance, ensure you
adequately investigated the problem. If the corrective actions listed in this chapter
do not solve the problem, collect all your troubleshooting information, the System
Problem log, and relevant technical manuals, and then report the problem to t
Waters Technical Service.
Tip: A log file is generated for each device. Refer to the client, laboratory network
devices, and application/database server chapters for the location of all folders and
files for each device.
When describe the problem to Waters personnel, be ready to offer the following
information:
l Software support plan number
l A description of the symptoms
l An accurate assessment of the problem’s severity; for example, system down,
server down, PC down, PC client not connecting to server, printer printing
unusual characters, or occasional malfunction
even if the connection to the server is lost. In such a case, data are stored locally
on the LND and transferred to the database after the connection is reestablished.
If the LND closes unexpectedly, the data for the interrupted injection (but not for
the entire sample list) are re-sent to the application/database server after its
connection is re-established.
Resolving issues
The following table includes symptoms, possible causes, and suggested corrective
actions for UNIFI software problems.
Troubleshooting issues:
Resetting a device
You can use the Reset device feature in UNIFI software: when acquisition is
paused, a system error occurs, and the acquisition is not removed from the queue
when the error is cleared. When you reset a device, queued acquisitions do not run,
and you cannot take the instrument system offline.
When you reset a device, these actions occur consecutively:
l The instrument system server services are stopped.
l All running and queued acquisitions are deleted from the MSMQ (Microsoft
Message Queuing).
l All running and queued acquisitions are deleted from the Program
Data\Waters\Acquisition\Jobs folder.
l The instrument system services are started.
l The laboratory network device is brought online.
l A notification message is created in the event browser.
Requirements:
l Your role must include the Delete Devices permission.
l You must resubmit all queued acquisitions for all the instrument systems
attached to the laboratory network device.
Tip: To view the list of paused and queued acquisitions, open the System Monitor
page in UNIFI software.
To reset a device:
1. Do one of the following:
l From the Workstation page, right-click the workstation, and then select
Reset Device.
l From the Laboratory Network Devices tab, select the laboratory network
device, and then right-click Reset Device.
2. Click Yes, to confirm this action.
Replacing an LND
When a laboratory network device cannot communicate with the
application/database server, and troubleshooting has diagnosed a hardware
problem with the LND, use the Release Resources feature to delete the LND from
UNIFI software.
When you do so, the software pings the LND. If it is unreachable, these actions
occur:
l All instruments, instrument drivers, and instrument systems are
disassociated from the LND.
Date/initials Drive Free disk space Date/initials Drive Free disk space
See also:
l Configure Watson agent
l Configure Forms agent
l Create Integration Manager interface
l Add instrument interface to Watson
l Update instrument parameter file
Lists IP Object Code field of the Custom Tab in the Configuration Detail
page.
l Import Object and its attributes.
Tip: When you configure LIMS in UNIFI software, you must enter the
Import Object name (Import Object) in the Results Object field of the
Custom Tab in the Configuration Detail page.
Name Properties
Name Watson to UNIFI_Map1
Description Leave blank
Interface map code Leave blank
IP 1 Object Sequence
IP 2 Object Form Interaction Worklist Object
To create and map an IM interface between UNIFI software and Watson LIMS:
1. Open Integration Manager, and then click System Configuration > Manage
Interfaces.
2. From the Interfaces page, right-click an empty area of the tree view pane,
and then select Add New Interface.
3. In the New Interface wizard page, enter "UNIFI to Watson" for the name,
leave the description blank, and then click Next.
4. Select Integration Points and then click Next:
l For Integration point 1 select "Export to UNIFI" on agent FormsAgent1.
l For Integration point 2, select "Watson" on agent WatsonAgent1.
5. Specify "30 seconds" as the Polling Interval and Unit, and then click Next.
6. Enter the following values, click Add Map, and then click Finish.
Name Properties
Name UNIFI to Watson_Map
Description Leave blank
Interface map code Leave blank
IP 1 Object Form Interaction Worklist Object
IP 2 Object Sequence
Name Properties
Instrument Enter a name that describes your instrument configuration
Name and include the word "UNIFI" in the name.
Example: UNIFI Interface 48 Position Plate.
Assay Type LC/MS
Data Raw and Concentration
Import
Type
Number of Enter the number of rows in a sample tray or titer plate.
Rows Example: Enter 6 for a 48-position vial tray.
Number of Enter the number of columns in a sample tray or titer plate.
Columns Example: Enter 8 for a 48-position vial tray.
Sequence Yes
File
Interface Gateway
type
Gateway IM Gateway
Executable
See also:
l Add instrument interface to Watson
6. Click Test.
Result: If UNIFI software can connect to LIMS, the "Connected
successfully!" message appears. If the connection is unsuccessful, ensure
that the Web service URL matches the External Service URL specified in
the Forms Agent page of Watson LIMS Integration Manager application.
7. In the Sample List Keys tab of the Configuration Detail page, select the
common, analytical-run assay field names. These sample list keys relate to
metadata exported from the LIMS analytical run, which are used to
automatically generate UNIFI analysis name. Use the Up and Down buttons
to change the order of the sample keys. (The order of selected sample keys
defines the order of list and is used as a name for the new analysis.)
8. On the Result Data tab of the Configuration Detail page, select Response, or
both Response and Observed RT, specifying analysis results for export to
9. Click Save.
5. In the LIMS Sample Lists dialog box, select the sample list that you created
in LIMS, and then click OK.
Result: Doing so ensures the LIMS-created sample list is used as the sample list
for the current analysis.
Result: The "Export successful" message appears at the bottom of the page.
7. In the second Instrument Parameters dialog box, select the analysis result
in the Value column.
Requirement: You can import the UNIFI analysis only to the matching
Analytical Run Assay. The date and time that the analysis was exported
from UNIFI software must match that the date and time the result was
imported into Watson LIMS.
See also: View exported results
Tip: Match the sample list key information to the analytical run assay
information.
8. Click OK.
9. To find the correct imported results in Watson LIMS, search the Import File
Name column in the Analytical Run Actions page.
Results: The imported data appear in LIMS.
Tip: NaN indicates that the value is not a number and that, consequently, no
result was found.
the date the analysis was exported, create a specialized view in UNIFI's Explorer
window.
Tip: You can move the “Last result export” column by dragging and dropping it to
the desired location in the Folders Contents table. By default, the column is
positioned as the last right-hand column.
Result: The "Last result export" column displays the date and time that the
analysis was exported from UNIFI software into LIMS.