LabVantage 8.8.x ReleaseNotes - 221207 880

LabVantage 8.8.
0
Release Notes
Subject: LabVantage 8.8.0 Release Notes
Document Revision: 221207-88
CONFIDENTIAL INFORMATION – PROPERTY OF LABVANTAGE SOLUTIONS, INC.
CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

LabVantage-8.8.x-ReleaseNotes_221207-880.docx
Page 2 of 86
LabVantage 8.8.0 Release Notes Revision: 221207-88
FOR CUSTOMER’S INTERNAL BUSINESS PURPOSES ONLY

This document contains confidential and proprietary information owned exclusively by LabVantage
Solutions, Inc. ("LabVantage") and its third-party licensors. Its content is to be viewed and used only by
customers of LabVantage and their employees and agents who are authorized pursuant a duly executed
license agreement and under strict legal obligations to retain confidentiality of the contents of this
document.
No part of this document may be reproduced, transmitted, or modified in any way, for any purpose,
without the express prior written consent of LabVantage.
LABVANTAGE SOLUTIONS, INC. AND ITS AFFILIATES DISCLAIM ALL WARRANTIES WITH
RESPECT TO THIS DOCUMENT, EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THOSE OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
SHALL LABVANTAGE SOLUTIONS, INC. OR ITS AFFILIATES BE LIABLE, WHETHER IN CONTRACT,
TORT, WARRANTY, OR UNDER ANY STATUTE OR ON ANY OTHER BASIS FOR SPECIAL,
INCIDENTAL, INDIRECT, PUNITIVE, MULTIPLE OR CONSEQUENTIAL DAMAGES IN CONNECTION
WITH OR ARISING FROM THIS DOCUMENT, INCLUDING, BUT NOT LIMITED TO, THE USE
THEREOF.
This document and the software described herein may be disclosed, copied and used only in accordance
with the terms of the license agreement provided with the software.
Information contained herein is subject to change without notice and does not represent a commitment on
the part of LabVantage.
Copyright © 1999-2022 LabVantage Solutions, Inc. All rights reserved.
TRADEMARKS
• All trademarks are the sole property of their respective owners:
• LabVantage is a registered trademark of LabVantage Solutions, Inc.
• Apache and Tomcat are registered trademarks of the Apache Software Foundation.
• Chrome is a registered trademark and Google is a trademark of Alphabet Inc.
• Empower and Waters are registered trademarks of Waters Corporation.
• Ephox is a registered trademark, and TinyMCE is a trademark of Ephox, Inc.
• GrapeCity is a registered trademark, and SpreadJs is a trademark of GrapeCity, Inc.
• Groovy is a registered trademark of the Apache Software Foundation.
• IBM and WebSphere are trademarks of International Business Machines Corporation in the United States
and other countries.
• Microsoft, Windows, Edge, Internet Explorer, and SQL Server are registered trademarks of Microsoft
Corporation in the United States and other countries.
• Northwest Analytics, Quality Analyst, and Quality Analyst Web Server are registered trademarks of
Northwest Analytics, Inc.
• Oracle, Oracle Java, and WebLogic are registered trademarks of Oracle and/or its affiliates.
• Red Hat, Red Hat Linux and JBoss are trademarks or registered trademarks, of Red Hat, Inc.
• Safari and Apple are registered trademarks of Apple, Inc.
• SAP and other SAP products mentioned herein are trademarks or registered trademarks of SAP AG in
Germany and other countries.
• Seagull Scientific is a registered trademark, and Bartender is a trademark of Seagull Scientific, Inc.
• Talend is a trademark of the Talend company.
• Jaspersoft or Jasper is a trademark of TIBCO Software Inc.

Page 3 of 86
REVISION HISTORY
Revision Date Changes
221207-88 7-Dec-2022 First revision to support LabVantage 8.8.0.

Page 4 of 86
DOCUMENT INFORMATION
Creation/Revision
By signing below, the signatory confirms that he/she is the author of (or has revised) this document, and it
contains the information needed to achieve its stated purpose.
Role Name, Signature and Date
Author Digitally signed by Aaron Mills

DN: cn=Aaron Mills, o=LabVantage Solutions,
ou=Development, email=amills@labvantage.com, c=US
Reason: I am the author of this document
Location: Florida, USA
Date: 2022.12.07 14:44:26 -05'00'
Review
By signing below, the signatory confirms that he/she has reviewed the content of this document and
agrees that it contains the information needed to achieve its stated purpose.
Role Name, Signature and Date
Reviewer Digitally signed by Matthew Grulke

DN: cn=Matthew Grulke, o=LabVantage
Solutions, Inc., ou=R&D,
email=mgrulke@labvantage.com, c=US
Date: 2022.12.07 14:53:13 -05'00'

Page 5 of 86
TABLE OF CONTENTS
1.1 Document Overview .................................................................................................................... 14
1.2 Configuration Reports.................................................................................................................. 14
1.3 Transmaster Spreadsheets ......................................................................................................... 15
1.4 Data Model .................................................................................................................................. 15
1.5 LabVantage Documentation ........................................................................................................ 15
2 Platform Support and Certification Systems for LabVantage 8.8.x ...................................................... 16
2.1 Supported Software ..................................................................................................................... 16
2.1.1 Supported Application Server and DBMS Platforms ................................................... 17
2.1.2 Operating System Support .......................................................................................... 17
2.1.3 Red Hat JBoss EAP Supported Platforms ................................................................... 17
2.1.4 IBM WebSphere Not Supported for 8.8.0 .................................................................... 17
2.1.5 Oracle WebLogic Supported Platforms ....................................................................... 18
2.1.6 Oracle RDBMS Support ............................................................................................... 18
2.1.7 Microsoft SQL Server RDBMS Support ....................................................................... 18
2.1.8 JDBC Drivers ............................................................................................................... 18
2.1.9 Supported Web Browsers ............................................................................................ 18
2.1.10 Other Supported Software ........................................................................................... 19
2.2 Certified Platforms ....................................................................................................................... 19
2.2.1 Red Hat JBoss EAP Certified Platform ........................................................................ 20
2.2.2 Oracle WebLogic Certified Platform ............................................................................ 20
2.2.3 Certified Web Browsers ............................................................................................... 21
2.2.4 Other Certified Software .............................................................................................. 21
2.3 HTTPS ......................................................................................................................................... 21
2.4 Browser Settings for Documentation ........................................................................................... 21
3 Upgrade Considerations ....................................................................................................................... 23
3.1 General Information ..................................................................................................................... 23
3.1.1 Remove JNetDirect from consoleconfig.props ............................................................ 23
3.1.2 Platform Support .......................................................................................................... 23
3.1.3 Upgrade Paths for LabVantage Databases and Applications ..................................... 23
3.1.4 Use of the dbo Schema for Microsoft SQL Server ...................................................... 23
3.2 Deprecated Features ................................................................................................................... 23
3.2.1 Queries Removed or Altered on the Contacts List Page ............................................. 23
3.2.2 Right to Left Option for Languages is Removed.......................................................... 24
3.2.3 Removal of References to eWorksheets used by eNotebook in eForms .................... 24
3.2.4 Continuous Logging Mode Removed .......................................................................... 24
3.3 Distributed Third-Party JAR Files ................................................................................................ 24
Page 6 of 86
3.4 Post-Upgrade Notes .................................................................................................................... 28

4 Major New Features in LabVantage 8.8.0 ............................................................................................ 30
4.1 Automatic Inter SDI Calculations ................................................................................................. 30
4.2 Approval by Exception ................................................................................................................. 31
4.3 Reporting ..................................................................................................................................... 31
4.4 Log4j ............................................................................................................................................ 32
4.4.1 Date Pattern Log File Syntax Changes ....................................................................... 32
4.5 Handsfree Installer ...................................................................................................................... 32
5 Additional New Features and Enhancements in LabVantage 8.8.0 ..................................................... 33
5.1 Core or General Enhancements .................................................................................................. 33
5.1.1 About LabVantage ....................................................................................................... 33
5.1.2 AddDataset Performance Improvement ...................................................................... 33
5.1.3 Adhoc Queries Available for DataSets and SDIWorkitems ......................................... 33
5.1.4 Application Resources support dynamic class loading................................................ 33
5.1.5 Approval Types ............................................................................................................ 34
5.1.6 Approve Multiple Versioned SDIs from any List Page ................................................. 34
5.1.7 Class Loading Security and Sandboxing ..................................................................... 34
5.1.8 Completion of SDIWorkitems when Reflex Rules are not Triggered........................... 34
5.1.9 Description Columns now have a Maximum Length of 255 Characters ...................... 34
5.1.10 Date Inputs May Require Four Digits for the Year ....................................................... 35
5.1.11 New SDI Certification Action ........................................................................................ 35
5.1.12 Intra SDC Copying of SDI Notes ................................................................................. 36
5.1.13 Local Event Plans Associated with First sdiworkitem Row Only. ................................ 36
5.1.14 Log File Viewer Page Allows Sorting ........................................................................... 36
5.1.15 Query Text Written to Application Log File .................................................................. 36
5.1.16 Sample Review and Approval...................................................................................... 36
5.1.17 LDAP Passwords now support Unicode Characters ..................................................... 36
5.1.18 Simple Instruments Response Wait............................................................................. 37
5.1.19 Statements and Agreements ....................................................................................... 37
5.1.20 Supporting Property Changes to Component Tasks .................................................... 37
5.1.21 Protecting Time Zone Reference Type Values ............................................................ 37
5.1.22 Upgrade Multiple Databases in One Click Using the Console .................................... 37
5.1.23 Upgrading Reference Type Values.............................................................................. 38
5.1.24 What is Required to Complete ..................................................................................... 38
5.2 AQC ............................................................................................................................................. 38
5.2.1 QC Batches and Consumable Types .......................................................................... 38
5.2.2 Add QC Sample Action ................................................................................................ 38
Page 7 of 86
5.2.3 QC Batch Templates for LES ...................................................................................... 38

5.2.4 Utilize AddSDIDetail and EditSDIDetail for AQC Persistence ..................................... 38
5.3 Array Management ...................................................................................................................... 39
5.3.1 Applied Array Methods no longer Automatically Cancelled ......................................... 39
5.3.2 Auto Load Scanned Items ........................................................................................... 39
5.3.3 Create Common or Distinct Child Samples ................................................................. 39
5.3.4 Support of Decimal Dilution Factors ............................................................................ 39
5.3.5 Default Volume and Concentration Values from Array Method ................................... 39
5.3.6 Default Entered Volume and Concentration Values in Successive Loads .................. 40
5.3.7 Dispose Source Sample When Consumed ................................................................. 40
5.3.8 Intra-Array Transfer...................................................................................................... 40
5.3.9 LoadArrayByPosition Action ........................................................................................ 40
5.3.10 Non-Numeric Data Types for use during Array Data Entry ......................................... 41
5.3.11 Order of Child Sample Creation................................................................................... 41
5.3.12 New Promote Results Rule Options ............................................................................ 41
5.3.13 Support for Remeasuring an Array .............................................................................. 42
5.3.14 Serial Dilutions - Calculation of Source Volume to Decrement ................................... 42
5.4 Attachments ................................................................................................................................. 43
5.4.1 Ability to Reorder Attachments by Sequence .............................................................. 43
5.4.2 Disabling Attachment Thumbnails ............................................................................... 43
5.4.3 Azure and CIFS File Repositories ............................................................................... 43
5.4.4 Class Loading .............................................................................................................. 43
5.4.5 File Rename Tokens for Manually Managed Repositories .......................................... 44
5.4.6 Maximum File Upload Size Increased to 1TB ............................................................. 44
5.4.7 Validation Check Added to the AddSDIAttachment Action ......................................... 44
5.5 Attributes ..................................................................................................................................... 45
5.5.1 SDCAttribute Detail Converted to an SDC .................................................................. 45
5.5.2 MultiSDIAttributeMaint Page ........................................................................................ 45
5.5.3 Configuration of MultiSDIAttributeMaint....................................................................... 46
5.5.4 New Attribute Type Options for Test Method Attributes ............................................. 46
5.5.5 Request Item Test Attributes ....................................................................................... 47
5.5.6 Manage Attributes for Multiple Sample SDIs from the SDI List Page ......................... 47
5.5.7 Save Operation Optimized for Attributes ..................................................................... 47
5.5.8 Workflow Step using the MultiSDIAttribute PageType Omprovements ...................... 47
5.5.9 Delete SDI Attributes ................................................................................................... 48
5.5.10 Directly Add or Manage Test Attributes on Master Data SDIs .................................... 48
5.6 Audit View .................................................................................................................................... 48
Page 8 of 86
5.6.1 Display of PropertyTree Data in the View .................................................................... 48

5.6.2 Dynamic Audit Support in Advanced Configuration Mode........................................... 49
5.6.3 Suppress First Audit Record in the Presentation of the Audit View Element .............. 49
5.7 Batch Management ..................................................................................................................... 50
5.7.1 Allow Samples on a Released or Rejected Batch to be Disposed .............................. 50
5.8 Biobanking ................................................................................................................................... 50
5.8.1 Alias Support in Genealogy Viewer ............................................................................. 50
5.8.2 Alias Support on Child Sample Creation Page ............................................................ 50
5.8.3 Departmental Access During Sample Transfers ......................................................... 50
5.8.4 Participant Status Validation ........................................................................................ 50
5.8.5 Preventing Enrollments and Additions into Completed and Cancelled Studies .......... 50
5.8.6 Receive and Accession Samples from Participant and Participant Event List Pages . 51
5.8.7 Remove Sample from Auxiliary Study ......................................................................... 51
5.8.8 Receive and Accession Samples Workflow Task ........................................................ 51
5.8.9 Duplicate Visits Allowed ............................................................................................... 52
5.8.10 Subject Description Column Relabeled as Full Name ................................................. 52
5.9 Calculations ................................................................................................................................. 52
5.9.1 Alternate Value when Calculation Token Cannot Be Matched .................................... 52
5.9.2 DateOffset added to Expression Library ...................................................................... 52
5.10 CMT ............................................................................................................................................. 52
5.10.1 Allow Change Control and CMT Transfer of Attributes ............................................... 52
5.10.2 Change to Key Generation Rule for Change Request SDC ........................................ 52
5.10.3 Change Request Inspector .......................................................................................... 52
5.10.4 Create New Change Request from Check Out Dialog ................................................ 53
5.10.5 Export Multiple Property Trees .................................................................................... 53
5.10.6 Import Sample Templates ............................................................................................ 53
5.10.7 Import Wizard............................................................................................................... 53
5.10.8 Linked Item Details Interchanged ................................................................................ 54
5.10.9 Warn When Exporting Provisional SDIs ...................................................................... 54
5.11 Configuration Report ................................................................................................................... 54
5.11.1 HTML Code Displayed as Text .................................................................................... 54
5.11.2 Role Labels in the Role Matrix ..................................................................................... 54
5.12 Consumables ............................................................................................................................... 54
5.12.1 Adhoc Addition of Equipment and Consumables to a DataSet ................................... 54
5.12.2 Consumable Chooser Dialog ....................................................................................... 55
5.12.3 Consistent Chooser Dialog Features throughout Application ...................................... 56
5.12.4 Freeze Thaw Tracking ................................................................................................. 56
Page 9 of 86
5.12.5 Hourly Expirations Date Unit ........................................................................................ 56

5.12.6 Instrument Integration .................................................................................................. 56
5.12.7 Mark a Consumable Type Mandatory for a Parameter List ......................................... 57
5.12.8 Notification Event Plan for Consumable Lot Expiration and Reorder ......................... 57
5.12.9 Select Lot from and Consumable Type Version .......................................................... 58
5.12.10 Prevent Setting Container Status to Valid if Consumable Lot is not Active................. 58
5.12.11 Query ContainersFronSimilarConsumable Updated ................................................... 58
5.13 Due Dates .................................................................................................................................... 58
5.13.1 Sample Columns Cleared when using Save as Template .......................................... 58
5.13.2 Sample Login Automatic Due Date Calculation Removed .......................................... 58
5.14 ELN and LES ............................................................................................................................... 58
5.14.1 Activity Log ................................................................................................................... 58
5.14.2 Allow Add Replicate Inside Control and Allow Remeasure Inside Data Entry Control 59
5.14.3 Attributes Control ......................................................................................................... 59
5.14.4 Audit Trail for Parameter Outliers ................................................................................ 59
5.14.5 Auto Numbering/Captioning of Attachments ............................................................... 59
5.14.6 Cancel Worksheet Action ............................................................................................ 59
5.14.7 Capture Electronic Signature when Saving any Control.............................................. 59
5.14.8 Custom Table Styling ................................................................................................... 60
5.14.9 Data Entry Control Completion .................................................................................... 60
5.14.10 Dock ............................................................................................................................. 60
5.14.11 The "Edit" Activate Operation has been added ........................................................... 60
5.14.12 File Control ................................................................................................................... 60
5.14.13 Incidents ....................................................................................................................... 61
5.14.14 LIMS Control ................................................................................................................ 61
5.14.15 Override Word Template File on Worksheet ............................................................... 61
5.14.16 Require Sections or Controls to be Marked as Complete ........................................... 61
5.14.17 Revert Worksheets (or Sections) to InProgress after being sent for Approval ............ 61
5.14.18 Section Behaviors ........................................................................................................ 61
5.14.19 Show Publish History ................................................................................................... 62
5.14.20 Signature Control ......................................................................................................... 62
5.14.21 Spreadsheet Control .................................................................................................... 62
5.14.22 SpreadJS 14 - Upgrade Considerations ...................................................................... 62
5.14.23 TOC ............................................................................................................................. 63
5.14.24 Unique Name for Controls (auto captioning) ............................................................... 63
5.15 Empower Connector Module ....................................................................................................... 63
5.15.1 Display Format for Unmatched/Unknown Peaks ......................................................... 63
Page 10 of 86
5.15.2 Consistent Empower Column Naming ......................................................................... 63

5.15.3 Unknown Peak Relative Retention Time (RRT) .......................................................... 63
5.16 Labelling ...................................................................................................................................... 64
5.16.1 Integration with Report Events ..................................................................................... 64
5.16.2 Jasper Reports for Label Reports ................................................................................ 64
5.16.3 Label Method Description Shown in Print Label Dialog............................................... 64
5.16.4 Printer Maintenance ..................................................................................................... 64
5.16.5 Printing Ease of Use .................................................................................................... 64
5.17 Lab Investigations ........................................................................................................................ 65
5.17.1 Buttons Added to the Toolbar ...................................................................................... 65
5.17.2 Incident Approvals ....................................................................................................... 65
5.17.3 Unplanned Incidents Incorrectly Closed ...................................................................... 65
5.17.4 Replacement of detailmaint Element for Incidents ...................................................... 65
5.18 Navigator ..................................................................................................................................... 65
5.18.1 Protecting Sample Editing from the Navigator ............................................................. 65
5.18.2 Translation of Navigator Node Labels ......................................................................... 66
5.19 Portal ........................................................................................................................................... 66
5.19.1 Allowing Parameter Values to be Passed into Reports ............................................... 66
5.19.2 Allowing Users to Select a Report ............................................................................... 66
5.19.3 App Access Set Solely by Template During User Creation ......................................... 66
5.19.4 AttributeMaintStellarElement ....................................................................................... 66
5.19.5 Attributes in List and Maintenance Pages ................................................................... 66
5.19.6 Chip Lists ..................................................................................................................... 66
5.19.7 Console Configuration ................................................................................................. 67
5.19.8 Date Picker Update ...................................................................................................... 67
5.19.9 DetailMaintStellarElement Data Filtering ..................................................................... 67
5.19.10 DetailMaintStellarElement Remove Link (Reverse FK only) ....................................... 67
5.19.11 DetailMaintStellarElement Detail Panel ....................................................................... 67
5.19.12 Detail List for a List Page ............................................................................................. 67
5.19.13 Disable Auto Complete for Logon Page ...................................................................... 68
5.19.14 Dropdown Edit Mode Enhancements .......................................................................... 68
5.19.15 SQL Edit Mode............................................................................................................. 68
5.19.16 Dynamic Fetching of Dropdown Values for Stellar Elements ...................................... 68
5.19.17 Global App Flag ........................................................................................................... 68
5.19.18 Increased Compliance with WCAG Level AA 2.1 ........................................................ 68
5.19.19 Parameter Gizmo ......................................................................................................... 70
5.19.20 Prompt Page ................................................................................................................ 70
Page 11 of 86
5.19.21 Role Security for Portal Pages and Operations ........................................................... 70

5.19.22 Single Sign On for Portal Users ................................................................................... 71
5.19.23 Support for Duo Security ............................................................................................. 71
5.19.24 Third-Party Library Upgrades ...................................................................................... 71
5.19.25 Installation Configuration Options ................................................................................ 71
5.20 Reporting ..................................................................................................................................... 71
5.20.1 Certificate of Analysis Reports ..................................................................................... 71
5.20.2 Collated Reports .......................................................................................................... 72
5.20.3 Database-Specific Embedded Jasper Reports ............................................................ 73
5.20.4 Digital Signatures on Confirmed Report Output .......................................................... 73
5.20.5 Example Reports Delivered as Embedded Jasper Type ............................................. 73
5.20.6 Jasper Reports Engine 6.20.0 ..................................................................................... 73
5.20.7 LV Noto Font cut off in Unix ......................................................................................... 73
5.20.8 Purge Existing Jasper Files ......................................................................................... 74
5.20.9 Report Event Output Stored as Attachments .............................................................. 74
5.20.10 Report Origination Address and Logo ......................................................................... 74
5.20.11 Styling .......................................................................................................................... 74
5.20.12 Translation of Report Content to Other Languages ..................................................... 75
5.20.13 Timezone Translation of Date-Time Values ................................................................ 75
5.20.14 Transmaster Spreadsheet includes Static Text for Example Reports ......................... 75
5.21 Sample Monitoring....................................................................................................................... 75
5.21.1 Clearing Excursions and Child Locations .................................................................... 75
5.21.2 Excursion Indicator Color Coding ................................................................................ 76
5.21.3 Image Map Hotspot Editor for Locations ..................................................................... 76
5.22 SaaS ............................................................................................................................................ 76
5.22.1 SMTP Configuration..................................................................................................... 76
5.22.2 Timezone Adjusted Key Generation ............................................................................ 76
5.23 SDMS .......................................................................................................................................... 76
5.23.1 Advanced File Collector Zip File Naming .................................................................... 76
5.23.2 Deliver Run File from Data Entry ................................................................................. 77
5.23.3 File Naming for Run File Delivery ................................................................................ 77
5.23.4 Expanded Field Length for Attachment Handler Default Values ................................. 77
5.23.5 Roles for SDMS Dashboard Buttons ........................................................................... 77
5.24 Security ........................................................................................................................................ 77
5.24.1 Allow Page Directives .................................................................................................. 77
5.24.2 Securing Menu Navigation ........................................................................................... 78
5.24.3 Single Sign On (SSO) and LDAP User Synchronization ............................................. 78
Page 12 of 86
5.24.4 Vulnerabilities ............................................................................................................... 78

5.25 Scheduler .................................................................................................................................... 78
5.25.1 Execute Now ................................................................................................................ 78
5.25.2 Protect from Deleting Plan Items that have associated WorkItems or Samples ......... 79
5.25.3 Scheduler Execution - Sample Creation Sequence .................................................... 79
5.25.4 SchedulePlanItem Audit View Page ............................................................................ 79
5.25.5 SchedulePlanItem Reorganization to Support Auditing .............................................. 79
5.26 Scheduler and Stability Module Retry Events ............................................................................. 80
5.27 Storage ........................................................................................................................................ 80
5.27.1 AddEventLogEntry Action Added ................................................................................ 80
5.27.2 ASL Requirement has been Removed for Portal ........................................................ 81
5.27.3 Box Templates ............................................................................................................. 81
5.27.4 Chain of Custody ......................................................................................................... 81
5.27.5 Copy Physical Store..................................................................................................... 81
5.27.6 FileTrackItem Action and Reserve Current Location ................................................... 81
5.27.7 Grant Custody .............................................................................................................. 81
5.27.8 Move Box ..................................................................................................................... 81
5.27.9 Moving Multiple Storage Units Simultaneously ........................................................... 82
5.27.10 Package Operations No Longer Require a User Specific Contact .............................. 82
5.27.11 Storage Unit Label ....................................................................................................... 82
5.27.12 Scanning a Subject ID, Sample ID, Sample Alias or Study ID During Box
Consolidation ............................................................................................................................... 82
5.27.13 New Reset Search Option on Box Consolidation Page............................................... 82
5.27.14 Select Box Position using Storage Explorer Lookup ................................................... 82
5.27.15 Restrict User to User Transfer when using Take Custody .......................................... 82
5.28 Tests ............................................................................................................................................ 83
5.29 Web Page Designer .................................................................................................................... 83
5.29.1 Blocking Column Updates ........................................................................................... 83
5.29.2 Bulletins ....................................................................................................................... 84
5.29.3 DataEntrySDIList Page Type ....................................................................................... 84
5.29.4 Dialog Type property for sdidetailmaint, detailmaint and linkedsdimaint Elements .... 84
5.29.5 Electronic Signature Reason Prompt........................................................................... 84
5.29.6 Prompt Page Column Behavior Properties .................................................................. 84
5.29.7 Defining Collection Display Options............................................................................. 84
5.29.8 Product Root Node Properties ..................................................................................... 85
5.30 WAP............................................................................................................................................. 85
5.30.1 Appointment and Activity Time Step ............................................................................ 85

