0% found this document useful (0 votes)

44 views124 pages

CDS ClientAIC

Uploaded by

gorisekpeter

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

44 views124 pages

CDS ClientAIC

Uploaded by

gorisekpeter

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 124

OpenLab CDS Clients and Instrument Controllers

Installation and Configuration

OpenLab CDS Clients and AICs Installation and Configuration

Notices
Document Information Warranty Safety Notices
Document No: D0007072 Rev. A The material contained in this document
Edition: 04/2021 is provided “as is,” and is subject to being C AUTI ON
changed, without notice, in future edi-
A CAUTION notice denotes a
Copyright tions. Further, to the maximum extent
permitted by applicable law, Agilent dis- hazard. It calls attention to an
© Agilent Technologies, Inc. 2015-2021 claims all warranties, either express or operating procedure, practice, or
No part of this manual may be repro- implied, with regard to this manual and the like that, if not correctly per-
duced in any form or by any means any information contained herein, includ- formed or adhered to, could result
(including electronic storage and retrieval ing but not limited to the implied warran- in damage to the product or loss
or translation into a foreign language) ties of merchantability and fitness for a
of important data. Do not proceed
without prior agreement and written con- particular purpose. Agilent shall not be lia-
sent from Agilent Technologies, Inc. as ble for errors or for incidental or conse- beyond a CAUTION notice until
governed by United States and interna- quential damages in connection with the the indicated conditions are fully
tional copyright laws. furnishing, use, or performance of this understood and met.
document or of any information con-
Agilent Technologies, Inc.
5301 Stevens Creek Blvd.
tained herein. Should Agilent and the user WARN IN G
have a separate written agreement with
Santa Clara, CA 95051, warranty terms covering the material in A WARNING notice denotes a
USA this document that conflict with these hazard. It calls attention to an
terms, the warranty terms in the separate operating procedure, practice, or
agreement shall control.
the like that, if not correctly per-
Technology Licenses formed or adhered to, could
result in personal injury or death.
Software Revision The hardware and/or software described Do not proceed beyond a WARN-
in this document are furnished under a
This guide is valid for revision 2.6 of ING notice until the indicated
license and may be used or copied only in
Agilent OpenLab CDS. accordance with the terms of such conditions are fully understood
license. and met.

Restricted Rights Legend

U.S. Government Restricted Rights. Soft-
ware and technical data rights granted to
the federal government include only
those rights customarily provided to end
user customers. Agilent provides this
customary commercial license in Soft-
ware and technical data pursuant to FAR
12.211 (Technical Data) and 12.212
(Computer Software) and, for the Depart-
ment of Defense, DFARS 252.227-7015
(Technical Data - Commercial Items) and
DFARS 227.7202-3 (Rights in Commer-
cial Computer Software or Computer
Software Documentation).

OpenLab CDS Clients and AICs Installation and Configuration

In this Guide ...

This document provides instructions for installation, configuration, administration,

and maintenance of OpenLab CDS Clients and Instrument Controllers. It includes
information on the license generation with SubscribeNet and operating system
configuration.
Table 1 Terms and abbreviations used in this document

Term Description

Content Management Component of OpenLab Server used to manage

your analytical data, including a database.
Always used in Client/Server systems, optional
for Workstations.

AIC Agilent's Analytical Instrument Controller

Control Panel Control Panel for Agilent OpenLab software

Microsoft Control Panel Part of the Microsoft Windows operating system

Shared Services Set of administrative services that control, for

example, the security policy and the central
configuration of OpenLab CDS. Shared services
are accessed via the Control Panel.

1 Prepare your PC
This chapter describes how to configure a non-Agilent-delivered PC.
Agilent-delivered PC Bundle systems are delivered with the supported pre-installed
Windows operating system and are configured for optimum performance.
Non-Agilent PCs require some manual configuration changes in order to provide
optimum performance.

2 Install OpenLab CDS

This chapter describes the installation of the OpenLab CDS software in a
Client/Server environment.

3 Post Installation Tasks

This chapter describes tasks that are relevant after finishing the installation.

OpenLab CDS Clients and AICs Installation and Configuration 3

4 Optional Procedures
This chapter describes the installation or upgrade of additional software. It also
contains information on the installation of OpenLab Help and Learning only, and on
performance improvement on offline machines.

5 Licensing
This chapter provides basic information on OpenLab licensing and describes how
you generate a license file with SubscribeNet.

6 Configure OpenLab CDS

This chapter describes the initial configuration steps after installing the software.
All configuration tasks are performed in the Control Panel. For more details, refer
to the Control Panel section in OpenLab Help & Learning.

7 Set Up NIST Library Search

This chapter describes the installation of NIST software components, and the
configuration steps in OpenLab CDS that are required for using the NIST MS library
search.

8 About the OpenLab CDS Software

This chapter contains an overview of the basic software features.

9 System Setup and Maintenance

This chapter contains information on the Control Panel and Shared Services
Maintenance. In addition, it contains information on maintenance procedures.

10 Upgrade to the latest OpenLab CDS Version

This chapter describes the upgrade of the OpenLab CDS software in a
Client/Server environment.

11 Uninstall OpenLab CDS

This chapter describes the uninstallation of the OpenLab CDS software.

OpenLab CDS Clients and AICs Installation and Configuration 4

Contents

1 Prepare your PC 8
Install and Update Windows 9
Install the .NET 3.5 and 4.x Framework 10
Before You Begin the Installation of OpenLab CDS 11
Run the System Preparation Tool 12

2 Install OpenLab CDS 19

Installation Workflow Overview 20
Prepare for Installation 22
Install an OpenLab Server 23
Install OpenLab CDS (Client or Instrument Controller) 24
Install CDS Client on Terminal Server 33
Silent Installation 34
Install or Upgrade Instrument Driver Software 38

3 Post Installation Tasks 39

Run a Software Verification after Software Installation 40
Create Account for Network Access and Printing 41
Configure the Antivirus Program 44

4 Optional Procedures 47
Install OpenLab Help and Learning Only 48
Improve Performance on Offline Machines 49

5 Licensing 50
About OpenLab CDS Licensing 51
Get a License 52
Install Your License 57

OpenLab CDS Clients and AICs Installation and Configuration 5

6 Configure OpenLab CDS 58
Configure Authentication 59
Configure Security Policy 60
Configure users and roles 61
Configure Initial Project 66
Configure Initial Instrument 66
Other settings in the Control Panel 67

7 Set Up NIST Library Search 68

Install Software and Library Components 69
Configure MS Library in OpenLab CDS 79

8 About the OpenLab CDS Software 80

Software Architecture 81
21 CFR Part 11 Compliance 85
Customization 87

9 System Setup and Maintenance 89

Control Panel 90
Other Maintenance Procedures 95

10 Upgrade to the latest OpenLab CDS Version 96

License Upgrade 97
Upgrade Process 99
Step 1: Upgrade the OpenLab Server 101
Step 2: Upgrade an Analytical Instrument Controller 101
Step 3: Upgrade an OpenLab CDS Client 103
Step 4: Upgrade Drivers 105
Register a Client or Instrument Controller on the Server 106
Sample Scheduler for OpenLab 109

11 Uninstall OpenLab CDS 110

Uninstall a Client or Analytical Instrument Controller (AIC) 111

OpenLab CDS Clients and AICs Installation and Configuration 6

Uninstall the OpenLab Server 111
Uninstall OpenLab Help and Learning Only 112

12 Appendix 113
Privileges in the Control Panel 114
Sales and Support Assistance 123

OpenLab CDS Clients and AICs Installation and Configuration 7

1 Prepare your PC

Install and Update Windows 9

Install the .NET 3.5 and 4.x Framework 10
Before You Begin the Installation of OpenLab CDS 11
Run the System Preparation Tool 12
Reference of SPT Checks 17

