History of Changes During R5.2 (DM0503)

 

Content

Document Revisions
LABVANTAGE R5.2 New and Enhanced Functionality
 
 

 
   

 

 

Document Revisions

Top ../images/arwup.gif (846 bytes)
Revision Date Description
110315-52 03/15/2011 Initial document release to support LABVANTAGE R5.2.

 

 

Index to LABVANTAGE R5.2 New and Enhanced Functionality

Top ../images/arwup.gif (846 bytes)

These link to descriptions of new and enhanced features in LABVANTAGE R5.2:

 Product Name Change
Actions
Data Set, Test, and Worksheet Management
Maint Page Formatted Text Editor
Storage
AQC
Display Format
Naming Restrictions
System Monitor
Calculations
Document Corrections and Updates
Packages
Web Page Designer
Certifications
eForms Technology
Reporting
Web Services
Configuration Reports
External Authentication (LDAP)
Simple Instruments    
Data File Definitions
JavaScript Global API
Specifications    

To view the history of changes made to LABVANTAGE from V1.1 (11/02/1999) through R5.1 (06/18/2010), see:

 History of changes prior to LABVANTAGE R5.2

 

Product Name Change

Top ../images/arwup.gif (846 bytes)

LabVantage Solutions, Inc. has changed the name of SAPPHIRE to "LabVantage". Accordingly, the changes listed below have been made to this document:

• Build files have been renamed to LabVantageDoc.chm, LabVantageDoc.htm, and labvantagedoc.war.
• References to "SAPPHIRE" have been eliminated from table of contents entries, except where such references apply to named APIs and API objects.
• Window titles and headers containing "SAPPHIRE" have been changed to "LabVantage".
• Textual references to "SAPPHIRE" have been eliminated or replaced with "LabVantage", except where such references apply to named APIs and API objects.
• References to "SAPPHIRE" in graphic images are being examined and modified on an ongoing basis.

Note that shortly before release, the case of the product name was changed, i.e., "LabVantage" is now "LABVANTAGE". This change will be addressed in documentation that supports the next major LABVANTAGE release.

 

Actions

Top ../images/arwup.gif (846 bytes)

Features

These new Actions have been added:
•AddOrEditSDI
Edits existing SDIs or adds SDIs if they do not exist, and returns their identifiers.
•AssignQCBatch
Assigns a QC Batch to an Analyst.
•CreateWorksheet
Creates a Document based on a Worksheet Form.
•FindKeyId
Returns KeyIds identified by non-key columns.
•UseReagent
Updates the Reagent Lot inventory.
These core Actions (exposed through the Action Public Interfaces) have been modified:
•AddDataSet
New properties added:
•createworksheet (Determines if Worksheets are created)
•formid, formversionid (Form used to create the Worksheet)
•AddDocument
Now handles Field inputs with repeated values, resolving dependent Fields from the inputs.
•AddSDIAttachment
New property added:
•documentfield (reference to a Document file Field)
•AddSDIDetail
New property added:
•separator (allows use of custom separators)
•AddSDIWorkitem
New properties added:
•createworksheet (Determines if Worksheets are created)
•formid, formversionid (Form used to create the Worksheet)
•EditDataSet
New properties added:
•createworksheet (Determines if Worksheets are created)
•formid, formversionid (Form used to create the Worksheet)
•assignto (defines the user to which the dataset and worksheet are assigned)
•EditSDIDetail
New property added:
•separator (allows use of custom separators)
•ImportDataFile
New property added:
•documentfield (reference to a Document file Field)
•RedoCalculations
•See Calculations.
•SendMail
New property added:
•messageheader (defines email headers)

Document Changes

Click the links above to open the Action in the Javadoc for the System Action Public Interfaces.

 

AQC

Top ../images/arwup.gif (846 bytes)

Features

During data entry, AQC calculations are now immediately executed to provide "live feedback" (rather than having to save prior to seeing the results).
"Create Worksheet Rules" have been added to QC Methods for integrating AQC with Worksheets.
The Sample Life Cycle depends on data entered for the mandatory Data Items associated with Samples in the QC Batch and Data Items of the QC Batch Params.

Document Changes

In QC Batches:
• Added "Create Worksheet Rules".
•Added note about the new AQC Policy.
•Changed "QCBatch Attributes"to "QCBatch Params" in text and screen captures.
In Entering Data for QC Batches, added AQC Calculations to the "Data Entry (Procedural)" section.
In QC Methods, added QCBatch Params, Variant, Version, QCBatch Params Spec, Version and Create Worksheet Rule.
In QC Batch Life Cycle:
• Modified the QC Batch Status Transition stages to reflect dependencies on data entered against mandatory Data Items associated with Samples in the QC Batch and Data Items of the QC Batch Params.
•Removed the "Started" status. It was intended to be implemented in R4.7, but was never actually enabled.
Added AQC Policy.
Updated documents to reflect that (due to definition of Parameter List Type in the QC Batch), Batch status changes from Initial to InProgress if any Preparation or Procedural data are entered for the Batch. This formerly stated that Batch status was inProgress, DataEntered and Completed based only on Procedural data.

 

Calculations

Top ../images/arwup.gif (846 bytes)

Features

RedoCalculations

The RedoCalcuations Action has been enhanced. RedoCalculations now updates a calculated data value only if it has changed. This prevents updating of incorrect ModBy and ModDt columns in the SDIDataItem table and eliminates unnecessary Audit records. The RedoCalculations Action is also called when a Data Item is marked as an "Outlier".

Note that this behavior applies only to RedoCalculations (and SetCalcExclude, which calls RedoCalculations). It does not apply to the Data Entry process when RedoCalculations is not executed. If you are entering data and you change any values, all Calculations are updated and Audit records are cut for all updates... as long as neither of these Actions is executed.

Updating Released Data

In R5.2, there is a new "Update Released Calcs" property for the Data Entry Policy:

Y = Whether or not data are Released, if you change the calculated value, the system will accept your change and update the Released value. This is R5.1 behavior.

N = For NC-type data, changing data values that cause a Released NC-type to be recalculated will generate an error. For N-type data, changing data values that cause a Released N-type to be recalculated will not generate an error. The newly entered data are saved, but the N-calculated value is not updated.

Workitem DataSet Filter

In R5.1, when referencing Data Sets by an SDIData column, the Data Set filter could be applied to either SourceWorkitemId or SourceWorkitemInstance.

In R5.2, the Data Set filter can be applied to both by specifying either of these new syntaxes:

• workitem=#
This matches on both the current SourceWorkitemId and the SourceWorkitemInstance. You can use this to do calculations on Data Sets within the same Workitem Instance, as the system adds an implicit "sourceworkiteminstance=#" to this.
•workitem=<workitemid> where <workitemid> is the identifier of the Workitem
This matches on SourceWorkitemId=<workitemid> and the current SourceWorkitemInstance.

Document Changes

In Reference Calculations: Explicit Reference to a Single SDI, added a notice that whenever RedoCalculation is executed, calculated data are updated and an audit record is cut only if the data value has changed.
In the RedoCalculations Action, removed references to "all Calculations for all UnReleased Data Items".
In the Data Entry Policy, added the "Update Released Calcs" property.
In Referencing Data Sets by an SDIData Column, modified Workitem filter to specify new workitem=<workitemid> and workitem=# syntax.

 

Certifications

Top ../images/arwup.gif (846 bytes)

Features

New "By Form" certifies Users for a Form.
New "Forms" tab added to "By Analyst" for certifying Forms for an Analyst.

Document Changes

Made these changes to Certifications:
• In Introduction, added "By Form".
•In By Analyst, changed screen captures (checkboxes are now radio buttons, "reset" button has been removed, "Forms" detail tab has been added) and added "Forms" tab.
•In By Parameter List, changed screen captures (checkboxes are now radio buttons, "reset" button has been removed).
•In Instruments, changed screen captures to reflect new Instrument form.
•Added By Form functionality.

 

Configuration Reports

Top ../images/arwup.gif (846 bytes)

Features

You can now create a Configuration Report in XML format.
New Configuration Report Diffing feature compares current configuration data to a reference report to show modifications, additions, deletions, and unchanged items.

Document Changes

In Configuration Reports:
• Added HTML Report, Compare against Reference Report, Reference Report Location options for the "Select Basic Options" page in the Configuration Report wizard under "Generation Options for HTML/XML Report" with new screen capture.
• In the "Generation of Diff Report" section, added information about comparing current configuration data with a reference report.

 

Data File Definitions

Top ../images/arwup.gif (846 bytes)

Features

Enhancements to Data File Definitions:
• Now supports import of .xlsx format (Excel 2007-2010 file).
•A "Parser" tab replaces the "Data File Parser" button to provide inline editing within the Maintenance page. The editor can be maximized.
•Now prompts you when an example file is not present (previously warned after clicking the button).
•The file dialog can now filter specific files, e.g., selecting "text" and "comma separated" filters selection by text and CSV.
•Changing any parser fields now prompts for reload of the example file.
•Now prompts if the spreadsheet is missing or incorrect when loading the Excel file.
•New Groovy methods let you manipulate delimited strings.
•New "Input" field type corresponds to additional properties passed to the ImportDataFile Action. At runtime, the value of Input fields is determined by the input properties of the ImportDataFile Action.

Document Changes

In Data File Definition:
• In "Overview", added the file extension ".xlsx" format for importing Excel data.
•Modified the "Creating Data File Definition" section by introducing the "Parser" tab to load the example file. The functionality of the Data File Parser button has been encapsulated in the Parser tab.
In Data File Parser, added the concept of the "Input" field to the "Fields" section to correspond to additional properties passed to the ImportDataFile Action.

 

Data Set, Test, and Worksheet Management

Top ../images/arwup.gif (846 bytes)

Features

Analyst and Instrument Assignment

Removal of Tramstops
• The SAPPHIRE → Tests → Assign Analyst and SAPPHIRE → Tests → Assign Instrument tramstops have been removed. Analyst and Instrument Assignment has been moved to LIMS → Tests → Manage Data Sets and LIMS → Tests → Manage Tests as described below.

Data Set Management

New "Manage Data Sets" Tramstop
• A new LIMS → Tests → Manage Data Sets tramstop opens a "Data Set List" page that lets you:
• Create Worksheets defined by an "On Demand" Worksheet Creation Rule in the Parameter List.
•Create Worksheets defined by an "On Demand" Worksheet Creation Rule in the Parameter List and assign them to Analysts.
•Assign Analysts and Instruments to Data Sets.
•Perform "Retest", "Remeasure", and "Data Entry" operations on Data Sets.
Duplicate Functionality
• The ability to Create and Assign Worksheets has been duplicated on SDI Data Set Maintenance pages (select a Sample in the Sample List page, then click "Data Sets" in the Sidebar).

Test Management

New "Manage Tests" Tramstop
• A new LIMS → Tests → Manage Tests tramstop opens an "SDI Workitem List" page that lets you:
• Create Worksheets defined by an "On Demand" Worksheet Creation Rule in the Test Method.
•Create Worksheets defined by an "On Demand" Worksheet Creation Rule in the Test Method and assign them to Analysts.
•Assign Analysts and Instruments to Data Sets defined by the Test Method.
•Perform "Retest" and "Data Entry" operations on Data Sets defined by the Test Method.
Duplicate Functionality
• The ability to Create and Assign Worksheets has been duplicated on SDI Workitem Maintenance pages (select a Sample in the Sample List page, then click "Tests" in the Sidebar).

Worksheet Management

New "Manage Worksheets" Tramstop
• A new LIMS → Tests → Manage Worksheets tramstop opens the eForm Manager for management of Documents based on Worksheet Forms.

Document Changes