Page 13 of 86
5.30.2 Core Hours ................................................................................................................... 85

5.30.3 Timezone Assignment and Adjustments ..................................................................... 85
5.30.4 Requirement for Recurring Appointments ................................................................... 85

Page 14 of 86
1 INTRODUCTION
1.1 Document Overview
This section describes the purpose for each chapter.
Chapter Description
1. Introduction Description of these Release Notes and other

documentation in the LabVantage Distribution.
2. Platform Support and Certification Supported and certified platform specifications for
Systems for LabVantage 8.8. LabVantage 8.8.
3. Upgrade Considerations High-level overview of LabVantage 8.8.0 upgrades.
4. Major New Features in LabVantage Descriptions of major new features introduced in

8.8.0 LabVantage 8.8.0.
5. Additional New Features and Descriptions of other new features and

Enhancements in LabVantage 8.8.0 enhancements in LabVantage 8.8.0.
6. Maintenance Releases Descriptions of LabVantage 8.8.x Maintenance

Releases as they are issued.
7. Appendices Additional information appended as required.
These Release Notes are intentionally concise. See the LabVantage Installation Documentation and
LabVantage Product Documentation for detailed information. Upgrade consequences are highlighted
throughout this document as applicable.
Throughout this document, VantageCare issues are referenced by the VantageCare Id (such as
0012345). The full list of bugs addressed in each release is included in the LabVantage Distribution.
1.2 Configuration Reports

The LabVantage Distribution contains the Configuration Reports described below. [R] denotes the
applicable LabVantage release. [PR] and [NR] denote previous and next consecutive releases,
respectively.
Report Description
LV[R]Config.zip Standard Configuration Report showing all master data and the OOB
configuration for the applicable LabVantage release.
LV[R]DataModel.zip Standard Configuration Report showing the data model for the
applicable LabVantage release (also see paragraph 1.4 Data Model).
LV[PR]Config- Differential Reports showing the deltas between previous consecutive

LV[NR]ConfigDiff.zip releases of LabVantage 8.x (if applicable).

Page 15 of 86
1.3 Transmaster Spreadsheets

These Transmaster Spreadsheets are provided in the LabVantage Distribution:
Transmaster-LV88AllTexts.xlsx contains all text used in the OOB configuration for LabVantage 8.8.
Transmaster-LV88NewTextsAddedVsLV87.xlsx contains text added between LabVantage 8.7 and
LabVantage 8.8.
1.4 Data Model

These data model views are provided in the LabVantage Distribution:
• LabVantage-88-DataModel_[revision].zip is a high-level diagram of the LabVantage 8.8 data
model.
• LabVantage88HighLevelDataModel.zip is a high-level view of the LabVantage 8.8 data model.
• LabVantage88DetailDataModel.zip is a detail view of the LabVantage 8.8 data model.
1.5 LabVantage Documentation

The following LabVantage Documentation is provided in the LabVantage Distribution. Each document is
version-controlled and revision-controlled. [R] denotes the document revision number and [V] denotes
the LabVantage version.
• LabVantage-[V]-ReleaseNotes_[R].zip contains this Release Notes document.
• LabVantageDoc_HTM_[R].zip contains the LabVantage Product Documentation structured as a
standalone Web site.
• LabVantageDoc_WAR_[R] contains the LabVantage Product Documentation WAR file for
deployment of the documentation in the Application Server.
• LabVantageInstall_[R] contains the LabVantage Installation Documentation.
Updates to these documents are maintained on VantageCare in Resources → LabVantage Software
Downloads → LabVantage 8.8.x Documentation.

Page 16 of 86
2 PLATFORM SUPPORT AND CERTIFICATION SYSTEMS

FOR LABVANTAGE 8.8.X
The LabVantage application runs in an n-tier architecture consisting of an Application Server tier
(Application Server and JDK), Database tier (Database Management System and JDBC driver), and
Client tier (Web Browser). A combination of these tier components constitutes a "platform" on which to
run LabVantage.
LabVantage supports a wide range of platforms. Certification is done on a smaller scale. Accordingly,
LabVantage Solutions distinguishes between "supported" and "certified" platforms as follows:
Supported: A "Supported Platform" indicates that LabVantage Solutions believes the platform should
deliver the intended functionality. The supported combination of platform components may
not have been tested with the LabVantage application. If any problems are discovered,
LabVantage Solutions will work with customers to reach a satisfactory resolution.
Depending on severity, LabVantage Development will provide the required resolution.
Certified: A "Certified Platform" indicates that LabVantage Solutions has fully tested the specific
combination of platform components with the LabVantage application at the 8.8.0 release.
The following table is a summary of what is certified as compared to what is supported. LabVantage does
not certify or test every possible combination of these platforms. Please see the Supported Software and
Certified Platforms sections for details and specific version numbers.
LabVantage Release
8.8.0 8.8.1+
Supported Certified
App JBoss 7.3 X All versions listed are supported.
Server Maintenance releases are not
7.4 X X
re-certified.
WebLogic 12.2 X X
Database Oracle 18c X
19c X X
MSS 2017 X
2019 X X
Web Edge 108.0 X X Minimal supported browser
Browser version is shown. Higher release
Chrome 108.0 X X
versions are supported in all
Safari 16.1 X LV8.8 releases.
2.1 Supported Software

This section details software currently supported by LabVantage for the specific LabVantage version as
detailed below.
Maintenance releases are minimally tested on third-party software platform versions that become
available before the testing cycle begins. These versions are therefore considered supported by
LabVantage. Only the version combinations listed in the Certified Platforms section have been fully
tested and can be considered certified.

Page 17 of 86
LabVantage features the option to launch an SAP BusinessObjects XI (BOXI) report from within
LabVantage. New LabVantage releases after July 2024 will not be tested for BOXI integration and may
not function as expected. Customers committed to using BOXI are permitted to use a direct connection
to the database independent of the LabVantage application.
2.1.1 Supported Application Server and DBMS Platforms

The Application Server and DBMS platforms specified in this document are supported in both non-
clustered and clustered configurations running in x86 or x86_64 architecture. The application server
should be hosted in the same data center as the database. When hosting on the cloud, work with your
provider to assure a minimal amount of network latency between your application server and your
database. Slow network speeds or interruptions between the two will be very apparent to your users.
In addition to being provided within the LabVantage distribution, the Installation Documentation is
published on the LabVantage VantageCare site. Check there for the most recent version.
2.1.2 Operating System Support

LabVantage has the most experience with Microsoft Windows and Red Hat Enterprise LINUX using x86-
64 architecture. These are the most used and tested operating systems. Some vendors such as Oracle,
IBM, and others may support the application server and/or database on other OS platforms. LabVantage
makes all efforts to provide the same support for these operating systems, with one known limitation.
LabVantage does not support the application server running on IBM AIX due to an incompatibility with
Argon2 password hashing.
2.1.3 Red Hat JBoss EAP Supported Platforms

LabVantage only supports JBoss releases that are published by Red Hat. Any other builds such as
WildFly and JBoss.org are not supported. The following table shows which JBoss releases are supported.
For the tested and certified version, please see Certified Platforms.
For LV 8.8 Red Hat JBoss EAP 7.3 Red Hat JBoss EAP 7.4
JBoss Minimally patched to Minimally patched to

7.3.8 7.4.6
Oracle JDK 1.8 Not Supported
Red Hat OpenJDK 11 11
Red Hat JBoss Core 2.4.37 Minimally 2.4.37 Minimally

Services (JBCS) patched to SP8 patched to SP8
Apache HTTP Server
More information about the use case for JBCS can be found in the installation guide.
2.1.4 IBM WebSphere Not Supported for 8.8.0

LabVantage Solutions does not support the use of IBM WebSphere as a deployment platform for the
LabVantage 8.8.0 application. In the future, LabVantage 8.8 may have the capability to run on
WebSphere. However, WebSphere will cease to be a supported platform for future releases of
LabVantage after version 8.8. Please plan accordingly.

Page 18 of 86
2.1.5 Oracle WebLogic Supported Platforms

Standard Edition is suitable for non-clustered implementations. Use Enterprise Edition for clustered
implementations.
For LV 8.8 WebLogic 12.2
WebLogic 12.2.1.4
Oracle JDK 1.8.0_351 or higher
For additional information, please see Oracle's Fusion Middleware Support
2.1.6 Oracle RDBMS Support

Both Oracle Enterprise Edition and Standard Edition 2 are supported. LabVantage recommends using
Oracle 19c. Oracle Standard Edition 2 (SE2) is intended by Oracle to be used for "deployment in small
enterprises, line-of-business departments, and distributed branch environments." It supports a maximum
of two sockets and may have additional Oracle licensing restrictions not implemented in Oracle Enterprise
Edition or SE1. Customers using SE2 should consider both current database computing needs and long-
term growth plans before installing using SE2.
LabVantage Oracle 18 Oracle 19

Version
8.8.x 18c 19c
2.1.7 Microsoft SQL Server RDBMS Support

In addition to the traditional on-premises installation, LabVantage supports Azure SQL and Azure SQL
Managed Instance provided there is compatibility with the SQL Server DBMS versions listed below.
LabVantage MSS 2017 MSS 2019

Version
8.8.x 14.0.2002.14 or higher 15.0.2095.3 or higher
2.1.8 JDBC Drivers

Oracle and SQL Server users should use the JDBC driver recommended by the manufacturer for the
DBMS version and JDK in use. This is available in the DBMS distribution or through the manufacturer's
JDBC download site.
2.1.9 Supported Web Browsers

The LabVantage user interface has been coded for compatibility with the Web browsers that are listed
below. These are supported on any operating system that is supported by the relevant vendor. The new
"Edge based on Chromium" browser is supported. Microsoft Edge Legacy and Microsoft Internet Explorer
are not supported.

Page 19 of 86
Web Browser LabVantage Version Minimum Supported Browser

Version
Google Chrome 8.8.x 107
Apple Safari 8.8.x 16.1 (on Apple devices only)
Microsoft Edge based on Chromium 8.8.x 107
Mozilla Firefox 8.8 Portal Only 107
2.1.10 Other Supported Software

LabVantage has tested and provides integration options for the following third-party software options.
Software LabVantage Version Supported Version
SAP Business Objects 8.8.x Business Objects BI Platform 4.2 minimum SP9
*See paragraph below regarding end-of-life
support for this integration option.
Jasper Reports 8.8.x Jaspersoft Jasper Reports 6.20
Bartender 8.8.x Seagull Scientific Bartender

2021 R8 and 2022 R2
NWA 8.8.x Quality Analyst 6.3

Quality Analyst Editor Release 2.4.326
Quality Analyst Web Server Release 2.2.63
NOTE: NWA supports these versions when
running in Windows Server 2012 or higher.
Empower 8.8.x Waters Empower 3 versions FR5 and FR6
ChemAxon 8.8.x Marvin JS 20.19
Talend 8.8.x Talend Open Studio 7.3 or higher using the

latest routines.jar
*New LabVantage releases after LV8.8 will not be tested for BOXI integration and may not function as
expected. LabVantage will discontinue support for this feature after version LV8.8. Previously released
software will continue to function as articulated in these Release Notes. Customers committed to using
BOXI are permitted to use a direct connection to the database independent of the LabVantage
application. The reporting framework in the LV application will no longer support the definition of a
business object report, nor executing it from reporting standard buttons, run dialogs, GenerateReport
actions, and so forth. Launching a BOXI report will no longer be part of the LabVantage solution.
2.2 Certified Platforms

These environments were used during testing of the 8.8.0 release. Only the software versions listed here
have been fully tested and can therefore be considered “certified”. This section details software currently
certified by LabVantage. Maintenance releases are not recertified unless otherwise noted.
Page 20 of 86
2.2.1 Red Hat JBoss EAP Certified Platform
App Server JBoss 7.4.7
App Server Type Cluster
SSL Yes
App Server Operating System RHEL Server 8.6 (Ootpa)

(Kernel: Linux 4.18.0-372.9.1.el8.x86_64)
JDK java-11-openjdk-11.0.17.0.8-2.portable.jdk.el.x86_64
DBMS MSSQL 2019 (15.0.2095.3)
Database Encryption No
Driver Microsoft MSSQL driver (mssql-jdbc-9.4.1.jre8)
DBMS Operating System MS Windows Server 2022 Datacenter

(Version: 21H2; OS Build 20348.1249)
Installation Type New Installation
2.2.2 Oracle WebLogic Certified Platform
App Server WebLogic 12.2.1.4.0
App Server Type Cluster
SSL Yes
App Server Operating System MS Windows Server 2022 Datacenter

JDK 1.8.0_351
DBMS Oracle 19c (19.3.0.0.0)
Database Encryption Yes
Driver Uses its own driver
DBMS Operating System MS Windows Server 2022 Datacenter

Installation Type Upgraded from LV8.6.0

Page 21 of 86
2.2.3 Certified Web Browsers

This table represents the browsers that were used for the majority of testing during the certification cycle.
Browser manufactures are known to frequently update and push new versions.
Web Browser LabVantage Version Certified Web Browser Version
Google Chrome 8.8.0 108.0.5359.95
Edge based on Chromium 8.8.0 108.0.1462.42
2.2.4 Other Certified Software

These versions of third-party software were used during testing.
Software LabVantage Version Certified Version

SAP BusinessObjects BI Platform 4.2 SP 9
SAP Business Objects 8.8.0
Patch 6 Build: 14.2.9.4130
Jasper Reports 8.8.0 Jasper Reports 6.20.0
Bartender 8.8.0 2021 R8 Version: 11.2/177370 (64-bit),

2022 R2 Version: 11.3/184527 (64-bit)
NWA 8.8.0 NWA Quality Analyst 6.3

NWA Quality Analyst Editor 2.4.326
NWA Quality Analyst Web Server 2.2.63
Empower 8.8.0 Empower3 FR5 (build 3471),

Empower3 FR6 (Version: 3.6.1)
ChemAxon 8.8.0 Marvin JS 20.19
2.3 HTTPS
LabVantage Solutions requires running the LabVantage application over an HTTPS connection to
enhance security and utilize advanced browser features. LabVantage checks the URL of the request to
the application server. If an HTTPS connection is not detected when LabVantage starts, a message is
displayed on the Logon screen warning of the unsecure connection.
In LabVantage 8.8, you can still log onto the LabVantage application using an unsecure port, but some
advanced browser features requiring HTTPS will not be available. For example, use of the video/camera
option in LabVantage Attachments, Portal, browser location services, and the Empower Connector
requires an HTTPS connection to enable the required browser functionality.
2.4 Browser Settings for Documentation

Some browsers block active scripts from running. Depending on the configuration of other options, active
script blocking can prevent the rendering engine from displaying the content of the LabVantage Data
Model and LabVantage Product Documentation. If active scripting is blocked, the browser usually
prompts with a message indicating that the browser blocked this page from running scripts or ActiveX

Page 22 of 86
controls. In some cases, an "Allow blocked content" button is available. There are two options for dealing
with this:
Option 1: Open your browser settings. Enable "Allow active content to run in files on My
Computer". This disables active script blocking, and usually requires a browser restart to take effect.
Option 2: Click "Allow blocked content" each time you open the document. This option lets you
view the document without changing settings.

Page 23 of 86
3 UPGRADE CONSIDERATIONS
3.1 General Information
3.1.1 Remove JNetDirect from consoleconfig.props
If you are upgrading a Microsoft SQL Server database and you previously used a JNetDirect driver, this
driver is no longer supported. You should use the JDBC driver supplied with your version of SQL Server.
Before you begin the upgrade, you will need to change the JDBC driver your application server uses over
to the Microsoft driver. This will be done for you if you use the Handsfree installer. Remove the following
line from your LabVantage consoleconfig.props file:
com.labvantage.sapphire.server.jdbcdriver.sqlserver=com.jnetdirect.jsql.JSQLDriver
3.1.2 Platform Support

Review chapter 2 Platform Support and Certification Systems for LabVantage 8.8.x. Before upgrading,
make certain your platform meets the requirements specified in paragraph 2.1 Supported Software.
For more information, see the LabVantage 8.8 Installation Documentation.
3.1.3 Upgrade Paths for LabVantage Databases and Applications

In most cases, LabVantage databases and applications for versions 6.0.x and later can be directly
upgraded through the LabVantage Console. Upgrades from LabVantage 3.4 through 5.x are supported
and managed on a per-case basis.
When upgrading, review the Release Notes between your current version and this one to understand the
implications of the upgrade procedure, making certain to complete all required post-upgrade tasks.
Note that it is not possible to predict the effects "project code" may have on an upgrade. We define
"project code" as "custom changes to the LabVantage data model and LabVantage application code that
may have been made for a specific customer's project". Changes resulting from existing (to be upgraded)
"project code" may cause unexpected behavior that we cannot predict, and thus may require specialized
treatment on a per-customer basis.
3.1.4 Use of the dbo Schema for Microsoft SQL Server

This paragraph applies to some legacy systems that were originally installed on a version of LabVantage
earlier than LabVantage 6. It could also apply if, for any other reason, your application utilizes any object
outside of the dbo schema. Your system must use the dbo schema as of LV8.5. If your system has been
migrated and will now be upgraded to LV8.8 or higher, a script must be run prior to starting your upgrade.
This does not apply to systems installed using an Oracle database platform. Additional information can be
found within the LabVantage Installation Guide.
3.2 Deprecated Features

3.2.1 Queries Removed or Altered on the Contacts List Page
Some queries were present on the Contacts list page that did not pertain to contacts. These have been
either removed or re-named. This includes:
• All Accredited Organizations – Not related to Contacts.
• All Customers – Not related to Contacts.
• All Organizations – Not related to Contacts.
• All Printers – Not related to Contacts.

Page 24 of 86
• All Regulatory Agencies – Not related to Contacts.

• Manufacturers by Product – Not related to Contacts as these are Organizations.
• Manufacturers by Product version – Not related to Contacts as these are Organizations.
• Suppliers by Product – Not related to Contacts as these are Organizations.
• Suppliers by Product version – Not related to Contacts as these are Organizations.
• By Address Type – only Contacts are displayed in this page which means other address types
are irrelevant.
• 'By Department' query relabeled as 'By Department User'.
3.2.2 Right to Left Option for Languages is Removed

In previous releases, a language configuration option was present that would position the application
features starting on the right instead of the left. This option was not fully supported and has been
removed.
3.2.3 Removal of References to eWorksheets used by eNotebook in eForms

Support has ended for LabVantage eNotebook-eWorksheets. References to this feature have been
removed from the relevant web pages. Customers can transition to LabVantage LES.
3.2.4 Continuous Logging Mode Removed

If you were previously using “Continuous” mode, this option has been removed. This configuration is
found in System Admin > Configuration > System Configuration… Logging and Stats options.
During the migration, any system using Continuous mode will be changed to Rolling mode. You should
review this conversion and make adjustments as needed.
3.3 Distributed Third-Party JAR Files