This chapter describes how to configure a non-Agilent-delivered PC.

Agilent-delivered PC Bundle systems are delivered with the supported
pre-installed Windows operating system and are configured for optimum
performance. Non-Agilent PCs require some manual configuration changes in
order to provide optimum performance.

OpenLab CDS Clients and AICs Installation and Configuration 8

1 Prepare your PC
Install and Update Windows

Install and Update Windows

1 Install the Windows operating system from the Microsoft installation media
or qualified PC image media provided by your IT department. During the
setup, provide the computer name, administrator password and network
settings.
For the computer name, do not use underscores; installation is not possible if
the computer name contains an underscore.
Both clients and instrument controllers must be in a Windows domain;
systems in workgroup mode are not supported.
2 In the Microsoft Control Panel under System > Windows activation, click
Change product key. Enter a valid value to activate Windows.
3 Update to the recommended version of Windows 10 (also known as a
semi-annual Feature Update). See the FAQ section of the OpenLab CDS page
at https://www.agilent.com/.
4 Check for Windows quality updates, and apply all critical security patches. Do
not choose to install a newer version of Windows 10 (see previous step).
Make sure the Windows quality updates have finished installing before
proceeding to install OpenLab CDS.
5 Check that your computer meets all requirements. You can access the
Requirements and Supported Instruments for Instrument Controllers, Clients,
or Workstations guide (CDS_Requirements.pdf) from the Setup\Docs folder
on the installation medium.
Use this PDF to check that your settings comply with the network
requirements, and to determine whether your hardware and software will
support the system.
6 To secure your system against viruses please install an antivirus program. Be
sure to open the firewall ports listed in the Firewall Settings in the
Requirements and Supported Instruments Instrument Controllers, Clients, or
Workstations guide (CDS_Requirements.pdf).
7 To configure remote settings: In the Microsoft Control Panel navigate to
System > Remote settings. On the Remote tab. In the Remote Desktop section,
select Don't allow connections to this computer.
8 In the Microsoft Control Panel under Date and Time: Choose the time zone of
your regional location.

OpenLab CDS Clients and AICs Installation and Configuration 9

1 Prepare your PC
Install the .NET 3.5 and 4.x Framework

Install the .NET 3.5 and 4.x Framework

If .NET 3.5 and .NET 4.x are not installed on your system, their installation will
automatically be triggered by the installation wizard. However, this may require a
system reboot. To avoid the system reboot during installation, install .NET in
advance.
1 Go to the Microsoft Control Panel.
In the Windows Start menu, enter "Control Panel" in the Search programs and
files field (alternatively, press [Win+R] and enter "Control panel"). To view all
items in the Control Panel view, select Small icons in the View by field.
2 Go to Programs and Features.
3 Go to Turn Windows features on or off.
4 Enable .NET 3.5 as follows:
a Expand the .NET Framework 3.5 (includes .NET 2.0 and 3.0) node.
b Select the Windows Communication Foundation Non-HTTP Activation check
box.

Figure 1 Enable .NET 3.5 (Win 10)

This requires an internet connection. If it does not work as expected, or the

NOT E computer has no internet access, install .NET 3.5 from the Windows installation
media. For Windows 10, see details 10 under
https://support.microsoft.com/en-us/kb/2734782.
If you do not have installation media, create them as described under
https://www.microsoft.com/en-us/software-download/windows10.

5 Select the .NET Framework 4.8 Advanced Services check box. Use the default
values for sub items.

OpenLab CDS Clients and AICs Installation and Configuration 10

1 Prepare your PC
Before You Begin the Installation of OpenLab CDS

Before You Begin the Installation of OpenLab

CDS

To simplify installation of the software, it is helpful to decide on some

configuration options before you begin the actual software installation.
1 Decide on a computer name.
The computer name will be reflected in the license. To avoid effort, it is
recommend to keep the computer name unchanged after installing OpenLab
CDS.
To make sure that a DNS server can resolve the computer name, follow the
NOT E internet standard for protocols (RFC952) and use only the following characters:
• Letters (a-z, A-Z)
• Digits (0-9)
• Hyphen (-)
Do not use an underscore. Installation is not possible if the computer name
contains an underscore.

2 Install all required hardware, including any cables, instrument detectors, and
communication cables. GPIB interfaces may be required for some non-Agilent
instruments.
3 Prepare an account with administrative privileges to run the installation.
4 To allow the successful installation and activation of all components, make
sure that the LAN-cable is connected and a network is available. A local
network is sufficient. If you install the workstation without a network cable,
the activation of the Content Management component will fail, and trying to
run the database will return an error.
5 Make sure that the antivirus software is disabled during the installation.
6 Check the Agilent Service Notes for software updates for your installation
package and software products. Service Notes are available from your Agilent
support representative.
7 If you use Trend MicroTM as an antivirus software, turn off Web Reputation to
allow the installation of all components.
8 If you plan to upgrade from a previous version of OpenLab CDS please refer to
the Upgrade OpenLab CDS chapter.

OpenLab CDS Clients and AICs Installation and Configuration 11

1 Prepare your PC
Run the System Preparation Tool

Run the System Preparation Tool

The System Preparation Tool (SPT) checks and applies Windows settings on
your machine. The settings are also applied automatically when you run the
OpenLab installer. Running the SPT in advance helps you to shorten the
installation process. For an overview of both mandatory and recommended
settings, see Table 2 on page 17.
1 If you want to keep your setting in the System Preparation Tool from one run
to the next: Copy the entire content of the USB media to a local drive or
centralized folder, then remove the USB media from the PC.
2 To open the installer, right-click the setup.exe file, and run it as administrator.
If User Account Control (UAC) is switched on, this step requires active
NOT E confirmation to continue.

OpenLab CDS Clients and AICs Installation and Configuration 12

1 Prepare your PC
Run the System Preparation Tool

3 On the start screen, select OpenLab CDS, and click OK.

4 From the Planning tab, select System Preparation Tool.

The System Preparation Tool window opens.

OpenLab CDS Clients and AICs Installation and Configuration 13

1 Prepare your PC
Run the System Preparation Tool

5 Select the product configuration corresponding to your system.

For AICs:
• OpenLab CDS~2.6~AIC~Win10
• OpenLab CDS~2.6~AIC~Win2016
• OpenLab CDS~2.6~AIC~Win2019
For clients:
• OpenLab (CDS, ECMXT)~2.6~(Client, CMServices)~Win10
• OpenLab (CDS, ECMXT)~2.6~(Client, CMServices)~Win2016
• OpenLab (CDS, ECMXT)~2.6~(Client, CMServices)~Win2019

Click Continue. The installer automatically applies all mandatory Windows

settings to ensure proper installation.

6 Select which recommended settings to apply to the system.

There are several settings that are recommended that can improve the
performance and stability of your system, but do not need to be completed to
deploy the application. The recommended settings are listed after the
mandatory settings.

OpenLab CDS Clients and AICs Installation and Configuration 14

1 Prepare your PC
Run the System Preparation Tool

You can clear the check boxes for recommended settings. Mandatory
settings cannot be cleared. Recommended actions are selected by default
and will be applied unless they are cleared.
For more information on mandatory and recommended settings, see Table 2
on page 17.

7 Click Apply Fixes to apply the correct settings.

The System Preparation Tool attempts to fix the selected settings and
displays the new status on the Update Configuration page. All actions are
saved to a log file.

8 Click Next to proceed to the System Preparation Report page.

The System Preparation Report is displayed. It lists the new status for all
selected settings.
The System Preparation Report for each run is saved separately to disk. Its
location is shown at the top of the page.

OpenLab CDS Clients and AICs Installation and Configuration 15

1 Prepare your PC
Run the System Preparation Tool

9 Click Print Report to print the System Preparation Report.

