Watson Web Services Library 2.0 Guide

Thermo Scientific Watson
Web Services
Library 2.0 Guide
Revision A
© 2009 Thermo Fisher Scientific Inc. All rights reserved.
Thermo Fisher Scientific Inc. provides this document to its customers with a product purchase to use in the
product operation. This document is copyright protected and any reproduction of the whole or any part of this
document is strictly prohibited, except with the written authorization of Thermo Fisher Scientific Inc.
The contents of this document are subject to change without notice. All technical information in this
document is for reference purposes only. System configurations and specifications in this document supersede
all previous information received by the purchaser.
Thermo Fisher Scientific Inc. makes no representations that this document is complete, accurate or error-
free and assumes no responsibility and will not be liable for any errors, omissions, damage or loss that might
result from any use of this document, even if the information in the document is followed properly.
This document is not part of any sales contract between Thermo Fisher Scientific Inc. and a purchaser. This
document shall in no way govern or modify any Terms and Conditions of Sale, which Terms and Conditions of
Sale shall govern all conflicting information between the two documents.
All trademarks recognized.

C
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Safety and Special Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Contacting Us . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Overview of Watson Web Services Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Watson Web Services Library (WWSL) 2.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Chapter 2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Installation Instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Pre-Install: Software Requirements for Hosting the Web Service . . . . . . . . . 3
NET 3.5 Framework Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Installing Internet Information Services (IIS). . . . . . . . . . . . . . . . . . . . . . . . . 12
Windows 2008 Server - Convert to Application . . . . . . . . . . . . . . . . . . . . . . . . 14
Watson SQL Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Confirming WWSL is Installed and Operating Correctly . . . . . . . . . . . . . . . . . 16
If Using a Secure Socket Layer (SSL) Certificate . . . . . . . . . . . . . . . . . . . . . . 18
Installation Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Chapter 3 WWSL 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Import Study Protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
WWSL 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Benefits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Procedure Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Studies and Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Date Styles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Date: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
DateTime: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
WWSL for ISP Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Supported Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Assumption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Thermo Scientific Watson Web Services Library 2.0 iii

Contents
Appendix Service Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i

Compatibility Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ii
Procedure Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
XSDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxii
iv Watson Web Services Library 2.0 Thermo Scientifi

P
Preface
The Watson Web Services Libarary 2.0 contains information on installing and using the
Watson Web Services Library version 2.0.
Related Documentation
Please reference:
• Watson LIMS 7.4 System Manager’s Guide
• Watson LIMS 7.4 Installation Guide
• Watson LIMS 7.4 User Manual
Safety and Special Notices

Make sure you follow the precautionary statements presented in this guide. The safety and
other special notices appear in boxes.
Safety and special notices include the following:
IMPORTANT Highlights information necessary to prevent damage to software, loss of

data, or invalid test results; or might contain information that is critical for optimal
performance of the system.
Note Highlights information of general interest.
Tip Highlights helpful information that can make a task easier.
Contacting Us
There are several ways to contact Thermo Fisher Scientific for the information you need.
Thermo Scientific Watson Web Services Library 2.0 v

Preface
❖ To contact Technical Support
Web www.thermo.com/informaticscontacts
E-mail support.informatics@thermofisher.com
❖ To contact Customer Service for ordering information

Web site http://www.thermo.com/com/cda/contactus/home/
❖ To suggest changes to documentation or to Help

Send an e-mail message to the Documentation Manager:
Sidinf.documentation@thermofisher.com
vi Watson Web Services Library 2.0 Thermo Scientific

1
Introduction
This chapter contains:
Contents
• Overview of Watson Web Services Library
• Watson Web Services Library (WWSL) 2.0
Overview of Watson Web Services Library

The Watson Web Services Library (WWSL) provides a standard mechanism for external
systems to interact with Watson LIMS using web service technology. A web service is defined
by the World Wide Web Consortium (W3C) as a software system designed to support
interoperable machine-to-machine interaction over a network environment. These services
use SOAP-formatted XML envelopes, and have their interfaces described by Web Services
Description Language (WSDL). Each web service implemented in the library will have
distinct integration points into Watson. Typically, the web service will integrate with the
Watson database to create, update, or retrieve data
WWSL provides an application-independent method to request a series of Watson-specific

operations to be performed by an external application. It is a direct system-to-system process,
which is initiated by the system, and that allows a push of external data into Watson. It is
designed to be used across all software applications that must process commands (usually
provided in XML form) within Watson. The Watson Web Service resides on an IIS server and
uses the secure HTTPS transport protocol.
Watson Web Services Library (WWSL) 2.0

The current release of the Watson Web Services Library, WWSL 2.0, will be used for Import
Study Protocol and samples.
The WWSL functionality also allows an external application to create (or supplement) a
Watson study design. Examples of external applications are:
• A clinical data system, which is now able to create study samples inside Watson.
• A custom built application.
Thermo Scientific Watson Web Services Library 2.0 1

1Introduction
Watson Web Services Library (WWSL) 2.0
There are additional methods to get project and study details. WWSL 2.0 also provides
methods to get or update subject, treatment, and sample data using different web service calls.
Also, methods to validate user name and check permissions are provided.
2 Watson Web Services Library 2.0 Thermo Scientific

2
Installation
Contents
• Installation Instructions
• NET 3.5 Framework Setup
• Windows 2008 Server - Convert to Application
• Watson SQL Scripts
• Confirming WWSL is Installed and Operating Correctly
• Installation Issues
Installation Instructions
The installation of the Watson Web Services Library 2.0 (WWSL) is a multi-step process. It
has been broken into a number of milestones. Each milestone has detailed written instructions
describing the operation to be carried out on the host operating system (excluding those
milestones involving rote Oracle configuration and testing tasks).
Pre-Install: Software Requirements for Hosting the Web Service

The following are the minimum necessary software requirements to install and operate the
Watson Web Services Library 2.0.
Software Download URL or License disposition
Windows Server 2003, 2008, or Base operating system: Licensed Software
XP
IIS 5.1 Web server: component of Windows Server
.NET 3.5 Framework .NET 3.5 Framework will be installed as part of the
installation process if it is not on currently installed.
The Watson Web Services Library 2.0 has been developed and tested with IIS 5.1 and 7.0,
ADO.NET 3.5, and ASP.NET 2.0 running on the Windows XP, 2003, or 2008 operating
system. The development environment was provided by Visual Studio 2008.

2 Installation
The following sections provide the installation instructions for Watson Web Services Library
2.0. The Microsoft .NET 3.5 Framework installation package is included with this
installation package and launches automatially during the installation process if InstallShield
detects that it is not already installed.
❖ To Install WWSL 2.0:

1. Click the WWSL_2.0.exe file to execute the installer. The Preparing Setup window
appears.
Figure 2-1. Preparing Setup
2. When Setup has been prepared, the Watson Web Services Library 2.0 - InstallShield
Wizard Welcome screen appears.