The basis of the LabVantage production build has changed from ANT scripts to Maven. This means that
most of our third-party JARs are now derived from Maven’s dependency calculation instead of a hand-
picked process.
Maven was chosen to allow LabVantage to assimilate new functionalities more quickly and to better
resolve class loading conflicts.
An install of LabVantage 8.8.0 will utilize the following JAR files:
FastInfoset-1.2.15.jar antisamy-1.6.8.jar
FlyingSaucer0617-1.0.LV.jar antlr-2.7.7.jar
SparseBitSet-1.2.jar apache-mime4j-core-0.8.4.jar
ant-1.10.12.jar argon2-jvm-2.5.jar
ant-antlr-1.10.12.jar aspose-cells-21.8.jar
ant-launcher-1.10.12.jar aspose-email-21.7.jar
Page 25 of 86
aspose-imaging-21.8.jar bcprov-jdk18on-1.71.jar
aspose-pdf-21.8.jar bcutil-jdk15on-1.70.jar
aspose-slides-21.7.jar beam-core-1.3.4.jar
aspose-words-21.8.jar beam-func-1.3.4.jar
avalon-framework-impl-4.2.0.jar biweekly-0.6.3.jar
axiom-api-1.3.0.jar bsh-2.0b6.jar
axiom-dom-1.3.0.jar byte-buddy-1.11.12.jar
axiom-impl-1.3.0.jar cdk-atomtype-2.7.1.jar
axis-1.4.jar cdk-charges-2.7.1.jar
axis-ant-1.4.jar cdk-core-2.7.1.jar
axis-jaxrpc-1.4.jar cdk-ctab-2.7.1.jar
axis-saaj-1.4.jar cdk-data-2.7.1.jar
axis2-adb-1.8.0.jar cdk-depict-2.7.1.jar
axis2-kernel-1.8.0.jar cdk-dict-2.7.1.jar
axis2-transport-http-1.8.0.jar cdk-fingerprint-2.7.1.jar
axis2-transport-local-1.8.0.jar cdk-formula-2.7.1.jar
axis2-xmlbeans-1.8.0.jar cdk-fragment-2.7.1.jar
barbecue-1.5-beta1.jar cdk-hash-2.7.1.jar
barcode4j-2.1.jar cdk-interfaces-2.7.1.jar
batik-anim-1.16.jar cdk-io-2.7.1.jar
batik-awt-util-1.16.jar cdk-ioformats-2.7.1.jar
batik-bridge-1.16.jar cdk-isomorphism-2.7.1.jar
batik-codec-1.16.jar cdk-qsar-2.7.1.jar
batik-constants-1.16.jar cdk-qsarmolecular-2.7.1.jar
batik-css-1.16.jar cdk-reaction-2.7.1.jar
batik-dom-1.16.jar cdk-render-2.7.1.jar
batik-ext-1.16.jar cdk-renderawt-2.7.1.jar
batik-gvt-1.16.jar cdk-renderbasic-2.7.1.jar
batik-i18n-1.16.jar cdk-sdg-2.7.1.jar
batik-parser-1.16.jar cdk-silent-2.7.1.jar
batik-script-1.16.jar cdk-smarts-2.7.1.jar
batik-shared-resources-1.16.jar cdk-smiles-2.7.1.jar
batik-svg-dom-1.16.jar cdk-standard-2.7.1.jar
batik-svggen-1.16.jar cdk-valencycheck-2.7.1.jar
batik-transcoder-1.16.jar classmate-1.5.1.jar
batik-util-1.16.jar closure-compiler-v20220502.jar
batik-xml-1.16.jar commons-beanutils-1.9.4.jar
Page 26 of 86
commons-cli-1.0.jar groovy-datetime-3.0.11.jar
commons-codec-1.15.jar groovy-dateutil-3.0.11.jar
commons-collections-3.2.2.jar groovy-docgenerator-3.0.11.jar
commons-collections4-4.4.jar groovy-groovydoc-3.0.11.jar
commons-compress-1.21.jar groovy-groovysh-3.0.11.jar
commons-configuration-1.10.jar groovy-jmx-3.0.11.jar
commons-digester-2.1.jar groovy-json-3.0.11.jar
commons-discovery-0.5.jar groovy-jsr223-3.0.11.jar
commons-fileupload-1.4.jar groovy-macro-3.0.11.jar
commons-io-2.11.0.jar groovy-nio-3.0.11.jar
commons-lang-2.6.jar groovy-servlet-3.0.11.jar
commons-lang3-3.4.jar groovy-sql-3.0.11.jar
commons-logging-1.2.jar groovy-swing-3.0.11.jar
commons-math3-3.6.1.jar groovy-templates-3.0.11.jar
curvesapi-1.07.jar groovy-xml-3.0.11.jar
dom4j-2.1.3.jar hibernate-commons-annotations-5.1.2.Final.jar
ecj-3.21.0.jar hibernate-core-5.4.33.Final.jar
ehcache-3.8.1.jar httpclient-4.5.13.jar
esapi-2.4.0.0.jar httpclient5-5.1.3.jar
fontbox-2.0.24.jar httpcore-4.4.13.jar
freehep-graphics2d-2.4.jar httpcore5-5.1.3.jar
freehep-graphicsbase-2.4.jar httpcore5-h2-5.1.3.jar
freehep-graphicsio-2.4.jar iReport-2.0.5.jar
freehep-graphicsio-pdf-2.4.jar image4j-0.7.jar
freehep-graphicsio-ps-2.4.jar istack-commons-runtime-3.0.7.jar
freehep-graphicsio-tests-2.4.jar itext-2.1.7.js10.jar
freehep-io-2.2.2.jar jackson-annotations-2.14.0.jar
geronimo-stax-api_1.0_spec-1.0.1.jar jackson-core-2.14.0.jar
geronimo-ws-metadata_2.0_spec-1.1.3.jar jackson-databind-2.14.0.jar
gluegen-rt-2.3.2.jar jackson-dataformat-xml-2.13.3.jar
gluegen-rt-main-2.3.2.jar jakarta.activation-api-1.2.1.jar
googleauth-1.4.0.jar jama-1.0.3.jar
groovy-3.0.11.jar jandex-2.2.3.Final.jar
groovy-ant-3.0.11.jar jasperreports-6.20.0.jar
groovy-astbuilder-3.0.11.jar jasperreports-chart-themes-6.20.0.jar
groovy-cli-picocli-3.0.11.jar javaparser-core-3.24.2.jar
groovy-console-3.0.11.jar javassist-3.27.0-GA.jar
Page 27 of 86
javax.activation-api-1.2.0.jar neko-htmlunit-2.61.0.jar
javax.persistence-api-2.2.jar pdfbox-2.0.24.jar
javax.servlet-api-3.1.0.jar pdfrenderer-0.9.1.jar
javax.transaction-api-1.3.jar picocli-4.6.1.jar
jaxb-api-2.3.1.jar poi-5.2.2.jar
jaxb-runtime-2.3.1.jar poi-ooxml-5.2.2.jar
jaxen-1.2.0.jar poi-ooxml-lite-5.2.2.jar
jboss-logging-3.4.1.Final.jar qdox-1.12.1.jar
jboss-transaction-api_1.2_spec-1.1.1.Final.jar sapphireexternal-1.0.jar
jcommon-1.0.24.jar serializer-2.7.2.jar
jfreechart-1.0.19.jar slf4j-api-1.7.25.jar
jline-2.14.6.jar spring-beans-5.3.20.jar
jna-4.5.2.jar spring-core-5.3.20.jar
joda-time-2.10.6.jar stax-ex-1.8.jar
jogl-all-2.3.2.jar stax2-api-4.2.1.jar
jogl-all-main-2.3.2.jar taglibs-standard-impl-1.2.5.jar
jsoup-1.15.3.jar txw2-2.3.1.jar
jsr311-api-1.1.1.jar vecmath-1.5.2.jar
jstl-1.2_1.jar vinnie-2.0.2.jar
jtidy-r938.jar woden-core-1.0M10.jar
jxl-2.6.12.jar woodstox-core-6.2.6.jar
log4j-api-2.17.2.jar wrapper-3.5.40.jar
log4j-core-2.17.2.jar wsdl4j-1.5.1.jar
lucene-analyzers-common-5.5.5.jar xalan-2.7.2.jar
lucene-backward-codecs-5.5.5.jar xercesImpl-2.12.2.jar
lucene-core-5.5.5.jar xml-apis-1.4.01.jar
lucene-queries-5.5.5.jar xml-apis-ext-1.3.04.jar
lucene-queryparser-5.5.5.jar xmlbeans-5.0.3.jar
lucene-sandbox-5.5.5.jar xmlgraphics-commons-2.7.jar
metrics-core-4.0.4.jar xmlschema-core-2.2.5.jar
metrics-jvm-4.0.4.jar xmlsec-1.4.3.jar
neethi-3.1.1.jar xom-1.3.7.jar
When upgrading “Development” labvantage.ear applications (exploded EARs deployed in JBoss EAP),
JAR files that are no longer used are never automatically deleted from the EAR library (labvantage.ear/lib
directory) during the upgrade process. These unused JAR files must therefore be manually deleted
before starting the upgrade.

Page 28 of 86
Note that “Production” labvantage.ear applications (packaged EAR files) with patched custom jar files are
automatically deleted during upgrade. Production applications with jar files added as components are
kept during an upgrade.
To be sure, please copy any custom java, web, and jar files to a backup folder before performing the
upgrade. Reintroduce these files post-upgrade if something was deleted in error.
3.4 Post-Upgrade Notes

These Release Notes contain "Post-Upgrade Notes" that describe manual tasks you must review and
may need to perform following an upgrade. In some cases, these tasks are required to maintain
backward compatibility with your previous version of LabVantage.
Please review the paragraphs below and read the accompanying "Post-Upgrade Note" to determine if
action is required following your specific upgrade.
1. Review Reporting. Example reports are delivered as Embedded Jasper type reports. This means the
.jrxml files are stored in the database rather than on the application server’s file system. The design of
these reports has changed including the means by which the company address is retrieved for the
report.
2. Review the Release Notes for all versions between your existing version and version 8.8 to identify
any other post-upgrade actions you may need to take.
3. Review any custom code in your implementation and see if it requires Log4j1 or can be migrated to
Log4j2. See section 4.4 Log4j
4. The ELN Spreadsheet Control has been upgraded to use SpreadJS 14. See SpreadJS 14 - Upgrade
Considerations for details.
5. Carefully consider the implications of the new Automatic Cross SDI Calculation functionality after
upgrade. See Automatic Cross SDI Calculations for details.
6. Some columns were moved in the property tree of the MultiSDIAttributeMaint Page Type. To prevent
the appearance of empty columns in the grid, some manual steps must be taken. See Configuration
of MultiSDIAttributeMaint
7. Systems that are upgrading from LabVantage 7 or earlier will need to run LabVantage’s Code
Checker. This tool will validate your code for HTML5 and Standards compliance. Use of this code
checker is not required for any system that is already on version 8 and is being upgraded to a more
recent release. Information about this tool can be found in the Product Documentation help system.
8. Reference Type values that previously had no ‘Display Value’ will now have one. See Upgrading
Reference Type Values
9. The SchedulePlanItem Table has been split into two definition tables. See SchedulePlainItem Table
Changes for upgrade considerations.
10. The “Headers” and “Corner Label” properties of the MultiSDIAttribute Page Type have been removed.
If you have defined values in these properties, see MultiSDIAttributeMaint Page Type Improvements
for information about re-configuring these headers.
11. The arguments of the ContainersFromSimilarConsumable query have been updated. See Query
Changes for upgrade details.
12. Jaspersoft Studio report designer allows you to preview the output of a report before it is deployed to
your application server. You will need to copy the latest sapphire.jar and log4j2 files into your Studio
user library. You will find instructions on how to do this in the Using Jaspersoft Studio with
LabVantage help topic within the LabVantage Product Documentation.
13. See Blocking Column Updates and determine if any of your custom code will require adjustment or if
this protective feature should be disabled.

Page 29 of 86
14. If your implementation uses the AddSDIAttachment action, see Validation Check Added to the
AddSDIAttachment Action for steps to take to continue to allow files to be uploaded to LabVantage as
attachments when using this action.
15. If you have created custom propertytrees, your display options now have a Direction attribute, If not
specified it will now be presented using the grouped style. To return to the prior defaulted style, the
Direction attribute should be set as 'down'. See Defining Collection Display Options.
16. Review Collated Reports and determine if this feature will be used. If required, copy two document
template files as described.
17. Description columns may display as a text area in maintenance pages. This depends on your column
mode in the maint element. See Description Columns now have a Maximum Length of 255
Characters for a potential configuration change if a single input line is required.

Page 30 of 86
4 MAJOR NEW FEATURES IN LABVANTAGE 8.8.0

4.1 Automatic Inter SDI Calculations
Prior to LabVantage 8.8 inter SDI calculations defined for a Parameter, on a Parameter List were not
automatically re-calculated when dependent values were modified.
With the introduction of Automatic Inter SDI Calculation Rules, you can now enable automatic
recalculation. For each parameter list you can now specify:
• Whether or not to enable automatic redo calculation (for any listed parameters having a defined
calculation rule).
• The SDC for which the parameter list is intended (the SDC to which dependent values will be
sent).
To better control which calculations are always automatically recalculated (and prevent recalculation
when not desirable) an Inter SDI Calc Rule definition SDI is created. This configuration lets you
determine which types of Inter SDI calculations should or should not be executed when dependent
values are changed. For example, you would likely not want to automatically recalculate a calculation
that references a Consumable Lot whose value happened to change.
A new CrossSDICalcDef SDC has been added to store the unique Parameter List combination of:
• Automatic Redo Calculation enabled (checked)
• Intended Use SDC defined
• Calculation rule defined for a Parameter on the Parameter List
This unique definition creates a reference that identifies (creates a reference to) the SDIs whose
calculations should be recalculated when values are modified.
Inter SDI Calc Rule definitions can be defined for the following calculation types:
• Foreign Key (FK)
• Reverse Foreign Key (REVERSE_FK)
• SDI Relation
• Reverse SDI Relation
• SDI Data Relation
• Sample:Parent, Child, Ancestor, Descendent
• AQC
• Absolute
These Inter SDI Calc Rule definitions are listed on a new Inter SDI Calc Rule List page. Here you can view
every defined Inter SDI Calc Rule definition, the Parameter Lists on which this definition is defined, and a
count of Active Datasets having this Inter SDI Calc Rule definition. You can also enable or disable
automatic re-calculation for each listed Inter SDI Calc Rule definition.
Rebuild buttons have been added to the Sample Template and Parameter List Pages:

Page 31 of 86
The Rebuild Inter SDI Calc Rules button on the Parameter List list page will rebuild the Inter SDI Calc
Rule definition for the Parameter List if the Intended Use SDC was populated using a database update
(or any update other than Parameter List Add or Edit).
The Rebuild Dataset Inter SDI Calc Rules button on the Sample Template list page lets you build the
Inter SDI Calc Rule definition for calculations defined on a Sample Template (where a Parameter List is
included directly against Sample Templates).
To provide broad control over how this feature is implemented several properties have been added to
the DataEntry Policy:
• Auto Calculate Cross SDI Calc Rule – Master switch to turn the feature on or off system wide.
• Inter SDI Calc Rule Defaults – For each calculation type you can determine the initial status of
the Inter SDI Calc Rule definition. This provides better control over when automatic recalculation
will be performed according to the calculation type. The “Pending” option defers the decision until
the Inter SDI Calc Rule definition is created (you can enable or disable it on the Inter SDI Calc
Rules page).
Post Upgrade Considerations
When upgrading to LabVantage 8.8, if you have no custom functionality in place for recalculation, you
need only determine whether or not you wish to utilize this feature. If not, be sure to set the Data Entry
Policy property Auto Calculate Cross SDI Calc Rule to “No”. By default, this property is set to “Yes”.
If you have custom functionality in place for recalculating cross SDI calculations, carefully consider the
following to be sure adopting this feature is the right decision for your organization:
• Any custom functionality will need to be turned off to prevent duplication.
• For any Parameter List having an Inter SDI Calc Rule defined, you must check Enable Automatic
Redo Calculation and define the Intended Use SDC.
• Any existing (in flight) Samples having inter SDI calculations will not be automatically recalculated
when Automatic Redo Calculation is enabled.
Previously recorded as VantageCare enhancements 0024431, 0017916, 0018677, 0019426, 0012397
and 0020561
4.2 Approval by Exception

This new feature allows you to establish rules that determine when a Batch, Sample, and some other
items will require manual approval. When configured, the system will automatically approve items except
when anomalies are found in the data. These exceptions will require manual approval in order to advance
the status of the item. Rules are configured on Approval Types that are subsequently linked to templates
or other master data.
Previously recorded as VantageCare enhancement 0018944
4.3 Reporting
Multiple enhancements have been introduced which affect the way reports are managed, output is
signed, timezones are represented and much more. See section 5.20 for a list of new features related to
reports and printing labels.

Page 32 of 86
4.4 Log4j
Previous versions of LabVantage used an open-source and well accepted logging library called Log4j
(version 1). LabVantage 8.8 uses the more up to date Log4j2. Any custom code that uses the
LabVantage logging APIs, such as trace.log, logger.log and others, will be unaffected by this change.
However, any custom code or downstream log-file processing that relied on the older libraries and syntax
may be affected. Please see https://logging.apache.org/log4j/2.x/manual/migration.html
Upgrade details:
There are two ways to configure logging for LabVantage. These are Managed and Unmanaged. This is
accomplished through System Admin > Configuration > System Configuration… Logging and Stats
options. The mode can also be set manually in the logging.props file by setting
sapphire.logging.managed=true/false. LabVantage recommends that you use managed=true.
During an upgrade, if in Managed mode, your logging.props file will be automatically upgraded from
log4j1 syntax to log4j2 syntax. Log files will continue to be created in the same fashion as before and
there should be no reason for further action with one exception: continuous mode. See 4.4.3.
If you are in Unmanaged mode, then you must reconfigure the logging.props file manually from log4j1
syntax to log4j2 syntax. See the link above for help on how to migrate. During 8.8 system startup, if your
system is in unmanaged mode and old log4j1 settings are found in the properties file, the system will fail
to start, and you will find this error message in the labvantage.log: labvantgelogging.props file is set to
managed=false, and a new .properties file has not been created
The behavior applies to both LabVantage application logging and console logging.
LabVantage allows for server-specific logging options through a policy of appending server and host
names to the logging.props file name. This naming behavior has not changed in LabVantage 8.8.
Post-Upgrade Note
If you are using a custom properties file, you must update this to log4j2 syntax. If you previously used a
custom date pattern for the LabVantage log as shown in the screen capture below, review the pattern
after migrating to confirm that it is valid for use with log4j2. If you used the “Continuous” option, your
system will now use the “Rolling” option.
4.4.1 Date Pattern Log File Syntax Changes

LabVantage allows you to define a daily LabVantage log file naming date pattern. Example:
If you have previously set a date pattern that includes ‘.’ this pattern is not valid with log4j2. You should
use the recommended value shown above or investigate a new date pattern that will comply with your
requirements.
4.5 Handsfree Installer

To assist in the installation and configuration of JBoss Enterprise Application Server, Apache and
LabVantage, a new installation process has been developed. This allows you to input values for
configuration variables that the installer will use to quickly deploy LabVantage on JBoss. See the
LabVantage Installation Guide for JBoss and the companion guide Installation Reference.
Previously recorded as VantageCare enhancement 0016096.

Page 33 of 86
5 ADDITIONAL NEW FEATURES AND ENHANCEMENTS IN

LABVANTAGE 8.8.0
These software features are available starting in LabVantage 8.8.0.
5.1 Core or General Enhancements

The features described in this section are not related to a specific module and may not be related to other
enhancements listed in these Release Notes.
5.1.1 About LabVantage

A page has been added which is accessible in the User Profile menu. This About page (LV_BuildInfo)
displays the LabVantage version, build number, the database to which you are currently connected, the
license expiration date (if any), as well as any components or accelerators that have been installed. To
hide this profile link to the About page, navigate to System Admin > Configuration > Policies and edit the
GUIPolicy. Change the “Hide About Profile Item” property to ‘Yes’. You can also use role security to
control what is visible on the LV_BuildInfo page.
As a security measure, the build information is no longer available to be viewed on the login page.
Previously recorded as VantageCare enhancements 0022679, 0024247, and 0022693.
5.1.2 AddDataset Performance Improvement

When a ParamList creates a DataSet that contains many Parameters and ParamLimits, this can take
considerable time to complete. Prior to this improvement, all rows were first inserted into a DataSet object
in-memory. Then all these rows were inserted into the database. This process consumes high memory
and database IO when the number of rows is very large. The AddDataSet action is now enhanced to
handle insertion of sdidataitemlimits rows efficiently. The action can now insert the rows into
sdidataitemlimits directly by using an INSERT from SELECT SQL statement. As a result, this requires
comparatively zero memory space and a single database transaction. This significantly improves
performance of this action for a high volume of data.
The disadvantage of this enhancement is that the sdidataitemlimits DataSet object becomes unavailable
for manipulation in the preAddDataSet and postAddDataSet SDC Rules. If the system uses the
PreAddDataset business rule to manipulate the ParamLimits, you will need to edit the DataEntryPolicy.
The new property “Optimize AddDataSet sdidataitemlimits insertion” can be set to Yes or No. It will be set
to Yes by default. Change to No to retain the legacy behavior.
Post Upgrade Note

Determine if your system uses preAddDataSet or postAddDataSet business rules. If the SDC Rules need
to continue to work, change « Optimize AddDataSet sdidataitemlimits insertion » in the DataEntryPolicy to
No.
The AddDataSet action also exposes a new property "usequickinsertsql4sdidataitemlimits" which can be
used to override the default Policy setting.
5.1.3 Adhoc Queries Available for DataSets and SDIWorkitems

Adhoc queries and searches are now available on DataSet and SDIWorkItem list pages
Previously recorded as enhancement 0015786
5.1.4 Application Resources support dynamic class loading

Previously, the Application Resources you could add were limited to text files (or URLs) that contained
JavaScript or CSS. This has been expanded to allow a third type: “Java Library”. This makes it possible to
customize certain aspects of the application using Java code and class definitions that you store in an
Page 34 of 86
attachment repository. The previous labels of text/css and text/javascript have been renamed Stylesheet
and JavaScript respectively.
5.1.5 Approval Types

On the Approval Type maintenance page, a column called Intended Use and a detail maintenance
element called Approval Rules are new to this release. New example Approval Types are included as
example data in a new installation.
Items that reference Approval Types, such as Samples and their Templates to name just a couple, will
now filter the applicable list of values to show only those with an appropriate Intended Use. For
backwards compatibility, approval types that have no intended use continue to be shown in all Approval
Type lookup pages.
The labels for the "Pass approval when" rules have been changed to be more consistent with the words
used during SDI Approval. This also differentiates these labels from the Pass/Fail labels used during
Specification evaluations. The words "Pass" and "Fail" have been replaced with "Accept" and "Reject"
when configuring Approval Types.
5.1.6 Approve Multiple Versioned SDIs from any List Page

The ‘Approve Version’ button utilizes the SetSDIVersionStatus action. When this button is utilized from a
list page, multiple SDIs can be selected and sent into the action. This button will now be able to send in
multiple values for the action to process including semicolon delimited values for keyid1, keyid2, keyid3
and versionstatus. A singular version status can be applied to all keyid1 records as long as the transition
is valid for all SDIs.
If more than one version status is provided and it does not match with the keyid1 input count, then the
action will return an error. If any error is returned all updates will be rolled back.
Previously recorded as Vantage Care enhancement 0024711
5.1.7 Class Loading Security and Sandboxing

Introducing LabVantage Class Security Manager which is configured by default to prevent destructive
behavior that could potentially be included in a dynamically loaded Java class. At the same time, some of
these restrictions can be lifted when needed for testing and developing new code. Using the JSON data
format, you can modify these properties by editing a file on the application server.
5.1.8 Completion of SDIWorkitems when Reflex Rules are not Triggered

Test Methods allow you to define reflex rules that apply or make Datasets available when certain
conditions are met. This enhancement solves the issue that arises when the reflex conditions are not met
and the SDIWorkitem or the Sample status does not move to Completed because the unavailable
mandatory Dataset is pending. Prior to LabVantage 8.8, the Mandatory flag for a Parameter List on a Test
Method was a Yes/No checkbox. This flag is converted to a drop down of three values:
1) Yes - Same as existing Yes. The Dataset will always be required.
2) No - Same as existing No. The Dataset is not required.
3) When Available - New. The Dataset is mandatory only after it is added or made available. This will be
the default for newly added rules.
5.1.9 Description Columns now have a Maximum Length of 255 Characters

All description columns have been expanded from a maximum of 80 characters to a max of 255
characters. Maintenance pages allow all 255 characters to be edited even if they are not all displayed on
the page. A large resizable text area is displayed on the maintenance page if the edit mode is set to
‘default’, ‘readonly’ or <blank>. A single line of text is displayed if the edit mode is ‘input’.
Page 35 of 86
Post Upgrade Note

If the description column in your maintenance pages or maint element was set to ‘default’, ‘readonly’ or
was not set, the description column will display as a text area after upgrading to LV8.8. To display this as
a single line input, change the mode to ‘input’ in the maint element. If desired, the “Read Only” flag can be
set to ‘Yes’ in the Behavior collection as a substitute for setting the mode to ‘readonly’.
5.1.10 Date Inputs May Require Four Digits for the Year
In prior versions, the system would automatically choose the century when a two-digit year was entered.
This is not always what the user intended. Starting in LV8.8, users will not be able to save a 2-digit year
for date inputs in a maintenance page where a format mask is defined with 4-digit year at either the page
or policy level. Client-side validation will prevent a save and display the message “Not a valid date
format”. If no formats are applied either by the DateFormatPolicy or the page, two-digit dates will continue
to be allowed using the “80/20 rule”. This means any 2-digit year will be seen as up to 80 years in the
past or 20 years in the future of the current date. For example, 01/01/43 will be saved as January 01,
1943, when saved in the year 2022.
The four-digit year requirement is supported by all maintenance page elements including
1) detailmaint
2) sdidetailmaint
3) linkedsdidetailmaint
4) sdclinkmaint
5) maintattribute
6) planitemmanager
7) Report and Query arguments
8) Biobanking accessioning task when creating subjects
9) ELN capturing of Date/DateOnly values
10) Date Attribute Values
11) Data Entry Date, and Date Only datatypes
Users who enter a four-digit year when the date format expects a two-digit year will be permitted to do so
as long as the year entered is within the current century.
Background Java actions such as EditSDI, AddSDI, and others will not require 4-digit years. These
actions previously accepted 2 digits at the action level and continue to do so for backward compatibility.
Often there is code or instrumentation that supplies a year with only 2 digits.
5.1.11 New SDI Certification Action

The action AddOrEditSDICertification has been added. This action is used to add, edit, or delete SDI
certifications. The action can be called individually, or via DFD and is used to do the following:
• Add/Edit/Delete record Instrument Certification.
• Add/Edit/Delete Analyst Certification for a paramlist record.
• Add/Edit/Delete User Certification for Form.
• Add/Edit/Delete User Certification for Task.
• Add/Edit/Delete ReagentLot for a particular paramlist.
• Add/Edit/Delete ReagentLot for any paramlist.

Page 36 of 86
Previously recorded as enhancement VC 0022691
5.1.12 Intra SDC Copying of SDI Notes

Previously, when an SDI was copied to create a new SDI, the SDI notes would also be copied. This
includes occasions where a new version of an SDI is created. The CopyDownPolicy now has options to
copy SDI notes from a template, while versioning, and when an SDI is copied. The default will be ‘No’.
5.1.13 Local Event Plans Associated with First sdiworkitem Row Only.
Local Event Plans were only associated with the first sdiworkitem row. When there were more than one,
the Local Event Plan was not associated with any additional rows. This resulted in the Event Plan not
being triggered for the second row onward.
To correct this, the code was changed to make all rows of sdiworkitem aware of the local Event Plan.
Previously recorded as VantageCare Bug 0022575.
5.1.14 Log File Viewer Page Allows Sorting

The log file viewer now supports sorting the columns just by clicking the column header.
5.1.15 Query Text Written to Application Log File