You may print to a file, for example, using the Adobe PDF printer, and add
comments.

10 The System Preparation Report lists any mandatory or recommended

settings that are not automatically updated by the System Preparation Tool.
Follow the instructions provided in the System Preparation report to manually
update operating system settings.

11 Click Finish.
12 Reboot your system if requested to do so.

OpenLab CDS Clients and AICs Installation and Configuration 16

1 Prepare your PC
Run the System Preparation Tool

Reference of SPT Checks

Table 2 Checks and Setting updates by the System Preparation Tool

Name Workstation Client OpenLab Server AIC

Workstation Plus CM Services ECM XT
OLSS Server for
ECM 3.x

Mandatory

Check Minimum Memory

Check CPU

Check OS Compatibility

Check OS Version

Check OS Architecture (64 bit)

Check Screen Resolution

Check language compatibility for OpenLab

Network Availability - Verify active network

adapter

Ports Check

Programs and Features - Enable/deploy .NET

Framework 3.5

Programs and Features - Tcp Port Sharing And

Activation

Programs and Features - Windows

Communication Foundation Non-HTTP Activation

Programs and Features - .NET Framework 4.X

Advanced Services

Programs and Features - Telnet Client

Programs and Features - TFTP Client

System - Local Group Policy Requirements1

Power options - Disable Quick Start

System HTTP service

OpenLab CDS Clients and AICs Installation and Configuration 17

1 Prepare your PC
Run the System Preparation Tool

Table 2 Checks and Setting updates by the System Preparation Tool

Name Workstation Client OpenLab Server AIC

Workstation Plus CM Services ECM XT
OLSS Server for
ECM 3.x

Mandatory, manual

Windows Update - Apply pending updates

Windows Activation

System domain membership

Region - Change system locale

Indexing options: Disable indexing Options for all

drivers and locations

Recommended

System - Startup and Recovery Settings

System - Turn off system protection (restore

points) for all drives

Windows Update - Disable Windows Update

service

Personalization - Disable advertising info

Personalization - Combine Taskbar Buttons

Recommended, manual

File Explorer - Display Settings

Recycle Bin - Set Recycle Bin properties

System - Performance Settings

Privacy - Set privacy settings

Apps - Default browser

Personalization - Turn off show lockscreen

background picture

1 Local Group Policy Requirements for OpenLab: - Set "Hide entry points for Fast User Switching" to Enabled - Adds “Users” group to
"Access this computer from the network" setting

OpenLab CDS Clients and AICs Installation and Configuration 18

2 Install OpenLab CDS

Installation Workflow Overview 20

Prepare for Installation 22
Install an OpenLab Server 23
Install OpenLab CDS (Client or Instrument Controller) 24
Sample Scheduler for OpenLab 32
Install CDS Client on Terminal Server 33
Silent Installation 34
Export Properties File 34
Run Silent Installation 35
Parameters and Return Codes 36
Logging and Tracing 37
Install or Upgrade Instrument Driver Software 38

This chapter describes the installation of the OpenLab CDS software in a

Client/Server environment.

OpenLab CDS Clients and AICs Installation and Configuration 19

2 Install OpenLab CDS
Installation Workflow Overview

Installation Workflow Overview

Decide if you want to go for a cloud deployment. In this case, check with your
NOT E Agilent representative or refer to the manual OpenLab CDS Configuration in the
Cloud on the Agilent Software Service Desk:
https://servicedesk.li.agilent.com/plugins/servlet/desk.

If you use the Content Management component

Install OpenLab Server provided by OpenLab Server or OpenLab ECM XT:
Refer to the Agilent OpenLab Server and OpenLab
1. Set up the Windows Operating System
ECM XT installation guide.
2. Install OpenLab Server If you use an existing ECM 3.X system to store
including Content Management you data, refer to the Configuring OpenLab CDS
3. Run Installation Verification with ECM 3.x guide.

Running the System Preparation Tool before

Prepare starting the installation is recommended.
Running it helps to reduce or avoid reboots during
• Check OpenLab CDS Requirements the installation.
See “Run the System Preparation Tool” on
and Supported Instruments for
page 12.
Client/Server Systems
If you plan scripted installations, see “Silent
• Run System Preparation Tool
Installation” on page 34.
• Configure Windows (manual steps)

OpenLab CDS Clients and AICs Installation and Configuration 20

2 Install OpenLab CDS
Installation Workflow Overview

It is recommended to install an AIC first before

Install Clients and AICs installing the clients.
• See “Install OpenLab CDS (Client or
1. Install OpenLab CDS
Instrument Controller)” on page 24
on AICs and clients • See “Post Installation Tasks” on page 39
2. Post Installation • See “Optional Procedures” on page 47
Software verification
Set account to enable automatic printing
3. Optional
Improve performance on offline machines
Install Add-ons

See “Licensing” on page 50

Get Licenses
1. Obtain licenses via SubscribeNet:
- OpenLab CDS
- Instrument products
- Add-ons
2. Install your licenses

See “Configure OpenLab CDS” on page 58.

All configuration tasks are performed in the
Configure Control Panel. For more details, refer to the
• Authentication Control Panel section in OpenLab Help &
• Projects, incl. audit trail settings Learning.
• Instruments

OpenLab CDS Clients and AICs Installation and Configuration 21

2 Install OpenLab CDS
Prepare for Installation

Prepare for Installation

1 Make sure that the antivirus software is disabled during the installation.
2 Do not run the Windows Update Service during installation. Make sure that no
Windows updates are performed during the installation.
3 Make sure that no system reboot is pending.
Pending reboots are indicated in the System Preparation Tool (see “Run the
System Preparation Tool” on page 12).
4 Ensure that all required ports can be used by OpenLab CDS. For details, see
Requirements and Supported Instruments for Instrument Controllers, Clients,
or Workstations (CDS_Requirements.pdf).

OpenLab CDS Clients and AICs Installation and Configuration 22

2 Install OpenLab CDS
Install an OpenLab Server

Install an OpenLab Server

If you use the Content Management component provided by OpenLab Server or

OpenLab ECM XT: Refer to the Agilent OpenLab Server and OpenLab ECM XT
Installation guide (ECM_XT_InstallationGuide.pdf).
If you use an existing ECM 3.X system to store you data, refer to the Configuring
OpenLab CDS with ECM 3.x guide (CDS_configure-with-ECM.pdf).

OpenLab CDS Clients and AICs Installation and Configuration 23

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

Install OpenLab CDS (Client or Instrument

Controller)

This procedure describes the installation of the OpenLab CDS software on a

client or Analytical Instrument Controller (AIC). Carry out this procedure on each
client PC and each AIC machine.

Prerequisites An OpenLab Server is already installed and available in your network.

OpenLab CDS versions on clients and AICs must not be higher than the OpenLab
Server version.
If a client needs to be installed on a scalable system, connect it to virtual host
NOT E (typically, the configured hostname of the load balancer) during the installation.

1 To open the installer, right-click the setup.exe file, and run it as administrator.

OpenLab CDS Clients and AICs Installation and Configuration 24

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

2 On the start screen, select OpenLab CDS, and click OK.

3 From the Installation tab, select Install/Upgrade.

OpenLab CDS Clients and AICs Installation and Configuration 25

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

4 License Agreement: Read and confirm Agilent terms and conditions.

5 Installation Type: Select Client or Instrument Controller, depending on what you

are installing.

OpenLab CDS Clients and AICs Installation and Configuration 26

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

6 Installation Folder: Provide an installation folder for OpenLab CDS. Do not use
the root folder of any drive.

7 If you are installing an Instrument Controller: Provide a Projects Root Path

that can be used to store projects data in a failover scenario.

OpenLab CDS Clients and AICs Installation and Configuration 27

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