Added new documentation for Manage Data Sets, Tests, and Worksheets.
Removed Analyst and Instrument Assignment from the Table of Contents.
Add a note to the old Assignment documentation that it is provided for backward-compatibility only.
In Concepts of Data Entry, updated Adding Tests to Samples.

 

Display Format

Top ../images/arwup.gif (846 bytes)

Feature

Literal strings can now be returned using an eval expression without throwing an error. For example:
[eval;if ([this] < 10, "'<10'", "'>10'")] now returns the literals <10 and >10.

Document Change

In Parameter Lists, added Returning Literals to provide an example of eval usage, plus an explanation of what happens if single quotes are not included in other expressions.

 

Document Corrections and Updates

Top ../images/arwup.gif (846 bytes)
Fixed 162 broken/orphaned links in the table of contents and other areas that use bookmark and running index references.
Two typographical errors on the Units Maintenance page have been corrected to provide an accurate example of using conversion factors. These typographical errors had the effect of reversing the intended conversion factors.
Updated Parameter List Display Format to delete the $#,##0;($#,##0) format and include the "AsEntered" format.
In Expression Editor Expression Library, updated the format of "max" and "mod" functions.
In Request Controller Syntax, updated the logoff example to "rc?command=logoff&url=logon.jsp".
In the Javadoc for the System Action Public Interfaces, modified the custom Javadoc Doclet class (docflex.class) to show the ActionId during full-text searches.

 

eForms Technology

Top ../images/arwup.gif (846 bytes)

Features

The following changes and enhancements have been made to eForms.

Worksheet Forms

New "Worksheet" Form Type
You can now create a special type of Form called a "Worksheet". Worksheet Forms can be bound to database records. Worksheet Forms provide:
•Automatic Datasource creation to retrieve and load database records for selected result sets.
• Binding of Form Fields to database records through the Datasource, providing:
•Saving to SDI Primary, SDIData, SDIDataItem, and SDIDataRelation records.
•Standard Data Entry in SDIDataItem.
•Display of SDI Primary, SDIData, SDIDataItem, SDIDataRelation, SpecParamLimits, QCBatch, QCBatchItems, and QCSampleType records.
• "Live feedback" of entered data that has been checked against Parameter Limits, Specification Limits, Transformations, and Calculations (such as returning red text to identify a failed condition).
• Automatic processing and saving of records without having to write special Form processing rules.
• Creation options:
• Automatic creation of Worksheets on system events involving:
•Data Sets (on demand, when a Data Set is created, or when a Data Set is assigned to an Analyst).
•Tests (on demand or when a Test is created)
•QC Batches (on demand, when a QC Batch is created, or when a QC Batch is assigned to an Analyst).
•Manual creation of Worksheets when managing Data Sets, Tests, and QC Batches.
•Programmatic creation of Worksheets using the CreateWorksheet Action.
•Ability to create and build Worksheets using the same tools as non-Worksheet Forms (Form Definitions, Form Builder, and eForm Manager).
•Integration with the Simple Instruments, AQC, and Reagents modules.

Automatic Datasource creation, automatic processing and saving, and the automatic and manual creation options are available out-of-the-box (referred to as "Context-Driven" Worksheets). Context-Driven Worksheets provide a high level of automation in the Worksheet creation and saving process. All Form processing rules for Context-Driven Worksheets are automatic. No user-defined processing is allowed.

You can also create advanced and customized Worksheets manually with custom processing rules (referred to as "Adhoc" Worksheets).

Form Definition

New Form Definition Options
• New "Translate" option makes the Form Translatable.
• New "Form Type" option defines if the Form is a Worksheet.
• "User Training Required" option restricts a user can from opening the Form unless he has a training certification for the Form.
• "User Training Overrides" lets a user open the Form whether or not he has a training certification for the Form.
• "Form Layout" tab lets you use the Form Builder from within the tab (expandable to full-screen).
• "Approve Version" button lets you Approve the Form.
• "Preview" button shows how the Form will be rendered.

eForm Manager

New Form and Document Search Utility
• New "Form Bar" search utility replaces R5.1 button bar.
• Configurable (defined by the EForm Page Type).
• Can be pinned open or automatically collapsed when a Document is opened.
• Consists of 5 collapsible/expandable panels:
• "New Forms" shows links to open new Forms. Similar to R5.1, but also supports LV_Form-based Queries (can be cascaded). Applies Form restrictive where and Version status restrictions.
• "Recent Forms" shows links to the 10 most-recently opened Forms.
• "Search By Form" shows links to open search Forms (similar to R5.1).
• "Document Search" shows links to find and open existing Documents. Similar to R5.1, but also supports LV_Document-based Queries (can be cascaded). Applies Document restrictive where.
• "Text Search" provides a free-text search for finding and opening existing Documents.
New Document Viewing and Selection Options
• Forms and documents can be viewed as Thumbnails, headers, or a List. Documents and Document Groups can be opened from here.
• Documents can be grouped into collapsible/expandable stacks of common attributes (such as group Documents by Form, Status, etc.).
New Document Toolbar Operations
• "SelectAll", "DeselectAll", and multi-select (Documents only).
• "Zoom" (Forms and Documents in Thumbnail view).
• "Refresh" (Forms and Documents).
• "Group" (Documents only).
• Sorting (Forms and Documents in List view).
New Field Toolbar Operation
• "Mark Outlier" button excludes a Field value from a Calculation (eNotebook only).
New Group Operation Buttons
• "Open" lets you step through Documents in the Group.
• "Lock", "Unlock", "Cancel", and "Assign" are available for Documents in the Group.
New Attachments Functionality
• Local files can now be attached to a Document prior to saving.
• New "Form Policy" provides saving options.
• Attachment Types:
• "Annotation Attachment"
Local file is attached to a Document or Field Annotation.
•"Field Attachment"
Local file is attached using the new File Field. Uploaded file can be used in Form processing. File can also be an image.
• New "Auto Attach" Field property adds the Field Annotation Attachments to the Field Linked SDC.
New Followup Functionality
• Followups can be defined with a notification that sends email or Bulletin to the assignee of the Followup (and back to the creator). This can be set on multiple Documents. A new Notifications Format System Configuration property lets you choose the default format (Email or Bulletin) used by the SendBulletin Action to send these notifications.
General Enhancements
• User settings are retained.
• A Second Double Data Entry user does not see the "View" option when opening a document unless has "Document Reconciler" privileges.
• A Form Version can be left blank, or it can be set to "C" in the URL to get the current Version of the Form.
• Users can resubmit a Form after an error.