When troubleshooting an issue, it can become difficult to understand the origin of the problem when the
results of a database query factor into the issue. In LabVantage 8.8, the internal RSET SQL query text
will be written to the labvantage.log file as a debug message when the query executes without an error.
This will include a Rset-SQL prefix making it easier to find these logs. You must set your logging level to
DEBUG in order to see this level of messaging.
Here is an example of a log file entry you might see:
2022-04-18 11:56:43,819 DEBUG [#224] DataAccess Service : RSet-SQL: SELECT… FROM…
WHERE… AND…
If the query throws an exception, this will be caught, and the log entry is generated at the ERROR level.
Example:
2022-04-18 12:51:23, 119 ERROR [#224] DataAccess Service : CreateRSetQ Failed. RSet-SQL:
SELECT… FROM… WHERE… AND…
5.1.16 Sample Review and Approval

Beginning in this version, you can apply an Approval Type to a Sample Template or directly to a Sample
when sample approval is set to be required. Approval Types allow you to link Roles to one or more
Approval Steps. Approval Types also allow you to enable automatic approval rules.
Previously, the Sample Review process would be performed in one step and did not consider Approval
Types. You can continue to use the same Sample Review process that has been in place for versions
prior to LabVantage 8.8, or you can convert to using Approval Types with their associated rules. This
transition can be gradual and progressive if you prefer since the Sample Review page will detect if the
selected samples are using the legacy review process or if Approval Types are attached to the selected
samples. If the Sample Review page detects that you have selected a mixture of Samples with and
without Approval Types for review, you will be prompted to make a different selection.
5.1.17 LDAP Passwords now support Unicode Characters

Users were unable to log on to the system if their password contained certain characters.
The algorithm was not handling many Unicode characters properly.
To correct this, the code has been updated to handle all utf-8 characters in passwords.

Page 37 of 86
Previously recorded as Vantage Care bug VC 0022309.
5.1.18 Simple Instruments Response Wait

Simple Instrument Parsing did not capture additional response lines if the time gap between lines
exceeded 5 seconds even though the configured End of Response String had not been encountered.
After receiving the instrument response, the system stopped if it encountered the End of Response
String, or nothing was read in 5 seconds. In rare cases, a response may have multiple parts with intervals
greater than 5 seconds. The response text was truncated.
To address this, the prefix ! has been introduced to allow strict End of Response String configuration. The
system will now always wait for the End of Response String before it stops reading responses. For
example, if End of Response String is 'xyz' configuring it as '!xyz' tells system to always wait for 'xyz' to
stop reading responses.
Previously recorded as Vantage Care bug VC 0025499.
5.1.19 Statements and Agreements

A statement is an announcement or an agreement that your users should read and perhaps effectively
sign. This text will display immediately after providing your user credentials to access the system. For
example, you might want to post a statement about system downtime. Also, users might need to agree to
your site’s use of cookies. Statements are new to LabVantage 8.8. They can be specific to LIMS, the
Portal, or both.
These Statements can be marked up using a rich text editor, can be translated, and versioned.
Agreements are a type of statement. If a person does not agree to the statement, they will not be allowed
to access the system.
New LV_Statement list, maint, lookup, view, and audit view pages were added. The LV_Statements SDC
was added. The sdclinkmaint, maint and list elements were modified to include properties related to this
feature. The System Admin menu gizmo includes a new menu item. Tracking the statements agreed to by
a user is possible through User view and maint pages. Similarly, Portal pages and elements were added
or updated to include this feature.
If you are using Multi-Factor Authentication (MFA) or Single Sign-On (SSO), these statements are not
supported.
5.1.20 Supporting Property Changes to Component Tasks

When LabVantage builds reusable Components, a subset of the SDCs permit component SDIs. These
SDIs are typically treated just as Core supplied master data and are sometimes modifiable by the project.
A correction was made to the Task Maint page to allow the task properties to be editable as previously
they were not.
5.1.21 Protecting Time Zone Reference Type Values

Prior to LabVantage 8.8, administrators were able to modify the values on the Time Zone Reference
Type. Entry (and save) of an invalid time zone could cause the Scheduler to malfunction.
To address this, the ‘Time Zone’ Reference Type values are no longer editable.
Previously recorded as Vantage Care bug VC0025124.
5.1.22 Upgrade Multiple Databases in One Click Using the Console

If your LabVantage Console has been configured for more than one database or schema, you can now
upgrade all available databases in series with a new “Upgrade LabVantage Databases” hyperlink in your
LabVantage Database list.

Page 38 of 86
5.1.23 Upgrading Reference Type Values

LabVantage is committed to preserving the data in your system while also continuing to improve the data
provided when the system is installed and upgraded. Recent releases have expanded the capabilities of
Reference Types. Upon upgrade, you will likely prefer to take advantage of not only the new capabilities
but also the new configuration data. The upgrade process will now fill in any empty fields for Reference
Type values when LabVantage has decided to adopt a change. This will only affect fields that are empty.
This will not affect fields where data is already present. Affected columns of a Reference Type Value are:
Column ID Label
refvaluedesc Description
refdisplayvalue Display Value
5.1.24 What is Required to Complete

Samples, tests, batches, requests, and monitor groups are automatically assigned a status in
LabVantage. Built-in business rules prevent you from taking certain actions until the status is Complete.
In this release, LabVantage has introduced a way for you to easily identify what is required to move the
status from InProgress to Complete. An icon will appear in the status column. You can click this icon to
reveal the reasons. This applies to samples, tests, data sets, QM batches, AQC batches, requests, and
monitor groups including the following list pages:
SampleList, SDIWorkItemList, DataSetList, LV_ActiveBatchList, LV_ActiveRequestList, QCBatchList,
LV_MonitorGroupList
5.2 AQC
The following changes were made to the Analytical Quality Control module.
5.2.1 QC Batches and Consumable Types

Previously when associating a Consumable Lot to the execution of a QC Batch (for example: controls),
the user could only select Consumables created using a Consumable Type having the same version that
was defined in the QC Method. Now, you can allow any version of the Consumable Type to be linked to
the performance of a test on a QC Batch.
5.2.2 Add QC Sample Action

The AddQCSample Action has been added. This allows adding a new QCSample to a QCBatch in Initial,
InProgress or DataEntered status only.
5.2.3 QC Batch Templates for LES

The new Simple QC Batch with Review Worksheet Template provides DataEntry Controls for QCBatch
Samples in two sections. One shows all Preparation datasets (in proper position order) and another
shows Procedural datasets (in proper position order).
5.2.4 Utilize AddSDIDetail and EditSDIDetail for AQC Persistence

Prior to LabVantage 8.8 business rules were never considered when QC Batch and QCBatchItem
details were modified. Now, the QCBatchItemPropertyHandler uses the AddSDIDetail action and
EditSDIDetail action calls instead of direct SQL. This will allow projects to properly sense changes to
the QCBatchItem using business rules.

Page 39 of 86
5.3 Array Management

The following changes have been made in Array Management.
5.3.1 Applied Array Methods no longer Automatically Cancelled

The system no longer automatically cancels the last applied Array Method when applying a new Array
Method. Now the Array Method Instance is only cancelled if in the Initial state.
5.3.2 Auto Load Scanned Items

When scanning items in the Load Array page it is now possible to automatically load those scanned items
directly into the next cell.
The following properties have been added to the arrayloadtransfer Element:
Option Description
By default, the scan searches by keyid1. Here you

Alternate ID List for Scan can configure an alternate key column for the
search.
Autoload on Scan When " Yes", and the "Scan Find and Select"
option is used to scan samples, in addition to
selecting the item, the loadArray operation is
automatically triggered.
When a sample is scanned successfully, a barcode
icon is displayed next to the sample to indicate
successful loading.
5.3.3 Create Common or Distinct Child Samples

When loading content into multiple wells it is now possible to create one common child sample for each
repeated well. You now have the following options for the “Unknowns/Transfer Child Samples field:
• No, do not create child samples.
• Create Distinct Aliquots/Derivatives
• Create Common Aliquots/Derivates
This is supported by the Load Array and Cherrypicking pages as well as the LoadArray,
LoadArrayByPosition and TranferArray Actions.
5.3.4 Support of Decimal Dilution Factors

Previously, dilution factors could only be specified as whole integers (such as 1:4).
Now, it is possible to specify dilution factors using fractions (such as 1:4.5).
Previously recorded as VantageCare bug VC 0023531.
5.3.5 Default Volume and Concentration Values from Array Method

The “Show Volume Dialog” option has been added to the Array Method, Content Details detail. This lets
you decide whether or not to show the Volume Dialog during array loading.
When checked, the Volume Dialog shows as before and allows you to enter Volume and concentration
values.
Page 40 of 86
When unchecked, Volume and Concentration values provided in the Array Method are used. Using
default volume and concentration values saves time when loading a large number of samples or
consumables. A “Show Volume Dialog” button is provided should you need to change the default values.
When the arraymethodcontent.showvolumedialogflag (Show Volume Dialog checkbox) is found to be null,
the Show Volume Dialog will render as if the checkbox is checked, the array loading page will continue to
show the volume dialog.
Unchecking the checkbox will then persist an "N" value (the Show Volume Dialog will not be shown).
5.3.6 Default Entered Volume and Concentration Values in Successive Loads

The option “Use Entered Values for Successive Loads” has been added to the Volume Dialog. This lets
you use the same Target Volume and Target Concentration values when performing successive transfers
(bypassing the Volume Dialog each time).
Use the "Show Volume Dialog" button to end the successive load session and show the Volume Dialog
again for each transfer.
The source volume to decrement will be recalculated for each successive load (in the background). If
found to be insufficient, a warning message is shown.
5.3.7 Dispose Source Sample When Consumed

A new property “Dispose Source When Consumed” has been added to the Arrays Policy. This determines
whether or not to dispose a source sample when the volume reaches "0" (or blank).
This is checked by the ArrayTransfer Action. When "Yes" the source sample is disposed when the volume
reaches "0" or is blank.
5.3.8 Intra-Array Transfer

This feature allows you to move array content between wells (within the same zone) using drag and
drop functionality.
Choose to:
• Move the entire contents from one well to another.
• Move a portion of the content from one well to another.
• Move the contents of a single well into multiple wells as repeats.
• Move the contents of a single well into multiple wells as serial dilutions with a specified dilution
factor.
Optionally, choose to create Derivative samples for the target content.
Several changes have been made to the Volume Dialog to support Intra-Array Transfer.
5.3.9 LoadArrayByPosition Action

The 'LoadArrayByPosition' Action failed to execute when multiple versions of an Array Method were
associated with the Array ID passed to it as input.
The application was incorrectly fetching the records for all versions of the Array Method Content. This
caused the Action to find duplicate records when multiple Array Methods were present.
To address this, the Application now only fetches the Array Method version associated with the Array.
Forced logout issues have been addressed.
Previously recorded as VantageCare bug VC 0025299.

Page 41 of 86
5.3.10 Non-Numeric Data Types for use during Array Data Entry
It is now possible to define a non-numeric Data Type when defining Parameters in the Array Method.
The “Reference” and “Validated Reference” options are now available in the Data Type dropdown list.
When selected, choose from a list of defined Reference Types. Values of the Reference Type are then
available in a dropdown list during data entry.
5.3.11 Order of Child Sample Creation

It is now possible to control the sequence in which Child Sample IDs are created during Array Loading
and CherryPicking. You have the following options which are available in the ArrayPolicy:
Option Description
Parent Sample ID Child Sample IDs are created in the order of the
Parent Sample IDs regardless of which position the
parent samples are loaded on the Array.
This is the default value.
Layout Zone Loading Direction Child Sample IDs are created according to the
order of the Zone Layout. Horizontal or Vertical, as
defined in the Array Layout.
5.3.12 New Promote Results Rule Options

Previously, when defining how Array Items were pushed to a Sample you could specify only the
ParamList and Param to which the results would be pushed.
Use the following options to more specifically define the content to be pushed and to where (DataSet).
In the “Target Sample’s DataSet” section, a new DataSet dropdown lets you specify to which DataItem
DataSet Array results are pushed. Choose:
Option Description
First UnReleased DataSet Push the Array Item DataSet results to the sample's
first DataSet (not in a Released or Completed state).
Last UnReleased DataSet Push the Array Item DataSet results to the last
(lastest) DataSet (not in a Released or Completed
state).
In the "From Source ArrayItem" section you can determine which results to push when multiple result
values are available (as in the case or Remeasure Array). Choose:
Option Description
DataSet Choose to push values from the "Last applied Array

Method Instance".

Page 42 of 86
Or, choose to push the aggregate value of

remeasured Array Method instances.
Rule to handle Multiple Repeated Wells When pushing results to multiple repeated wells
choose:
Max or Min to push either the Max (maximum) value
or Min (minimum) value of all ArrayItem results
(across all datasets).
Average to push the average of all Arrayitem results.

Optionally, check “Ignore missing and non numeric
values” if you do not want to consider empty
arrayitem data or non numeric arrayitem data
(entered as NaN or #Empty). Instruments
occasionally send Non-numeric values like NaN or
#Empty.
Multiple Repeats to Individual Replicate to create

individual replicates (rather than calculating an
average).
Previously recorded as VantageCare enhancement 0015336 and 0015792.
The PromoteArrayResult action no longer allows overriding a released dataitem of the content Sample.
The operation is skipped and throws an error providing information about the the dataitem, which was
found released.
Previously recorded as VantageCare enhancement VC 0015336, 0015792.
5.3.13 Support for Remeasuring an Array

A new "Remeasure Array" button has been added to the Plates & Gels list page. The latest ArrayMethod
instance of each selected Array will be remeasured. A new Array Method Instance will be created with a
status of "Initial".
On the ArrayItem and Array Zone Dataentry pages, "Remeasure Array" replaces the Retest and
Remeasure Dataset buttons.
The RemeasureArray Action has been added.
5.3.14 Serial Dilutions - Calculation of Source Volume to Decrement

The formula that determines the source volume to decrement (when performing serial dilutions) has been
changed.
In the example below "Dilution Number" assumes that the serial dilutions are numbered 1, 2, 3….
DilutionCount.
When Formula
“Dilute First” is not DVDN = TV - ( TV*TC/ (SC* (DF^(DN-1) ) ) )
checked (false)

Page 43 of 86
“Dilute First” is DVDN = TV - ( TV*TC/(SC* (DF^(DN) ) ) )

checked (true)
Where:
DN - Dilution Number
DVDN - Dilution Volume for Diluent Number
TV - Target Volume
TC - Target Concentration
SC - Source Concentration
DF - Dilution Factor
The source volume to decrement is the sum of the amounts needed for each dilution.
5.4 Attachments
This section highlights changes to how files that are uploaded as attachments to SDIs are managed and
stored.
5.4.1 Ability to Reorder Attachments by Sequence

Within the Attachment Element you can now reorder the sequence of Attachments. On the List and Grid
views select a single row, then use the up and down arrows to move the selected item within the list. On
all views, you can toggle into re-sequence mode, then drag and drop an item to the desired location.
In addition, the width of the Attachment Description column has been increased to 255 characters.
5.4.2 Disabling Attachment Thumbnails

If the creation of a thumbnail preview for attachments is a performance concern, you can disable all
thumbnail generation for all varieties of file uploads using one system configuration switch. When
disabled, this will override any policy settings. This new ‘Disable Thumbnail Generation’ property can be
found in System Admin > Configuration > System Configuration… Miscellaneous Options
5.4.3 Azure and CIFS File Repositories

Two new types of Attachment Repositories are supported.
1. Azure File Repository - managed file shares in the cloud that are accessible via the industry-
standard SMB and NFS protocols.
2. CIFS File Repository - SMB and CIFS network shares with username and password
Azure and AWS file repositories can be configured to allow browsing of the cloud container giving the
user the option to select where the attachment will be stored. These use individual class loaders.
Previously recorded as VantageCare enhancements 0022732 and 0023090:
5.4.4 Class Loading

Dynamic Class Loading can be enabled and disabled for Attachment Repositories using the Security
Policy. Extensive changes have been made to how specialized class files are loaded. For full detail, see
the LabVantage product documentation. Here is a summary:

Page 44 of 86
1. Dynamic class loading has been expanded from just reports and Attachment Handlers (Talend
and Java) to now include Attachment Repositories.
2. Attachment Repositories can add an appresource property in the root of the property tree which
points to the Application Resource SDI of type Java Library. If an app resource is given, it will
load all its libraries from the dynamic area using the child first, parent last model. Required
classes will then be loaded from there for the Attachment repository.
3. The class loader instance is cached for the keyid1. Thus, each attachment repository has a
cached class loader independent of another attachment repository, handler, or report.
4. In 8.7 and earlier, dynamic libraries were only taken from the SDI's attachments (Jars attached of
class=library) or from the dynamicclasslibaries folder (custom and product) under the application
home. Now in 8.8 subfolders can be provided under the dynamic class libraries folder which can
be referenced by the application resource.
5. The LabVantage class loader is a child first, parent last class loader. The order of library loading
for an Attachment Handlers, Reports, and Repositories has been modified to include app
resources.
5.4.5 File Rename Tokens for Manually Managed Repositories

When a file attachment repository is configured with Managed = No, this means the contents of that
repository are not automatically managed by LabVantage. In this case, you can configure a custom
rename pattern for the uploaded file. Previously, the Upload File Custom Pattern allowed tokens including
[sdcid] [keyid1] [keyid2] [keyid3] [currentuser] and [filename].
In addition to these, you can now also use
• Columns from the primary table. Example: [primary.createdt].
• Columns from the sdiattachment table. Example: [sdiattachment.sdcid].
• Current date tokens. Example: [yyyymmdd].
5.4.6 Maximum File Upload Size Increased to 1TB

LabVantage allows files to be uploaded for different purposes. This includes attachments using the
Attachment element, attachments in ELN, and standard uploads such as CTT, CMT, and SDMS. There is
a priority for determining the maximum file size for an upload.
1. If using the Attachment element, the maximum is set in the Attachment Policy. This will default to
100MB. If you have set this to ‘-1’, the maximum is set by the system configuration.
2. The system configuration allows a maximum upload size to be specified. This is used for ELN,
CTT, CMT, and SDMS. It is also used when the Attachment policy maximum is set to -1. If the
system configuration value is -1, this is the same as 1 terabyte. Previously, this signified 1
gigabyte.
5.4.7 Validation Check Added to the AddSDIAttachment Action

When calling the action AddSDIAttachment, the action now validates the value passed in for the
‘filename’ property. For security reasons, the path to this file must be allowed by the File Location Policy.
Any file path not allowed by this policy will result in a failure to upload the file with the message “not a
valid file location. Please review ‘File Locations’ property in the file location policy.”
Post Upgrade Note

Page 45 of 86
Add your allowed file upload locations to the Custom node under the Attachments node in the
FileLocationPolicy. Any directory contained underneath this location will also be an allowed source of files
for upload as an attachment to an SDI in LabVantage.
5.5 Attributes
To better support the display of attributes associated with SDI Workitem and SDI Data SDIs and provide
a way to manage attributes associated with multiple SDIs, the following improvements have been made.
5.5.1 SDCAttribute Detail Converted to an SDC

The SDCAttributeDef detail table has been converted to an SDC. It is no longer a detail table of the SDC
SDC. For persistence, the AddSDI, EditSDI and DeleteSDI actions must be used for this new SDC. The
SDIDetail actions can no longer be used.
The SDC list page button labeled "Attributes" now opens the new SDCAttributeDef page. Here, users can
manage SDC Attributes within a maintenance grid using the Add or Edit AttributeDef pages. The Maint
grid works as it did before (as it was in the detail element of LV_SDCAttrMaint page).
From a data model perspective, the following changes have been made:
• Created a new SDC for SDCAttributeDef.
• Created a new table with a renamed column SDCID as BasedOnSDCID.
• Rearranged the order of the primary key, and point the FK constraint of SDIAttribute.
• Created a view for backward compatibility.
A new menu option “Attribute Definitions” has been added to the Configuration menu. This opens the
Attributes Definitions List page. Here you can view a list of all defined Attributes.
Attributes associated with an SDC can be deleted using the “Delete Row” operation.
Previously recorded as VantageCare Enhancement 0023146.
5.5.2 MultiSDIAttributeMaint Page

To better support the display of attributes associated with SDI Workitems and SDI Data SDIs and provide
easier management of multiple SDIs with multiple Attributes, several improvements have been made to
the MultiSDIAttributeMaint Page Type:
• Users can now manage Attributes for multiple SDIs. SDIs and Attributes are presented in grid format.
Choose to view the Attributes across and list the SDIs (Attribute Across) or show the SDIs across and
list the Attributes (SDI Across). Using properties of the MultiSDIAttribute Maint Page Type, configure
the columns displayed, and options for managing and viewing listed attributes.
Post Upgrade Note

When upgrading to 8.8, it is necessary to consider the removal of the "Headers" properties. If you had
previously defined values in the "Primary Headers" or "Corner Labels" properties, you must now manually
re-configure your headers using the new "Attribute Source SDC Columns" properties (and other related
SDC column collections). Configure a collection for each column you wish to show.
• The Primary Columns collection was renamed to Attribute Source SDC Columns and now includes a
property to define the "Width" of the column.
• The Parent SDCID property has been renamed Primary SDCID. This lets you define the Primary SDC
when either SDI Workitem or DataSet is the Attribute Source SDC.
• Three Column collections have been added, Primary SDC Display Columns, SDIWorkItem Display
Columns and SDIDatata Display Columns. These collections let you configure the additional columns
to display (depending on the Attribute Source SDC).

Page 46 of 86
• The “Sort Primary In Key Order” property has been renamed “Sort by order of the Keys provided in
Request”. By default this property is "No". Three new sort by column collections have been added.
When "Sort by order of the Keys provided in Request" property is "No", these collections let you
specify by which column to sort attributes for each the Primary SDC, SDIWorkItem, and DataSet.
• The “Show Child WorkItem Attributes” and “Show Child DataSet Attributes” properties let you control
the display of child sdidata attributes according to the selected Primary SDIs or selected
SDIWorkItems. This is not available when Attribute Source SDC is “DataSet”.
• The “Column Header Text property” lets you define the text to be displayed as the header of columns
collection. Supports substitution of following tokens [sdcid], [primarysdcid]/[parentsdcid] in the text.
• The "Child WorkItem Attributes Header" property lets you define text to be displayed as the header of
Child WorkItem Attributes. Applicable when source attribute SDC is not SDIWorkItem or DataSet.
• The "Child DataSet Attributes Header" property lets you define text to be displayed as the header of
Child SDIData Attributes. Applicable when source attribute SDC is not DataSet.
• The "Save operation requires Electronic Signature" property determines whether to requires Esig
when saving data or adding a new Attribute. The default is “No”.
• The property “Headers” which was used to define the column name for the X axis column header and
the corner label has been removed.
• In SDI Across mode, when SDC is DataSet or SDIWorkItem, the parent SDC columns can be
displayed, however SDI Across mode does not support display of child SDC attributes.
Previously recorded as VantageCare enhancements 0022169 and 0023184.
5.5.3 Configuration of MultiSDIAttributeMaint

The Sapphire Product node no longer has any properties set for this element. Those columns that were
specified were specific to Samples. They are removed from Sapphire Product node and set in the Sample
page level.
Post-Upgrade Note
You must manually remove these voided columns from the Sapphire Custom node. To accomplish this,
sign on to LabVantage as a system administrator. Navigate to System Admin  Web Page Designer 
Page Types.
1. Edit the MultiSDIAttributeMaint Page Type
2. Click the Custom node under Sapphire
3. Find the “Attribute Source SDC Columns” collection
4. Remove any columns found in this collection.
5.5.4 New Attribute Type Options for Test Method Attributes

The Test Attribute Type field has been added to the Test Attributes detail. Specify an Attribute Type for
attributes targeted to SDIWorkItems. The following options are provided:
Option Description
Setup Setup attributes typically define testing conditions and are added to the
SDIWorkItems of master data SDIs such as Request Item or Product.
The CopySDIDetail Action copies the Setup attributes of Request Items
(SDIWorkItem) to the SDIWorkItem of the sample (matching the Workitem Id).
Execution Execution attributes are used to record information about the test itself.

Page 47 of 86
The AddSDIWorkItem Action copies Execution attributes defined in the TestMethod

(with target as "SDIWorkItem") to the Sample SDIWorkItems.
These attributes are added to samples only when the Test Method (SDIWorkItem) is
applied for an SDI (ApplyWorkItem is "Yes").
Any entered values are also copied to the Sample SDIWorkitem. If the Sample already has the attribute,
only the entered value is updated to the attribute of the Sample SDIWorkItem (matching the Attribute Id
and Attribute instance).
5.5.5 Request Item Test Attributes

The Request Management module has been improved to now allow requestors the ability to specify
additional attributes for each of the different test(s) associated with Request Items. This is done via a
button that is added to the Request Items detail on a request.
Request Item Test attributes may be defined as Execution or Setup Attributes (as described above).
Attributes associated with Request Item tests are then copied down to the tests on the individual samples
created accordingly.
These changes have led either directly or indirectly to the attribute improvements expressed in the
following sections.
5.5.6 Manage Attributes for Multiple Sample SDIs from the SDI List Page
Users can now manage Attributes for multiple Sample SDIs selected from the Sample SDI list page. The
“Manage Attributes” button has been added to the Sample List page List Control menu.
SDIs and Attributes are presented in grid format. Choose to view the Attributes across and list the SDIs
(Attribute Across) or show the SDIs across and list the Attributes (SDI Across). Using properties of the
MultiSDIAttribute Maint Page Type, configure the columns displayed, and options for managing and
viewing listed attributes.
5.5.7 Save Operation Optimized for Attributes

Saving the Attribute Control or MultiSDIAttributeMaint page took considerable time when many Attributes
were associated. The code has been restructured. Now the EditSDIAttribute action call will be called once
depending on sdcid. All the sdiattributes (of same SDC) are retrieved together.
Also, in the SyncSDIWIstatus action, a single SQL has been constructed to check the status of the block
flag and blocksdc of the worksheet associated with the sample.
5.5.8 Workflow Step using the MultiSDIAttribute PageType Omprovements

When a Workflow Step pointed to a WebPage based on the MultiSDIAttributeMaint pagetype the
callbefore Action (when configured in a button of a Workflow step) was not working consistently
The save() function in JSP uses an AJAX call to persist the data. In some cases (while being used in a
workflow step) when the save and next function are called one after another, the save function may not
get a chance to fire the AJAX call before the next function sends the task to next step. This prevented the
data from being saved.
To correct this, the “save()” function has been modified to support a third optional parameter. This
parameter lets you specify whether to go to next workflow step or not and a fourth parameter to specify
the step id.
Configure the Next Button as follows:
1. To save and go to next step:
sapphire.task.step.webpage.window.multiSDIAttributeMaint.save('Sample', false, true)

Page 48 of 86
2. To specify the next step (step11):

sapphire.task.step.webpage.window.multiSDIAttributeMaint.save('Sample', false, true, 'step11')
5.5.9 Delete SDI Attributes

Prior to LabVantage 8.8 selected Attributes were immediately saved after providing e-signature. Now,
users have the following options for permitting users to delete SDI Attributes:
Option Description
Permit Delete any Unentered Attribute Any listed Attribute (existing or newly added) can be
deleted.
Permit Delete on any new Attributes Only newly added Attributes (before save) can be deleted.
added Newly added attributes are shown with the delete option
(red X).
Do not permit any Deletion of Attributes Attributes cannot be deleted at any time.
5.5.10 Directly Add or Manage Test Attributes on Master Data SDIs

It is now possible to directly add or manage attributes for SDIWorkitems for the following master SDIs:
• Product Maintenance
• Location Maintenance
• Sample Point Maintenance
• BioBanking Study Maintenance (New and Active Studies)
• Sample Template
• Request Item
• Formulation Stage
The “Attributes” button has been added to the Tests (or Services) detail. Clicking the Attributes button
opens the Manage Request Item Attributes page (MultiSDIAttributeMaint Page).
5.6 Audit View

5.6.1 Display of PropertyTree Data in the View
The Audit view page is now enhanced to show complex data from a PropertyList in a PropertyTree. The
Audit View element will support CLOB column values which contain a serialized PropertyList as an XML.
This support is hard-coded to include all the existing CLOB columns present in a standard installation.
The AuditView page now interprets and presents XML in a human-readable fashion rather than as a long
string of text. This allows the property values to be displayed showing the old and new values when the
page is rendered in Changed Rows mode.
The following table lists the columns in the database tables that contain Property Lists that are stored in
database CLOB columns.
Table.Column Defined where

App.ValueTree hardcoded
App.ProductValueTree

Page 49 of 86
GizmoDef.ValueTree via GIZMODEF.PropertytreeID

GizmoDef.ProductValueTree
GizmodefUserOverride.ValueTree
Instrument.CollectorValueTree via Instrument.CollectorPropertyTreeID &

InstrumentModelCollectorValueTree via InstrumentModel.CollectorPropertyTreeID
Portal.ValueTree hardcoded
Portal.ProductValueTree
Propertytree.ValueTree PropertyTree.DefinitionTree
SchedulePlanDefaults.ValueTree via SchedulePlanDefaults.PropertytreeID
ScheduleConditionDefaults.ValueTree via ScheduleConditionDefaults.PropertytreeID
SchedulePlanItem.ValueTree via SchedulePlanItem.PropertytreeID
S_Location.ValueTree
S_Location.ProductValueTree
TaskDefStep.ValueTree via TaskDefStep.PropertyTreeID
TaskDefStep.ProductValueTree
WebpagePropertyTree.ValueTree via WebPagePropertytree.PropertyTreeId
WebpagePropertyTree.ProductValueTree
WebpagePropertyTree.ComponentValueTree
WorksheetItem.Config via WorksheetItem.PropertyTreeId
This feature is only supported in the Changed Rows mode.

This new feature allows the user to view complex data type in 2 different modes. See the Product
Documentation for more information and examples.
5.6.2 Dynamic Audit Support in Advanced Configuration Mode

Dynamic Auditing will record changes made before saving by writing to the "ActivityLog" table. Previously,
if an audit view page was configured for Advanced mode, the audit view page was unable to also display
dynamic audit records. With the addition of 4 new properties to the Advanced Configuration section of the
Audit Details Element, it is now possible to include dynamic audit details in the view.
5.6.3 Suppress First Audit Record in the Presentation of the Audit View Element
The audit trail for every SDI begins with a line that records the creation of data for the columns that are
included in the view. If this detail is deemed to be insignificant, it can be suppressed. The auditdetails
element now features a property called "Suppress First Row". The default is No. With this set to Yes, the
Audit View page for the configured SDC will continue to include a row for the creation of the SDI, but will
offer no details for the values that were set when the SDI was added.

Page 50 of 86
5.7 Batch Management

5.7.1 Allow Samples on a Released or Rejected Batch to be Disposed
Previously, if a Sample was linked to a Batch, any change to the Sample would cause the Batch Status to
be re-evaluated and potentially revert the Status of the Batch back to Pending Release. This includes
disposing of the sample. If the BatchSamplePolicy did not allow changes to child samples on a Released
Batch, disposal was only possible if the Batch was un-released first.
Since disposal of a Sample is an indication that the physical sample has been removed from storage but
the data on that Sample remains intact, you may now dispose Samples on a Released or Rejected Batch
without altering the Batch Status. A Dispose Now button is available on the Historical Samples list page.
5.8 Biobanking
The Biobanking module has received the following enhancements
5.8.1 Alias Support in Genealogy Viewer

When viewing samples in the genealogy viewer, it is now possible to display a sample alias type and its
value. Administrators can modify the genealogyviewer element using Web Page Designer and add a
substitution token to the Node Text property. For a full solution description, please see the Product
Documentation for the genealogyviewer element.
5.8.2 Alias Support on Child Sample Creation Page

When you create aliquots or derivatives, it is now possible to enter values for the resulting sample
aliases. Both the MultiSampleChild and CreatePooledSample pages allow administrators to configure one
or more Sample Alias types for which values can be entered on the child samples. Also, the "Parent
Sample Properties" section has been moved above the "Pooling Sample Properties" section in the Pool
sample creation page.
5.8.3 Departmental Access During Sample Transfers

Prior to LabVantage 8.8, when transferring samples to a target department and departmental security is
enabled, the user in the receiving department does not have access to take custody of the sample. Now
when samples are transferred and if Sample SDC has departmental access control enabled, a value is
inserted in the SDISECURITYDEPARTMENT column. This allows a user in the destination department to
be able to view and take custody of the sample. The Take Custody dialog also allows the user from the
sending department to take custody of the sample that is in transit. If the sender takes custody of all
samples in a transfer (CDT), the CDT package status is set to Cancelled.
5.8.4 Participant Status Validation

When a participant is enrolled in a study that is not a protocol-driven study, that participant cannot
Withdraw, Complete, UnWithdraw or UnComplete.
5.8.5 Preventing Enrollments and Additions into Completed and Cancelled Studies
Two new properties have been added to the BioBankingPolicy. These are
1. Allow Participant enrollment in Completed/Cancelled study – When set to ‘No’ (the default),
LabVantage does not allow users to select a Completed Study and proceed during Receive and
Accessioning. The error message " Not allowed to enroll Participant in Cancelled or Completed
Study" is shown. If you allow Subject enrollment into Completed / Cancelled studies (setting this

Page 51 of 86
property value to Yes), the Study Lookup will need to be modified to display Completed /
Cancelled studies.
2. Allow Allocating/Receiving Samples in Completed/Cancelled Studies – The default is ‘Yes’. When
set to ‘No’, LabVantage does not allow users to select a Completed or Cancelled Study and
proceed for allocating a Sample. The error message " Study is already Completed (or Cancelled).
Operation Unsuccessful" is shown. This includes any attempt to create aliquots or derivatives for
such a study.
5.8.6 Receive and Accession Samples from Participant and Participant Event List Pages
A button "Accession Samples" has been added to the Participant and Participant Event list pages. Using
this button, Samples can be received for one participant at a time through the Accession Samples
workflow task. A new step accepts the selected participant ID and study. This results in a populated
study, site, subject, and cohort workflow task for the participant. The user only needs to select a visit and
a collection date to continue. If this action is taken from the Participant Event list page, the event will also
be populated. Duplicated visits are also allowed.
5.8.7 Remove Sample from Auxiliary Study

A sample that has been linked to a study as an auxiliary can now have that link removed using the
Auxiliary Study tab on the Sample Maintenance page.
5.8.8 Receive and Accession Samples Workflow Task

These enhancements were made to this workflow task
5.8.8.1 Accession Expected Sample Step Receive Stage

The Accession_ExpectedSampleStep of the AccessionSamples Workflow task allows you to choose
which samples are being received. In some cases, the sample for a chosen subject may have already
been received for the selected event. Therefore, showing these on this step can cause confusion and
clutter.
This step has a new property and a user option to show/hide received samples during this step. This can
hide the expected samples that have already been received under an event for the subject when the step
is loaded. The property “Hide Received Samples Initially” defaults to "No" to exhibit legacy behavior.
Users can toggle the Show Received Samples checkbox to No or administrators can default this to No by
setting Hide Received Samples Initially to Yes.
5.8.8.2 Accession Samples Fill Down

The Receive and Accession Samples workflow task page has been enhanced so that the receive
samples page now supports a click of the column header to select all rows for the purpose of a fill-down.
The header row has been moved on top and is no longer rendered for each visit or timepoint in case
samples are being received for multiple visits/timepoints.
5.8.8.3 Accession Samples Subject Search Query Count Warning

The Workflow task AccessionSamples has multiple steps. One of the steps allows you to search for and
associate a Subject with the incoming samples. If your subject search on the Accession_ParticipantStep
returns thousands of subjects, this can cause performance issues. This workflow step has been
enhanced to allow you to define a "Search Warning Limit". The default will be 100. When a user search
for Subjects exceeds the limit, then a message is shown indicating the number of records found and the

Page 52 of 86
search limit. Users can either continue and show all the returned results or restrict the search criteria
further and search again.
5.8.9 Duplicate Visits Allowed

If a participant duplicates a visit, this is allowed in the workflow task.
5.8.10 Subject Description Column Relabeled as Full Name

Most Biobanking protocol-driven studies involve humans. The label for the subjectdesc column on the
LV_Subject list and maint pages has been changed from “Description” to “Full Name”.
5.9 Calculations
Parameter Lists have always supported the definition of a calculation rule. In addition to the features
mentioned in section 4.1, these enhancements have been made.
5.9.1 Alternate Value when Calculation Token Cannot Be Matched

When the calculation engine runs, it tries to locate a dataitem or dataset attribute for each token in the
expression. If it fails to match a token, it generates an CALC_PARAM_ERROR and the expression is not
evaluated. In such a case, the dataset cannot be completed.
The calc parameter syntax now supports the addition of an "Alternate Value" that will be used to complete
the calculation if no matching dataitems or dataset attributes are found.
5.9.2 DateOffset added to Expression Library

Previously, LabVantage provided a way to calculate a future date using a starting date plus a number of
days as an offset. This DateOffsetInDays expression did not support offsets in terms of years, months,
weeks, hours, or fractions. The new DateOffset expression supports these options.
5.10 CMT
The following changes were made to Configuration Management and Transfer (CMT).
5.10.1 Allow Change Control and CMT Transfer of Attributes

The SDC detail table sdcattributeddef has been moved to its own SDC. This isolates change control of
Attribute Definitions from the SDC's themselves.
CMT Policy has been configured to now allow Change Control and CMT Transfer of AttributeDefs. A new
policy node "LV_AttributeDef Product/Custom" has been added.
When exporting SDIs containing attributes, CMT will now export the AttributeDef (when found).
5.10.2 Change to Key Generation Rule for Change Request SDC

The keygeneration rule for the Change Request SDC has been changed to yymm-nnnnn for newly
installed systems.
Upgrading systems will retain their existing rule.
5.10.3 Change Request Inspector

The Change Request Inspector lets you perform a pre-build check of Change Requests. These checks
are intended to help users identify and eliminate any referential integrity problems when a Snapshot
package is imported into the target system.

Page 53 of 86
As the Change Logs of each Change Request are inspected the inspector shows:
• A progress bar to indicate inspection progress.
• The inspection status of each Change Log. The inspection status indicates whether all needed
references are included (either within the Snapshot package or by another Change Log). Clicking
the Change Log opens a more detailed view of results.
• Change Log problems are identified with a magnifying glass icon. When a link is missing in the
package the system attempts to find another Change Request on which the Change Log is
present and alerts the user. A hyperlink to the Change Log and Change Request is provided.
The behavior of the Change Request Inspector can be configured using the CR Inspector Props
properties in the CMT Policy, Sapphire Custom node. Use caution when configuring these properties until
you have a full understanding of the consequences.
5.10.4 Create New Change Request from Check Out Dialog

It is now possible to create a new Change Request from within the Check Out dialog.
A new property "Allow Create new on Dynamic Lookup" and Create New Options property collection has
been added to the Prompt Page Type, Lookup URL properties.
When "Allow Create new on Dynamic Lookup" is "Yes" an option to add a new Change Request is
availble within the Lookup. Use the following Create New Options properties to define the
QuickCreateSDI page:
• Create New Text - Title displayed on the page header.
• QuickCreateSDI Page - Choose the QuickCreateSDI Page to open.
• Template - Optionally, specify a Template for the QuickCreateSDI Page.
5.10.5 Export Multiple Property Trees

It was not possible to export several policies at once despite the ability to select multiple.
The system did not support exporting multiple Property Trees. However, the system did not prevent the
user from selecting multiple items, causing confusion.
To address this, the system now provides support for exporting multiple PropertyTrees with the following
exceptions:
• This ability is only supported by CMT.
• Node export is not allowed when exporting multiple items.
Previously recorded as VantageCare bug 0022392.
5.10.6 Import Sample Templates

When migrating Sample Templates from the source environment to the target, Site is populated with the
Parent Site under the default Department of the importing User, even though no value was assigned in
the source.
CMT Import called the AddSDI Action to import the Sample SDI. This triggered the Sample SDC rule
which incorrectly changed the Parent Site.
To correct this, when using CMT Import, the assignment SDC rule is bypassed.
5.10.7 Import Wizard

The following improvements were made to the Parse Import File page of the Import Wizard:
Page 54 of 86
• Prior to LabVantage 8.8 when a matching versioned SDI was found, match details were not listed
in the Parse Import File page of the Import Wizard.
Now when parsing the Import File, if a found match happens to be the current version (in the case
of a Test Method or Paramlist for example) Matched SDI and Matched By details are now shown
with an icon indicating it cannot be updated.
• Prior to LabVantage 8.8 users were required to manage the Import Option even when an exactly
matching SDI was found. There was no means of knowing whether changes were made (other
than showing the Diff Viewer). As a result, the system incorrectly added a new version.
Now when an exact Matching SDI is found, by default CMT will set the Import Option to "Do Not
Import".
5.10.8 Linked Item Details Interchanged

Linked items (such as attributes) of different versions were incorrectly interchanged after import.
The Import Snapshot did not sort the linked items before importing. This caused the system to incorrectly
associate version specific details.
To address this, the code now orders the linked items alphabetically ensuring that lower versions are
added first.
5.10.9 Warn When Exporting Provisional SDIs

A new option "Check for Provisional SDI" is now available when setting export options. When previewing
validation errors versioned SDI change logs are shown with "Provisional" in the Export Validation column.
To support a default setting for this field a new property has been added to the CMT Policy. Use the
"Provisional Version Check on Export" property to set the default value (either "Yes", checked or "No"
unchecked).
5.11 Configuration Report

5.11.1 HTML Code Displayed as Text
In previous versions, any HTML entered for web page properties and CMT visualization would be
interpreted as HTML by the browser displaying the report output. This caused difficulty when comparing
configuration reports. Now, this HTML is escaped meaning the text of the HTML code is viewable.
5.11.2 Role Labels in the Role Matrix

Newer versions of Chrome and Edge now display the Role text in a vertical manner rather than horizontal
which reduces the horizontal space required for the grid.
5.12 Consumables
The Consumables module has received the following enhancements:
5.12.1 Adhoc Addition of Equipment and Consumables to a DataSet

Traditionally, a consumable type or instrument type would have to be defined on a Parameter List or Test
Method before a consumable or an instrument could be linked to a dataset.
In this release, the Data Entry Choose Consumable dialog allows you to link the use a of consumable lot
to the execution of a test even if the added consumable type was not previously linked to the master data.

Page 55 of 86
This requires the chosen DataSet to be modifiable. Likewise, the Choose Instrument dialog permits
modifiable DataSets to accept additional instrument types.
5.12.2 Consumable Chooser Dialog

Prior to LabVantage 8.8, when the Consumable Chooser dialog was rendered, it looked back into the
master data definition to find the Consumables of the selected datasets. The internal code for rendering
the Consumable and Equipment chooser dialogs has been improved to remove this master data
dependency.
The following improvements have been made to the Consumable Chooser dialog:
• Auto-loading of Consumable Chooser Dialog
o In the Consumable Chooser dialog, when auto-loading containers, containers having a
sufficient quantity are automatically assigned to a sample.
o When auto-loading containers, the system loads the container having enough available
amount to fulfill the sample's recommended amount. If the initially loaded container
cannot fulfill the requirement the next available container is used. Two icons indicate
when a change in containers occurs.
o Users can now stop auto-loading containers in the Choose Consumable dialog at the
Consumable Type level. The Stop Auto Select Container option has been added to the
Consumable Type, Expected Amount tab. When checked no consumable lots will be
loaded into the dialog initially.
• A new property, “Automatically Advance To Next Cell”, has been added to the UseReagent Page
Type. When scanning individual container ids using the Choose Consumable dialog, users can
now automatically advance to the next container cell after scanning. This eliminates the need to
navigate to the next cell manually.
• The visual indicator (R) has been added to the Consumable Chooser dialog to indicate when a
Consumable Lot is required to advance the sample through the lifecycle.
• When managing consumables for multiple samples you can now utilize improved fill down
capabilities to fill the same value for select samples. It is now possible to use the fill down button
for a selected row rather than the entire list).