8 Server Information: Enter the hostname of the Shared Services server you
would like to connect to, and click Connect. If you install an Instrument
Controller, you must additionally provide the OpenLab Control Panel login
credentials of an administrator for the specified server.

9 System Preparation: The installer shows the list of recommended settings for
the system. You may unselect items that you do not want to apply on the
system. Other mandatory settings will be applied automatically during
installation. For an overview of both mandatory and recommended settings,
see Table 2 on page 17.
Click Next to proceed to the Review page. The settings will be applied as part
of the installation.

OpenLab CDS Clients and AICs Installation and Configuration 28

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

10 Review: All components (with their version numbers) that will be installed, and
all settings that will be applied are listed here. The screenshot shows the
review for an OpenLab CDS client.
• To save a properties file for a future silent installation (see “Silent
Installation” on page 34), click Save to config File.
• To start the installation, click Install.

OpenLab CDS Clients and AICs Installation and Configuration 29

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

11 If there are still manual actions required before installation, a warning is

shown.

Options to proceed
• Recommended: Click Open SPT Report to view instructions to complete
these actions. After completing the operations, click Resume Installation.
• Cancel Installation: Installation is aborted. Make necessary updates and
restart installation.
• Resume Installation: The dialog is closed, and installation continues with
the installation of the CDS components even if a setting was not applied,
or the Operating System does not meet requirements.

12 Install: After the installation has completed, click Next.

OpenLab CDS Clients and AICs Installation and Configuration 30

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

13 Finish:
• To view the report of the applied Windows settings, click the link under
System Preparation. If you still need to apply settings manually, a warning
will be displayed. You will find details in the linked report.
• To confirm everything has been installed correctly, click Run Software
Verification1.
• To complete the installation, select the Reboot the computer now check
box, and click Finish.

1 To start the tool separately at a later point in time, select Start > Agilent Technologies > Software
Verification Tool.

OpenLab CDS Clients and AICs Installation and Configuration 31

2 Install OpenLab CDS
Install OpenLab CDS (Client or Instrument Controller)

14 In case of errors during the installation: Check the installation log files under
C:\ProgramData\Agilent\InstallLogs\<date and time>. Note that ProgramData
is a hidden folder.

As of OpenLab CDS version 2.5, registration of the CDS application is no longer

done at the end of the CDS Client installation. For regulated customers, we
recommend to:
• Perform the Operational Qualification (OQ) of the CDS Clients after having
installed at least one Analytical Instrument Controller (AIC).
or
• For configuration with no AIC to run the OpenLab Configuration tool after
installing the first CDS Client (see “Register a Client or Instrument Controller
on the Server” on page 106).

The installation includes a set of standard instrument connections. If you need

other instrument driver software, install it in a separate step. See “Install or
Upgrade Instrument Driver Software” on page 38.

Sample Scheduler for OpenLab

As of OpenLab CDS version 2.6, Sample Scheduler for OpenLab is installed by
default with an OpenLab CDS Client/Server installation. The following
components are available in the Client/Server topology after upgrading to 2.6:
• Server: Sample Scheduler Database as part of the Data Repository, LIMS
Agent, Web Server
• Instrument Controller: Sample Scheduler Agent
• Client: Sample Scheduler Client, Sample Scheduler Configuration
Sample Schedule services are disabled after installation. To try out Sample
Scheduler for OpenLab select Agilent Technologies > Agilent Sample Scheduler
from the Start menu. Click Access free dashboard, and follow the instructions.
If you decide to regularly use Sample Scheduler or want to evaluate more
capabilities please activate it first. For details on activation see information page
that is launched.

OpenLab CDS Clients and AICs Installation and Configuration 32

2 Install OpenLab CDS
Install CDS Client on Terminal Server

Install CDS Client on Terminal Server

1 Set up a Terminal Server.

2 Install the CDS client as described under “Install OpenLab CDS (Client or
Instrument Controller)” on page 24.
3 Publish the Control Panel RemoteApp program from the Terminal Server
setup.
4 From a thin client, access the Terminal Server published link

OpenLab CDS Clients and AICs Installation and Configuration 33

2 Install OpenLab CDS
Silent Installation

Silent Installation

OpenLab CDS supports a command-line mode for installation, also referred to as

silent installation. This mode supports installation, upgrade, and uninstallation.
You can execute silent installations either manually or as part of software
management systems such as LANDesk or HP CM.

Export Properties File

The OpenLab Installer supports a feature to export the installation parameters
into a properties file which you can then use for the silent installation.
1 Launch the OpenLab Installer.
2 Follow the instructions of the wizard.
3 When you have reached the Review screen, click Save to config file.
Save the file to a suitable location. The file will automatically be saved as a
.properties file.
You can now use the properties file for the silent installation.

OpenLab CDS Clients and AICs Installation and Configuration 34

2 Install OpenLab CDS
Silent Installation

Run Silent Installation

Prerequisites • You have prepared a properties file for silent installation. See “Export
Properties File” on page 34.
• .Net Framework is present on your system.
If it is not present, it will automatically be installed. You must then manually
select Accept to agree with the license agreement.

Install application on client or AIC

1 Copy the content of the USB media to a centralized folder.
2 Copy the properties file to the same directory as the CDSInstaller.exe.
3 Right-click the executable of the command prompt or Power shell prompt,
and run it as administrator.
4 Navigate to the location where you have saved the installation files.
For example: C:\CDS
5 To start the installation, call CDSInstaller.exe with the following syntax:
CDSInstaller.exe -s -c <PropertiesFile>
For example:
CDSInstaller.exe -s -c Silent.Properties
With this command, you start the OpenLab Installer without a user interface.
6 Wait about 5 minutes while the installation takes place. To check the process
of installation, look at the log files under %ProgramData%\Agilent\InstallLogs.
If a required installable is missing, the OpenLab Installer will create an entry in
a log file, and, depending on the component type, will continue or roll back the
installation. An error code will be returned in such scenarios.
7 After the installation has finished, reboot the PC.

Register AIC on the server

1 Call registercds.exe with the required parameters.
For example, register an AIC on a server named server01 with the user admin
and password admin in the domain domain01:
registercds.exe -registerapp -regaic -olssserver="server01" -olssuser="admin"
-olsspw="admin" -olssdomain="domain01" -log="C:\temp\log.log"

OpenLab CDS Clients and AICs Installation and Configuration 35

2 Install OpenLab CDS
Silent Installation

Parameters and Return Codes

Parameters
Use the following parameters when calling CDSInstaller.exe in command line
mode:
• -s
Silent mode - no user interface will be shown.
• -c
Configuration file - a properties file contains all parameters.
• <PropertiesFile>
The properties file contains all required inputs for the installer. Replace
<PropertiesFile> with the correct file path and file name. The file must be
located in the same directory as the CDSInstaller.exe.
• -uninstall
Uninstall the currently installed CDS.

Use the following parameters when calling registercds.exe in command line

mode:
• -registerapp
Register the OpenLab CDS software on the server. This adds permissions,
permission groups, and roles; it enables activity log, creates the RecoveryData
folder structure and adds firewall exceptions.
• -regaic
Register the machine as an AIC. This adds the name, hostname, port, and
description of the machine to the list of AICs on the server. It also registers
the installed drivers, registers the instrument icons, and adds support for
multiple instruments.
• -olssserver="nameOfServer"
Connect to the server specified and set default connection.
• -olssuser="nameOfUser"
Username for connecting to the OLSS server specified by the -olssserver flag
• -olsspw="password"
Password for connecting to the OLSS server specified by the -olssserver flag

OpenLab CDS Clients and AICs Installation and Configuration 36

2 Install OpenLab CDS
Silent Installation

• -olssdomain="nameOfDomain"
Domain for the user connecting to the OLSS server specified by the
-olssserver flag
• -log="PathAndNameToLogfile"
Log the actions performed by the tool