Formlets

Versioning
• Formlets can now be Versioned.
By Reference
• Formlets can now be included in a Form "By Reference", which links the included Formlet to the Formlet Definition so that the host Form is updated when the Formlet Definition is updated.
• You can choose the "Current" version or an explicit Version.
Formlet Definition
• "Editable in Form" option allows Formlet to be editable in the host Form.
• "Allow AutoSave Binding" option enables Field Binding properties for use in Worksheet Forms.

Form Builder

User Interface Enhancements
• Form "Preview" mode lets you see how the Form is rendered.
• The new integrated Form editing environment includes maximize and retain state after save.
• You can now apply the same changes to multiple objects. This lets you select multiple Fields and apply the same property changes to all.
• Formlets can be edited from within the host Form.
• Show/hide page overflow is now available to show objects beyond the page dimensions.
• New "Draft" button group allows options for saving drafts.
• New "style" properties have been added for "Add Panel/Div" cosmetics.
• New "Insert HTML" feature imports HTML into the Form. You can write (or copy/paste) HTML text or source code directly into the editor.
• Add Formlet now offers "Insert" and "By Reference" (links the included Formlet to the Formlet Definition as described in Formlet above).
• New "Zoom" feature allows magnified viewing.
• New "Toggle Positioning" feature allows Fields to be positioned absolutely.
Form Builder Fields
• The Form Builder shows only the properties that can be used with the selected Field.
• New option for arranging and ordering Field properties (categorized, alphabetical, used/unused, editor type, and none).
• Optional value selection is now available for certain properties, i.e., defaultvalue = [currentuser]|[currentdatetime]|[currentdate].
• Groovy expressions are now visible in the Field property list.
• Groovy script auto completion provides ordering, fieldinstance object for Fields in repeating Sections, new spec object for Specification expressions, and sysusername added to user object.
• New "Formatted Text" Field allows a user to enter formatted text into a field (a basic formatting toolbar is included).
• New "File" Field Type added to allow a file from the local machine be defined as a field value.
• New "Fill Container" option added to "Insert Field" dialog to make the Field match the width of the parent object in which it is placed.
• The "Type" property has been renamed to "Edit style".
• New options have been added to the "Mandatory" property (Yes/No/IfVisible/IfEnabled).
• New options have been added to the "Readonly" property (Yes/No/OnCreation).
• In "Data" properties:
• The "KeyId1", "KeyId2", "KeyId3" properties (for Autocheck and Autolink) have been moved from the "Data" to the "Validation" property group. These have been renamed to "Key Id 1 Field", "Key Id 2 Field", "Key Id 3 Field".
•New "SDC Restrictive From" and "SDC Restrictive Where" properties have been added.
• In "Validation" properties:
• New "Max Length" property added.
•"Simple Validation" and "Complex Validation" have been changed to "Simple Validation" and "Script Validation".
•The functionality for "Simple Validation" has been significantly changed (dropdown choices, DDT.tableid.columnid, new enable options).
•Added new "Enabled" property.
•"Autocheck" SDI keys are now automatically populated.
• In the new "Datasource Binding" properties, new "Binding Mode" and "Bind Error" properties have been added for Worksheet Forms to bind a Field to a specific row and column in a Datasource result set.
• In "Layout" properties:
• New "Suppress Repeating" property suppresses repeating rows.
•New "View Image File", "File Image Width", "File Image Height" properties have been added to support Attachments to the "File" Field.
• In Misc properties:
• The "Instrument Type" and "Instrument Id" properties have been added to support integration of Worksheets with the Simple Interface functionality.
•The "Id Field" property has been renamed to "Identity Field".
•New "Auto Attach" property to add Field Annotation Attachments to a Field that is linked to an SDC.
•New "Save Field Value" property to specify the save behavior for a Field.
•New "Show Toolbar" property.
• New database objects: selectString(), selectDate(), selectNumber().
• In the Field Context Menu:
• New "ShowOverflow"/"HideOverflow" properties let you view/hide objects beyond the page boundary.
•New "Auto Fill Width" property allows a Field to be expanded to the width of its parent object.
•New "Match Width" property allows multiple Fields to be matched in width.
Form Builder Groups
• In"Validation", new "Enabled" property lets you conditionally enable the Group.
Form Builder Sections
• Section Fields can use the new Datasource object to populate the Fields with database data. Datasource properties are expression based, so loaded data can be dependent on other Form Fields.
• New "Exclude Binding Values" property to exclude Fields that match the Datasource Binding properties.
• New "Section Repeater" property defines the result set within the Datasource that will be used as the repeater or iterator for a repeating Section of data.
• New "Max Repeats" and "Max Repeats Message" properties allow greater control over repeating Sections.
• New "Clear Fields" property clears field values in the Section when the Section is hidden or disabled.
• New Formlet properties ("From Formlet", "From Formlet Version", "Locked", "By Reference") define the Formlet in the Section.
Form Builder Elements
• New "Element" object lets you make dynamic objects out of hyperlinks, buttons, images, and text .
Form Builder Pages
• New Page properties added ("Mode" for page or screen view, conditional "Clear Fields", and "ShowOverflow"/"HideOverflow" for viewing objects beyond the page boundaries).
• New "Image Repeat" property has been added to New Page to improve background image functionality.

EForm Page Type