2 Installation
Figure 2-2. InstallShield Wizard Welcome screen
3. Click Next. The Watson Web Services Library 2.0 - InstallShield Wizard: License
Agreement appears.
Figure 2-3. Watson Web Services Library 2.0 License Agreement
\

2 Installation
4. Click I accept the terms of this license agreement. To print the terms for review, click
Print.
5. Click Next to continue. The Select IIS Root Folder screen appears.
Figure 2-4. Select IIS Root Folder
6. Click Browse to select a location for the IIS Root Folder. Click Next to continue.
7. The Watson Web Services Library 2.0 - InstallShield Wizard window shows that it is
ready to begin the installation.

2 Installation
Figure 2-5. Watson Web Services Library 2.0 - InstallShield wizard
8. Click Install. The Setup Status window appears, displaying the status of the installation.
Note At this point in the installation, you will receive an error message if the correect
version of Internet Information Server 5.1 (IIS) is not installed on your system. It is
required for the installation of WWSL 2.0 to continue. If IIS must be installed, exit the
WWSL 2.0 installation and install IIS and then resume the WWSL 2.0 installation.

2 Installation
Figure 2-6. Installation Status
NET 3.5 Framework Setup

The .NET 3.5 Framework Setup Welcome to Setup screen appears. This screen allows you to
access the supplemental license terms for the .NET 3.5 Framework. To print the terms, click
Print.

2 Installation
Figure 2-7. .NET 3.5 Supplemental License
9. Select I have read and ACCEPT the terms of this License Agreement then click Install.
10. The .NET 3.5 installer window alerts you of the progress of the download and
installation.

2 Installation
Figure 2-8. .Microsoft .NET Framework 3.5 Setup Download and Install Progress
11. When Setup is complete, a window appears alerting you that Microsoft .NET 3.5
Framework has installed correctly.

2 Installation
Figure 2-9. .NET 3.5 Framework Setup complete
12. Click Exit.

13. The InstallShield Wizard complete screen appears, alerting you that Watson Web Services
Library 2.0 has installed successfully.

2 Installation
Figure 2-10. InstallShield Wizard Complete screen
Installing Internet Information Services (IIS)

IIS is available on your Windows XP DVD, under Optional Components.
In the example below, the operating system is Windows XP. The version of IIS is 5.1. It is
recommended that 5.1 be used.
❖ To install IIS
1. Load the Installation CD.
2. The Windows XP Welcome Screen appears.

2 Installation
Figure 2-11. Windows XP Welcome screen
3. Click the arrow to the left of the Install optional Windows components option to select
it.
4. The Windows Components window appears. Scroll down to Internet Information
Services (IIS), and click the checkbox to the left of it to select it then click Next.
Figure 2-12. Windows Components

2 Installation
Windows 2008 Server - Convert to Application
5. The Windows Components Wizard alerts you when it has completed the installation.
Click Finish to load an Installation Report.
Figure 2-13. Completing the Windows Components Wizard
Windows 2008 Server - Convert to Application

Note On Windows Server 2008, the WCF Activation feature under the .NET
Framework 3.0 Feature must be installed.

2 Installation
Watson SQL Scripts
1. Go to the IIS Manager and expand the Default Web Site category.
2. Right-click the ThermoWebAccess folder icon.
Figure 2-14. Convert to Application
3. Click OK to confirm.
4. If the conversion was successful, the ThermoWebAccess folder icon changes to the
following:
Figure 2-15. Icon Change
Watson SQL Scripts

Part of the installation of Watson is the creation of the user, Watson, and the corresponding
tablespaces. SQL scripts for these purposes and other purposes are provided on the
distribution media within the \Oracle\WWSL2_user\ directory. On the CD ROM, the SQL
scripts are marked as Read-only. If any of these scripts need to be modified, they will need to
be moved to your local hard drive or network so that the Read-only property can be turned
off.

2 Installation
Confirming WWSL is Installed and Operating Correctly

To confirm that the Watson Web Services Library is installed and operating correctly,
complete the following steps:
1. Choose Start>Control Panel.
2. The Control Panel window appears. Click Administrative Tools.
3. Click the Internet Information Services (IIS) Manager icon. Expand the Web Sites and
the Default Web Site folders.
4. Locate the WWSL_2.0 icon within the Default Web Site folder, right-click and select
Browse to browse the web service.
If you receive an error when browsing the web service:

1. Execute the iisreset command from the run dialog or the command prompt.
Figure 2-16. iisreset command
Figure 2-17. Command Prompt
2. Ensure the ASP.NET version is 2.0 on the ASP.NET tab of Web Service properties on IIS.
3. If you are still unable to browse the web service, select Properties by right-clicking the
web service in the IIS Admin dialog.

2 Installation
Figure 2-18. Properties
4. On the Virtual Directory tab select Configuration. The Application Configuration

window appears.
Figure 2-19. Application Configuration

2 Installation
5. Verify that there is an entry for .svc extension.

If there is not, add it by clicking Add. All the data should match that of the .asmx file.
Figure 2-20. Add/Edit Application Extension Mapping
6. Reset IIS and browse the web service.
If Using a Secure Socket Layer (SSL) Certificate

The following must be added in the binding configuration:
<security mode="Transport">
<transport clientCredentialType="None" proxyCredentialType="None"
realm="" />
<message clientCredentialType="Certificate" algorithmSuite="Default"
/>
</security>
clientCredentialType value can be “Certificate” or “UserName”
Additionally, change <serviceMetadata httpGetEnabled="true" /> to

<serviceMetadata httpsGetEnabled="true" />
Comment out <endpoint address="mex" binding="mexHttpBinding"

contract="IMetadataExchange" /> in the config file.

2 Installation
Installation Issues
Installation Issues
Please be sure to include or have available the following information with the support request:
• The TNSNAMES file for the Oracle Client installed on the Host Server for the Web
Service.
Possible Issue: Has Oracle been configured correctly on the client?
• The name of the server the Watson Web Service has been installed on.
Possible Issue: Corroborate that the Web.config file has been configured correctly.
• A screen capture of the permissions on the folder the Web Service was installed on.
Possible Issue: Has "Authenticated Users" been added to the permission list with Read &
Execute permission?
• A screen capture of the folder the Web Service was installed on with all of the
subfolders expanded and the contents of the folders displayed in the right hand pane.
Possible Issue: Is the folder where the web service was unzipped to the virtual folder setup
in IIS?
• A screen capture of the permissions on the root folder that the Oracle Client was
installed on.
Possible Issue: Has "Authenticated Users" been added to the permission list with Read &
Execute permission?
• A screen capture of the Certificate Installed on the Web Service Host Server.
Possible Issue: Has the Certificate been correctly installed on the server and the client?
This information will make it easier for the support staff to troubleshoot your issue.