• A Container can now be saved if a Used Amount is not provided in the Consumable Chooser
Dialog.
• For ease of entry, the Consumable Chooser dialog now allows entry of a unit value along with
entered amounts in the Amount field (for example 10 ml). Upon tabbing out of the Amount field,
the corresponding unit is selected in the Unit dropdown. An error is shown if the entered unit is
invalid.
• The row header is now fixed. Only the body of the grid (that shows the Consumable Types) is
scrollable.
• Use of a Consumable Lot when the status of the Lot is “Initial” is no longer permitted. Initial Lots
must be approved prior to use.

Page 56 of 86
5.12.3 Consistent Chooser Dialog Features throughout Application

Prior to LabVantage 8.8, use of the different features of the Consumable Chooser dialog was not
consistent across the functional areas in which it was used. There were different use cases depending on
where the dialog was used. These features included:
• Initial Container Loading in the dialog.
• Automatic population of the Used Amount.
• Support for Alternate containers.
• Support for adjusting recommended amount.
• Supporting simple instruments.
The use cases included access to the Consumable Chooser dialog from:
• Data Entry LIMS or LES
• QCBatch SampleType tab to choose for a QC Sample Type
• QCBatch Consumable tab
• Mix consumable LES worksheet
• Box Transfer Execution page
To support the different use cases, individual UseReagent webpages were introduced (one per use
case). The calling use case is modified to open the appropriate webpage (designed for the use case). In
these pages, only the properties that are appropriate for the use case are presented.
A similar strategy applies to the Equipment chooser pagetype UseInstrument.
A new property “Use Case” has been added to both the UseReagent and UseInstrument Page Types.
This field lets you show only properties for the selected use case.
5.12.4 Freeze Thaw Tracking

Freeze Thaw Tracking details have been added to the Consumable Chooser dialog. When enabled for a
Consumable Type (and therefore the Consumable Lot) the freeze thaw icon is shown. Hovering over the
icon displays the freeze thaw count. Checking in and out keeps track of these counts.
5.12.5 Hourly Expirations Date Unit

Previously it was not possible to set a Consumable Expiration date with an hourly unit. The “Hourly” unit
is now available from the Expiry Period Unit, Expiry Warning Period Unit, Expiry Grace Period Unit, and
Expiry Reorder Period Unit dropdowns.
5.12.6 Instrument Integration

The Simple Instrument Integration icon has been added to the Choose Consumable dialog. When
choosing the Consumable (while using the instrument) the icon identifies the Instrument used. This
allows you to choose which balance/pipet was used when measuring out the quantity while mixing of the
new Consumable.

Page 57 of 86
5.12.7 Mark a Consumable Type Mandatory for a Parameter List

Previously, marking a Consumable Type as mandatory was only possible for WorkItems. For consistency,
users can now mark a Consumable Type "Mandatory" for a Parameter List. Supplying the Consumable
Lot and Container is needed to allow the test and sample to Complete
5.12.8 Notification Event Plan for Consumable Lot Expiration and Reorder
Several improvements have been made when notifying users of Consumable Lot expiration and reorder
requirements. Prior to LabVantage 8.8, Consumable notifications were hard coded using an action called
ReagentNotification. This was silently specified on all consumable Type SDIs.
Now with 8.8, an event plan is introduced to handle all Consumable notifications. This allows you to
choose who should receive these notifications, and what the content of the bulletin should be. The new
Event plan, ReagentNotifications, delivers similar behavior as the old ReagentNotification action but now
offers you the option to change this behavior.
5.12.8.1 Calculate Total Available Quantity based on User’s Department and Version
It is now possible to consider the User’s departmental security or Consumable Type version when
calculating the total available quantity for a consumable (when determining reorder thresholds for
notification). Two properties have been added to the Consumable Policy:
Property Description
Consider Consumable Type version for Reorder Whether or not to consider the Consumable Type
Threshold notification version when determining reorder thresholds for
notification.
When "Yes", the total available quantity will be
calculated based on the Consumable Lots of the
specific Consumable Type Version defined in the
ReagentNotifications Event Plan. If not defined in
the ReagentNotifications Event Plan, version will be
ignored. The default is set to "No".
Consider User department for Reorder threshold Whether or not to consider a User's departmental
notification security when determining reorder thresholds for
notification.
When "Yes", the total available quantity will be
calculated based on Consumable Lots for the
Department defined in the ReagentNotifications
Event Plan (and any Consumable Lots with no
assigned department). Otherwise, department will
be ignored.
The default is set to "No".
5.12.8.2 Specify the Scope for Notifications

When the total available quantity is calculated to determine if a reorder should be triggered, a bulletin can
be sent (see previous section). Should this notification be sent when one lot’s inventory falls below a
minimum value? Or should the bulletin go out after the overall inventory has fallen by totaling all lots for a
Consumable Type? A new field “Reorder Threshold Scope” has been added to the Expiration/Reorder
tab of the Consumable Type page. You can now specify the scope of reorder notifications, choose:
• "Per Type" to issue a notification for all Consumable Lots of this Consumable Type.

Page 58 of 86
• "Per Lot" to issue a notification for an individual Consumable Lot.

