PLA 3.0 MICROSOFT EXCEL DATA ACQUISITION MODULE · Welcome to the user guide for the Microsoft Excel Data Acquisition Module. This handbook is intended for users, functional administrators

PLA 3.0 MICROSOFT

EXCEL DATA ACQUISITION MODULE Version 1.2.0

User Guide

PLA 3.0 Microsoft Excel Data Acquisition Module - User Guide

2

COPYRIGHT PLA 3.0 © 2006-2016 Stegmann Systems GmbH, Rodgau, Germany. All rights reserved.

The Stegmann Systems products referred to in this document are also copyrighted, and all rights are reserved

by Stegmann Systems and/or its licensors, if any. This manual may not, in whole or in part, be copied, translat-

ed, or reduced to any electronic medium or machine-readable form without prior consent, in writing, from

Stegmann Systems.

The information in this manual is subject to change without notice, and Stegmann Systems assumes no respon-

sibility for any errors that may appear in this document. The references in this manual to specific platforms

supported are subject to change.

Java and all Java-based marks are trademarks or registered trademarks of Oracle, Inc. in the U.S. and other

countries.

Any other trademarks or service marks contained herein are the property of their respective owners. PLA 3.0

includes software developed by the Apache Software Foundation (http://www.apache.org/, Copyright 1999-

2014 The Apache Software Foundation. All rights reserved.

PLA 3.0 uses libraries that are subject to the Lesser GNU Public License (LGPL) Version 2.1 (the "License"); you

may not use these files except in compliance with the License. A copy of the License is distributed in the same

folder as the respective file. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT

WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights

and limitations under the License. All rights reserved.

Contact

3

CONTACT Stegmann Systems GmbH

Raiffeisenstr. 2 // C1, C2

63110 Rodgau

Germany

Phone: +49 6106 770100

Fax: +49 6106 77010190

www.bioassay.de

[email protected]

mailto:[email protected]


4

TABLE OF CONTENTS Copyright ................................................................................................................................................................. 2

Contact .................................................................................................................................................................... 3

Table of Contents .................................................................................................................................................... 4

Welcome ................................................................................................................................................................. 5

How to use this Manual ...................................................................................................................................... 5

Overview ................................................................................................................................................................. 6

System Requirements ............................................................................................................................................. 7

Acquire Data Using the Microsoft Excel Data Acquisition Module ......................................................................... 8

Manage Configurations ......................................................................................................................................... 14

Standard Configuration Options ....................................................................................................................... 17

General .......................................................................................................................................................... 17

Name ......................................................................................................................................................... 17

Import Strategy ......................................................................................................................................... 17

Dataset .......................................................................................................................................................... 19

Visualization of the Dataset Options ......................................................................................................... 20

Values ............................................................................................................................................................ 21

Invalid Value Handling ............................................................................................................................... 21

Floating Point Handling ............................................................................................................................. 21

Advanced Configuration Options ...................................................................................................................... 22

Define Available Configuration Profiles ........................................................................................................ 22

Prevent Configuration of Configuration Profiles ........................................................................................... 23

Installation ............................................................................................................................................................ 24

Setup ................................................................................................................................................................. 24

Package Management ....................................................................................................................................... 26

Welcome

5

WELCOME Welcome to the user guide for the Microsoft Excel Data Acquisition Module. This handbook is intended for

users, functional administrators of PLA and system administrators.

The user guide for the Microsoft Excel Data Acquisition Module describes all aspects of the installation, config-

uration and usage of the Microsoft Excel Data Acquisition Module.

HOW TO USE THIS MANUAL

This manual is a user guide for the Microsoft Excel Data Acquisition Module. The structure of this document is

as follows:

System Requirements (System Administrators and PLA Administrators)

Requirements of the Microsoft Excel Data Acquisition Module

Step by Step Guide: Acquire Data with Microsoft Excel Data Acquisition Module (PLA Users)

Acquire data

Manage configurations

Installation (System Administrators)

Installation of the Microsoft Excel Data Acquisition Module


6

OVERVIEW The Microsoft Excel Data Acquisition Module gives you the opportunity to acquire data from Microsoft Excel

files using PLA 3.0.4.

A single import format is available for Microsoft Excel Data Acquisition Module:

Microsoft Excel (*.xls, *.xlsx) – Allows importing data from a Microsoft Excel file.

System Requirements

7

SYSTEM REQUIREMENTS The Microsoft Excel Data Acquisition Module v1.2.0 requires PLA 3.0.4. An installation of Microsoft Excel is not

required.


8

ACQUIRE DATA USING THE MICROSOFT EXCEL DATA ACQUISITION MODULE The Microsoft Excel Data Acquisition Module allows you to import data from existing Microsoft Excel files into

PLA Quantitative Response Assay documents. To start the Microsoft Excel Data Acquisition Module, run the

Acquire Data… action of a PLA Quantitative Response Assay document.

Select the Microsoft Excel import format and proceed with OK.

Acquire Data Using the Microsoft Excel Data Acquisition Module

9

You can select a configuration profile using the drop-down menu of the PLA Microsoft Excel Data Acquisition

dialog.

If there is no configuration profile listed, it is necessary to create one (see chapter Manage Configurations).


10

After choosing a configuration profile, select a Microsoft Excel file using the ‘…’ button.


11

When you have chosen a configuration and a Microsoft Excel file, you can start the import process using the

Start button. The effective settings are set by the configuration profile and define the import strategy.


12

You can view the progress and result of the data acquisition using the status dialog.


13

The result of the data acquisition is available in the response column in the observations view of the PLA doc-

ument editor.


14

MANAGE CONFIGURATIONS Within PLA, the Microsoft Excel Data Acquisition Module offers the possibility of creating, editing or deleting

data acquisition configurations.

You can open the profile configuration dialog using the Configure… button in the Acquire Data dialog.

Manage Configurations

15

To configure the Microsoft Excel Data Acquisition Module, you need to create a configuration profile in the

Manage Data Acquisition Configurations dialog.


16

The Manage Data Acquisition Configurations dialog also allows editing or removing existing configuration pro-

files.


17

STANDARD CONFIGURATION OPTIONS

Within PLA, the Manage Data Acquisition Configurations dialog offers the possibility of creating, editing or

deleting data acquisition configurations. When creating or editing a configuration profile, the following options

are available:

GENERAL You can name the profile and define an import strategy using the General tab of the configuration dialog.

NAME

Allows you to enter the name of the configuration profile.

IMPORT STRATEGY

Describes how the data is written into the observations view of the Quantitative Response Assay.

Label Description

Start writing at first empty row Starts writing at the first empty observation row, keeping existing values

Start writing at first row (overwrites existing values) Starts writing at the first observation row, over-writing existing values

Start writing at first row (resets previously imported values)

Starts writing at the first observation row, resets all values to default values before inserting data.

Start writing at defined row (overwrites existing values) Starts writing in specified observation row, over-writing existing values

Start writing after last row (append) Starts writing after the last observation row, keeping existing values


18

Acquire Position Information Acquires row, column and plate position factor values if available


19

DATASET You can define the location of the data within the excel file using the Dataset tab of the configuration dialog.

Label Description

Sheet number The number of the sheet in which the values are located.

First row The first row within the sheet that contains data that should be acquired.

Last row The last row within the sheet that contains data that should be acquired.

First column The first column within the sheet that contains data that should be acquired.

Last column The last column within the sheet that contains data that should be acquired.


20

VISUALIZATION OF THE DATASET OPTIONS

This example explains the options available in the Dataset tab.


21

VALUES You can define how valid and invalid values are imported using the Values tab of the configuration dialog. Any

value that is not a double value is considered as invalid value.

INVALID VALUE HANDLING

You can define how invalid values are imported using the invalid value handling settings.

Label Description

Import as void Invalid values will be imported as empty values.

Import as void and mark as technical outlier Invalid values will be imported as empty values and marked as technical outlier.

Import unchanged value and mark as technical outlier Invalid values will be imported without any changes, but marked as technical outlier. Floating point han-dling settings apply.

Import unchanged value Invalid values will be imported without any changes. Floating point handling settings apply.

Skip value Invalid values will be skipped.

FLOATING POINT HANDLING

You can define the overall handling of values using the floating point handling settings.

Label Description

Import unmodified value Imports the original value.

Round value to Microsoft Excel precision Imports the rounded value (max. 15 significant digits).


22

ADVANCED CONFIGURATION OPTIONS

The advanced configuration of the Microsoft Excel Data Acquisition Module is handled via the Excel Data Ac-

quisition Package.properties configuration that is stored in the C:\ProgramData\Stegmann Systems\PLA [ver-

sion] directory. Any settings that are made using the Microsoft Excel Data Acquisition Module configuration

profiles are also saved to the Excel Data Acquisition Package.properties file.

Important: The encoding of the .properties file is ISO-8859-1 (Latin-1). All non-Latin-1 characters must be en-

tered by using \ as escape character. Example: The special character : must be entered as \: and the special

character \ must be entered as \\

To configure the Microsoft Excel Data Acquisition Module, you need write permissions on the Excel Data Acqui-

sition Package.properties file. Regular Microsoft Windows user accounts do not have write permissions within

the Program Data directory, so you might need an administrative account to change the configuration.

DEFINE AVAILABLE CONFIGURATION PROFILES You can define the available configuration profiles per folder on a database. To define the available configura-

tion profiles, add the following property to your Excel Data Acquisition Package.properties file:

com.stegmannsystems.edp.dataacquisition.excel.restrictions.<DB-

UUID>.profile.<Folder-Key>

You can view the DB-UUID of the database using the PLA Database Policies (General tab). The folder key can be

viewed using the PLA folder properties dialog (Document Key value).

The following example will limit the available configuration profiles for the folder with the folder-key “Folder-1”

(Root Folder) and all of its subfolders, unless a subfolder defines its own set of available configuration profiles.

Multiple configuration files need to be separated by a pipe symbol (|). Only the configuration profiles named

“Excel Profile1” and “Excel Profile2” can be used in the Microsoft Excel Data Acquisition Module:

com.stegmannsystems.edp.dataacquisition.excel.restrictions.6c868b23-d386-

45f8-833b-15e8014b424f.profile.Folder-1=Excel Profile1|Excel Profile2

This setting does not prevent users from changing the available profiles. See chapter Prevent Configuration of

Configuration Profiles for further information.


23

PREVENT CONFIGURATION OF CONFIGURATION PROFILES By default, all users that can access the Microsoft Excel Data Acquisition Module can create, edit and delete

configuration profiles. To prevent users from creating, editing and deleting configuration profiles, you have to

add the following property to your Excel Data Acquisition Package.properties file:

com.stegmannsystems.edp.dataacquisition.excel.restrictions.canEditProfiles=

false


24

INSTALLATION Installing the Microsoft Excel Data Acquisition Module consist of two parts. The Setup part will install the Mi-

crosoft Excel Data Acquisition Module on your local hard disk. Afterwards, it can be installed on multiple data-

bases via the PLA Package Management.

SETUP

To install the Microsoft Excel Data Acquisition Module, start the installation program using a Microsoft Win-

dows Administrator account.

Follow the on screen instructions of the Microsoft Excel Data Acquisition Module.

Installation

25

When the installation finished successfully, close the installation program using the Finish button.


26

PACKAGE MANAGEMENT

To use the Microsoft Excel Data Acquisition Module, it has to be installed on the specific database.

To make the module available in a PLA database, a PLA user account with the permission to view and manage

packages is required. Login to PLA using a user account with the required permissions and open the PLA pack-

age management.

Installation

27

Select the Microsoft Excel Data Acquisition Module out of the list of available packages and press the Install

button.


28

PLA will install the Microsoft Excel Data Acquisition Module in the database. When the installation is complete,

the module will be listed as installed package. The module can now be used to acquire data into PLA Quantita-

tive Response Assays, using the Acquire Data action of the PLA document editor.

Documents

PLA 3.0 MICROSOFT EXCEL DATA ACQUISITION MODULE · Welcome to the user guide for the Microsoft Excel Data Acquisition Module. This handbook is intended for users, functional administrators