2 Installation
Installation Issues

3
WWSL 2.0
Contents
• Import Study Protocol
• WWSL 2.0
Import Study Protocol

The Import Study Protocol (ISP) within Watson allows a Watson user to enter study samples
and sample-related information into the Watson database by importing a properly formatted
Microsoft Excel file. This is a manual process initiated by the user when he or she selects the
Import Study Protocol menu item from the Study Actions menu within Watson. Through the
Import Study Protocol process the study design is updated. The updated design may be
viewed through the Watson Design Summary window which is populated with the newly
imported samples and their associated data such as Subject, Group, and Treatment, etc.
Figure 3-21. Example - ISP vs. Web Services

3WWSL 2.0
WWSL 2.0
WWSL 2.0 allows an external application to create (or supplement) a Watson study design.
Examples of external applications are:
• A clinical data system, which is now able to create study samples inside Watson.
• A custom built application.
WWSL 2.0
The Watson Web Services Library 2.0 has the following features and benefits.
Features
Features include:
• Create a project in Watson
• Get list of projects from Watson
• Get list of studies from Watson
• Get study details and study status
• Update study details
• Get subject details
• Update subject details
• Get treatment details
• Update treatment details
• ImportProtocol
• Get sample details
• Add sample details
• Update sample details
• ValidateProject
• Check permissions
• GetProtocolServiceSchema
• ValidateUserNamePassword
• Single report of any import problems

3 WWSL 2.0
WWSL 2.0
Benefits
Benefits include:
• An application-independent way to perform Import Study Protocol
• Automation of Watson LIMS
• Automated study and sample creation
• Secure and automated data transfers
• Productivity improvements
• Use of standard transport protocols
• Maintenance and control by IT and System Administrators, allowing more time for the
research and development personnel to focus on other priorities.
Compatibility
All web service calls except Import Study can be used with older versions of Watson.
Procedure Calls
There are currently sixteen WWSL procedure calls available. See “Appendix: Service
Parameter Definitions.” for details.
Studies and Samples

WWSL 2.0 provides the capability to create both samples and studies within Watson. WWSL
2.0 can be used to create new studies, new samples for new studies, or new samples for
existing studies within Watson. It may also be used to update sample information within an
existing study.
To complete these functions successfully, there are certain requirements that must be met.
Most importantly, the WWSL 2.0 user must have the "Import Study Protocol" Watson
Security Privilege assigned to them (see the Watson System Manager’s Manual for information
on assigning security privileges). In conjunction with the creation and/or update process, the
system also makes it possible to enter an electronic signature for both Study Creation and
Import Study Protocol function.
To create a new study in Watson using WWSL, the following information must be supplied:
• Project ID (Must be a pre-existing project Id)
• Security Workgroup (Must be a pre-existing security workgroup)
• Study ID

3WWSL 2.0
WWSL 2.0
• User Name
• User Password
To create new sample records within a newly created study using WWSL, the following
information must be supplied:
• Study ID
• Subject
• Treatment ID
• Biological Matrix
• Day Nominal
• Hour Nominal
• Minute Nominal
New samples can also be created for existing studies within Watson. In addition to creating
and updating samples, WWSL 2.0 also makes it possible to automatically accept newly
created samples within Watson.
Note It must not be possible for an external user (a user outside of Watson) to use WWSL
without an appropriate Watson WWSL security privilege, username, and password. A user
is defined as either a living person or a computer system.
Date Styles
WWSL 2.0 will support the date formats currently supported by XML standards which are
defined in ISO 8601.
Date:
CCYY-MM-DD
DateTime:
CCYY-MM-DDThh:mm:ss
WWSL for ISP Operations

The Watson Web Service Library will receive a request to execute the Import Study Protocol
operation through the defined process previously described.

3 WWSL 2.0
WWSL 2.0
The request will contain the following in XML format
Date Field Status

Watson Password Required
Watson Security Workgroup Required
Watson StudyName Required
Optional Study Definition Data Refer to the Supported Data
section of this chapter
Watson Project ID Required
Esignature Reason Optional
Esignature UserName Optional
Esignature Password Optional
Esignature LocalTimeStamp Optional
Data for Import Study Protocol Refer to the Supported Data
section of this chapter
Once invoked WWSL 2.0 Import Study Protocol operation will:

• Authenticate the Watson user
• Authenticate Watson user security permissions for Import Study Protocol function
• Validate that Watson User belongs to an existing Watson Security Workgroup
• Validate the existence of the Watson Project
• Create a new study if the study does not already exist
• Generate an Esignature for the Import Study Protocol event if defined in the System
Configuration
• Update the Watson study design
• Return success or error codes to invoking external application through XML

3WWSL 2.0
WWSL 2.0
Supported Data
The following data is supported by the Import Study Protocol function of the Watson web
service.
Field Definition Data Tyoe Required Data Requirement
PROJECT ID Unique text String (30) Yes Must be an
identifier for a existing project
project
STUDY ID Unique text String (50) Yes
identifier for a
study
STUDY TITLE Title of study String (255)
STUDY Description of String (4000)
DESCRIPTION study
STUDY Director of study String (50)
DIRECTOR
STUDY USER User defined String (50) Must be defined
STATUS status of study in Watson
Libraries
DEPUTY STUDY Deputy Study String (50)

DIRECTOR Director
(PRINCIPAL
INVESTIGATOR)
SPECIES Define species for String (50) Must be defined
study in Watson
Libraries
PK DIRECTOR PK Director String (50)
(BIOANALYTICA
L MONITOR)
STUDY TYPE Type of study String (50) Must be defined
in Watson
Libraries
ANALYTICAL Analytical String (50)
COORDINATOR coordinator for
study
STUDY START Start date of study Date
DATE

3 WWSL 2.0
WWSL 2.0

STUDY Completion date Date
COMPLETION of study
DATE
DEPARTMENT Department String (50)
NOTEBOOK Notebook String (50)
PK Completion date Date
COMPLETION of PK
DATE
FILE PREFIX File Prefix String (50)
PAGE NUMBER Page number String (50)
AMENDMENT Amendment String (50)
GLP STUDY (Y GLP study String (1) Y or N
OR N)
(Default to N)
SET SAMPLE Not Supported
CONDITION TO
NOT RECEIVED
(Y OR N)
SUBJECT Text description String (20) Yes
for the subject
TREATMENT ID Unique text String (8) Yes
identifier for a
treatment
BIOLOGICAL Sample Type String (50) Yes Must be defined

MATRIX Used in Study in Watson
(Blood, Plasma, Libraries
Urine)
DAY NOMINAL Nominal Numeric Yes
Sampling Day
HOUR Nominal Numeric Yes
NOMINAL Sampling Hour
MINUTE Nominal Numeric Yes
NOMINAL Sampling Minute
START DAY Nominal start day Numeric
NOMINAL of a collection