Return Codes
After installation, uninstallation, or upgrade in the command-line mode, the
system will return a number code which is explained below.
Table 3 Return codes

Error/return code Return value

Success. You can see all of the information in the 0

log file.

Reboot required. After reboot you need to 3010

execute installation command again. 1641
350

Failure. Verify against the log file to see what any other number
failed.

Logging and Tracing

All exceptions, errors and information messages are logged under C:\
ProgramData\Agilent\InstallLogs\<date and time>. Note that ProgramData is a
hidden folder.

OpenLab CDS Clients and AICs Installation and Configuration 37

2 Install OpenLab CDS
Install or Upgrade Instrument Driver Software

Install or Upgrade Instrument Driver Software

The following driver software packages are automatically installed and

configured with OpenLab CDS. For details, see chapter Supported Instruments in
the OpenLab CDS Requirements and Supported Instruments for Client/Server
Systems guide (CDS_ClientServer_Requirements.pdf).
• Agilent GC & GC/MS
• Agilent LC & LC/MS
• Agilent 35900 A/D
• Agilent SS420x
• Agilent Data Player (Virtual Instruments)
Other instrument driver software, add-on software, or upgrades to existing driver
software, must be installed and configured manually. Instrument driver software
and add-on software can be found on the installation media under Setup\
Packages\Add-Ons.
The latest Agilent drivers are available in SubscribeNet. In the Product List, select
OpenLab Software > OpenLab Agilent Instrument Drivers.

On the Analytical Instrument Controller (AIC)

1 Run the driver installer package, and follow the installation wizard.
For details on the installation or upgrade procedures, refer to the respective
driver documentation.
2 Register the new drivers on the server. The procedure is identical to
registering an existing OpenLab PC as a Client or AIC on the server. See
“Register a Client or Instrument Controller on the Server” on page 106.
New instrument types are now available in the Control Panel.
Both steps can alternatively be done via silent installation. For details, see “Run
NOT E Silent Installation” on page 35.

On the relevant clients

1 Run the installer package on each client from which you will access the
instrument.

OpenLab CDS Clients and AICs Installation and Configuration 38

3 Post Installation Tasks

Run a Software Verification after Software Installation 40

Create Account for Network Access and Printing 41
Set up the domain user account 41
Enable automatic printing 43
Configure the Antivirus Program 44

This chapter describes tasks that are relevant after finishing the installation.

OpenLab CDS Clients and AICs Installation and Configuration 39

3 Post Installation Tasks
Run a Software Verification after Software Installation

Run a Software Verification after Software

Installation

The Software Verification Tool (SVT) provides documentary evidence that your
system has been built and installed correctly, and that all design specifications
have been met. You do not need to run the software verification again if it has run
successfully at the end of the installation.
1 Using your Windows operating system, go to Start > All Programs > Agilent
Technologies > Software Verification Tool.
2 Select the components to qualify.
3 Select Qualify.
The system will run the application and generate a Software Verification
Report. Reports are automatically saved to C:\SVReports.
4 If the report indicates failure, verify the computer requirements and reinstall
the data system.
Do not use the system until the Software Verification Report gives a ‘pass’
result.

OpenLab CDS Clients and AICs Installation and Configuration 40

3 Post Installation Tasks
Create Account for Network Access and Printing

Create Account for Network Access and Printing

OpenLab CDS allows you to automatically process your data during acquisition,
without opening Data Analysis. During this processing specific domain user
privileges to access a network share/network printer and log on as a service are
required:
• You can generate reports and print them to printer or save them as files.
Exporting the reports to a network share is a typical way how they are sent to
an external system (for example, LIMS).
• You can export raw data or results during a run, and save the files to a
network share.

Set up the domain user account

1 Log in as Windows domain user who has local administrative privileges.
2 Go to Control Panel > All Control Panel Items > Administrative Tools and
double-click Services. Make sure the status of Agilent OpenLab Instrument
Service is Started or Running. If not, right-click and select Start.
3 Right-click Agilent OpenLab Instrument Service and select Properties.

OpenLab CDS Clients and AICs Installation and Configuration 41

3 Post Installation Tasks
Create Account for Network Access and Printing

4 Click the Log On tab, select This account and enter the login credentials of a
domain user who has network printing privileges. Click OK.

5 The Services window confirms that the account has been granted the Log On
As A Service right. Click OK.

6 Click OK in the Services window to acknowledge that The new logon name will
not take effect until you stop and restart the service.

OpenLab CDS Clients and AICs Installation and Configuration 42

3 Post Installation Tasks
Create Account for Network Access and Printing

7 Restart the PC. This will enable the Log On user specified in Instrument
Service to automatically print reports in Data Acquisition.

8 After the PC reboots, log in using the same domain user account (for
example, agilent\ppadmin) specified in the Log On tab of Agilent OpenLab
Instrument Service Properties window.

Enable automatic printing

If you plan to acquire a single sample or a sequence that specifies a processing
method that has Printer report destination, add a default printer to the PC to
enable automatic printing of reports.

Prerequisites You have set up a domain user account (see “Set up the domain user account” on
page 41).

1 Go to Control Panel > All Control Panel Items > Devices and Printers and click
Add a printer.
2 Select Add a network, wireless or Bluetooth printer and browse or type a shared
printer name that you want to add. Once the printer is added, print a test page
and set it as a default printer.

OpenLab CDS Clients and AICs Installation and Configuration 43

3 Post Installation Tasks
Configure the Antivirus Program

Configure the Antivirus Program

1 Be sure to open the firewall ports listed in the Firewall Settings in the OpenLab
CDS Requirements and Supported Instruments (Client/Server) guide
(CDS_ClientServer_Requirements.pdf).
2 The following folders should be excluded from Antivirus scan. If you want to
have these folders scanned, you should do this while the system is not
acquiring or doing data Analysis as scanning may cause slowness and runs
to be aborted due to concurrent access to the same file by the AV program
and the CDS Application.
• [C:\]DsData\DsArchive
• [C:\]DsData\DsContent
• [C:\]DsData\DsIndex
• [C:\]Program Files (x86)\Agilent Technologies
• [C:\]ProgramData\Agilent
• [C:\]ProgramData\Agilent IPB Files
• [C:\]ProgramData\Agilent Technologies
• [C:\]ProgramData\ChromatographySystem
• [C:\]ProgramData\Firebird
• [C:\]ProgramData\IsolatedStorage
Refer to your specific antivirus software documentation on how to configure
folder exclusions.

Settings for Trend MicroTM antivirus software

OpenLab CDS can be used with other antivirus programs as well. If you use Trend
MicroTM, the following settings are recommended to optimize system
performance.
1 If your version of Trend Micro has Web Reputation: Turn off to maximize
performance.
The risk of turning off Web Reputation is that web traffic through browsing
from the machine will not be checked.
Ensure that there is another URL/web scanner on the gateway level to protect
the endpoint, or ensure that the endpoints have limited access to Internet.
These production machines should not have access to Internet websites
where most of the infections are coming from.

OpenLab CDS Clients and AICs Installation and Configuration 44

3 Post Installation Tasks
Configure the Antivirus Program