Property Changes
• The "Search" property has been renamed "Search Id".
• The "Search Name" property has been renamed to "Search title".
• New "Mode" property has been added to define the overall behavior of the page and override other properties.
• New "Show Lookup Icons" and "Show Form Version Id" properties have been added to the "Layout" property group.
• New "New Form", "Form Query Search", and "Document Query Search" Types have been added to the "Searches" group to configure the new Form Bar.
• New "Form Bar" property group has been added to define the Document Panel that provides each search specified by the "Searches" property.
• New "Versions" property has been added to determine the Form version to show.
• New "Field Panel" property group has been added to configure the Field panel.
• New "Tools" property group has been added to configure default values.
• New "CSS Includes" has been added for custom CSS classes.

JavaScript

New JavaScript Functions
These new JavaScript functions are not exposed in a *.js file. They are created dynamically in Google Web Toolkit when a Form is created:
•getFields() returns an array of Field Ids.
•getCurrentFieldId() returns the current Field Id.
•getCurrentFieldInstance() returns the current fieldinstance.
•getCurrentFieldIndex() returns the current fieldindex.
•gotoField( fieldid, instance ) goes to the specified Field (including changing the page if necessary, but will not open a non-visible page).
•gotoPageNext() goes to the first Field of the next visible page (does not wrap to page 1 when at page n). Returns the new page number.
•gotoPagePrev() goes to the first Field of the previous visible page (does not wrap to page n when at page 1). Returns the new page number.
•getCurrentPage() returns the current page number.
•gotoBookmark( bookmark ) goes to the specified bookmark (including changing the page if necessary, but will not open a non-visible page).
•gotoSection( sectionid ) goes to the first Field of the specified Section (including changing the page if necessary, but will not open a non-visible page).
•gotoSectionNext() goes to the first Field of the next visible Section (does not wrap to the first Section when on the last Section).
•gotoSectionPrev() goes to the first Field of the previous visible Section (does not wrap to the last Section when on the first Section).
•getSectionInstances( sectionid ) returns the number of Section instances for a specified Section.
•getCurrentSectionId() returns the current Section for the current Field.
•getCurrentSectionInstance() returns the current Section instance for the current Field.
•getCurrentSectionIndex() returns the current Section index for the current Field.
•getFieldBinding( fieldid, instance ) returns an object map with the specified Field's binding properties.
•showInstrumentPopup( fieldid, instance ) displays the Instrument popup for the specified Field (if applicable).
•addReplicate( replicates, fieldid, instance ) adds the specified number of Replicates for the specified bound field (if applicable).
•clearValuesCache() clears the local cache of values.
Request Parameters and Old JavaScript Functions
• The elimination of the "Form Builder" button has eliminated the need for related Request Parameters.
• The new JavaScript functions created in GWT has eliminated the need for formmaint.js.

Actions

System Actions
• "AddDocument" now handles Field inputs with repeated values. Dependent fields are resolved from the Action inputs.
• New "CreateWorksheet" extends AddDocument to handle inputs for different Worksheet Types. This Action is used only with Worksheet Forms.

Modules

Module-Specific Functionality
• eForms Functionality is split across modules (eSubmission, BBEDC, eNotebook).

Document Changes

To support related functionality, these changes have been made to this document:

 Introduction to eForms