3WWSL 2.0
WWSL 2.0

START HOUR Nominal start Numeric
NOMINAL hour of a
collection
START MINUTE Nominal start Numeric
NOMINAL minute of a
collection
SUBJECT ALIAS Alternate text String (50)
description for
the subject
GENDER Specifies subject String (20) Must be defined
gender in Watson
Libraries
TREATMENT Description of String (100)
DESCRIPTION treatment
DOSE Numerical Numeric
amount of dose in
units specified by
Dose Units
DOSE UNITS Identifies dose String (50) Must be defined
units associated dose unit in
with Dose Watson
ROUTE Route of String (50) Must be defined

administration in Watson
Libraries
FASTED FED Fasted/fed status String (20) Must be defined
for the treatment in Watson
Libraries
PLACEBO If Y then the String (1) Y or N
TREATMENT sample is a
placebo and the
dose is assumed to
be zero
CUSTOM ID External Identifier String (255)

for a sample
SPLIT Identifies split of Numeric
the sample

3 WWSL 2.0
WWSL 2.0

STUDY DAY Study Day value Numeric
corresponding to
treatment
WEEK Week value Numeric
corresponding to
treatment
YEAR Year value Numeric
corresponding to
treatment
PERIOD Period value Numeric
corresponding to
treatment
VISIT Visit value Numeric
corresponding to
treatment
MONTH Month value Numeric
corresponding to
treatment
AGE Specifies age of Numeric
subject
HEIGHT Specifies height of Numeric

subject
PLACEBO "N" if subject is String (1) Y or N
SUBJECT not placebo, "Y"
otherwise
REGIMEN Regimen for the String (50) Must be defined
treatment in Watson
Libraries
SAMPLE Status of sample String (50) Must be defined
CONDITION in Watson
Libraries
SAMPLE Date sample is Date
RECEIPT DATE changed from
"Not Received"
SUBJECT GROUP Text identifier for String (8)
this subject group

3WWSL 2.0
WWSL 2.0

SUBJECT USER User specified text String (100)
TEXT 1 associated with
subject
subject
subject
subject
subject
subject
subject
subject
TIME TEXT Text identifier for String (50)
time information
TREATMENT Identifies site String (50)
SITE associated with
subject
TREATMENT User specified text String (100)
USER TEXT 1 associated with
treatment

treatment

3 WWSL 2.0
WWSL 2.0

treatment
treatment
treatment
treatment
treatment
treatment
WEIGHT Specifies weight Numeric
of subject
VOLUME Volume of sample Numeric
ACTUAL Actual date and Date
SAMPLING time of the
DATE/TIME sampling time
FROZEN Identifies a frozen String (50) Must be defined
CONDITION condition in Watson
associated with Libraries
this sample
IDENTIFICATIO Identification String (50) Must be defined
N STATUS status associated in Watson
with this sample Libraries
INACTIVATION Infectious String (20)
TEMP inactivation
temperature for
sample
INACTIVATION Start time for Date
TIME IN sample infectious
inactivation

3WWSL 2.0
WWSL 2.0

INACTIVATION End time for Date
TIME OUT sample infectious
inactivation
INFECTIOUS Y indicates String (1) Y or N
sample is
infectious
INFECTIOUS Infectious agent String (50) Must be defined

AGENT associated with in Watson
this sample Libraries
ISOTOPE 1 Isotope associated String (50) Must be defined
with this sample in Watson
Libraries
ISOTOPE 2 Isotope associated String (50) Must be defined
with this sample in Watson
Libraries
OTHER Other condition String (50) Must be defined
CONDITION associated with in Watson
RADIOLABELED Y indicates String (1) Y or N
sample is radio
labeled
TUBE Tube condition String (50) Must be defined
CONDITION associated with in Watson
SAMPLE User entered String (2000)
COMMENTS comments
regarding the
sample
Each sample must have a unique combination of:

• SUBJECT GROUP
• SUBJECT
• TREATMENT ID
• DAY NOMINAL
• HOUR NOMINAL
• MINUTE NOMINAL

3 WWSL 2.0
WWSL 2.0
• BIOLOGICAL MATRIX
• SPLIT (If used)
If any of the following contain a value for any sample, the samples will be considered active
and will be assigned the current date as the SAMPLE RECIEPT DATE unless one is supplied:
• VOLUME
• IDENTIFICATION STATUS
• ACTUAL SAMPLING DATE/TIME
• SAMPLE RECIEPT DATE
• ISOTOPE 1
• ISOTOPE 2
• INFECTIOUS
• INFECTIOUS AGENT
• OTHER CONDITION
• FROZEN CONDITION
• TUBE CONDITION
• RADIOLABELED
• INACTIVATION TEMP
• INACTIVATION TIME IN
Assumption
Not all Web Service calls create audit records.

3WWSL 2.0
WWSL 2.0

A
Service Parameter Definitions

This Appendix contains:
Contents
• Compatibility Matrix
• Procedure Definitions
• XSDs
Thermo Scientific Watson Web Services Library 2.0 i

i Service Parameter Definitions
Compatibility Matrix
Compatibility Compatibility Compatibility

Available in of WWSL v1.0 Available in of WWSL v2.0 of WWSL v2.0
WWSL v1.0 with Watson WWSL v2.0 with Watson with Watson
7.2 to 7.3.0.01 7.2 to 7.3.0.01 7.4
ImportProtocol Yes Yes Yes No Yes
GetProtocolServiceSchema Yes Yes Yes Yes Yes
ValidateProject Yes Yes Yes Yes Yes
Get list of Projects from Watson No --- Yes Yes Yes
Create a Project in Watson No --- Yes Yes Yes
Get list of Studies from Watson No --- Yes Yes Yes
Get Study details and study status No --- Yes Yes Yes
Update Study details No --- Yes Yes Yes
Get Subject details No --- Yes Yes Yes
Update Subject details No --- Yes Yes Yes
Get Treatment details No --- Yes Yes Yes
Update Treatment details No --- Yes Yes Yes
Get Sample details No --- Yes Yes Yes
Add Sample details No --- Yes Yes Yes
Update Sample details No --- Yes Yes Yes
Check Permissions No --- Yes Yes Yes
ValidateUserNamePassword No --- Yes Yes Yes
ii Watson Web Services Library 2.0 Thermo Scientific

Procedure Definitions
• All WWSL v2.0 functions are compatible with Watson 7.4