2 Real time scan: Add exclusions, and modify scan direction from
Created/Modified/Retrieved to Created/Modified.
Exclusions ensure that the working directory of Agilent Technologies will not
be scanned, thus improving performance.
The risk is that only files that are created and changed on this machine are
scanned. Files that are just accessed will be bypassed. Dormant Files that got
infected without being noticed at the time they were created or written to the
machine will not be scanned.
Increase scheduled scan to daily to ensure all files on the machine are being
checked for infections that are dormant or not moving.
3 Behavior Monitoring: Add below list of programs to Approved programs.
• OpenLab\Services\Distributed Transaction Coordinator Service\
Agilent.OpenLab.DistributedTransactionCoordinator.Rest.exe
• OpenLab Backup Utility\Monitoring Service\
Agilent.OpenLab.BackupRestore.BackupMonitoringService.exe
• OpenLab Backup Utility\Notification Service\
Agilent.OpenLab.BackupRestore.NotificationService.exe
• OpenLab Backup Utility\Task Status Cache Service\
Agilent.OpenLab.BackupRestore.TaskStatusCacheService.exe
• OpenLab\Services\Electronic Signature Service\
Agilent.OpenLab.ESignature.Rest.exe
• OpenLab Acquisition\
Agilent.OpenLab.Acquisition.AcqInstrumentService.exe
• OpenLab Acquisition\Agilent.OpenLab.AcquisitionClient.exe
• OpenLab Data Analysis\Bin\
Agilent.Chromatography.DataAnalysis.Processing.ProcessingServer.exe
• OpenLab Data Analysis\Bin\
Agilent.Chromatography.DataAnalysis.UI.CustomCalculationDesigner.exe
• OpenLab Data Analysis\Bin\Agilent.OpenLab.DataAnalysis.exe
• OpenLab Data Analysis\Bin\
Agilent.OpenLab.DataAnalysis.Api.ApplicationService.exe
• OpenLab Data Analysis\Bin\Reporting\
Agilent.OpenLab.Reporting.RdlDescriptor.exe
• OpenLab Data Analysis\Bin\Reporting\
Agilent.OpenLab.Reporting.RdlDescriptorContextMenu.exe
• OpenLab Data Analysis\Bin\Reporting\
IntelligentReporting.RenderServiceHost.exe

OpenLab CDS Clients and AICs Installation and Configuration 45

3 Post Installation Tasks
Configure the Antivirus Program

• OpenLab Data Analysis\Bin\Reporting\TemplateDocumentation.exe

• OpenLab Platform\Data Repository\Data Repository\Base\BaseService\
Agilent.OpenLab.DR.BaseService.exe
• OpenLab Reverse Proxy Configuration Service\ConfigurationService\
Agilent.OpenLab.ReverseProxy.ConfigurationService.exe
• OpenLab Services\Distributed Transaction Coordinator Service\
RegistrationTool\Agilent.OpenLab.DataRepository.RegistrationTool.exe
• OpenLab Services\Automation\AutomationServerHost.exe
• OpenLab Services\Diagnostics\DiagnosticsToolsServiceHost.exe
• OpenLab Services\Licensing\Flexera\lmadmin.exe
• OpenLab Services\Licensing\Licensing.Service.Host.exe
• OpenLab Services\Server\SharedServicesHost.exe
• OpenLab Services\UI\Agilent.OpenLab.ControlPanel.exe
• Test Services\Agilent.TestServices.WebService.exe
• Test Services\Central Management Service\
Agilent.TestServices.Server.Main.exe

C:\Program Files (x86)\Agilent Technologies\...

The risk is that if any of the excluded files get infected, it will not be detected.
For example, trigger a schedule on a daily basis to cover these files.

4 Realtime monitoring: Add below folder to the exclusion list of Realtime

Monitoring setting:
C:\Program Files (x86)\Agilent Technologies\

OpenLab CDS Clients and AICs Installation and Configuration 46

4 Optional Procedures

Install OpenLab Help and Learning Only 48

Improve Performance on Offline Machines 49

This chapter describes the installation or upgrade of additional software. It also

contains information on the installation of OpenLab Help and Learning only, and
on performance improvement on offline machines.

OpenLab CDS Clients and AICs Installation and Configuration 47

4 Optional Procedures
Install OpenLab Help and Learning Only

Install OpenLab Help and Learning Only

Use this option to install OpenLab Help and Learning content without installing
OpenLab CDS applications.
Do not use this option on a machine where OpenLab CDS is, or will be, installed.
1 Insert the USB media, right-click the setup.exe file, and run it as administrator.
2 On the start screen, select OpenLab CDS, and click OK.
3 In the OpenLab CDS Installer, click Documentation.
4 Click Install OpenLab Help and Learning Only.
5 Select your language, and click Next.
6 Accept the terms on the License agreement page, and click Next.
7 On the welcome screen, click Next.
8 Review the installation directory. If desired, click Change... to specify a
different directory.
9 Click Install.
10 When the installation is complete, click Finish.
11 If you plan to use Internet Explorer to view the content, make the following
settings to ensure that OpenLab Help and Learning is opened without
showing a confirmation prompt. No configuration is required for Google
Chrome or Edge.
a In Internet Explorer, click Tools > Internet Options.
b Select the Advanced tab.
c Under Security, select Allow active content to run in files on My Computer.
d Confirm your settings.
e Reboot the computer to make the settings effective.
Without these settings, you will need to click Allow blocked content when
opening the help.
You can uninstall or repair OpenLab Help and Learning from the same link in the
installer (see “Uninstall OpenLab Help and Learning Only” on page 112).

OpenLab CDS Clients and AICs Installation and Configuration 48

4 Optional Procedures
Improve Performance on Offline Machines

Improve Performance on Offline Machines

Computers running OpenLab CDS may exhibit slow performance when they are
not connected to the Internet.
Use the following system settings on all workstations, clients, AICs, and servers
to remedy this problem.
1 Open Internet Explorer and select Tools > Internet Options. In the Advanced tab,
clear the following check boxes:
• Security > Check for publisher's certificate revocation
• Security > Check for server certificate revocation
2 Change or add the following registry keys:
• [HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\
SystemCertificates\AuthRoot]
"DisableRootAutoUpdate"=dword:00000001
• [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Policies\
Microsoft\SystemCertificates\AuthRoot]
"DisableRootAutoUpdate"=dword:00000001
3 Document that you turned off the Root Certificates, as this can prevent users
from installing other applications.

OpenLab CDS Clients and AICs Installation and Configuration 49

5 Licensing

About OpenLab CDS Licensing 51

License Types 51
License File 51
Get a License 52
Obtain a License with SubscribeNet 52
Other Ways to Obtain a License 55
Install Your License 57

This chapter provides basic information on OpenLab licensing and describes

how you generate a license file with SubscribeNet.

OpenLab CDS Clients and AICs Installation and Configuration 50

5 Licensing
About OpenLab CDS Licensing

About OpenLab CDS Licensing

License Types
The license file is a collection of Product, Instruments and Add-on licenses (or
activation keys), and is installed to your OpenLab CDS System.
The licenses or activation keys in the license file can either be Shared or Counted:
• Shared licenses — system computers and other components can have
shared, or add-on, licenses — because they share a core license.
• Counted licenses — these licenses are part of the OpenLab CDS floating
licensing strategy. They are not permanently assigned to any one component.
Instead they are automatically assigned to components, such as AICs and
instruments, while the components are starting up. The licenses are
automatically returned when the component is closed. The license
management program controls license issuance and retrieval.
In this case, the only requirement is that a component is licensed while
running. You only need enough licenses for all components running
concurrently, rather than for each installed component.
A startup license for the system allows you to run OpenLab CDS for 60 days after
the installation. In order to run the data system software after the 60-day period,
you must install your license file.

License File
A license file will contain your software license. This file is installed to the license
server, that is, the workstation computer, or the server to which your product was
installed in a client/server system. The license file is bound to this server address,
and cannot be moved to another server.
Information in the license file defines the number of instruments and other
options that may be used concurrently with your system.
The most efficient way to manage and maintain your licensing is through the
Internet.
If you have not received a lavender envelope for your product, contact your
vendor or internal support.

OpenLab CDS Clients and AICs Installation and Configuration 51

5 Licensing
Get a License

Get a License

Obtain a License with SubscribeNet