• Overview
• Added a brief introduction to Worksheets.
• Forms
• Added "Elements" to the list of available objects.
• Added a brief introduction to Worksheets.
• eForms Documentation
• Added links to new Worksheets and Elements documents.
• eForms Functionality Module Exclusions
• Added distribution of functionality across modules.
Form Definitions
• Overview
• Updated the Form List page and Form Maintenance page screen captures.
• Removed references to "Form Builder" button.
• Form Maintenance
• Added new "Translate" option.
• Added new "Form Type", "Worksheet Type" and "Items/Worksheet" functionality.
• Added new "User Training Required" and "User Training Overrides".
• Added new "Versionable" option.
• Added new "Form Layout" tab.
• Specialized Buttons
• Added new "Approve Version" and "Preview" buttons.
Form Builder: Overview
• Creating Forms
• Added new "Form Layout" tab.
• Form Builder Frames
• Updated Form Builder screen capture.
• Added new capability to select multiple objects.
• Object Tree
• Added new "Datasources" and "Elements" objects to the Object Tree.
• Editing Frame
• Added new "Elements" object.
• Toolbars
• Added new "Image Repeat" property to New Page.
• Added new "Draft" button group.
• Added new "style" properties for Add Panel/Div.
• Added new "Insert HTML" feature.
• Added new "Toggle Positioning" feature.
• Added the new "Insert" and "By Reference" options to "Add Formlet".
• Changed positioning comment for Tables due to new absolute positioning options.
• Added new "Insert Column" for tables.
• Added new "Zoom" feature.
• Added new Elements and Worksheet documents to related documentation links.
Form Builder: Fields
• Fields Toolbar
• Added new "Formatted Text" Field.
• Added new "File" Field.
• In "Controlled Vocabulary" Field description, noted that the edit style depends on the Field type.
• Removed reference to Formlet creation (no longer valid).
• Field Properties
• Added new property sorting feature.
• Rearranged and reorganized all properties to reflect new R5.2 default organization.
• Noted that you now see only properties relevant to the Field type.
• Added Fields enabled for each property.
• Behavior
• Changed "Type" property to "Edit style".
• Added new options for "Mandatory" property (Yes/No/IfVisible/IfEnabled).
• Added new options to "Readonly" property (Yes/No/OnCreation).
• Data
• Moved "KeyId1", "KeyId2", "KeyId3" properties (for "Autocheck" and "Autolink") from the "Data" to the "Validation" property group. Renamed to "Key Id 1 Field", "Key Id 2 Field", "Key Id 3 Field".
• Added new "SDC Restrictive From" and "SDC Restrictive Where" properties.
• Validation
• Added new "Max Length" property.
• Changed "Complex Validation" to "Script Validation".
• Rewrote "Simple Validation" to reflect new functionality and new properties (dropdown choices, DDT.tableid.columnid, new "Enabled" options).
• Added new "Enabled" property.
• Revised "Autocheck" to reflect new functionality (SDI keys are automatically populated).
• Datasource Binding
• Added "Datasource Binding" properties with links to the Worksheet documentation.
• Layout
• Added "Suppress Repeating" property.
• Added "View Image File", "File Image Width", "File Image Height" properties.
• Misc
• Added Instrument Type, Instrument Id properties.
• Renamed "Id Field" to "Identity Field".
• Added note about automatic key population to "Autolink" property.
• Added new "Auto Attach" property.
• Added new "Save Field Value" property.
• Added new "Show Toolbar" property.
• In Field Context Menu, added "ShowOverflow"/"HideOverflow", "Auto Fill Width", "Match Width" properties.
• Database Objects: Added selectString(), selectDate(), selectNumber().
Form Builder: Groups
• Group Properties
• Rearranged and reorganized all properties to reflect new R5.2 default organization.
• Validation
• Added new "Enabled" property.
Form Builder: Sections
• Section Properties
• Behavior
• Added new "Max Repeats" property.
• Added new "Max Repeats Message" property.
• Added new "Separator" property.
• Added new "Clear Fields" property.
• Formlet
• Added new Formlet properties (From Formlet, From Formlet Version, Locked, By Reference).
• Datasource Binding
• Added new "Datasource Id" property.
• Added new "Section Repeater" property.
• Added links to Worksheets document for Field Binding information.
• Added new "Exclude Binding Values" property.
Form Builder: Elements
• Added new document for the "Element" object.
eForm Manager
• Overview
• Updated main screen capture.
• Form Bar
• Deleted all information concerning R5.1 navigation tools and methodology and replaced with new "Form Bar".
• Added new "New Forms" panel.
• Added new "Recent Forms" panel.
• Added new "My Search Forms" panel.
• Added new "Document Searches" panel.
• Added new "Text Search" panel.
• Views
• Added new "Thumbnail View".
• Added new "header View".
• Added new "List View".
• Groups
• Added new "Groups" functionality with "Group By", "SelectAll"/"DeselectAll.
• Document Toolbar
• Added "View Document History" toolbar button.
• Modified "Search Using This Form" functionality.
• Operation Buttons
• Removed "Copy" button.
• Added "Open" button.
• Noted Group operation behavior.
• Added "New Version" button.
• Field Toolbar
• Added "Mark Outlier" button and link to PageType configuration to Field Toolbar.
• Annotations and Followups
• Changed Document Annotation and Followup screen capture.
• Added information about new feature that send notification to Followups.
• Attachments
• Added new "Field Attachments" functionality.
• Added new "Annotation Attachments" functionality.
eForm Worksheet Principles
Added new topic to describe basic Worksheet functionality:
•

Overview

•

Datasources

Overview

Worksheet Types

Workitem

DataSet

QCBatch

SDI

Status Management Options

•

Field Binding

Overview

Binding Mode

Binding Keys

Bind Error

Basic Mechanics of Field Binding

 
•

Creating a Worksheet Form

•

Creating Worksheets

Workitem

DataSet

QCBatch

SDI

•

Example of Basic Worksheet Form

•

Worksheet Assignment and Analyst Certification

Worksheet Assignment

Analyst Certification
eForm Worksheet Advanced Concepts
Added new topic to describe advanced Worksheet functionality:
•

Overview

•

Using Repeating Sections to Make a Grid

•

Multiple Items per Worksheet

•Binding Fields to Multiple Data Records
•Multiple Matching Rows
•AddReplicate
 
•

SDI Worksheets

•

Customizing the Display Expression for Specifications

•

QC Batches

•

ReagentsIntegration

•Adhoc Worksheets
•SQL Datasources
Field and Formlet Definitions
• Formlet Definitions
• Modified description to describe implications of the new "By Reference" functionality.
• Added new "Versioning" option.
• Updated screen capture.
• Added new "Editable in Form" and "Allow AutoSave Binding" options.
eForm Data Entry Examples
• Rewrote all examples to reflect new behaviors (mostly related to searching) in Single Data Entry and Double Data Entry resulting from new eForm Manager changes.
• Updated all screen captures with new examples.
eForm Document Reference
• Added the "Pending" state to Document Status.
• Added Worksheet Data Entry to note that Worksheet status transitions begin in the "Pending" state.
EForm Page Type
• Changed the name of the "Search" and "Search Name" properties to "Search Id" and Search title", respectively.
• New "Mode" property to define the overall behavior of the page and overrides other properties.
• Added "Show Lookup Icons" and "Show Form Version Id" "Layout" property group.
• Added "New Form", "Form Query Search" and "Document Query Search" Types to "Searches" group to configure the new Form Bar.
• Added new "Form Bar" property group to define the Document Panel that provides each search specified by the "Searches" property.
• Added new "Versions" property to determine the Form version to show.
• Added new "Field Panel" property group to configure the Field panel.
• Added new "Tools" property group to configure default values.
• Added new "CSS Includes" property group for custom CSS classes.
Forms Policy
• Added new Form Policy.
Form Builder: APIs
• Added new Auto Completion feature.
• Added 20 new JavaScript functions (created dynamically in GWT when a Form is created).
• Added reference and link to new CreateWorksheet Action.
• Removed references to formmaint.js and the eForm-related Request Parameters.
Added "Create Worksheet Rule" and "Forms" detail to:
•Parameter List Maintenance page.
•Test Method Maintenance page.
•QC Method Maintenance page.
In Enhanced Data Entry Pages, added "Worksheet" to Data Set Detail Panel with information and link to SDIData locking.
In System Configuration User Options, added new Notifications Format property.

 

External Authentication (LDAP)

Top ../images/arwup.gif (846 bytes)

Features