• All WWSL v2.0 functions, except ImportProtocol, are compatible with earlier versions of
Watson (v7.2 to v7.3.0.01)
• To get backwards compatibility with earlier versions of Watson you can mix-and-match:
Use ImportProtocol from WWSL v1.0 and all other functions from WWSL v2.0
– Set up both web services
– The new report detailing errors during ImportProtocol is not available with this
combination
Note For the following calls, a valid Watson userId and password are always required
whether permission is required or not.
All parameters are mandatory for the service calls except for where explicitly mentioned.
The user needs appropriate permissions for all the web service calls except for
checkPermissions(), ValidateProject(), GetProtocolServiceSchema(), GetProjectList(), and
GetProjectStudyList.
Example:
userIdentityXml =
<?xml version="1.0" encoding="utf-16"?>
<UserIdentity xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" UserName="system"
Password="secret" />
Version = “1.0.0.0 “
Note The above parameters are repeated for all the WWSL calls. Replace the UserName
and Password with the appropriate text for your system.
Thermo Scientific Watson Web Services Library 2.0 iii

Procedure
GetProjectList
Purpose
Gets all projects from the database
Syntax
string GetProjectList(string userIdentityXml, string version)
Parameters
Parameter Type Comments
userIdentityXml string • Mandatory
• XML serialized string of
userIdentity object
represents user credential
Version string • Mandatory
• Version of method call
Return value
Type Comments
string XML serialized object of type projectList
Example
projectListXml =
<ProjectList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ProjectAttrib projectId="238" projectIdText="test project"
projectName="test projectName" eSigned="true"
projectTitle="projectTitle" />
<ProjectAttrib projectId="241" projectIdText="NN9112"
projectName="MC4 alpha MSH" eSigned="false" projectTitle="" />
</ProjectList>
iv Watson Web Services Library 2.0 Thermo Scientific

Procedure
GetProjectDetail
Purpose
Gets project detail data
Syntax
string GetProjectDetail(int projectId, string userIdentityXml, string
version)
Parameters
ProjectID • Mandatory
• Project Id
userIdentityXml • Mandatory
userIdentity object
• Represents user
credential
Return value
Type Comments
string • XML serialized object of type

projectAttrib
Example
projectAttribXml =
<ProjectAttrib xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" projectId="10"
projectIdText="Validate" projectName="Validate ProjNamekjhkjh"
eSigned="false" projectTitle="Project Description" />
Thermo Scientific Watson Web Services Library 2.0 v

Procedure
CreateProject
Purpose
Creates a project record in the database
Syntax
string CreateProject(string projectAttribXml, string userIdentityXml,
string version)
Parameters
ProjectAttrib string • Mandatory
• XML serialized object of
type ProjectAttrib
• ProjectId Text is
mandatory, remaining
fields are optional
userIdentityXml string • Mandatory.
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type method
Return
Example
methodReturnXml =
<MethodReturn xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" IsSuccessful="true"
xmlns="http://thermofisher.com/wgx/schemas/MethodReturn.xsd">
vi Watson Web Services Library 2.0 Thermo Scientific

<ErrorCollection />
</MethodReturn>
projectAttribXml =
<ProjectAttrib xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" projectId="10"
projectIdText="Validate" projectName="Validate ProjNamekjhkjh"
eSigned="false" projectTitle="Project Description" />
Thermo Scientific Watson Web Services Library 2.0 vii

Procedure
GetProjectStudyList
Purpose
Gets list of studies for a given project from the database
Syntax
string GetProjectStudyList(string StudySelectionCriteriaXml, string
userIdentityXml, string version)
Parameters
studySelectionCriteria string • Mandatory
• ProjectId (Mandatory),
remaining fields are
optional
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type studyList
Example
StudySelectionCriteriaXml =
<StudySelectionCriteria
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" ProjectId="10"
ShowOnlyAssigned="false" />
viii Watson Web Services Library 2.0 Thermo Scientific

studyListXml =
<StudyList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<StudyAttrib StudyId="1362" StudyDirector="" PKDirector=""
StartDate="0001-01-01T00:00:00" ProjectId="10" StudyStatus="New"
StudyType="" StudyCompletionDate="0001-01-01T00:00:00" StudyTitle=""
/>
<StudyAttrib StudyId="1361" StudyDirector="" PKDirector=""
/>
</StudyList>
Thermo Scientific Watson Web Services Library 2.0 ix

Procedure
GetStudyDetail
Purpose
Gets details for a given study from database
Syntax
string GetStudyDetail(int studyID, string userIdentityXml, string
version)
Parameters
studyId int • Mandatory
• Study Id
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type studyAttrib
Example
studyattribXml =
<StudyAttrib xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" StudyId="895"
StudyDirector="John Smith" PKDirector=""
/>
x Watson Web Services Library 2.0 Thermo Scientific

Procedure
UpdateStudy
Purpose
Update study data in database
Syntax
string UpdateStudy(string studyAttribXml, string userIdentityXml, string
version)
Parameters
studyAttribXml string • Mandatory
• ProjectId and studyId
are Mandatory,
remaining fields are
optional
StudyAttrib object
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type methodReturn
Example
methodReturnXml =
Thermo Scientific Watson Web Services Library 2.0 xi

<ErrorCollection />
</MethodReturn>
studyAttribXml =
<StudyAttrib xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
StudyDirector="" PKDirector=""
StartDate="2009-08-10T11:30:54.6459203-04:00" ProjectId="10"
StudyStatus="" StudyType=""
StudyCompletionDate="2009-08-10T11:30:54.6459203-04:00" StudyTitle=""
/>
xii Watson Web Services Library 2.0 Thermo Scientific

Procedure
GetStudySubjectList
Purpose
Gets a list of subjects for a given study from the database
Syntax
string GetStudySubjectList(int studyID, string userIdentityXml, string
version)
Parameters
studyid int • Mandatory
• Study Id
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type
DesignSubjectList
Example
DesignSubjectListXml =
<DesignSubjectList
<DesignSubjectAttrib StudyId="1362" DesignsubjectId="1"
DesignSubjectTag="1001" GenderId="NotSpecified = -1" Age="-1"
Weight="-1" Height="-1" />
Thermo Scientific Watson Web Services Library 2.0 xiii


</DesignSubjectList>
xiv Watson Web Services Library 2.0 Thermo Scientific

Procedure
UpdateSubject
Purpose
Updates subject data in the database
Syntax
string UpdateSubject(string subjectDetailXml, string userIdentityXml,
string version)
Parameters
subjectDetailXml - string • StudyId and SubjectId
are mandatory,
remaining properties are
optional
• XML serialized Design
subjectAttrib object
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type methodReturn
Example
subjectAttribXml =
Thermo Scientific Watson Web Services Library 2.0 xv

<DesignSubjectAttrib
DesignsubjectId="1" DesignSubjectTag="1001" GenderId="Male = 1"
Age="32" Weight="75" Height="180" />
methodReturnXml =
<ErrorCollection />
</MethodReturn>
xvi Watson Web Services Library 2.0 Thermo Scientific