Use the following procedure to generate and download your license. In case you
do not have internet access, skip to the section “Other Ways to Obtain a
License” on page 55.
If you are a new user who has not registered with SubscribeNet, continue with the
section New Users.
If you have registered with SubscribeNet, skip to the section Users registered with
SubscribeNet.

Prerequisites To generate, download, and install a final license for your product, you will need:
• The authorization code label provided in the lavender envelope containing
your Software Entitlement Certificate.
If you have not received a lavender envelope for your product, contact your
vendor or internal support.
• The URL for SubscribeNet from the Software Entitlement Certificate.
• The host name of the computer where the Control Panel is running.
• The MAC address.
To retrieve your MAC address from a computer where OpenLab CDS is
already installed, open the Control Panel and browse to the Administration >
Licenses section. Use the Copy MAC Address or Save MAC Address function to
obtain the MAC address for license generation.
During this process you will have to enter the MAC address of your license
server. For workstations, this is the local computer. For client/server systems,
this is the server.
If any changes are made to the computer name or domain reference after the
NOT E license is installed, remove the license. A new license will need to be created in
SubscribeNet, downloaded, and installed.

If the network adapter that provides the MAC address used during license
NOT E creation is removed from the machine, your license will no longer be valid. A new
license will need to be generated with a currently available MAC on the license
server.

OpenLab CDS Clients and AICs Installation and Configuration 52

5 Licensing
Get a License

New Users
1 Go to https://agilent.subscribenet.com/control/agil/AgilRegisterToAccount
to register the product with SubscribeNet.
2 On the registration page, enter the authorization code from the label and
complete the profile information (required fields are marked with an asterisk
*).
The email address you enter will become your login ID.
3 Click Submit. The system will generate and display an account name for you.
SubscribeNet will send a welcome email with your login ID and password.
4 Log in to SubscribeNet using your login ID and password.
Once you log in, you can use the online user manual link for help with any
questions you have.
5 Select Generate or View licenses from the left navigation bar.
6 Follow the prompts to generate your new license.
You will be prompted for the HOST NAME of the computer. The host name
you enter must match with the network name of the computer where the
Control Panel is running. Do not include any DNS suffix (domain.com)
references in the entered machine name.
7 When the system generates the license, view its details, then click Download
License File. Save the license file to your computer and to a backup location
(such as a portable storage device).
Use your login ID and password when you revisit the Agilent SubscribeNet site
to regenerate a license file, add new authorization codes, or further configure
the license for your system.

OpenLab CDS Clients and AICs Installation and Configuration 53

5 Licensing
Get a License

Users registered with SubscribeNet

1 If you already have a SubscribeNet account, use
https://agilent.subscribenet.com/.
Lost your SubscribeNet password? Use
https://agilent.subscribenet.com/control/agil/password to have it emailed
to you.
2 Select the SubscribeNet account associated with this authorization code, if
you have more than one account.
3 From the SubscribeNet navigation pane, select Register Authorization Code.
This will allow you to enter your new authorization code and make available
the new license entitlements.
4 Follow steps 5 through 7 in the previous procedure, New Users, to generate or
view your new licenses.

OpenLab CDS Clients and AICs Installation and Configuration 54

5 Licensing
Get a License

Other Ways to Obtain a License

If you are unable to generate a license, contact your nearest Agilent technical
support office. A representative will tell you how to submit an OpenLab CDS
License Generation Form in your location.

Offline Licensing
If an internet connection is not available in your laboratory:
You or your local on-site service engineer will collect the necessary information
from you to allow Agilent to create a license account on your behalf. For phone
support in your region, call the sales and service number for your region. See the
Appendix for contact information.

Required Customer Information for Agilent License Support:

The following information must be provided to Agilent in order to enable us to
create a licensing account on your behalf.
1 Collect Account Information:
Your account name will be your company name and Lab name separated by a
comma. Employee information provided here will be used to define the first
administrator of your account for future access to the system as required.
Please prepare the following pieces of information prior to contacting your
local Agilent sales and service center in order to expedite service:
• Company Name
• Lab/Department Name
• First Name
• Last Name
• E-mail address
• Job Title
• Phone #
• Address, City, State/Province, Postal Code, Country
2 Collect Authorization Code(s):
The authorization code is an alpha-numeric code provided on a label which is
enclosed in a lavender envelope. If you have received more than one code you
must provide all codes to ensure that all ordered licenses are granted to your
account.

OpenLab CDS Clients and AICs Installation and Configuration 55

5 Licensing
Get a License

3 Receiving your license:

Once the above information is provided Agilent will then work on your behalf
to generate a license file through SubscribeNet. The license file will either be
sent to your shipping address (on a CD), or your local FSE will deliver it in
person (usually on USB media). Once your license is received follow the below
section on “Install your License” to finish installing your license on your CDS
system(s).

OpenLab CDS Clients and AICs Installation and Configuration 56

5 Licensing
Install Your License

Install Your License

The license must be added to your system using the Control Panel.
1 Start the Control Panel from any machine connected to the system you want
to install the license for.
2 Navigate to Administration > Licenses.

3 In the ribbon, click Add License .

4 Choose to install the license by:

• Using the license file option to browse to and open the license file (.lic)
saved from the license generation process in SubscribeNet.
• Selecting the License Text option and copying the license text from a text
file received into the provided field.
5 Click OK.
The Administration interface in the Control Panel will now display the status of
installed licenses.
A full restart is required in order for any license to have an immediate effect.
NOT E

OpenLab CDS Clients and AICs Installation and Configuration 57

6 Configure OpenLab CDS

Configure Authentication 59
Configure Security Policy 60
Configure users and roles 61
Create or import users 61
Groups 62
Roles and Privileges 63
Add users or groups to a role 64
Specific Roles for Individual Instruments or Projects 65
Configure Initial Project 66
Configure Initial Instrument 66
Other settings in the Control Panel 67

OpenLab CDS Clients and AICs Installation and Configuration 58

6 Configure OpenLab CDS
Configure Authentication

Configure Authentication

OpenLab CDS supports the following authentication providers:

• Internal
In this mode, the user's credentials are stored in the OpenLab CDS system.
You are asked to create an administrator account for OpenLab CDS before
setting up other users. This is the only mode in which you can create new
users within the system; in all other modes you can only map to users that
exist in a different system.
• Windows Domain
You import existing Windows users into OpenLab CDS system. The
authentication is done either by Windows Active Directory domain or NT 4.0
Domain within the Enterprise. OpenLab CDS only uses the identity and
password of the mapped users; roles and privileges for OpenLab CDS are still
configured in the Control Panel.
Prior to Client or AIC installation, authentication has been configured on your
OpenLab Server. If it is internal authentication, and you are fine with it, nothing
needs to be done.
1 Launch the Control Panel. Log in with the internal administrator's credentials.
2 Navigate to Administration.
3 In the navigation pane, select System Configuration.

4 In the ribbon, click Edit System Settings .

5 Select the authentication provider Windows Domain from the drop-down list,
then click Next.
Do not change the storage type.
NOT E

6 Select the check box to use a domain user, and provide user credentials with
the rights to obtain user and group information. Then click Select Account to
open the Search Users dialog and select an administrator account.
7 Confirm your settings. When complete, the Control Panel will restart.

OpenLab CDS Clients and AICs Installation and Configuration 59

6 Configure OpenLab CDS
Configure Security Policy

Configure Security Policy

If you need to comply with specific standards (for example, 21 CFR Part 11),
adjust the security policy as required.
With the authentication provider Internal, you can set all parameters in the Control
Panel.
With an external authentication provider (Windows Domain), you can set the
inactivity time or enable single sign-on; all other parameters are defined by the
external system.
1 Launch the Control Panel and navigate to Administration.
2 In the navigation pane, select Security Policy.
3 In the ribbon, click Edit Security Policy.
4 Set the parameters as required, and confirm your changes.
Restart the Control Panel to apply your changes.
To meet 21 CFR Part 11 requirements, set the Password expiration period to 180
NOT E days or less. Do not change the other default values, they comply with 21 CFR
Part 11.