A new action GetTotalConsumableQuantity uses this to return the available quantity to the Event Plan
5.12.9 Select Lot from and Consumable Type Version

Throughout the system when referencing a versioned SDI, a null version reference implies that the
current version should be used. However, in the specific case of when choosing Consumable lots
semantically the null version reference means a consumable lot for any version of the Consumable Type.
To address this, when choosing a Consumable Type using a lookup, the Select Current & Return button
has been changed to Select Any Version & Return. This eliminates confusion by not implying the ability to
choose a Reagent Lot from a Reagent Type version.
5.12.10 Prevent Setting Container Status to Valid if Consumable Lot is not Active
It is no longer possible to set the Container status to "Valid" if the Consumable Lot is not Active.
5.12.11 Query ContainersFronSimilarConsumable Updated

The arguments of the ContainersFromSimilarConsumable query have been updated.
Post Upgrade Note

When upgrading to 8.8.0, you must delete the "reagenttype" argument of the
"ContainersFromSimilarConsumable" query.
5.13 Due Dates

5.13.1 Sample Columns Cleared when using Save as Template
While saving a Sample as a template, the columns duedt, receiveddt and duedtoverrideflag will be saved
without a value. This allows samples that will be logged by the template to have due dates calculated
using an appropriate relative date rather than fixed dates from a template.
5.13.2 Sample Login Automatic Due Date Calculation Removed

Sample Login pages automatically applied and locked in an N+3 calculation to Sample due dates. This
default could not be controlled by a user and was not based on any Product or Sample Type due date
offset calculation. This default was configured through the maint element to automatically set the
Sample's due date. These default values were removed from the product node of the maint element so
that policy calculations can be used. To restore this behavior, modify the Sample Custom node to
reinstate the default as required for the due date and due date lock columns.
5.14 ELN and LES

This section lists various improvements or changes that have been made to the electronic lab notebook
module.
5.14.1 Activity Log

The following changes have been made in the Activity Log:
• Audit reasons are now shown in the Reason column of the Activity Log. When attribute values are
changed, the Activity Log now shows old and new values.
• Deleted and edited controls are now identified with a Dock icon. Clicking the icon provides details
about the edited or deleted control in the Dock.

Page 59 of 86
• An Activity Log is created for any added or edited Incidents against a worksheet, section, or
control.
Previously recorded as VantageCare enhancements 0023169, 0023172 and 0022088.
5.14.2 Allow Add Replicate Inside Control and Allow Remeasure Inside Data Entry Control
A new option is available in the DataEntryControl. Previously there were two options for ‘Allow Add
Replicate/Remeasure Inside Control. The options were Yes, or No. A third option is now available called
‘Yes with Esig Prompt’. This will challenge the user for electronic signature when adding a replicate or
remeasure using the data entry control on a worksheet.
5.14.3 Attributes Control

Attribute Control sorting abilities have been extended to allow alternate columns for sorting sdiworkitems
and sdidata rows. Two property list collections have been added:
• SDIWorkitem Display Columns
• SDIData Display Columns
To improve performance, when many attributes are saved at once, the code has been restructured so
that the EditSDIAttribute action is called only once.
In addition, the required (R) indicator in the Attributes Control is now suppressed once a value is
provided.
5.14.4 Audit Trail for Parameter Outliers

When marking a Parameter as an outlier, the system did not provide any information in the audit trail of
the Detail Panel.
The auditdetail Element was not showing all dataitem columns.
To address this, the auditdetail Element was changed to show all dataitem columns in the auditrail.
5.14.5 Auto Numbering/Captioning of Attachments

Attachments (included in the body of the worksheet only) can now be automatically numbered and
captioned using Fields (defined in a Form or Spreadsheet Control). Generated numbers are combined
with a prefix (Field Prefix) configured in the Attachments Control. Optionally, choose to include the
attachment description.
5.14.6 Cancel Worksheet Action

The CancelWorksheet Action has been made available. This allows users to cancel a Worksheet pro-
grammatically. The Action supports one or more worksheetid/versionids.
5.14.7 Capture Electronic Signature when Saving any Control

Users can now require an Esig when Saving any control. The Esig reason is displayed against
"SetContent" types in the Activity Log.

Page 60 of 86
5.14.8 Custom Table Styling

When rendering tables in a worksheet you now have the ability to choose from several basic table styles
or define your own. Style classes are defined by an ELNTableStyling Reference Type value. This option
is available in the SDIViewer, Equipment, Consumable, Consumable Lot, WorkOrder, QCBatch,
Attachment and Attribute controls.
For the Equipment, Consumable and Attribute controls, the "Table Styling (Render)" property was
originally called "Display Style". Property values defined for "Display Style" are still honored for backward
compatibility.
5.14.9 Data Entry Control Completion

When completing an LES Worksheet, the validations performed were inconsistent when using the "Mark
as Complete" and "Submit for Approval" buttons.
The Worksheet Submit for Approval button incorrectly automatically completed the Data Entry Control
regardless of the control's Item Completion option configuration.
To correct this, both the "Worksheet Submit for Approval" and "Mark as Complete" buttons now check the
Data Entry control Completion option. Only when "Not Required" will the system automatically release all
unreleased entered data items before completing the worksheet (or waiting for Approval). If the Data
Entry Control is set to "Allows 'Mark as Complete'", the system first checks that the dataset is in the
"Complete" state.
5.14.10 Dock
The following changes have been made to the Dock:
• The Reason column now shows audit reasons in the Dock Bar for any save operations.
• The Dock Bar is now available in Worksheet Templates.
• Improvements have been made when rendering spreadsheet changes including changes to a
cell's value, rows that have been newly inserted or deleted.
• Deleted Controls are listed in the Activity Log and available to view in the Dock. When viewing the
Activity Log a Dock Icon is shown with deleted items (only those whose audit trail is stored within
the worksheet). Clicking the icon opens the item in the Dock where you can view more details
about the deleted item.
5.14.11 The "Edit" Activate Operation has been added

Users can now define an "Edit" Activate Operation in the Spreadsheet, Rich Text, and Data Entry
Controls. This allows you to control the "Edit" operation using Role security. In addition, you can now
change the title and button icon.
5.14.12 File Control

To improve the rendering and publishing of files in the File Control:
• A new property “File Type” filters the list of available properties (showing only properties for the
selected file type).
• New File Control templates have been added for each file type.
• A new "Injected" render style (Publish Render Style) has been added to improve rendering of
Word and PDF files. File content can now be directly injected into the published output.
• The option “Add as Attachment When Publishing” lets users include an original file attachment
within the published Word or PDF document. An icon or caption is shown to identify and open the
attachment.
• A new property “Image Quality and Resolution” allows a custom quality and image scale for both
the inline rendering mode and the export publishing mode.
Page 61 of 86
5.14.13 Incidents
ELN/LES now supports Incidents against a Worksheet, Section or Control. Choose to add the incident to
the worksheet, the worksheet and all its SDIs, or just SDIs within a specific control.
Optionally block Worksheet, Section or Control completion until all Incidents are in a “Closed”,
“Cancelled”, or “Complete” state.
Two new privileges, “Add Incidents” and “Manage Incidents” control which users can create and/or
manage Incidents. Users with ELNAdmin privileges can always create and manage Incidents.
Incident details are shown in the Detail panel when enabled.
The addition of embedded Incidents within a worksheet has made the use of the Incident button on the
Worksheet list page obsolete. Therefore, the button has been hidden. Use of the Incident button outside
the Worksheet Manager may cause incorrect Incident behavior.
5.14.14 LIMS Control

Prior to LabVantage 8.8, operations could not be executed from LIMS controls configured with a source of
"Query" (as opposed to the Control or Worksheet SDIs as the source). That limitation has been removed.
Operations can now be passed the list of SDIs even when the list is driven from a query.
5.14.15 Override Word Template File on Worksheet

It is now possible to override the Word Template (initially defined in the ELN Policy) at the Worksheet
level. Use the “Override Word Template File” field within the Worksheet Options dialog.
Any templates you wish to select (as the override) must reside within the same location as the template
defined in the ELN Policy. OOB these templates are stored in [applicationhome]/officetemplates.
5.14.16 Require Sections or Controls to be Marked as Complete

A new option “Required sections and controls must be marked “Complete”, lets you require a Section or
Control be manually marked as “Complete” before the Worksheet can be completed.
Optionally, include or exclude hidden or disabled sections and controls.
5.14.17 Revert Worksheets (or Sections) to InProgress after being sent for Approval
Using the new Revert to InProgress button users can now return a worksheet or section that was
incorrectly sent for approval back to InProgress.
5.14.18 Section Behaviors

Use Section Behaviors to control when content is presented within a worksheet. Sections and Controls
can be shown, hidden, enabled, or disabled dynamically according to defined conditions.
Choose to:
• Present a new section once a prior section is complete. This provides the ability to "walk" LES
users through a worksheet.
• Expose or hide Controls conditionally based on variables in the worksheet (such as the value of
meta-data).
• Easily create sophisticated LES (or reporting) worksheets.

Page 62 of 86
Behaviors are primarily controlled at the section level. You can show, hide, enable or disable any section
based on defined conditions. Behaviors defined for the section trickle down to the enclosed sub-sections
and controls.
These behaviors are typically defined at the Worksheet or Section Template level, however anyone with
access to Section Options can define behaviors for a specific worksheet.
5.14.19 Show Publish History

The Show Publish History button has been added to the Worksheet Manager Publish operations. This
lets you view the publishing history of a Worksheet. Choose to filter results by Publisher (user who
published the report), or a publish date range.
5.14.20 Signature Control

Signature images, defined as Attachments for a User, can now be rendered in the Signature control.
5.14.21 Spreadsheet Control

The Spreadsheet Control has been updated to Grape City SpreadJS 14. In addition, the following
rendering and publishing improvements have been made:
• Define a maximum number of rows to render on screen and when publishing. Additionally, you
can now specify a "Render Area" (click and drag to define an area within the spreadsheet to
render) within a spreadsheet for publishing.
• Previously, when only one sheet was shown, the Sheet tab was not displayed. The option
"Always show sheet tab" has been added. When "Yes" this shows the tab even when there is
only one sheet.
• The ability to show or hide Row and Column headers and Gridlines has been added.
• The "Use Scalable Widths" property has been added. This allows the browser to try and show as
many columns as possible (by scaling the width of cells when possible).
• The "Cross String Type" property has been added. This controls how a cell's text is rendered
should it overflow into the following cell. This is particularly important when the following cell
contains text.
The following user experience improvements have also been made:
• The option to always open the Spreadsheet Control in a maximized state.
• Several keyboard shortcuts are now available when editing a worksheet.
• The ability to remove a control from the Dock has been moved from the sidebar to the tab in the
Dock.
• Comment and Formula indicators are now available to quickly show cell comments or formulas in
a popup.
Spreadsheet content (Cell, worksheet tab names, and cell comments) is now indexed as part of the
global system search functionality.
5.14.22 SpreadJS 14 - Upgrade Considerations

The ELN Spreadsheet Control has been upgraded to use GrapeCity SpreadJS 14. This upgrade will have
the following impact on existing worksheets:
• Spreadsheets in a Completed or InProgress state will continue to render and publish as before.
However, once edited, the system will recognize that the control is using an older version and
warn that saving may result in changes to the rendered output. Upon saving, its contents will be
updated to use the new edit, render, and publish modes.
Page 63 of 86
• Pie Sparklines in an upgrading spreadsheet will not port into the new spreadsheet and may need
to be replaced manually with a Pie Chart. The new spreadsheet (like Excel) does not have
support for Pie Sparklines.
• When creating new sparklines, ensure that the "isFunctionalSparkline" option is unchecked - this
enables editing of the sparkline using the toolbar. Forgetting to uncheck this box, saving and re-
editing the spreadsheet will convert it to a toolbar-compatible mode.
• It is no longer possible to import a list of RefValues for the DropDown cell type. The list of
dropdown values can be created using the ComboBox CellType functionality.
• When rendering the spreadsheet into the worksheet, there will likely be small cosmetic changes
to the spreadsheet’s appearance.
5.14.23 TOC
Improvements have been made to the LIMS Data table of contents including:
• The Worksheet Option "Collapse LIMS Data ToC" has been added. Users can now opt to
automatically show the LIMS ToC as collapsed when a worksheet is opened initially.
• Selecting multiple SDIs (ctrl-click and shift-click) is now supported.
• Presentation of linked SDIs has been improved.
5.14.24 Unique Name for Controls (auto captioning)

Previously, when multiple controls of the same type were added to a worksheet, they were all shown with
the defined title (derived from either a Caption or Name). This resulted in multiple controls having the
same name.
Now, when more than one control of the same type is added to a worksheet, the control name is
appended with an ordinal number (1). The suffix is dynamic and sequential throughout the worksheet.
The appended number will update accordingly as controls are added, moved, or change captions.
5.15 Empower Connector Module

These features were added or enhanced within the Empower Connector optional module.
5.15.1 Display Format for Unmatched/Unknown Peaks

When Empower returns values for unmatched Components (not expected by LIMS) or unknown peaks
(no Component name in CDS), these can create new SDIDataItems in LabVantage. When these values
are displayed in LabVantage, you can now set a numerical display format for them in your Empower
Policy. The default format is 0.000. If you desire some other rounding format, supply a valid LabVantage
format for this property. This example format would essentially apply no rounding: 0.#########
5.15.2 Consistent Empower Column Naming

Some of the Reference Type display values used by the Empower module to identify columns utilized by
the Empower Policy were not consistent with the column names used by the Empower application.
These names have been corrected.
5.15.3 Unknown Peak Relative Retention Time (RRT)

The Empower Connector has been improved in to allow appending the Relative Retention Time to the
Peak identifier when uploading unknown peaks to LIMS. If Empower has not calculated this value, then
the Unknown peak is not uploaded. This is enabled by selecting the new AppendRRT option for the
Unknown Peaks Handling Rule property in the Empower Policy. See EmpowerPolicy > Empower Upload
> Peaks > Unknown Peaks > Handling Rule.

Page 64 of 86
5.16 Labelling
Jasper Reports has been added as an option for designing and printing labels.
5.16.1 Integration with Report Events

The execution of a label report can now store a record of that print event including the option to track
reprint events.
5.16.2 Jasper Reports for Label Reports

Multiple features were added to support the option to use Jasper Reports as the technology for designing
and printing labels. Details are available in the Product Documentation.
• If a printer is added to LabVantage that uses a PDF system printer, this will return the output to
the user’s browser allowing the user to select a local print destination for the label.
• Eight new example Label Methods demonstrate how Jasper Reports can be configured to print
labels in both a controlled and a standard mechanism.
• Features added to the Printer Maintenance page allow automatic rotation of the report output to
best fit the orientation of the paper in the printer.
• The system will store and retrieve the user’s last selection for the print label dialog making this
the default for the next label printing request.
• A report can be flagged as a label report thus preventing it from appearing on the list of selectable
Reports. Such a report will appear when printing labels.
5.16.3 Label Method Description Shown in Print Label Dialog

In prior versions, the Print Label dialog displayed only the Label Method identifier for selection when
printing a label. Now, the system shows the Label Method Description. If no description was entered, the
Label Method identifier is shown in the list.
5.16.4 Printer Maintenance

Columns were added to the Printer maintenance page and the underlying Address SDC. These columns
support new label printing features including the option to use Jasper reports to print labels.
1. A paper height and width can be specified. The system can then rotate the output, if configured,
to match the orientation of the paper in the printer. This allows the printer to maximize the use of
the available paper size.
2. A printer type can be specified. This allows the Print Label dialog to filter out those printers that
are not configured to print labels. Likewise, the Reports button will not offer a label printer as an
option for printing reports.
3. A department can be specified. This prevents users from using printers outside of their
departmental designations.
4. When configuring printers, a printer lookup allows you to select a system printer that is installed
on the application server. This list is generated by LabVantage through Java code that reads the
list of printers installed locally.
5.16.5 Printing Ease of Use

Users can select ‘Open PDF’ when printing from the LV_LabelMethodPrompt and LV_SMSPrintLabel
prompt pages permitting them to print the label on a local printer. The user’s selected printer will be
persisted as the default value for the next occasion when that user elects to print a label.
Page 65 of 86
5.17 Lab Investigations

To aid in processing incidents, these capabilities were added. This module was previously called CAPA.
5.17.1 Buttons Added to the Toolbar

The workflow for incidents did not previously consider the possibility that items might need to be added to
open incidents or that incidents, action plans and workorders may occasionally be brought back from their
Cancelled or Closed status. Buttons have been added to the toolbar of these pages allowing:
1. Edit and add new items to existing Incidents after they are created but before they are closed.
2. UnCancel and UnClose incidents, action plans and workorders.
5.17.2 Incident Approvals

The application incorrectly allowed users to modify the Approvals attached to an Incident using the
Recent History breadcrumb links.
Users should not be permitted to remove Approval Types from an Incident using the recent history
breadcrumb link.
To correct this, the Edit Incident page is now opened in view mode when the Incident status is in
PendingApproval, Approved or Rejected.
Previously recorded as Vantage Care bug 0023237.
5.17.3 Unplanned Incidents Incorrectly Closed

The system allowed unplanned incident(s) to be closed while in an Approved status even though the
"Investigation Required" flag was checked.
Previously for an unplanned incident, if the Investigation Required flag was set (checked) and the incident
was approved, the incident could incorrectly be closed.
To correct this, the system now adds a restriction that Approved unplanned incidents cannot be closed
when the Investigation Required flag is set to true (checked).
Previously recorded as Vantage Care Bug 0022242.
5.17.4 Replacement of detailmaint Element for Incidents

The Incident maintenance pages now use a sdclinkmaint element which replaces the detailmaint element.
This affects the following pages: LV_IncdtActiveMaint, LV_IncdtTemplatMaint, LV_IncdtTemplatAdd,
LV_IncdtEditMaint, LV_IncdtHistoryView, LV_IncdtAddMaint, and LV_IncdtPndAppMaint.
Post-Upgrade Note
If you have customized the detailmaint element included on any of the pages mentioned in this
enhancement, you will need to reconfigure the sdclinkmaint element associated with these pages in
order to retain your existing design.
5.18 Navigator
5.18.1 Protecting Sample Editing from the Navigator
The reviewrequiredflag determines whether a sample can be edited using a Navigator once Complete.
When Yes, Completed Samples are editable as they will require review. When No, even Completed
samples are not editable, therefore the Edit operation is hidden.

Page 66 of 86
If configured changes to the Navigator Policy retrieve the sample SDI, these SQL statements will need to
retrieve the reviewrequiredflag column as well. Failure to do so will result in a runtime error opening the
Navigator.
5.18.2 Translation of Navigator Node Labels

Navigator Policy will now support translation of Navigator node labels such that terms like “Building” and
“Floor” will appear using their translated values in the Location Navigator.
Previously recorded as VantageCare enhancement VC 0021834.
5.19 Portal
The Stellar Client Portal optional module has the following improvements. See also Statements and
Agreements.
5.19.1 Allowing Parameter Values to be Passed into Reports

Report parameters offer additional configuration on ReportStellarPageType pages. These allow the page
to prompt the user for values to be used as criteria in the report. A refresh button will re-run the report
with new values.
5.19.2 Allowing Users to Select a Report

In the prior release, a Stellar report page could only run one report. This meant that an operation button
(or icon) would need to be added to a page for each report.
Now, you can configure multiple reports as options for the user to choose when running a report from an
operation. See Configuring Multiple Reports for a Single Page in the product documentation.
5.19.3 App Access Set Solely by Template During User Creation

When a user is created, the new user is granted access to all apps available to the chosen Base Client. In
LV 8.7, if a User Template was used to create the user account, the user would also receive access to
any apps listed on the user template. In LabVantage 8.8, when a template is used, the user will only be
automatically granted access to the apps listed in the template and no others.
5.19.4 AttributeMaintStellarElement
This new element makes it possible to manage attributes on primary and detail records in the portal.
5.19.5 Attributes in List and Maintenance Pages

Both the List Stellar Gizmo and the List Stellar Element have a new Column Source Type that allows you
to display Attributes as if they were a column from the SDC.
5.19.6 Chip Lists

In the first release of Portal, Category and Test Method (Workitem) columns in a maintenance page
supported a display mode of chip. This allowed multiple values to be selected and displayed in one field.
In version 8.8, this capability has been extended to include managing a list of “Many to Many” links. It has
also been extended to provide more options for the presentation and management of the “chips” –
specifically for Test Method and Many-to-many modes.
Corresponding changes to properties of a Maint and Detail Maint Stellar Element include:
1. Changes to the labels for the selectable Column Source Types

Page 67 of 86
2. A change to the label for the property grouping for Chip List properties
3. Two Edit Modes for Clip Lists: ‘Add and Remove’ or ‘Read Only’
4. Query Order By supports many-to-many
5. Group By extended from ‘Category’ only to include Chip Rule
6. Chip Display Format separated into six different properties: Dropdown Text, Chip Text, Ship Style
Rule Column, Chip Style Rules, and Chip Display Limit
5.19.7 Console Configuration

The LabVantage administrative console now provides a configuration section for Portal allowing you to
add or change database configurations, security options, and turn on ‘Portal Only’ mode. See the
LabVantage Installation Guide for details.
5.19.8 Date Picker Update

This is a technology upgrade. The user format of the rendered date and the date value conversion for
storing to the database continue to be handled like in 8.7. This change affects DataOnlyEditor.jsx,
DateTimeEditor.jsx and DateFilterCell.jsx which now use DatePicker and DateTimePicker components of
Material UI 5. Also changed is the StellarPage.jsx to use the existing user locale logic with new
LocalizationProvider component of Material UI 5.
5.19.9 DetailMaintStellarElement Data Filtering

A Data Filter collection has been added to the DetailMaintStellarElement. Now a Column Id & Value pair
can be defined to filter the detail maint to only load a certain set of rows on page/section load. The
element reads the Data Filter configurations and maps the filter information with the relative
requestid/detailtable info on prepareDataSource method to the DataSource. The element then filters all
the retrieved data. Display Column SQL and FK.Columnid type columns are filtered on the front-end by
the DisplayValueField component when the value is fetched for the first time right after the page is
loaded. Display Column fields are queried separately and are not included in the main SDIRequest.
5.19.10 DetailMaintStellarElement Remove Link (Reverse FK only)

There can be instances where deleting a reverse foreign-key related record is not the desired operation
and yet a removal of this link is needed. A new function called "Remove Link (Reverse FK only)" has
been added to the DetailMaintStellarElement operations. This will null out the link columns to the
primary/parent SDI.
5.19.11 DetailMaintStellarElement Detail Panel

This feature allows details of a detail record on a DetailMaintStellarElement to be edited and managed as
a drill-down detail element or as a form style layout. For example, a forensics case might have evidence
and evidence might have tests. The test is a detail of evidence and evidence is the detail of a case. By
adding a detail panel to a detail element, you will be able to manage the tests (detail of detail) while
editing the case and edit the details of the evidence rows in form fashion. Currently this supports foreign-
key related tables, detail tables, and attachments. See Detail Maint Stellar Element
5.19.12 Detail List for a List Page

You can now add a second list element to a list page. The secondary list element will appear in the Detail
Panel of the list page. When configured, a user will be able to expand the details for a row and see
foreign-key related records. For example, when viewing a list of Requests, a user can expand this detail
panel for a row and see a list of Samples that are related to the displayed Request.

Page 68 of 86
5.19.13 Disable Auto Complete for Logon Page

A property is available in the portal configuration. This allows you to prevent the browser from suggesting
values for the username field of the logon page. With this set to Yes, passwords will also not be stored in
the browser.
5.19.14 Dropdown Edit Mode Enhancements

These features have been added to the MaintStellarElement. When a column in this maintenance
element has the edit mode of ‘Dropdown’ these formatting features are available
• New Display Value (with mapping) Display Mode – Display Value mode allows you do display text
in the dropdown instead of the actual value. For example: P=Pass;F=Fail would display the words
‘Pass’ and ‘Fail’ in a droplist when P and F are available values. This new display mode (with
mapping) allows you to return a value to a chosen column on the maint page.
• Dropdown Display Format – This new property allows you to dictate what is displayed in a field
after a value is chosen in a Multi Column Dropdown. This could include any column in the multi-
column dropdown including any that are hidden (Show = No)
• Map to Column – This new property is available when the Display Mode is “Multi Column
Dropdown” or “Display Value (with mapping)”. The chosen column from the dropdown can be
returned to any column in the maint page.
5.19.15 SQL Edit Mode