Procedure
GetStudyTreatmentList
Purpose
Gets list of treatments for a given study from the database
Syntax
string GetStudyTreatmentList(int studyID, string userIdentityXml, string
version)
Parameters
studyId int • Mandatory
userIdentity object
• represents user credential
Return value
Type Comments
DesignTreatmentList
Thermo Scientific Watson Web Services Library 2.0 xvii

Example
treatmentListXml =
<DesignTreatmentList
<DesignTreatmentAttrib StudyId="1362" TreatmentKey="1"
TreatmentDesc="A" DoseAmmount="-1">
<DesignTreatmentSite SiteId="8" SiteDescription="UAT Site 1" />
<DesignTreatmentSite SiteId="111" SiteDescription="0003" />
<DesignTreatmentSite SiteId="17" SiteDescription="Theravance" />
<DesignTreatmentSite SiteId="3" SiteDescription="ALZ Clinical
test" />
<DesignTreatmentSite SiteId="2" SiteDescription="PSS, Inc." />
<DesignTreatmentSite SiteId="7" SiteDescription="AstraZeneca
R&D Charnwood" />
<DesignTreatmentSite SiteId="42" SiteDescription="Lilly Clinic" />
</DesignTreatmentAttrib>
</DesignTreatmentList>
xviii Watson Web Services Library 2.0 Thermo Scientific