OpenLab CDS Clients and AICs Installation and Configuration 60

6 Configure OpenLab CDS
Configure users and roles

Configure users and roles

With internal authentication, you create the required users in the Control Panel.
With Windows domain as an external authentication system, you import the
Windows domain users.
To define what users are allowed to view or do, OpenLab CDS offers predefined
roles and allows you to define your own specific roles.
Roles are equipped with numerous specific privileges. When you set up a
customized role, it is therefore recommended starting from a lower role (that is,
with fewer privileges) and adding specific required privileges, rather than
removing privileges from a higher role.
Each user can be member of multiple groups. You must assign one or more
specific roles to each group. You can also assign roles to single users; however,
for the sake of clarity, it is strongly recommended to assign roles only on the
group level. Every member of a group automatically has all roles of this group.
1 Launch the Control Panel and navigate to Administration.
2 In the navigation pane, select Users, Groups, or Roles.
3 Create new items, or edit the existing ones.

Create or import users

Add users (Internal Authentication only)
1 From the navigation pane, click Administration > Users.
2 In the ribbon, click Create User.
3 In the Create User dialog, provide the relevant parameters:
• Enter the name and password for the new user.
• By default, the new user will need to change the password at next logon. If
this is not required, clear the User must change password at next logon
check box.
• In the Role Membership tab, assign the user to an appropriate role. You can
use the default roles, or prepare your own roles in the Control Panel under
Administration > Roles.
4 Click OK.

OpenLab CDS Clients and AICs Installation and Configuration 61

6 Configure OpenLab CDS
Configure users and roles

Import users (Windows Domain Authentication only)

To add users to your system, you must have privileges to obtain user and group
information from the domain.
1 From the navigation pane, click Administration > Users.
2 In the ribbon, click Import User.
3 In the Search Users dialog box, enter search string for the Windows domain
username.
4 From the Search Results list, select the user you want to import, and click Add.
The user is added to the Selected Users list.
5 Repeat steps 2 to 4 until you have added all the user names that you want to
import to the Selected Users list, then click OK.

Groups
Each user can be member of multiple groups. You must assign a specific role to
each group. You can also assign roles to single users; however, for the sake of
clarity, it is strongly recommended to assign roles only on the group level.
If you use an external authentication provider, you can either import the names of
groups that exist in the external system, or create new internal groups. There is
no limit on the number of groups that can be mapped or created.
Assign users to groups either in the external system or in the Control Panel. If you
need additional user assignments that are relevant only for OpenLab CDS, create
them in the Control Panel.
If you delete or unmap a group, the users who were members in this group
remain unchanged.

OpenLab CDS Clients and AICs Installation and Configuration 62

6 Configure OpenLab CDS
Configure users and roles

Roles and Privileges

Roles are used to assign privileges to a user or a user group globally or for a
specific instrument, project, project group or location. The system contains a list
of predefined roles which are installed as part of the system installation (for
example, Instrument Administrator, Instrument User, or Everything). Each role has
certain privileges assigned.
Privileges are grouped according to the three main role types (Project role,
Instrument role, and Administrative role). When you assign privileges to a role,
you first select the required role type and then select the privileges related to this
role type. Each role can only have privileges of one specific role type; the only
exception is the predefined role Everything, which has all privileges of all role
types. Users or groups may require multiple roles to perform system functions.
For example, a user with the role Chemist may need another role such as
Instrument User with the privilege to run an instrument.
You can create a tree of different locations in the Control Panel, and add
instruments to the relevant locations. For each instrument or instrument group,
you can assign different instrument roles (see also “Specific Roles for Individual
Instruments or Projects” on page 65). For example, a user can have the role
Instrument Administrator for one instrument, and Instrument User for another
instrument.
You can also create a tree of different projects or project groups in the Control
Panel, and assign different Project roles for different projects (see also “Specific
Roles for Individual Instruments or Projects” on page 65). For example, a user
can have the role Project Administrator in one project, so that he can manage the
settings in the Control Panel. In a second project, he may have a role that allows
him to edit the content of a project, but not to change the project settings.
For more information on privileges, see the Appendix.
Table 4 Description of role types

Role Type Description

Administrative privileges These privileges are globally assigned to a user or group and cannot be
changed on the instrument/location level. They are the typical
administration privileges such as Backup and restore, Manage security,
Manage printers, etc.

OpenLab CDS Clients and AICs Installation and Configuration 63

6 Configure OpenLab CDS
Configure users and roles

Table 4 Description of role types

Role Type Description

Instrument privileges These privileges can be assigned globally or on the instrument/location

level. Privileges for instruments are, for example, View instrument or
location and Run instrument.
Users need the View instrument or location privilege on the global level to
see the locations and instruments tree in the Control Panel.

Project privileges Privileges for accessing or modifying different levels of data. You can
assign these privileges globally or on project or project group level.

Add users or groups to a role

1 From the navigation pane, click Administration > Roles.
2 In the Roles window, select the role you want to assign to users or groups.
3 In the ribbon, click Edit Role.
4 In the Edit Role dialog box, click the Members tab.
5 Click Add user or group.
6 In the Search Users and Groups dialog box, enter the name of a user or group,
and click Search to view a list of all users and groups that meet the search
criteria.
7 Under Search Results, select a user or group, and click Add.
8 Click OK.

OpenLab CDS Clients and AICs Installation and Configuration 64

6 Configure OpenLab CDS
Configure users and roles

Specific Roles for Individual Instruments or Projects

By default, the roles of users or groups are globally set for all locations,
instruments, project groups, or projects. The role settings are inherited from the
root node Instruments or Projects, respectively. In order to assign a different role
to a user or group for one specific project:
1 Select the relevant project.
2 In the ribbon, click Edit Privileges.
3 In the Edit Privileges dialog, clear the Inherit privileges from parent check box.
Afterwards, you can assign a different role that will be valid only for the specific
node.
You can assign Instrument roles to individual locations or instruments.
If you use projects, you can assign Project roles to individual project groups or
projects.
Administrative roles are always set globally.

OpenLab CDS Clients and AICs Installation and Configuration 65

6 Configure OpenLab CDS
Configure Initial Project

Configure Initial Project

1 Launch the Control Panel and navigate to Projects.

2 Click Create in the ribbon to create a new project.
On the CDS Settings tab:
• Enter the locations for Methods, Sequences, Results, Sequence Templates
and Report Templates.
• Consider the required audit trail settings for this project.
For more details, refer to the Control Panel section in OpenLab Help & Learning.

Configure Initial Instrument

1 Launch the Control Panel and navigate to Instruments.

2 Click Create in the ribbon to create a new instrument.
3 Select the new instrument, and click Configure Instrument in the ribbon.
4 It is recommended that you use Auto Configuration (if available) to configure
your instruments: Click Auto Configuration, and provide the instrument's IP
address or hostname.
For more details, refer to the Control Panel section in OpenLab Help & Learning.

OpenLab CDS Clients and AICs Installation and Configuration 66

6 Configure OpenLab CDS
Other settings in the Control Panel

Other settings in the Control Panel

Consider also other settings in the Control Panel, such as:

• Changing the instrument status reporting frequency
• Changing audit trail settings for a project
• Editing signature levels for a project
For more details, refer to the Control Panel section in OpenLab Help & Learning.

OpenLab CDS Clients and AICs Installation and Configuration 67

7 Set Up NIST Library Search

Install Software and Library Components 69

Configure MS Library in OpenLab CDS 79

This chapter describes the installation of NIST software components, and the
configuration steps in OpenLab CDS that are required for using the NIST MS
library search.