In External Authentication, a new "LDAP to User Message Mappings" property collection allows LDAP error messages to be displayed in a more user-friendly manner. You can specify a literal string, which is matched to the error message issued by the LDAP server. You can specify a custom message to display when a match is found. The custom message accepts a literal text string and the [currentuser] and [ldaperrormessage] tokens. For example, this can be a string such as "Password expired" or "User not found for [currentuser]". If these values are not specified, a generic message is issued to maintain backward-compatibility.

Document Changes

In External Authentication, added new LDAP to User Message Mappings property collection.

 

JavaScript Global API

Top ../images/arwup.gif (846 bytes)

Features

A new sapphire.util.url object handles encoding and passing Unicode charcters through the request. All navigation routines have been changed to use the sapphire API which, in turn, uses this new url object. The APIs for opening URLs (sapphire.page.navigate) and windows (sapphire.lookup.open) were also enhanced to encode the URL using the new API. Also, more new methods and objects have been added as enhancements (see "Document Changes" below).

Document Changes

See the JavaScript Global API to access these objects from the object tree.
Object Change
sapphire.browser Added new object properties and deprecated "id" object property.

Deprecated "determine" method.
sapphire.connection Added "isDevMode" object property.
sapphire.events Added "vFunction" property to attachEvent method.

Added detachEvent and fireEvent methods.
sapphire.page Added getKeyId2, getKeyId3, maximizeLayout, minimizeLayout, toggleLoading, and getPageType methods.

Added a note to describe that the navigate method now works with Unicode.
sapphire.page.maint Added getRowCount, getAllColumnValues, getLocked, and getLockedBy methods.
sapphire Added translate and translatePartial methods.
sapphire.util.script New object.
sapphire.util.dom New object.
sapphire.util.date New object.
sapphire.util.url New object.
sapphire.util.url.href New object.

 

Maint Page Formatted Text Editor

Top ../images/arwup.gif (846 bytes)

Features

In the maint Element, a new "formattedtext" Column Mode renders a new "Formatted Text" editor that lets you enter formatted text into a CLOB column. The editor consists of an editing pane and basic self-explanatory toolbar. Features that do not work with Reports are noted in the documentation.

Document Changes

In maint Element, added formattedtext mode and Formatted Text Editor, including a link to Reporting Caveats.
Deleted the RTF Editor API from the documentation. It has been declared for internal development use only.

 

Naming Restrictions

Top ../images/arwup.gif (846 bytes)

Features

SDC/SDI naming restrictions have been extended to include Reference Types and Reference Values.

Document Changes

In Naming Restrictions and Syntax Standards, extended SDC/SDI naming restrictions to include Reference Types and Reference Values.

 

Packages

Top ../images/arwup.gif (846 bytes)

Features

In R5.1, the status of Samples in a Package is set to Received when the Receive Sample when Package is Received lets you continue this behavior, or change it so that Sample status is not changed when the Package is Received.

Document Changes

In BioBankingPolicy, added Receive Sample when Package is Received property.

 

Reporting

Top ../images/arwup.gif (846 bytes)

Features

Jasper Reports has been upgraded to version 3.7.4.
The compatible JasperSoft iReport installer is no longer provided with the LabVantage distribution CD.
The JasperReportScriptlet class is no longer provided as a standalone file (it is now accessible only through the Java Public API).
Caveats exist in various areas of Reporting.

Document Changes

In Concepts of Reporting:
• In Jasper Reports UI Integration, removed references to the iReport executable.
•In Jasper Reports APIs, removed references to standalone class file and replaced with reference to the sapphire.report.JasperReportScriplet class in the LabVantage Java Public API.
•Removed client setup and replaced with requirement to put sapphire.jar in the iReport CLASSPATH.
In Using Unicode in Jasper Reports, added stipulation that the Unicode font must go into the root of the EAR.
Added Reporting Caveats. Also added warning and link to Concepts of Reporting, Reports and Execute Reports, Formatted Text Editor, and Adhoc Queries.

 

Simple Instruments

Top ../images/arwup.gif (846 bytes)

Features

A new "Simple Instruments" feature allows data to be transferred from a "simple" laboratory instrument to Data Entry. A "simple" instrument is defined as one that uses a protocol such as RS-232, generates raw test results without knowing Sample Ids, synchronously receives commands, and optionally sends back responses. Examples include weight balances and pH meters.

You can define "Instrument Response Parsing" rules to specify how the raw response from an instrument is parsed to fields and field values in Data Entry and eForm pages (Interfaces are available on Enhanced Data Entry pages and Form Fields configured with Instrument properties).

An instrument can be simulated using the example response when running an instrument in "simulation mode". When running in simulation mode, all configurations related to an instrument are tested except for actual connectivity to the instrument.

This functionality is available at these Lab Admin → Certifications and Resources tramstops:

• Instrument Types (functional classification of the instrument, such as "WeightBalance" or "pHMeter".
•Instrument Models (identifier of a model of a specific Instrument Type, e.g., the Instrument Type "WeightBalance" can be manufactured in two Models: "WB-200" and "WB-500".
•Instruments (Identifier for a specific Instrument, e.g., "SolidsLabWeightBalance").

Document Changes

Added new documentation for Simple Instruments.
Added Simple Instrument interface button to Enhanced Data Entry Page Toolbar.

 

Specifications

Top ../images/arwup.gif (846 bytes)

Features

A new Specification Transform Rule is now executed during Data Entry to transform the entered data value immediately before evaluating the Specification Limits.

 Problem in R5.1:
• Entering a data value of 5.001 with a Display Format of 2 decimal places displays 5.00. When this value is evaluated against a Specification Limit of "Pass when <= 5.00", the entered value fails the Specification Limit check.
•You could use a Transform Rule to round the value prior to testing against the Specification Limit. However, the rounded value would then used to evaluate Calculations. This could cause problems downstream.
Solution in R5.2:
• A new Specification Transform Rule is now executed during Data Entry. This new rule transforms the entered value immediately before evaluating the Specification Limits.
•The Parameter List Transform Rule continues to be defined in SDIDataItem.TransformRule. The result of the transformation continues to be stored in SDIDataItem.TransformValue (for numeric data) and SDIDataItem.EnteredText (for non-numeric data).
• The new Specification Transform Rule is defined in SpecParamItems.TransformRule. The result of the transformation is stored in SDIDataItemSpec.TransformValue. This value is also stored in SDIDataItemSpec.CheckedValue (for numeric data) and SDIDataItemSpec.CheckedText (for non-numeric data). The "CheckedValue" and "CheckedText" are the values that are reported in Data Entry pages. For example:
SpecParamItems.TransformRule=round( [this], 1 )
Entered Data Value=10.269
SDIDataItemSpec.TransformValue=10.3
 =Data value checked against Specification Limits
SDIDataItemSpec.CheckedValue=10.3
 ="Checked Value" reported in Data Entry pages
•Define the new Specification Transform Rule in the Specification Maintenance page (Lab Admin → Tests → Specifications). The "Parameter Details" tab has a lookup in "Transformation Rule" that opens the Expression Editor. This is where you define the new Specification Transform Rule.
• In Data Entry pages:
• The Specification Transform Rule is applied if it exists. If it does not exist, SDIDataItemSpec.TransferValue is (null) and the Parameter List Transform Value (SDIDataItem.TransferValue) becomes the Specification Transform Value.
•The Limits detail shows the SDIDataItemSpec.CheckedValue (for numeric data) or SDIDataItemSpec.CheckedText (for non-numeric data).
•Limits are now shown with the correct precision. For example, <=5.00 was previously reported as <=5. It is now reported as <=5.00.

Document Changes

In the Specification Maintenance page, added "Transformation Rule" to the "Parameter Details" tab to define the new Specification Transformation Rule.
In How Transformations and Calculations are Processed (formerly "How SAPPHIRE Handles Data Entry"), changed process to include new Specification Transformation Rule. This is in preparation to adding a separate topic covering the entire Data Entry process (to be done in a future document revision).
In Concepts of Transformations and Calculations and Parameter List Maintenance page, changed descriptions of N and NC Data Types.
In the Parameter List Maintenance page, added a link to Concepts of Transformations and Calculations.
In the Limits Detail Panel for Enhanced Data Entry pages, updated screen capture to show "Checked Value".

 

Storage

Top ../images/arwup.gif (846 bytes)

Features

In SAPPHIRE R5.1, adding a child to an existing Storage Location was a two step process. In R5.2, a new "Add Child" button on the Storage Units Tree page lets you add a child to a single parent in one step. Validations are also done to make certain you have selected only one Storage Location. For consistency of operation, "Add Child" provides the same wizard for building the child hierarchy as in the parent.

Document Changes

Updated screen captures and added Adding a Child Storage Location to reflect shift from detail element operation to "Add Child" button operation.

 

System Monitor

Top ../images/arwup.gif (846 bytes)

Features

"Trending" (System Admin → Monitoring → Trending) provides a graphical representation of trends regarding ToDo List Maintenance, Performance Statistics, System Monitor, User Connections, and JVM. Trending can aid with problem diagnosis or monitoring system stability. Options are provided for showing "Historical Trends" over extended time domains, and "Live Trends" currently in process.

Document Changes

Added new Trending section to Monitoring.

 

Web Page Designer

Top ../images/arwup.gif (846 bytes)

Features

A new "Node Finder" lets you find a specific node on a large Property Tree. Enter a search string, and nodes containing the search string are highlighted in yellow.

Document Changes

Added new Node Finder feature to Web Page Designer: Properties Overview.

 

Web Services

Top ../images/arwup.gif (846 bytes)

Features

Thirteen new Web Service methods have been added to allow direct object interaction with SOAP languages:
translateTable getSDIData editSDIAttachment
checkConnection processAction addSDIAttachment
getDatabaseList processActionBlock deleteSDIAttachment
getSqlDataSet getSequence  
getSDCProperties getSDIAttachment  

Recall that LabVantage R5.1 Web Services provide generic calls to the Java Public API (such as getSQLDataSet and processAction). However, they also use LabVantage-specific XML structures to send/receive data to/from the Web Service, i.e., XML is sent within XML. This has proven to be inefficient, since objects must be manually serialized to LabVantage XML structures, then deserialized in the client using the XML structure to create the objects. Note that the LabVantage propertylist and dataset XML does not use standard XML ddt or schema, and is therefore not recognized by other languages.

New Transport Beans have been created for classes that handle things such as for Data Sets, Property Lists, and SDI Data. These are Java Bean Wrappers for current classes that are built from primitives and expose get and set properties. Each complex LabVantage API object is therefore wrapped by a primitive Java Bean

The current Web Service methods have been enhanced to accept and return these new Java Bean objects. This means that the SOAP interface in LabVantage's Axis engine and on the .NET (or other language) client is responsible for serialization. We therefore need not know anything about the object. The object can then be used "as-is" on the client. This allows direct object interaction with SOAP languages such as .NET. For example, you can send a Property List object to the Web Service call to process an Action. With the old methods and XML structures, you would have to send a Property List XML string... which the 3rd party vendor does not know how to build.

For backward-compatibility, all methods continue to accept the older (pre-R5.2) XML structures.

New complex methods such as getSDIData, getSDCProperties and getDatabaseList have been added to let you use the LabVantage Java Public API and query the database using the recommended techniques. You can therefore query SDCs for primary and detail tables from any external language, rather than having to know the exact SQL and data structure.

Client code and LabVantage object .NET equivalents have been integrated into a centralized .NET library that is still in the process of being created for future use. This new wrapper class will hide the complexities of the Web Service and LabVantage architecture (such as connection management) and will manage logging and pinging.

A new Web Service method is also available to create and update Attachments.

Document Changes

In Web Services, added the new Web Service methods accompanied by background information.