Procedure
GetTreatmentDetail
Purpose
Gets detail data for treatment from database
Syntax
string GetTreatmentDetail(string treatmentIdentifierXml, string
Parameters
treatmentIdentifierXml string • Mandatory
type DesignTreatment
Identifier
userIdentity object
• Represents user
credentials
Return value
Type Comments
treatmentAttrib
Example
designTreatmentIdentifierXml =
<DesignTreatmentIdentifier
TreatmentKey="1" />
Thermo Scientific Watson Web Services Library 2.0 xix

treatmentAttribXml =
<ArrayOfDesignTreatmentAttrib
<DesignTreatmentAttrib StudyId="1362" TreatmentKey="1"
TreatmentDesc="A" DoseAmmount="-1">
<DesignTreatmentSite SiteId="8" SiteDescription="UAT Site 1" />
<DesignTreatmentSite SiteId="17" SiteDescription="Theravance" />
<DesignTreatmentSite SiteId="3" SiteDescription="ALZ Clinical
test" />
<DesignTreatmentSite SiteId="2" SiteDescription="PSS, Inc." />
<DesignTreatmentSite SiteId="7" SiteDescription="AstraZeneca
R&D Charnwood" />
<DesignTreatmentSite SiteId="42" SiteDescription="Lilly Clinic" />
</ArrayOfDesignTreatmentAttrib>
xx Watson Web Services Library 2.0 Thermo Scientific

Procedure
UpdateTreatment
Purpose
Updates treatment data in database
Syntax
string UpdateTreatment(string treatmentDetailXml,string userIdentityXml,
string version)
Parameters
treatmentAttribXml string • Mandatory
• StudyId and
TreatmentId are
mandatory, remaining
properties are optional
Attrib
userIdentity object
• Represents user
credentials
Return value
Type Comments
MethodReturn
Example
methodReturnXml =
Thermo Scientific Watson Web Services Library 2.0 xxi

<ErrorCollection />
</MethodReturn>
treatmentAttribXml =
<DesignTreatmentAttrib
TreatmentKey="1" TreatmentDesc="test" DoseAmmount="-1" DoseUnits="µg
eq/g = 1">
<DesignTreatmentSite SiteId="2" SiteDescription="" />
xxii Watson Web Services Library 2.0 Thermo Scientific

Procedure
GetStudySampleList
Purpose
Gets list of samples for a given study and treatment from the database
Syntax
string GetStudySampleList(int studyID, string userIdentityXml, string
version)
Parameters
studyId int Mandatory

userIdentity object
• Represents user
credential
Return value
Type Comments
DesignSampleList
Example
sampleListXml =
<DesignSampleList
<DesignSampleAttrib StudyId="2" DesignSampleId="3131001"
SamplingDateTime="1997-02-04T15:45:00" SampleType="Plasma"
DesignSubjectTreatmentKey="1" NominalSamplingTime=" " />
Thermo Scientific Watson Web Services Library 2.0 xxiii

</DesignSampleList>
Procedure
GetStudyTreatmentSampleList
Purpose
Syntax
string GetStudyTreatmentSampleList(string treatmentIdentifierXml, string
userIdentityXml, string Version)
Parameters
treatmentIdentifierXml string • Mandatory
Identifier
userIdentityXml string • Mandatory.
userIdentity object
• Represents user
credential
Return value
Type Comments

DesignSampleList
Example
designTreatmentIdentifierXml =
xxiv Watson Web Services Library 2.0 Thermo Scientific

<DesignTreatmentIdentifier
TreatmentKey="1" />
DesignsampleListXml =
<DesignSampleList
</DesignSampleList>
Thermo Scientific Watson Web Services Library 2.0 xxv

Procedure
GetSampleDetail
Purpose
Syntax
string GetSampleDetail(string sampleIdentifierXml, string
userIdentityXml, string Version)
Parameters
SampleIdentifierXml string Mandatory.

userIdentity object
• Represents user
credential
Return value
Type Comments
DesignSampleList
Example
DesignSampleIdentifier =
<?xml version="1.0" encoding="utf-16" ?>
<DesignSampleIdentifier
DesignSample-Id="3131001" />
xxvi Watson Web Services Library 2.0 Thermo Scientific

DesignSampleAttrib =
<?xml version="1.0" encoding="utf-16" ?><DesignSampleAttrib
DesignSampleId="3131001" SamplingDateTime="1997-02-04T15:45:00"
SampleType="Plasma" DesignSubjectTreatmentKey="1"
NominalSamplingTime="" />
Thermo Scientific Watson Web Services Library 2.0 xxvii

Procedure
ImportProtocol
Purpose
Imports a protocol for creating a study along with treatment and sample data
Syntax
string ImportProtocol(string protocolXML, string userIdentityXml, string
version)
Parameters
ProtocolXml string • Mandatory
• XML serialized Protocol
object
userIdentity object
• Represents user
credential
Return value
Type Comments
string XML serialized object of type Response
xxviii Watson Web Services Library 2.0 Thermo Scientific

Note ProtocolXML details are located above.
Procedure
GetProtocolServiceSchema
Purpose
Returns Protocol XSD
Syntax
string GetProtocolServiceSchema(string typeSchema, string
Parameters
typeSchema string Hard-coded "PROTOCOL"
value needs to be sent

userIdentity object
• Represents user
credential
Return value
Type Comments
string Protocol XSD as string object
Thermo Scientific Watson Web Services Library 2.0 xxix

Procedure
ValidateProject
Purpose
Validates a project for the XML format
Syntax
string ValidateProject(string projectId, string userIdentityXml, string
version)
Parameters
projectId string • Mandatory
• Project Id
userIdentity object
• Represent user
credential.
Return value
Type Comments
string Returns True or False as string
xxx Watson Web Services Library 2.0 Thermo Scientific

Procedure
CheckPermission
Purpose
Checks permission
Syntax
string CheckPermission(string userIdentityXml, int securityArea, int?
securityObjId, int permissionId, string version)
Parameters
securityArea Enum • Mandatory
• Enum value of type
securityArea
securityObjId int • Optional
• StudyId if study level
permission check
userIdentity object
represents user
credential.
permissionId - Enum • Mandatory
• Enum value of type
SecurityPermission
Return value
Type Comments
Thermo Scientific Watson Web Services Library 2.0 xxxi

Procedure
ValidateUsernamePassword
Purpose
Validates a project for the XML format
Syntax
string ValidateUserNamePassword(string userIdentityXml, string version)
Parameters
userIdentity object
• Represents user
credential
permissionId enum Value of type
SecurityPermission
Return value
Type Comments
XSDs
ProjectList:

<xs:schema elementFormDefault="qualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="projectAttrib.xsd" />
<xs:element name="ProjectList">
<xs:complexType>
<xs:sequence minOccurs="1" maxOccurs="unbounded">
xxxii Watson Web Services Library 2.0 Thermo Scientific

<xs:element ref="ProjectAttrib" />

</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
ProjectAttrib:
<xs:element name="ProjectAttrib">
<xs:complexType>
<xs:attribute name="projectId" type="xs:int" />
<xs:attribute name="projectIdText">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="projectName">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="eSigned">
<xs:simpleType>
<xs:restriction base="xs:boolean" />
</xs:simpleType>
</xs:attribute>
<xs:attribute name="projectTitle">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>
DesignSampleAttrib:

<xs:element name="DesignSampleAttrib">
<xs:complexType>
<xs:attribute name="StudyId" type="xs:int" />
<xs:attribute name="DesignSampleId" type="xs:int" />
<xs:attribute name="SamplingDateTime" type="xs:dateTime" />
<xs:attribute name="SampleType">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
Thermo Scientific Watson Web Services Library 2.0 xxxiii

<xs:attribute name="DesignSubjectTreatmentKey" type="xs:int" />

<xs:attribute name="NominalSamplingTime" type="xs:string" />
</xs:complexType>
</xs:element>
</xs:schema>
DesignSampleIdentifier:

<xs:element name="DesignSampleIdentifier">
<xs:complexType>
<xs:attribute name="DesignSampleId" type="xs:int" />
</xs:complexType>
</xs:element>
</xs:schema>
DesignSampleList:

<xs:include schemaLocation="DesignSampleAttrib.xsd" />
<xs:element name="DesignSampleList">
<xs:complexType>
<xs:element ref="DesignSampleAttrib" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
DesignSubjectAttrib:

<xs:element name="DesignSubjectAttrib">
<xs:complexType>
<xs:attribute name="DesignsubjectId" type="xs:int" />
<xs:attribute name="DesignSubjectTag">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="GenderId">
<xs:simpleType>
<xs:enumeration value="NotSpecified = -1" />
<xs:enumeration value="Male = 1" />
<xs:enumeration value="Female = 2" />
xxxiv Watson Web Services Library 2.0 Thermo Scientific

</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Age" type="xs:int" />
<xs:attribute name="Weight" type="xs:int" />
<xs:attribute name="Height" type="xs:int" />
</xs:complexType>
</xs:element>
</xs:schema>
DesignSubjectList:

<xs:include schemaLocation="DesignSubjectAttrib.xsd" />
<xs:element name="DesignSubjectList">
<xs:complexType>
<xs:element ref="DesignSubjectAttrib" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
DesignSubjectTreatment:

<xs:element name="DesignSubjectTreatment">
<xs:complexType>
<xs:attribute name="DesignSubjectTreatmentKey" type="xs:int" />
<xs:attribute name="DesignSubjectId" type="xs:int" />
<xs:attribute name="SubjectGroupId" type="xs:int" />
<xs:attribute name="TreatmentEventId" type="xs:int" />
<xs:attribute name="TreatmentKey" type="xs:int" />
<xs:attribute name="TreatmentId">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="Period" type="xs:int" />
<xs:attribute name="StudyDay" type="xs:int" />
<xs:attribute name="Week" type="xs:int" />
<xs:attribute name="Visit" type="xs:int" />
<xs:attribute name="Year" type="xs:int" />
<xs:attribute name="Month" type="xs:int" />
<xs:attribute name="Phase" type="xs:int" />
<xs:attribute name="DoseAmount" type="xs:int" />
<xs:attribute name="DoseUnitsId" type="xs:int" />
<xs:attribute name="DoseDateTime" type="xs:dateTime" />
<xs:attribute name="PlaceOfLag">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
Thermo Scientific Watson Web Services Library 2.0 xxxv

</xs:attribute>
<xs:attribute name="Status" type="xs:int" />
<xs:attribute name="RevisionNumber" type="xs:int" />
<xs:attribute name="VisitText">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="UserId" type="xs:int" />
<xs:attribute name="RecordTimeStamp" type="xs:dateTime" />
<xs:attribute name="DoseDateHasNoTime">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="CommentMemo">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>
DesignSubjectTreatmentList:

<xs:include schemaLocation="DesignSubjectTreatment.xsd" />
<xs:element name="DesignSubjectTreatmentList">
<xs:complexType>
<xs:element ref="DesignSubjectTreatment" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
DesignTreatmentAttrib:

<xs:include schemaLocation="DesignTreatmentSite.xsd" />
<xs:element name="DesignTreatmentAttrib">
<xs:complexType>
<xs:element ref="DesignTreatmentSite" />
</xs:sequence>
<xs:attribute name="TreatmentDesc">
<xs:simpleType>
xxxvi Watson Web Services Library 2.0 Thermo Scientific

</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="DoseAmmount" type="xs:int" />
<xs:attribute name="DoseUnits">
<xs:simpleType>
<xs:enumeration value="None = -1" />
<xs:enumeration value="µg = 1" />

<xs:enumeration value="µg eq = 2" />
<xs:enumeration value="ng = 3" />
<xs:enumeration value="ng eq = 4" />
<xs:enumeration value="mg = 5" />
<xs:enumeration value="µg/kg = 6" />
<xs:enumeration value="µg eq/kg = 7" />
<xs:enumeration value="ng/kg = 8" />
<xs:enumeration value="ng eq/kg = 9" />
<xs:enumeration value="mg/kg = 10" />
<xs:enumeration value="pg = 11" />
<xs:enumeration value="pg/kg = 12" />
<xs:enumeration value="nmolr = 13" />
<xs:enumeration value="µmol = 14" />
<xs:enumeration value="nmol = 15" />
<xs:enumeration value="mmol = 16" />
<xs:enumeration value="nmolr/kg = 17" />
<xs:enumeration value="µmol/kg = 18" />
<xs:enumeration value="nmol/kg = 19" />
<xs:enumeration value="mmol/kg = 20" />
<xs:enumeration value="iu = 21" />
<xs:enumeration value="iu/kg = 22" />
<xs:enumeration value="units = 23" />
<xs:enumeration value="units/kg = 24" />
<xs:enumeration value="mg/kg/day = 25" />
<xs:enumeration value="µg/kg/day = 26" />
<xs:enumeration value="mg/m² = 27" />
<xs:enumeration value="IU/kg/Day = 29" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>
StudySelectionCriteria:

<xs:element name="StudySelectionCriteria">
<xs:complexType>
<xs:attribute name="ProjectId" type="xs:int" use="required" />
<xs:attribute name="ShowOnlyAssigned" type="xs:boolean"
use="required" />
</xs:complexType>
</xs:element>
</xs:schema>
Thermo Scientific Watson Web Services Library 2.0 xxxvii

StudyList:

<xs:include schemaLocation="StudyAttrib.xsd" />
<xs:element name="StudyList">
<xs:complexType>
<xs:element ref="StudyAttrib" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
StudyAttrib:
<xs:element name="StudyAttrib">
<xs:complexType>
<xs:attribute name="StudyDirector">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="PKDirector">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="StartDate" type="xs:dateTime" />
<xs:attribute name="ProjectId" type="xs:int" />
<xs:attribute name="StudyStatus" type="xs:string" />
<xs:attribute name="StudyType">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="StudyCompletionDate" type="xs:dateTime" />
<xs:attribute name="StudyTitle">
<xs:simpleType>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:schema>
xxxviii Watson Web Services Library 2.0 Thermo Scientific

DesignTreatmentSite:

<xs:element name="DesignTreatmentSite">
<xs:complexType>
<xs:attribute name="SiteId" type="xs:int" />
<xs:attribute name="SiteDescription" type="xs:string" />
</xs:complexType>
</xs:element>
</xs:schema>
DesignTreatmentList:

<xs:include schemaLocation="DesignTreatmentAttrib.xsd" />
<xs:element name="DesignTreatmentList">
<xs:complexType>
<xs:element ref="DesignTreatmentAttrib" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
DesignTreatmentIdentifier:

<xs:element name="DesignTreatmentIdentifier">
<xs:complexType>
</xs:complexType>
</xs:element>
</xs:schema>
UserIdentity:

<xs:element name="UserIdentity">
<xs:complexType>
<xs:attribute name="UserName" type="xs:string" use="required" />
<xs:attribute name="Password" type="xs:string" use="required" />
</xs:complexType>
</xs:element>
Thermo Scientific Watson Web Services Library 2.0 xxxix

</xs:schema>>
SecurityPermission:
enum SecurityPermission
{
//System level
FileCreateProject,
AssignSecurity,
//Study level
EditStudy,
EditSubject,
TreatmentMenuItem,
EditTreatment,
ViewStudyDesign,
StudyAssignSecurity,
ProtocolImportFunction
SecurityArea:
public enum SecurityArea

{
System,
Study,
Project
xl Watson Web Services Library 2.0 Thermo Scientific

Watson Web Services Library 2.0 Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Watson Web Services Library 2.0 Guide

Uploaded by

Copyright:

Available Formats

Thermo Scientific Watson

All trademarks recognized.

Chapter 3 WWSL 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Thermo Scientific Watson Web Services Library 2.0 iii

Appendix Service Parameter Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i

iv Watson Web Services Library 2.0 Thermo Scientifi

Safety and Special Notices

Safety and special notices include the following:

IMPORTANT Highlights information necessary to prevent damage to software, loss of

Note Highlights information of general interest.

Tip Highlights helpful information that can make a task easier.

Thermo Scientific Watson Web Services Library 2.0 v

❖ To contact Technical Support

❖ To contact Customer Service for ordering information

❖ To suggest changes to documentation or to Help

vi Watson Web Services Library 2.0 Thermo Scientific

Overview of Watson Web Services Library

WWSL provides an application-independent method to request a series of Watson-specific

Watson Web Services Library (WWSL) 2.0

Thermo Scientific Watson Web Services Library 2.0 1

2 Watson Web Services Library 2.0 Thermo Scientific

Pre-Install: Software Requirements for Hosting the Web Service

Thermo Scientific Watson Web Services Library 2.0 3

❖ To Install WWSL 2.0:

4 Watson Web Services Library 2.0 Thermo Scientific

Figure 2-2. InstallShield Wizard Welcome screen

Thermo Scientific Watson Web Services Library 2.0 5

6 Watson Web Services Library 2.0 Thermo Scientific

Figure 2-5. Watson Web Services Library 2.0 - InstallShield wizard

Thermo Scientific Watson Web Services Library 2.0 7

Figure 2-6. Installation Status

NET 3.5 Framework Setup

8 Watson Web Services Library 2.0 Thermo Scientific

Figure 2-7. .NET 3.5 Supplemental License

Thermo Scientific Watson Web Services Library 2.0 9

10 Watson Web Services Library 2.0 Thermo Scientific

Figure 2-9. .NET 3.5 Framework Setup complete

12. Click Exit.

Thermo Scientific Watson Web Services Library 2.0 11

Figure 2-10. InstallShield Wizard Complete screen

Installing Internet Information Services (IIS)

12 Watson Web Services Library 2.0 Thermo Scientific

Figure 2-11. Windows XP Welcome screen

Thermo Scientific Watson Web Services Library 2.0 13

Windows 2008 Server - Convert to Application

14 Watson Web Services Library 2.0 Thermo Scientific

Watson SQL Scripts

Thermo Scientific Watson Web Services Library 2.0 15

Confirming WWSL is Installed and Operating Correctly

If you receive an error when browsing the web service:

Figure 2-17. Command Prompt

16 Watson Web Services Library 2.0 Thermo Scientific

Figure 2-18. Properties

4. On the Virtual Directory tab select Configuration. The Application Configuration

Thermo Scientific Watson Web Services Library 2.0 17

5. Verify that there is an entry for .svc extension.

6. Reset IIS and browse the web service.

If Using a Secure Socket Layer (SSL) Certificate

Additionally, change <serviceMetadata httpGetEnabled="true" /> to

Comment out <endpoint address="mex" binding="mexHttpBinding"

18 Watson Web Services Library 2.0 Thermo Scientific

Thermo Scientific Watson Web Services Library 2.0 19

20 Watson Web Services Library 2.0 Thermo Scientific

Import Study Protocol