The MaintStellarElement, DetailMaintStellarElement, and Prompt Page have a new Edit Mode for
columns called SQL. This gives more flexibility to the display of columns in a dropdown. This functions
similarly to the "Dropdown - SDC" mode except that the columns and rows are defined based on pure
SQL instead of SDCs.
5.19.16 Dynamic Fetching of Dropdown Values for Stellar Elements

Two new properties have been added to three Stellar elements. These properties enable dynamic
retrieval of data using Ajax calls and limit the number of rows that will be retrieved. These properties are
available in MaintStellarElement, DetailMaintStellarElement and ReportStellarPageType. These are
performance enhancements for dropdown lists.
Prior to LabVantage 8.8, dropdown lists would retrieve all items from the database then filter them using
JavaScript on the client. This can cause delays when there are thousands of items to retrieve for the list.
When the edit mode property of a column is set to Dropdown, you will be able to set the Dropdown –
Dynamic property to ‘Yes’ and the Max Rows to Retrieve to an integer. The default max rows will be 500.
5.19.17 Global App Flag

A new column has been added to the portalapp table. The expected values for this column are Y or N.
When you are managing the Apps in the detail element on a Portal maintenance page, you can tick the
checkbox or clear it. If this column is set to Y(es), then automatically every client that is added to this
portal will be granted access to the configured app. This does not grant or remove access to/from existing
clients that were previously created in the system.
Prior to LabVantage 8.8, all apps were made available to a client when a client was added to a portal.
Now, only those marked Global are automatically made available on the addition of a client to a portal.
5.19.18 Increased Compliance with WCAG Level AA 2.1

Screen readers such as NVDA and JAWS need to be able to announce error messages and other
content making the information more accessible to all users. In this version, status messages, such as
form submission confirmations, are announced. Additional enhancements include:

Page 69 of 86
1. A new hidden element is included in the HeaderLV component which gets focus when tab is
pressed for the first time on the page. When the element gets focus, the element is shown. This
includes a “Skip to contend” button. If the Enter key is pressed while the element is in focus, the
focus is moved to wrapper div element in StellarPage page component which is not normally
focusable. Then the focus is moved to the first element that is for real focusable inside the
StellarPage. This is done with new focusNextElement StellarUtil function. This allows users to
avoid tabbing through other images or links on the page.
2. App picker child buttons use the ‘Aria-labelled by’ to display labels for screen readers.
3. The OperationFab component now opens after other operations. In 8.7, the component was
rendered after the whole list element which caused the tab order to be illogical.
4. Dialogs, Toasts and Confirms make use of the Aria-live implementation so that screen readers
are updated when content changes. For confirmation boxes and dialogs, the role on the dialog is
"dialog". The aria-labelledby points to the title node. Snackbars are hosted by a parent modal
dialog so that the screen reader registers their content as being in focus. The role of alert is set
for the snackbar inside the dialog. Introduced a 100ms delay for the snackbar for NVDA to
register the alert when triggered from the modal dialog. The changes also involved making sure
the operation buttons and operation cell buttons had aria-labels for the screen reader.
5. On a tablet in landscape mode, showing a list page does not show all the content. To address
this, the following changes were made:
a. Changed breadcrumb bar to be more compact in medium devices and lower. Also
reduced the number of breadcrumb entries when using smaller devices.
b. Removed Username and Application Title from sidebar on smaller resolutions when
sidebar is in collapsed mode.
c. Reduced size of toolbar on list page and buttons for smaller devices.
d. Made wrapping better for quick search bar and reduced the size of quick bar items when
using smaller resolution.
e. If user has not overridden quick search to show or density to comfortable, then ‘small’ will
set quick search to hidden by default and density as compact by default.
f. Reduced size of list page header on smaller devices.
g. Fix alignment of main page to allow full scrolling on smaller pages (removed min height of
300).
6. Except for captions and images of text, a page can be resized without assistive technology up to
200 percent without loss of content or functionality. Contrast and font size is reasonable by
default and coded in such a way that users can adjust with their user agent, as required.
7. Screen readers expect that headings are correctly nested. For example, a 'h2' heading is nested
in a 'h1' heading. In LV8.8, Breadcrumbs are set to be h1. Also adjusted are the headings for
MaintElement, MeterGizmo, ButtonGizmo, StellarReport, StatementList and StellarAPI
components.
8. When using a screen reader or voice recognition, the Select Files button is available.
9. Added support for Apple iOS on iPhone using Safari
10. To help provide known resolutions to validation errors, DataStores has been extended to have
getErrors method which returns the validation errors found in the DataStore. The MaintPage
component calls this method on save if any validation errors are present and then uses
getErrorSuggestions to shows suitable suggestions based on the validation error messages in the
error alert box.
11. A new getErrorStep method has been added to the MaintPage component. The method returns
which is the first step of a wizard maintenance page that has validation errors. The method is
called on Save if validation errors are present. The wizard is set back to the step returned by the
method. Alert messages managed by StellarAPI component were changed to not auto focus.
Focus is set to the first field that has validation errors on the maintenance page/wizard step.
12. A switch is available for enabling/disabling Keyboard shortcuts. This is included in the Portal
settings dialog which managed by StellarLayout component. By default, the keyboard shortcuts
Page 70 of 86
are enabled. StellarConfig component was extended to store this "shortcutsEnabled" (true/false)
information. GlobalLottie component was extended with bindShortcuts and unbindShortcuts
methods which are used to remove/re-add the keyboard shortcuts of the mousetrap library when
the shortcutsEnabled state is changed (the switch on the settings dialog is used). The
shortcutsEnabled information is also used when the Lottie component is mounted for the first time
and the commands are added to determine if the keyboard shortcuts are added in the first place.
13. With CSS disabled the ordering of the page content appears in a logical linear order.
a. Added a default image height to the dynamic image and icons so that they display at the
defined height without css
b. Replace use of Hidden tag to use props.width to not render content if not needed on
screen. This stops three duplicate sidebars rendering, one of which is at the bottom of the
page.
14. Fixed sidebar heights when restricted and scroll of main content to allow scrolling while zoomed
in.
15. Added and improved focus indicators for StellarGrid cells, OperationCells, Breadcrumbs,
MeterGizmos and operation buttons in DetailMaintElement and AttachmentMaintCard by
adjusting the on-focus background color and borders. Current theme is taken into account when
changing the background color and borders.
16. Updated login and stellarlayout to show page title using Helmet component. Will now show the
portal title on login and then the application title and current page title on each page.
17. For all controls including breadcrumbs, dashboard meter gizmos, list column headers, column
header filter menus, list row expand button, profile picture and profile picture file selector to be
accessible and usable with keyboard. Other controls were already available when tabbing through
the page using a keyboard.
18. A High Contrast theme is available for selection by each user. For the visually impaired, this theme
gives a minimum contrast ratio of 3:1 against the surrounding background. Users can choose this
theme as one of their preferences.
5.19.19 Parameter Gizmo

Similar to core LIMS dashboards, the Portal dashboard pages now support the addition of parameters
using this ParameterStellarGizmofl gizmo. When values are supplied for these parameters, they can filter
the data shown in other gizmos on the same dashboard.
5.19.20 Prompt Page

Operation buttons in the Stellar Portal have supported the use of a Prompt Page allowing the user to
provide data for properties that are used to call an action or perform other tasks. The properties for the
Prompt Page have been extended to include the capabilities that are available in a maintenance page.
This includes cascading dropdowns, default values, read only values, dynamic behavior and other
features of maintenance fields that have been traditionally available in the application. This includes
prompts on the following Stellar objects: DashboardStellarPageType, ListStellarPageType,
MaintStellarPageType, DetailMaintStellarElement, and ListStellarGizmo.
5.19.21 Role Security for Portal Pages and Operations

Stellar pages can now be role-secured preventing unauthorized users from accessing pages and
operations on pages. When Roles are created, they can be designated as an App Role. An App Role is
for use with Portal. Roles that are not flagged as an App Role will be used for LIMS.
The LabVantage application will install with three Portal App Roles. These are App_User, App_Manager,
and App_Administrator. These can be associated to Portal pages. Users will then be required to have the
appropriate role to view those pages and links to those pages in the side bar. To support this feature, an

Page 71 of 86
appflag column has been added to the table: role. The Portal user maintenance page includes a detail for
role assignment. The page RoleMaint has a check box for this column.
5.19.22 Single Sign On for Portal Users

If you have integrated with a third-party SSO provider, Portal users can authenticate using single sign on
credentials. If an SSO user successfully authenticates and does not have a Portal account, the system
can be configured to create a Portal account for them and grant access using attributes from their LDAP
or SSO account.
5.19.23 Support for Duo Security

Cisco Duo was introduced as an MFA option for LabVantage in version 8.7. Availability of this option was
limited to enterprise LIMS users. In LabVantage 8.8, Portal users can also be configured for multi-factor
authentication using Duo.
5.19.24 Third-Party Library Upgrades

Several technologies used by the Portal have been upgraded to never versions. Most notable are React
17.0.2, Material UI - 5.0.3, Kendo - 4.9.0, Node - 16.10, and Bootstrap 5.1.2. All others can be seen in the
package.json dependency tree.
5.19.25 Installation Configuration Options

It is now possible to configure the web.xml options for Portal using the LabVantage Console. Sign into the
Console and navigate to Applications > Application ID > Portal Configuration. This includes two new
options for debugging the application.
• Debug remains as before but is now limited to controlling the client-side debugging which
displays the logs in console. Previously this would also encrypt data and cookies.
• Encrypt parameter (new) controls if the data and commands are encrypted
• Encryptcoookies parameter (new) determines if the cookies should be encrypted.
5.20 Reporting
The majority of these changes are in relation to Jasper report output.
5.20.1 Certificate of Analysis Reports

Multiple issues were addressed by altering the definition of the CoA reports. These problems included:
• Report takes around 13-15 seconds to render completely which is a serious performance issue.
• The reports do not honor the Report Flag of the Spec as some parameter lists are also displayed
even though the 'Reportflag' was unchecked for them.
• The Accreditation details are not displayed when there is a mixture of Accredited and Non-
Accredited tests in the Specification.
• The parameter lists which have no spec limit defined are also displayed in the reports.
• Accreditation numbers in the Results table and Accreditation statements section do not match.
• In a MS SQL Server database, Preliminary COA, COA, and Summary COA reports all fail to load
successfully.
These alterations were made to these Certificate of Analysis reports to address these problems:

Page 72 of 86
The main query had used ‘v_sampletestresults’ and ‘v_specdetails’ joins with other tables to fetch
data along with the use of ‘OR’ in the condition “AND (s.s_sampleid IN
($P!{SAPPHIRE_KEYID1List}) OR s.batchid IN ($P!{SAPPHIRE_KEYID1List}))”, to take either a
Sample ID or a Batch ID was severely impacting the performance. The views have been replaced
with their respective underlying tables, unnecessary tables were removed from the join and the
above condition has been made dynamic for the Accreditation statement and header subreports
to use ‘s.s_sampleid IN ($P!{SAPPHIRE_KEYID1List})’ when run from Sample list and use
‘s.batchid IN ($P!{SAPPHIRE_KEYID1List})’ when run from batch list page.
The main query checked both the ‘sdidataitem.reportflag’ and ‘specparamitems.reportflag’ for
parameter lists. The main query has been corrected to use only ‘specparamitems.reportflag’ to
check for value ‘Y’ for the parameter lists added under the specification.
A column called ‘RNUM’ is used to calculate the accreditation numbers for the associated
Accreditations, the value of which is ‘NULL’ for those parameter lists which have no accreditation.
The value of the ‘Print When Expression’ property for the Accreditation subreport was set to
‘$F{RNUM}>1’ which caused the subreport to fail to display. This property value has been
removed which now allows to display the accreditation details even when there is a mixture of
Accredited and Non-Accredited tests in the Specification. Ordering the main query using the
same column ‘sw.usersequence’ as the query in the Accreditation statement subreport resolved
the problem.
The reports were failing because the ‘compositeparamid’ column that is fetched from the
‘v_sampletestresults’ view used a ‘CASE’ statement to concatenate ‘paramid’, ‘paramtype’
columns which are of ‘nvarchar’ datatype with ‘replicateid’ column which is of ‘numeric’ datatype.
As a solution to this problem, the column ‘compositeparamid’ is replaced with
‘sdidataitem.paramid’ and the concatenation logic has been shifted to jasper by replacing the
‘$F{COMPOSITEPARAMID}’ field expression with the following expression:
($F{NUMREPLICATES}.toString().equalsIgnoreCase("1")?
($F{PARAMTYPE}=="Standard"? $F{COMPOSITEPARAMID}:
($F{COMPOSITEPARAMID}+"
"+$F{PARAMTYPE})):($F{PARAMTYPE}=="Standard"?($F{COMPOSITEPARAMID}+"
Rep: "+$F{REPLICATEID}.toString()):($F{COMPOSITEPARAMID}+"
"+$F{PARAMTYPE}+" Rep: "+$F{REPLICATEID}.toString())))
These issues were previously recorded as VantageCare enhancements 0022858 and 0022707.
5.20.2 Collated Reports

You can now bundle the output of multiple reports into one PDF or DOCX. The collated output can have a
title page and separator pages for each subsequent report. A table of contents is generated to include
hyperlinks allowing you to jump to each section of the report.
This feature uses Microsoft Word document templates. These are installed automatically for new
installations but must be copied over after an upgrade to an existing system.
Post Upgrade Note

If you intend to use this feature, a manual step must be taken to complete the installation. On the
application server, navigate to
LABVANTAGE_HOME  console  install  officetemplates
In this directory, you will find four files. Two of them are related to collated reports. These are
Collated Report Separator.dotx
Collated Report Title.dotx
Copy these two files into
LABVANTAGE_HOME  applications  [app_id]  officetemplates

Page 73 of 86
5.20.3 Database-Specific Embedded Jasper Reports

The LabVantage application supports connections to multiple databases from one application server.
Examples include development and testing databases that use the same LabVantage application server.
Historically, the LabVantage application used one folder to store the compiled Jasper (.jasper) files that
are generated when a report of the type Embedded Jasper is run. Therefore, if two databases accessing
from the same application server use the same report identifiers for reports of the type Embedded Jasper,
these two databases would use the same report definition.
With this enhancement, LabVantage will create a directory on the application server within your
LabVantage REPORTS_HOME when a user runs a report of the type Embedded Jasper. The name of
this directory will be derived from the LV database identifier to which the user was connected when s/he
executed the report. The Jasper file will be compiled and written within this directory.
Example: REPORTS_HOME\labvantage\EmbeddedReportID. Previously, this path would not have
included a database identifier.
5.20.4 Digital Signatures on Confirmed Report Output

When a report event is recorded in LabVantage, a PDF file is generated which captures the output of that
report. This PDF is stored for retrieval but until now, the file has not been secured meaning modifications
to the file could not be easily detected. Starting in LabVantage 8.8, you can configure a Signing Provider
to enable change detection (or prevention when using Adobe-compliant software). You can also verify the
signature and timestamp when viewing the file.
5.20.5 Example Reports Delivered as Embedded Jasper Type

Starting in LV8.8, LabVantage will distribute example Jasper reports as embedded attachments within the
application. Any files stored within [application_home]\reports\OOB will no longer be used by these
example reports. Rather, the report definition files are attached to the records found in System Admin 
Reporting  Reports. Existing example reports will be converted to the new Embedded Jasper type.
These attachments will have a classification of OOBReport. You should use the classification of
“CustomReport” when creating custom reports.
This allows you to access the report definition files without the need to access the server’s file system.
LabVantage will over-write the OOBReport classification ZIP file attachments during each upgrade. The
embedded Jasper Report Library may be affected by the upgrade. Custom ZIP files that are added to the
registered reports are not affected.
5.20.6 Jasper Reports Engine 6.20.0

LabVantage packages version 6.20.0 of the Jasper Reports libraries with the deployment of the
LabVantage application. This is an upgrade from Jaspersoft 6.14.0 used by LabVantage 8.7.0.
5.20.7 LV Noto Font cut off in Unix

When using the LV Noto font in a "Static Text" field (used as a header in the report), the field is cut off in
Unix (works properly in Windows OS).
The LV Noto Font was not working properly when the application was deployed in production mode.
To address this, consider the following:
LabVantage assumes that the "fonts" folder is found in the following location:
[labvantage_home]/[application_name]/reports/lib
If the folder does not exist there, then:
Copy the 'fonts' folder from build path (console\install\reports\lib) and paste it there.
Restart the application server
Page 74 of 86
If the ‘fonts’ folder is present in the path mentioned above, then check for the ‘font-extension’ folder under
the ‘fonts’ folder.
If ‘font-extension’ does not exist, then restart the application server.
If the ‘font-extension’ folder exists, then:
1. Delete ‘font-extension’ folder.
2. Restart the application server.
5.20.8 Purge Existing Jasper Files

When a user runs any report for a selected a language, then a compiled .jasper file will be generated in
the reports folder on the application server. As a result, a language-specific file persists the translations
that were in place the first time the report was run. A change to the translation is not shown the next time
the report is run unless a change was made to the report’s definition or files.
In LabVantage 8.8.0, a Delete Jasper Files button gives you the option to purge any compiled .jasper
files including subreports so that the new language translations can be generated.
5.20.9 Report Event Output Stored as Attachments

In prior versions, reports that generated report history events would store a copy of the output in the
REPORTCONTENT column (type = BLOB) of the REPORTEVENT table. Now, all report event output is
converted to a file and stored as an attachment. Using rules in the Attachment Policy, a repository is
chosen for storage of this file.
5.20.10 Report Origination Address and Logo

The LabVantage ReportScriptlet class has two new methods that allow a report to read your company
address and logo from the database then print this text and image on a report. The Report maintenance
page allows you to choose which address and related image applies to the report. See the LabVantage
Product Documentation for detail on how to implement this reporting strategy.
Post-Upgrade Note
If your reports are using $P{REPORT_SCRIPTLET}.text( "address" ) to retrieve the company address from
a file, this will no longer read any file. This method will redirect to the new method, getAddress(), which
retrieves the address information from the Address SDC in the database. To have your company address
print on your reports, you will need to log into LabVantage and navigate to Lab Admin  Certifications
& Resources  Organizations. Edit the ‘Global’ address and supply your company’s details. The option
to use other Address SDIs is described in the Product Documentation.
5.20.11 Styling
A new modernized style has been developed and applied to the example reports and templates for
Jasper reports. The general settings are:
The LV Noto font is used for all standard text
Background colors are removed with some exceptions.
Line colors for group or section headers may include

Page 75 of 86
LVBlue - RGB: 0, 110, 158; Hex: #006E9E

LVOrange - RGB: 255, 158, 22; Hex: #FF9E16
LVDarkGrey - RGB: 89, 89, 89; Hex: #595959
LVMediumGrey - RGB: 127, 127, 127; Hex: #7F7F7F
LVLightGrey - RGB: 242, 242, 242; Hex: #F2F2F2
With few exceptions, all report body text will inherit the ‘Normal’ style which includes font face and size.
5.20.12 Translation of Report Content to Other Languages

LabVantage always translates a report to the language of the current user. This language might not be
the language of the targeted reader of the report. Therefore, new options have been provided to allow
control over the language for the report. The user generating a report can now choose a language. The
language translation tables in LabVantage will then be used to translate the static and dynamic text on
the report to the selected language for the targeted recipient of the report. This includes output to email,
file, printer, and HTML. The use of the GenerateReport action also accepts a languageid input parameter
supporting language-specific report output. If a Report Event is recorded, the chosen language is also
stored in the event history.
5.20.13 Timezone Translation of Date-Time Values

At runtime, the user generating a report can choose a timezone. If the report has date-time fields that use
the LabVantage report scriptlet to format the date, this will accept the timezone that was passed in and
use it to adjust the date and time to the specified timezone. If the timezone is not passed to the report, or
if this report variable is empty, the report will continue to adjust to the current user's timezone as
established on their user account. This applies to both the main report and any included subreports.
From the Run Report dialog, the system will prompt for the target timezone, defaulting to the current
user's timezone. The example report templates provided with the installation include the variables that are
needed to support timezone and language translation. These templates include an example of how a
message can be shown in the footer to signal that the dates and times on the report are shown in the
translated timezone.
5.20.14 Transmaster Spreadsheet includes Static Text for Example Reports

The Transmaster spreadsheet is a listing of all text or phrases used throughout the LabVantage user
interface. This spreadsheet can be found on the documentation media. Example:
D:\documentation\Transmaster Spreadsheets. This spreadsheet is supplied so that you can create your
own translation of these texts into different languages. This spreadsheet will include any static text used
by the example reports so that you can configure complete language translation for the output.
5.21 Sample Monitoring

The Sample Monitoring module can be used to track excursions which are deviations from the expected
range of test results. These enhancements aid in the management of excursions.
5.21.1 Clearing Excursions and Child Locations

Locations can have child locations. In previous versions, it was not easy to identify when an excursion
came from a chosen location verses a child of that location since the application is designed to tally all
child excursions at the parent level. Users may have been confused when attempting to clear an
excursion at the parent level. LabVantage will only clear excursions at the selected level and will not
recursively clear all excursions for all children beneath the selected location. If an attempt is made to

Page 76 of 86
clear an excursion where one does not exist, LabVantage will display a message indicating the full path to
the location of the actual excursion.
5.21.2 Excursion Indicator Color Coding

In previous versions, all excursion indicators used a red background. Now, there are two excursion
indicators. If the excursion occurred on the displayed record, the red square background for the white
foreground number continues to be used. If the excursion occurred on a child of the displayed record, an
orange circle background is used.
5.21.3 Image Map Hotspot Editor for Locations

You can now imbed an image map with hotspots into a location. This makes linking locations, child
locations, and sample points using image maps a faster and easier task. It also makes it possible to
define hotspots for each location without creating new gizmos.
To support this, a page has been added called LV_ImageMapEditor. The LocationMaint page has two
new columns HotspotImage and HotspotImageDefinition, The Gizmo imagemapgizmo has a new
HotspotImage Location node. The LocationList page Map label for Location Gizmo changed from
keycolid1 to locationlabel. The image map indicator on the LocationList page is now color coded to
indicate if the image map was added to the location or added as a gizmo.
5.22 SaaS
The following enhancements were added primarily for the purpose of supporting Software as a Service
(SaaS). Several other enhancements mentioned here in these Release Notes were made with SaaS in
mind such as various reporting improvements and security hardening.
5.22.1 SMTP Configuration

Within your System Configuration options, a new tab has been introduced. This gives you the option to
use a SMTP mail server specific to the active database. Previously, all databases serviced by a single
application server would send mail through the same SMTP server.
5.22.2 Timezone Adjusted Key Generation

When an SDC is configured, the primary key can be automatically generated. In prior versions, the date
segment of this key generation would use the application server’s date and time. The option to use ‘today
in my timezone’ has been added to the column key generation configuration. This will generate the date
segment of the key generation using the user’s local timezone.
5.23 SDMS
These improvements address the Scientific Data Management System (SDMS) module.
5.23.1 Advanced File Collector Zip File Naming

When a collector is configured using the Advanced File Collector Type, you can enable an option to
combine multiple files into one ZIP file when files are collected for a data capture. Previously, the ZIP File
Name property would supply a static file name for the ZIP. Now this property supports the use of
[foldername] as a token. The collector will then identify the first common folder name shared by all files in
the ZIP going back up the directory tree and label the ZIP file with this folder name. This allows users to
be able to relate the files in a repository back to the source of those files.

Page 77 of 86
5.23.2 Deliver Run File from Data Entry

A button has been added to the Data Entry pages allowing required information to be sent for creation of
a run file report.
5.23.3 File Naming for Run File Delivery

If an instrument is configured using a Collector Type of "Advanced File", "Network" or "Simple File", this
provides the option to deliver a run file from LabVantage to the instrument. The default file name for the
run file will be "sequence123.txt". You can now configure a Collector Type to create a file name based on
values obtained from the selected SDI when the "Generate Run File" dialog is invoked. For example, if
the selected s_sampleid is 'S-3210' then the delivered runfile could be automatically named 'S-3210.txt'.
5.23.4 Expanded Field Length for Attachment Handler Default Values

The Setup Variables tab of the Attachment Handler maintenance page has a default value column.
Previously, this column supported only 100 characters. Now, it allows up to 1000.
5.23.5 Roles for SDMS Dashboard Buttons

In previous versions, some key administrative functions for SDMS were only available users who were
granted the "SDMS Admin" role. Now, features such as clearing alerts, adding collectors, and viewing the
instrument log can be limited to users who have been granted specific roles. This can be configured for
SDMS Alert Gizmo and SDMS Monitor Gizmo.
5.24 Security
LabVantage is committed to making the application and your data secure. To that end, improvements
continue to be made as described below. Some descriptions are purposely terse to avoid exposing
weaknesses that may be present in other release versions.
5.24.1 Allow Page Directives

In LV8.8, we have introduced a new flag in the Security Policy. This flag is called ‘Allow Page Directives’.
With this set to ‘No’, these types of activities will not be permitted:
1. JavaScript built by the client. Example: "href":"javascript:parent.accept('[keycolid1]')
2. pagedirectives in the URL. Example: rc?command=file&file=WEB-

CORE/lookup/lookup.jsp&sdcid=User&__pagedirectives=…
The default is ‘No’ for heightened security. In the rare occasion where you have customized a page to
build page directives on the client, it will no longer work when Allow Page Directives is set to No. In some
cases, modern firewall security will continue to block this regardless of the ‘Allow Page Directives’ value
being set to ‘Yes’. Instead, you would need to build the directives on the server.
To continue supporting desired functionality, LabVantage is appending a PageDirective Id as ‘pageDirId’

and storing the whole pagedirective in a session object with the ‘pageDirId’ value. If ‘Allow Page
Directives’ flag is set to ‘No’, only PageDirId and RestrictiveWhere will be allowed to pass to the server
side. Based on the passed pageDirId value, it will be fetched from the session object and added to the
request in the server.

Page 78 of 86
5.24.2 Securing Menu Navigation

This enhancement secures the menu navigation string on the client side and validates that it is secured
on the server side before injecting the user’s navigation into the JSP rendering. This includes an added
benefit of eliminating Javascript in the parameters of the response sent by the server back to the client.
5.24.3 Single Sign On (SSO) and LDAP User Synchronization

Authentications are defined through System Admin > Security > Authentications
5.24.3.1 New Authentication Property Tree: DefaultSSOAuthentication

These enhancements provide a solution for the below use cases when an LDAP or SSO user
successfully authenticates:
1. Allow mapping of attributes from SSO to columns in the sysuser table
2. Allow creation of new Portal or LIMS users based on SSO attributes
3. Require SSO users to have specific values for attributes (like department) before creating an
account
4. Allow LabVantage to create user accounts through templates that are selected based on SSO
attribute value matching.
5. Allow Job Types to be synchronized according to attributes
6. An Allow Logon Expression gives you the option to define a Groovy statement which determines
if the user is allowed to logon through SSO even if their credentials are valid and they have an
active user account.
5.24.3.2 Properties Added to DefaultLDAPAuthentic.

Two new properties were added to DefaultLDAPAuthentic. These enhancements provide a solution for
the below use cases when an LDAP user successfully authenticates:
1. Allow Logon Expression - Require LDAP users to have specific values for attributes like
department before creating an account
2. Logon Mapping Expression - Expression gives you the option to define a Groovy statement which
determines if the user is allowed to logon through LDAP even if their credentials are valid and
they have an active user account.
5.24.4 Vulnerabilities
Several security vulnerabilities were identified and addressed.
• XSS vulnerabilities were addressed.
• Forced logout issues have been addressed. VC 0024449
• When navigating, a variable called _selectedws is encoded on its transport to and from the server
VC 0022650
5.25 Scheduler
The following changes have been made to the Scheduler.
5.25.1 Execute Now

Prior to LabVantage 8.8 it was not possible to use the Execute Now operation on more than one source
at a time. From the source list page, you can now select multiple sources for execution.

Page 79 of 86
When using the Execute Now operation, a new Execute Options dialog is presented.
You have the following options:
• Schedule Specific Classes (Defaults to All). This lets you choose to execute only Schedule Plans
having the specified Class.
• Include only Enabled Schedules. Whether or not to execute only Enabled Schedule Plans.
When defining a Schedule Plan Item, it is now possible to specify a plan item "Class". Use this Class to
limit schedule plan item execution when using the Execute Now operation for Sample Points.
To support the new Schedule Plan Item Class, the PlanItemClass Reference Type has been added.
The ExecuteNowForSDI Action has a new planitemclass property.
5.25.2 Protect from Deleting Plan Items that have associated WorkItems or Samples
Prior to LabVantage 8.8, references to the Schedule Plan Item that created a sample were incorrectly
removed if the Schedule Plan Item was deleted. This eliminated a historical reference for the sample.
It is no longer possible to delete a Schedule Plan Item that has associated Samples or WorkItems.
Instead consider hiding the schedule plan item.
5.25.3 Scheduler Execution - Sample Creation Sequence

When a scheduler execution created samples for multiple Schedule Plans and/or Schedule Plan Items,
samples were created in a random sequence. This resulted in labels (printed on sample creation) being
printed in a random sequence.
Events other than Schedule Plan Items for execution (such as already executed/cancelled events) were
considered. This created an execution order not based only on currently executable events.
To correct this, events are now ordered by events in "Scheduled" status only.
5.25.4 SchedulePlanItem Audit View Page

Scheduler Schedule Plan Items are often linked to Locations, Sample Points, or Instruments. The list
pages for these items now offer a View Audit page that will display changes to the schedule plan for that
item. The audit details can include the type of task to be performed, the frequency, the start date and
more.
To support this, the following changes were made:
• Added the SchedulePlanItem2 node to the AuditDetails Element.
o Associated that Element to the InstrumentAuditView, LocationAuditView and
SamplePointAuditView pages.
• Added a View Audit toolbar button to the InstrumentList, LocationList and SamplePointList list
pages to show the Audit page for the selected SDIs.
5.25.5 SchedulePlanItem Reorganization to Support Auditing

Previously, enabling the scheduleplanitem table for auditing was not useful, as there were many columns
that were continually updated during the routine polling of the scheduler. It was not desirable to have
these updates generate audit records. Therefore, to support the new SchedulePlanItem Audit View page,
the SchedulePlanItem table has been split into two definition tables (old scheduleplanitem) and runtime

Page 80 of 86
table (scheduleplanitemexec). The following columns have been moved from scheduleplanitem to
scheduleplanitemexec:
• inprocessflag
• currentcount
• executedflag
• scheduledtodt
• nextscheduledt
• lastscheduledt
• lasteventdt
The scheduleplanitemexec table is not defined as a detail table to SchedulePlanItem. This keeps the
table out of Auditing. If auditing is needed, it is possible to add the audit triggers using the database API.
Post Upgrade Note

The old columns of the schedulplanitem table are not cleared/removed on upgrade. Projects should
consider this in their configuration on upgrade. The content of the columns is merged from
scheduleplanitem to scheduleplanitemexec on the first installation of post 8.8.0 installation.
The catchall-scripts on upgrade will do the migration of data from scheduleplanitem to
scheduleplanitemexec.
Things to consider:
• For those customers still using CTT, when moving scheduleplanitems, if the
scheduleplanitemexec rows are not imported with CTT, the rows will be added when editing the
scheduleplan for the first time. If the scheduler does not seem to work correctly after importing,
the Schedule Plan should be saved manually in Schedule Plan maintenance page (make a
change and save) the scheduleplanitemexec rows will be created.
• With CMT the scheduleplanitemexec rows are created automatically.
5.26 Scheduler and Stability Module Retry Events

When a Schedule Plan Item fails (goes to Error), previously it was not possible to easily re-execute the
task. Instead, the user would have to manually create a new task for the Scheduler. Now, Scheduler
Items and Studies with failed tasks are displayed with an error icon in the Active Study and Schedule Plan
Item list pages. Clicking the error icon will open the schedule events view with errored events shown.
In the toolbar, you will find the "Activate / Re-try Error" and "Inactivate / Acknowledge Error" buttons. By
selecting the errored item and using the Activate / Re-try Error button, this will set the status of the
schedule plan event back to "Scheduled" which will trigger the scheduler to pick it up and re-try execution
on the next schedule poll. Using the "Inactivate / Acknowledge error" will set the event to
Inactive/Cancelled so that it will not be shown in the error list anymore.
5.27 Storage
Enhancements were made to the management of storage units and locations.
5.27.1 AddEventLogEntry Action Added

This new action accepts trackitem identifiers as an input property and allows a chain of custody transfer
to be recorded when this action is called.
Page 81 of 86
5.27.2 ASL Requirement has been Removed for Portal

Prior to LabVantage 8.8, if the current Portal user does not have ASL (when ASL is not sitewide) they
cannot assign the ASL module to selected users. Portal creation of a Package was failing.
In 8.8, this requirement has been removed from the SDC Rule. Now when a Package is created, its
associated Storage Unit and Trackitem are also created independent of the ASL module.
5.27.3 Box Templates

The creation of a freestanding Box now features the use of a Box Template. This allows you to create
templates with different storage restrictions instead of creating new storage unit types for different
restrictions. The templates can also predefine things like the Study ID and Array Layout. A menu choice
for Box Templates was added to Lab Admin > Templates. You may also add new Box templates using
the "Save As Template" button from the Box Maint page.
The creation of a new Storage Unit Type with an identifier of a new Box template ID that contains child
Box Positions will automatically create a new box template for you.
LabVantage includes examples of 4 box templates. These are revealed on the Box Templates list page
after certain steps are taken to enable them. See the Product Documentation for steps.
Previously recorded as VantageCare enhancement VC 0019049.
5.27.4 Chain of Custody

In previous versions, the Chain of Custody log was only visible in the master history report and a few
other select places. Chain of Custody is now based on trackitem event logs. This improves the
presentation of this information making it more visible in the Sample and Box maintenance pages. The
following pages have a COC detail: LV_AdminSampleEdit, LV_SMSSampleView, LV_BoxMaint,
LV_BoxView, SampleMaint, and SampleView.
Pages that previously used a “Custody” detail are now switched to the COC detail.
5.27.5 Copy Physical Store

The Copy operation has been added to the List Control menu on the Storage Explorer and Physical Store
List pages.
After specifying a Label for the new Physical Store, this copies the selected Physical Store including all
underlying storage hierarchy and refreshes the list page.
5.27.6 FileTrackItem Action and Reserve Current Location

When the FileTrackItem action is used to move an item from one location to another, the
reservecurrentlocation input property can be passed a value of Y. In this case, the current location is
reserved allowing a user to return the item to that location in the future.
5.27.7 Grant Custody

A user can directly transfer a sample or a box to another user and bypass the check-in, check-out or
package management process. This is available as a button on Samples and Box list pages including
both Biobanking and LIMS. This feature comes with a new page type: GrantCustody.
5.27.8 Move Box

A button is available on the box list page making it easy to move a box to a new location.

Page 82 of 86
5.27.9 Moving Multiple Storage Units Simultaneously

In previous versions, the movement of storage units was restricted to one unit at a time. For example,
only one shelf could be moved between freezers at a time. This restriction has been removed. You can
move multiple storage units simultaneously. To prevent performance problems, LabVantage will warn the
user if too many storage units are selected for a move.
5.27.10 Package Operations No Longer Require a User Specific Contact

Users are no longer required to have a contact record in order to manage packages. The query to display
package history has been adjusted accordingly.
5.27.11 Storage Unit Label

An improvement has been made to the storage subsystem where every StorageUnitType now has a
Label property to allow for a friendlier name for that Type. Previously, only the StorageUnitType’s
nodename was shown when references were made. In LV8.8, the StorageUnitType column is hidden
from various list and maintenance pages and a StorageUnitTypeLabel pseudo column was
introduced. This pseudo column will present the Label property. If there is no value for Label, the
StorageUnitType nodename identifier will be used. This affects Box list, lookup and maint pages, the
Storage Explorer and the StorageCreation Wizard.
At the time of this release pseudo columns are not exported. Therefore, the label will not be included
when exporting to Excel or PDF.
5.27.12 Scanning a Subject ID, Sample ID, Sample Alias or Study ID During Box Consolidation
The box consolidation page now supports scanning of the Subject ID, Sample ID, Sample Alias, or Study
ID to automatically select those positions in a box that currently hold items meeting the criteria. The
selected positions can then be dragged to a target position as if they were selected by other manual
means. Administrators can add options if there is a need to search by other criteria.
5.27.13 New Reset Search Option on Box Consolidation Page

A new option, “Reset Search” has been added to the Find and Select Dialog when consolidating storage.
This clears any previously defined search criteria.
5.27.14 Select Box Position using Storage Explorer Lookup

It is now possible to select a single individual empty Box Position (Sorted Boxes only) for loading from the
Storage Explorer Lookup page.
5.27.15 Restrict User to User Transfer when using Take Custody

The Take Custody dialog now supports a new request parameter "restricttransfer". This is used to
determine if a trackitem is already in the custody of a user. When passed a value of "Y", the take custody
dialog is opened in restricted mode. In restricted mode:
• Users can only take custody of a trackitem if it is filed in a storage location in a department in
which the user is a member.
• Force custody is not allowed.
• The item must not be in any package.

Page 83 of 86
5.28 Tests
All workitems (SDIWorkItems) selected across multiple Manage Tests list pages did not appear in the
DataEntry page after clicking “Data Entry”. The Manage Tests list page was incorrectly included only
items from the current page.
To correct this, the data entry function in the sdiwiworksheet.js file was updated to include workitems
selected across all list pages.
Allowing selection of items across multiple list pages is better aligned with the default behavior in other list
pages.
5.29 Web Page Designer

5.29.1 Blocking Column Updates
When the user clicks Save on a maintenance page, all columns configured on the page, including hidden
and read-only columns, are sent back to the server and potentially persisted to the database. A new
feature has been added to the maint element’s column collection that now controls when updates should
be allowed. This is most pertinent to read only or hidden columns. A new advanced property Block
Updates, with values of (Yes, No, or Always) has been added for each column. ‘Yes’ prevent, and ‘No’
will permit the column value to be updated when sent back. The default is to not block the update, as
many LabVantage pages rely on that behavior. The ‘Always’ option is described below.
This capability is controlled by a similar advanced property, Enable Column Update Blocking, at the maint
element that indicates that this feature is to be enabled or disabled, and if enabled what action is desired
when violations are detected. One option for upgrading systems is to disable this feature entirely. More
on upgrading systems at the end of this section. The configuration can elect to raise persistence errors,
or to silently skip cases where the blocked column is being modified by setting this value to Yes (silent),
or Yes (raise error). LabVantage now comes configured so that the system will silently (without
presenting an error message) block violations. When blocked, all violations are written to the
labvantage.log. This decision may be made on an SDC-by-SDC basis in the maint element or deferred to
the MaintenanceForm pagetype Sapphire Custom node to make this election for the whole configuration.
In some cases, some status column values should never be updated from the client regardless of this
globally set or SDC-wide switch. That is where the Block Update value of Always option is used. In many
cases we never want the client to reset a rolled-up status value.
There are several cases where it is proper to update read-only or hidden columns. These include
1. The primary keyid column that is passed to the persistence actions, AddSDI/EditSDI,
2. The column may have its initial value set by a default value that needs to be changed by AddSDI,
3. The column is configured to receive its value as a result of choosing a different column via a
lookup mode,
4. The column is modified by page level javascript functions that are used to set values of these
columns, or
5. The column must be passed through to the persistence actions and their business rules, so that
proper validation can take place
In these cases, it is incorrect to block the update of the value from the persistence actions. The entire
LabVantage configuration has been reviewed and the proper Block Update property has been determined
and populated.
Post Upgrade Note

Upgrading customers have a decision to make depending on the scope of their configuration changes, vs
how much control you want over which columns should be blocked.
Page 84 of 86
Property: Enable Column Update Blocking

Set to Yes (silent), or Yes(raise error)
Upgrading customers can specify which specific columns should be Blocked. Doing so will require
retesting the configuration. These columns include not only the newly configured pages, but also user
columns on the various pages. We do not recommend altering the Block Update property to Yes or
Always on any default columns since these have already been reviewed and the property has been set to
the correct value to ensure correct system operation. Nevertheless, upgrading systems may choose to
enable this property on custom columns to provide an additional layer of data integrity. We would
recommend performing sufficient testing around any changes to this property as newly enabled behaviour
may have unexpected consequences – particularly for custom implementations.
Set to No - Recommended
Upgrading customers can elect not to enable Column Update Blocking and continue to allow updates
through HTML and JavaScript client layer.
5.29.2 Bulletins
The “URL” field is now optionally included in the Send New Bulletin page. A new property “Show URL”
has been added to the BulletinList Page Type. By default, this is set to “No”.
5.29.3 DataEntrySDIList Page Type

LabVantage offers multiple views for selection during Data Entry. One view is called "Grid List". When the
Grid List view is selected, the title of “Samples” appears. This view is using a custom JSP for the
iDataEntrySDIList page. Because of that, there was no option to change this title using the standard Web
Page Designer features.
For this reason, the DataEntrySDIList page type was created. There is one property: Title. You may
change the value of this property to a text that corresponds to your design for this page. The LabVantage
Product Documentation provides an example for this new Page Type.
5.29.4 Dialog Type property for sdidetailmaint, detailmaint and linkedsdimaint Elements
The elements sdidetailmaint, detailmaint and linkedsdimaint now include the same Dialog Type property
that was available for sdclinkmaint elements that allow definition if an opened window is a new window or
a modal dialog. The default configuration has been modified to use dialogs.
5.29.5 Electronic Signature Reason Prompt

The EsigForm page type now features a property allowing the Reason field to be hidden.
5.29.6 Prompt Page Column Behavior Properties

When columns are added to a prompt page, they can now be configured as hidden, mandatory, and/or
read only. The mandatory option was moved from the validations section to the behaviour section.
5.29.7 Defining Collection Display Options

When defining custom Page Types, Elements, Policies, and Layouts using Web Page Designer
Professional, the attribute editor has been enhanced to support additional input validation including
numbers, date formats, uniqueness checking, required fields, and a URL editor. Display options feature
collection item flagging, item hiding, collection header substitution and theme selection for Stellar colors.
See Advanced Operations within the Web Page Designer section of the Product Documentation for
details.
When properties are displayed, those that are hidden will show with a line-through font. Those that are
deprecated are displayed with a wavy line-through.

Page 85 of 86
All property tree collections for elements, pagetypes, policies, etc have been reviewed and configured to
consistently show a display label and/or an identifier as the collection items title. When presenting
collections, the default Direction style has been changed from 'down' to 'grouped'.
Post Upgrade Note

All custom propertytrees including elements, policies, schedule tasks, etc. that define collections may be
affected by this change. When looking at the Property Definition, on examination of the custom
collection's Display Options when looking at the Direction attribute,
If not specified it will now be presented using the grouped style. To return to the prior defaulted style, the
Direction attribute should be set as 'down'.
5.29.8 Product Root Node Properties

Property trees have always had a Root node. These values are editable. The system needed a way for
LabVantage to set defaults at the root node without disturbing custom settings. Version 8.8 introduces
product defaults that are configured in the definition of the propertytree. These defaults are free to change
from release to release without affecting the Root node which is not modified.
5.30 WAP
5.30.1 Appointment and Activity Time Step
It is now possible to configure the time step interval (in minutes) for Calendar and Planning pages. The
“Appointment Time Step (mins)” property has been added to the Calendar Page Type.
For example, setting the Appointment Time Step (mins) property to “15” configures time options in 15-
minute increments. Available times will be 9:00, 9:15, 9:30 etc. By default, the increment is 5.
5.30.2 Core Hours

In prior versions, core (or working) hours were assumed to be 9am to 5pm Monday to Friday in the
timezone of the application server. This can be set individually for a site, lab, shift, or user. In this version,
if no core hours are set, the system now assumes working hours are 7 days a week and 24 hours a day
in the timezone of the site.
5.30.3 Timezone Assignment and Adjustments

Departments and Instruments can now be assigned a specific Timezone using the new “Timezone” field.
This allows the Calendar page to present its data in a timezone of the user’s choosing. By default, the
viewer’s (“You”) timezone is selected. The dropdown list offers the option to switch to either the calendar
owner’s timezone (if different) or the browser’s timezone (if different). This latter option effectively allows
the user to view the calendar in any timezone they please (by switching the timezone of the computer and
refreshing the page).
The planning page and manage-work pages also presents a list of timezones based on the timezones of
the Department, Planner or browser. When a new timezone is selected, the calendar updates to show
activities and appointments in this timezone. Any date columns in the planning page list (such as a “due
date”) adjusts to the selected timezone.
5.30.4 Requirement for Recurring Appointments

In prior versions, calculating the actual date and time of an appointment for a repeating event would
present some challenges when the timezone of the current user and the timezone of the calendar are not
the same. This is especially true when the user’s timezone participates in daylight savings time
adjustments. Now, you can only create a recurring appointment in a calendar if you are logged as a user
in the same timezone as the calendar’s owner. The calendar owner is defined as the user, department or
instrument to whom the calendar belongs. If the calendar is a global calendar, the user must be in the

Page 86 of 86
server’s timezone. If an attempt is made to add an appointment to a calendar and the current user is in a
different timezone than said calendar, the “Repeat Event” options will be disabled.


LabVantage 8.8.x ReleaseNotes - 221207 880

Uploaded by

Document Information

Original Title

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

LabVantage 8.8.x ReleaseNotes - 221207 880

Uploaded by

Copyright:

Available Formats

LabVantage 8.8.

Subject: LabVantage 8.8.0 Release Notes

Document Revision: 221207-88

CONFIDENTIAL INFORMATION – PROPERTY OF LABVANTAGE SOLUTIONS, INC.

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

FOR CUSTOMER’S INTERNAL BUSINESS PURPOSES ONLY

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

Revision Date Changes

221207-88 7-Dec-2022 First revision to support LabVantage 8.8.0.

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

Role Name, Signature and Date

Author Digitally signed by Aaron Mills

Role Name, Signature and Date

Reviewer Digitally signed by Matthew Grulke

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

3.4 Post-Upgrade Notes .................................................................................................................... 28

5.2.3 QC Batch Templates for LES ...................................................................................... 38

5.6.1 Display of PropertyTree Data in the View .................................................................... 48

5.12.5 Hourly Expirations Date Unit ........................................................................................ 56

5.15.2 Consistent Empower Column Naming ......................................................................... 63

5.19.21 Role Security for Portal Pages and Operations ........................................................... 70

5.24.4 Vulnerabilities ............................................................................................................... 78

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

5.30.2 Core Hours ................................................................................................................... 85

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

1. Introduction Description of these Release Notes and other

3. Upgrade Considerations High-level overview of LabVantage 8.8.0 upgrades.

4. Major New Features in LabVantage Descriptions of major new features introduced in

5. Additional New Features and Descriptions of other new features and

6. Maintenance Releases Descriptions of LabVantage 8.8.x Maintenance

7. Appendices Additional information appended as required.

1.2 Configuration Reports

LV[PR]Config- Differential Reports showing the deltas between previous consecutive

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

1.3 Transmaster Spreadsheets

1.4 Data Model

1.5 LabVantage Documentation

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

2 PLATFORM SUPPORT AND CERTIFICATION SYSTEMS

2.1 Supported Software

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

2.1.1 Supported Application Server and DBMS Platforms

2.1.2 Operating System Support

2.1.3 Red Hat JBoss EAP Supported Platforms

JBoss Minimally patched to Minimally patched to

Oracle JDK 1.8 Not Supported

Red Hat OpenJDK 11 11

Red Hat JBoss Core 2.4.37 Minimally 2.4.37 Minimally

2.1.4 IBM WebSphere Not Supported for 8.8.0

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.

2.1.5 Oracle WebLogic Supported Platforms

For LV 8.8 WebLogic 12.2

Oracle JDK 1.8.0_351 or higher

For additional information, please see Oracle's Fusion Middleware Support

2.1.6 Oracle RDBMS Support

LabVantage Oracle 18 Oracle 19

8.8.x 18c 19c

2.1.7 Microsoft SQL Server RDBMS Support

LabVantage MSS 2017 MSS 2019

8.8.x 14.0.2002.14 or higher 15.0.2095.3 or higher

2.1.8 JDBC Drivers

2.1.9 Supported Web Browsers

CONFIDENTIAL - PROPERTY OF LABVANTAGE SOLUTIONS, INC.