History of Changes During LabVantage 8.2.x

Document Revisions

Revision	Date	Description
170901-82	01-Sep-2017	Fifth revision to provide a LabVantage 8.2.x document maintenance release.
170515-82	15-May-2017	Fourth revision to provide a LabVantage 8.2.x document maintenance release.
170323-82	23-Mar-2017	Third revision to provide a LabVantage 8.2.x document maintenance release.
170210-82	10-Feb-2017	Second revision to provide a LabVantage 8.2.x document maintenance release.
170111-82	11-Jan-2017	Initial document release to support LabVantage 8.2.

Changes Made in Document Revision 170901-82

Web Page Designer (General)

This document revision contains changes affecting these areas of LabVantage functionality:

The links below describe changes made in previous document revisions that support the LabVantage 8.2.x codeline:

Changes Made in Document Revision 170515-82

Changes Made in Document Revision 170323-82

History of changes from V1.1 (02-Nov-1999) through LabVantage 8.1.x (03-Aug-2017)

To examine changes made in document revisions prior to LabVantage 8.2.x, follow this link:

BioBanking

This change was made as a document correction:

In BioBanking Sample Operations → Basic Operations → Allocate Samples, changed the description of the Study Id column. This previously stated that the lookup was restricted to Active Studies.

Requirement: LV-27327 VC: 0016431

Calculations

This change was made to update third-party information:

In Concepts of Transformations and Calculations → Calculation Rules, changed Groovy reference to the Apache Software Foundation (http://www.groovy-lang.org/).

Requirement: None.

Data Entry

These changes were made to provide additional information concerning existing functionality:

In Data Entry Pages → Editing Features → Toolbar, added information about the "Paste" operation concerning Chromes security restriction preventing access to the User's clipboard.

Requirement: LV-25637. VC: 0016144.

In Data Entry Pages → Editing Features → Toolbar, added information about the "Mark Outlier" operation concerning behavior if no match is found for a token in the Calculation.

Requirement: LV-22507. VC: 0016051.

This change was made to provide additional information concerning existing functionality:

In gwtdataentrygrid Element, added information to the "Details" collection concerning the Addheaders filter in the deployment descriptor.

Requirement: LV-23723. VC: 0014183.

ELN/LES

These changes were made as document corrections:

In Introduction to LabVantage ELN/LES → LabVantage ELN/LES Implementation → ELN Structural Components, changed "Notebook" to "Workbook" in one of the Workbook examples in the diagram.

Requirement: None.

In ELN/LES Worksheet Manager → Detail Panels → Notes → Extended Note Functionality, removed reference to exporting Notes and Comments.

Requirement: None.

Expression Editor

This change was made to provide additional information concerning existing functionality:

In Expression Library and Expression Editor → Expression Editor → LabVantage Aggregate Expressions, added Note 4 concerning the round( [x], n ) expression.

Requirement: None.

Gizmo Notifications

These changes were made to describe new functionality added to LabVantage 8.2.3:

In bulletingizmo and urlgizmo, added "Enable Refresh on Events" property.

Requirement: LV-24399. VC: 0016156.

Parameter Lists

This change was made to provide additional information concerning existing functionality:

In Parameter Lists → Description → Data added a note to the "Parameter" field stating the implications of using the AddSDIDetail Action to add a non-existent Parameter.

Requirement: None.

Passwords

This change was made to describe functionality that has changed in LabVantage 8.2.3:

In Obtaining a New Password, added a new feature that checks the Web Application Base URL first.

Requirement: LV-23985. VC: 0016128.

Scheduler

This change was made as a document correction:

In Schedule Plans and Schedule Groups → Schedule Plans, changed the tramstop for the Location List page.

Requirement: LV-27204. VC: 0016342.

Storage

This change was made as a document correction:

In Manage Storage Restrictions, changed the Operator "In" and "Not In" conditions to accept a comma-delimited string (such as Value1,Value2).

Requirement: None.

This change was made to describe new functionality added to LabVantage 8.2.3:

In Storage Unit Types, added the "Update Content Custody" property.

Requirement: LV-26129. VC: 0016413.

Tests

This change was made to describe new functionality added to LabVantage 8.2.3:

In Manage Data Sets, Manage Tests, and Manage Worksheets → Manage Tests → Apply, added enhancement to deal with Applying multiple Tests.

Requirement: LV-26015. VC: 0016371.

Web Page Designer (General)

This change was made as a document correction:

Removed outdated "Specialized Variables" section from Naming Restrictions and Syntax Standards. Corrected information concerning [currentdevice] (it cannot be used in Action buttons), then moved the variables information to Web Page Designer: Properties Overview → Properties Overview → Specialized Variables.

Requirement: None. VC: 0016437.

Changes Made in Document Revision 170515-82

Changes Made in Document Revision 170323-82

This document revision contains changes affecting these areas of LabVantage functionality:

Action Public Interfaces

Storage

The links below describe changes made in previous document revisions that support the LabVantage 8.2.x codeline:

History of changes from V1.1 (02-Nov-1999) through LabVantage 8.1.x (02-Dec-2016)

To examine changes made in document revisions prior to LabVantage 8.2.x, follow this link:

Action Public Interfaces

This change was made to update the System Action Public API:

Updated the Javadoc for the System Action Public Interfaces.

Requirements: None. This Javadoc is derived from Java Interfaces in the source code and rebuilt in each document release to detect changes made to System Actions.

Also see ELN/LES.

ELN/LES

These changes were made to include information omitted from the previous document release:

Added ELN APIs.

Requirement: None. VC: None.

Added ExportWorksheet Action.

Requirement: LV-22247. VC: 16021.

These changes were made as document corrections:

In Equipment Control and Reagents Control, changed the "Operations" property (in the "Operations" collection) to "Page".

Requirement: None. VC: None.

In File Viewer Control, stated the precise location of uploaded files.

Requirement: None. VC: None.

Enterprise Connector

This change was made as a document correction:

In LabVantage Enterprise Connector → Using the SAPMsgType → Incoming Message Example 1, added the creation of a non-SAP Message Type to step 2 of the example.

Requirement: LV-21369. VC: 0014456.

Java Public API

This change was made to update the Java Public API:

Updated the Javadoc for the Java Public API.

Requirements: None. This Javadoc is derived from source code and rebuilt in each document release to detect changes made to classes in the sapphire.* packages.

Miscellaneous

This change was made to remove obsolete information:

In Naming Restrictions and Syntax Standards, removed information concerning SQL Server column restrictions (it is no longer an issue).

Requirement: None. VC: None.

Policies

This change was made to clarify existing information:

In Copy-Down Policy, simplified the examples of copy-down behavior when using SDI Templates, and added a link to the detail section concerning Tests and Specifications.

Requirement: LV-21697. VC: 0015979.

Security

This change was made as a document correction:

In Security Policy, changed the default value of "Request Filter → Sanitize Request" from "No" to "Yes".

Requirement: LV-21367. VC: 0013868.

Stability

This change was made to describe new functionality added to LabVantage 8.2.2:

In Stability Plans → Creating a Plan Template, noted that locked records are identified by a red padlock icon.

Requirement: LV-21108. VC: 0015721.

Storage

These changes were made to describe new functionality added to LabVantage 8.2.2:

In TrackItemManagement Page Type, added "View Pages" property collection.

Requirement: LV-21110. VC: 0015058.

In Storage Unit Types, added "Synchronize Content Custody" property.

Requirement: LV-20962. VC: 0015886.

This change was made as a document correction:

In Package Overview → Package Status Transitions → PKG Packages and CDT Packages, changed the Status Transition for "Unpack Package" and "Unpack CDT" from "Receive → Unpacked" to "Received → Emptied".

In Move Samples → Transfer → CDT Packages Lifecycle, changed the Status Transition for "Unpack CDT" from "Receive → Unpacked" to "Received → Emptied".

Requirement: LV-14644. VC: 0014847.

Changes Made in Document Revision 170323-82

This document revision contains changes affecting these areas of LabVantage functionality:

Action Public Interfaces

Data File Definitions

The links below describe changes made in previous document revisions that support the LabVantage 8.2.x codeline:

History of changes from V1.1 (02-Nov-1999) through LabVantage 8.1.x (02-Dec-2016)

To examine changes made in document revisions prior to LabVantage 8.2.x, follow this link:

Action Public Interfaces

This change was made to update the System Action Public API:

Updated the Javadoc for the System Action Public Interfaces.

Requirements: None. This Javadoc is derived from Java Interfaces in the source code and rebuilt in each document release to detect changes made to System Actions.

Also see Array Management.

AQC

This change was made to describe functionality changed in LabVantage 8.2.1:

In QC Batches → QC Batch Items Detail, noted new Sample removal rule for the "Remove" button.

Requirement: LV-18496. VC: 0015397.

Array Management

This change was made to describe new functionality added to LabVantage 8.2.1:

New properties have been added to the Actions shown below to indicate when the source volume falls below zero and provide the required validation:

•	In the AdjustTrackItemInv Action, the "validatequantity" property has been added.
•	In the EditArrayItem Action, the "validatetotalvolume" property has been added.
•	In the Load Array, LoadArrayByPosition, and TransferArray Actions, the "validatesourcevolume" property has been added.

Requirement: LV-20419. VC: 0015760.

Attachments

This change was made as a document correction:

In File Location Policy, changed the File Types in the "Attachment Excludes" collection to specify a semicolon-delimited list using only the three-character extension.

Requirement: LV-20528. VC: 0015840.

BioBanking

This change was made to describe new functionality added to LabVantage 8.2.1:

In BioBanking Policy, added "Optimize Child Sample Creation" property.

Requirement: LV-19183. VC: 0015494.

Dashboards

This change was made as a document correction:

In groupgizmo, identified the "Gizmo Properties" that apply only to pre-LabVantage 8 "Classic Dashboards".

Requirement: LV-18891. VC: 0015040.

Data Entry

This change was made to clarify existing information:

In Data Entry Policy → Update Released Calcs, explicitly stated that the default value refers to leaving the property blank.

Requirement: LV-20857. VC: 0013708.

This change was made as a document correction:

In Data Entry Policy → Enter Default Values On Add, noted that the CopyDataSet Action always copies the Default Value.

Requirement: LV-21442. VC: None.

This change was made to describe functionality that has been changed in LabVantage 8.2.1:

In Data Entry Policy → Enter Default Values On Add, noted that the Default Value is not shown if entered text is blank.

Requirement: LV-19916. VC: 0015741.

Data File Definitions

These changes were made to describe new functionality added to LabVantage 8.2.1:

In Data File Definition → Importing the Data, changed the upload location to use the File Location Policy.

In File Location Policy, added the Data File Definition upload location.

Requirement: LV-20355. VC: 0015758.

eForms

These changes were made to describe new functionality added to LabVantage 8.2.1:

In Form Builder Fields → Adding Fields to Forms, added the "Width" property.

Requirement: LV-21038. VC: 0015902.

In Form Builder Overview → Editing Frame → Menus → Table, added "Table Layout" menu item.

Requirement: LV-21045. VC: 0015903.

This change was made as a document correction:

In Form Builder Overview → Editing Frame → Menus → Table, corrected two typographical errors in the "Width" and "style" property descriptions.

Requirement: None. VC: None.

Java Public API

This change was made to update the Java Public API:

Updated the Javadoc for the Java Public API.

Requirements: None. This Javadoc is derived from source code and rebuilt in each document release to detect changes made to classes in the sapphire.* packages.

Labels

These changes were made to include information omitted from the previous document release:

In Labels:

•	Replaced references to "Commander" with "Integration software" (as applicable) throughout the document.
•	In Bartender Integration, added references to the new Integration Builder in Bartender 2016.
•	In Bartender Templates, added references to Seagull Scientific documentation for Bartender 2016, and added guidelines for creating a data source in the Bartender Integration Builder.
•	Changed "Setting Up Tasks" to Setting Up Tasks or Integrations to cover changes in Bartender terminology, added references to Seagull Scientific documentation for Bartender 2016, and added guidelines for creating an Integration in the Bartender Integration Builder.

Requirement: LV-20058. VC: 0015750.

These changes were made as document corrections:

In Labels:

•	In Label Methods, deleted a reference to the "Test Sql" button, which was removed in an earlier LabVantage version.
•	Changed the default Label location to LABVANTAGE_HOME\APPLICATION_HOME\labels throughout.
•	In Label Events → Label Events List, removed strikethrough debug comments remaining from the LabVantage 8.x interface redesign.

Reporting

These changes were made as document corrections:

In Reports and Execute Reports → Using Unicode in Jasper Reports, changed the location of the custom font JAR to the EAR\lib directory.

In Reporting Caveats and Unicode Fonts in Jasper Reports and "View As PDF", removed obsolete information and replaced it with a link to the Reporting topic referenced above.

Requirement: None. VC: 0065651.

SDC Maintenance

This change was made to include information omitted from the previous document release:

In SDCs → SDC Table Maintenance → Columns, added the "Decimal" Data Type with a table showing how "Numeric" and "Decimal" LabVantage Data Types correspond to numeric data types defined by the DBMS in use.

Requirement: None. VC: 0063814.

Security

These changes were made to describe new functionality added to LabVantage 8.2.1:

In File Location Policy, added new behavior of LabVantage file lookup dialog in LabVantage 8.2.1 and higher. Also added nodes configured OOB.

Requirement: LV-19174. VC: 0015386.

Thread Profiler

These changes were made to describe functionality that has been changed in LabVantage 8.2.1:

In Thread Logging Policy, noted that "Thread Logging → Log Mode" is set to "Never" by default in LabVantage 8.2.1 and higher.

In Thread Profiler → Overview → Requirements, noted that the "Thread Logging → Log Mode" of the Thread Logging Policy must be enabled (it is now disabled by default in LabVantage 8.2.1 and higher).

Requirement: LV-19912. VC: 0015743.

Web Services

This change was made as a document correction:

In Axis and JAX Web Services → SapphireWS → Generating the WSDL and Source Files for Sapphire WS, updated the example for the Service Locator and stubs to use the most recent labvantage.ear structure.

Requirement: None. VC: None.

Changes Made in Document Revision 170210-82

This document revision contains changes affecting these areas of LabVantage functionality:

JavaScript Global API

Parameter Lists

Reporting

Storage

The links below describe changes made in previous document revisions that support the LabVantage 8.2.x codeline:

History of changes from V1.1 (02-Nov-1999) through LabVantage 8.1.x (02-Dec-2016)

To examine changes made in document revisions prior to LabVantage 8.2.x, follow this link:

Action Block Editor

This change was made to include information omitted from the previous document release:

In Action Block Editor, added Specifying Property Values as Groovy Expressions to describe Groovy expressions for evaluation of property values.

Requirement: None.

In Data File Definition:

•	In Creating a Processing Script, added a reference regarding syntax required in the Action Block Editor (using Alt-G for expressions as property values) if the Data File Definition's "Process Block Size" is set to more than 1 item.
•	In Groovy Utilities, added an example of of the above syntax using the propertyutil.replaceListItems method.

Requirement: None.

Adhoc Queries

This change was made as a document correction:

In AdHocQuery Page Type, added a missing closing bracket to the example token for Parameter List Description substitution shown in the "Searchable SDCs → Data Entry Search" collection.

Requirement: None.

AQC

This change was made to to include information omitted from the previous document release:

In QC Methods → Test Method Detail, added a note indicating that a Test Method Group cannot be used when defining QC Batches and, if selected, associated Samples will not display as candidates when defining the QC Batch.

Requirement: LV-18789. VC: 0015398.

Array Management

This change was made to include information omitted from the previous document release:

In Arrays Policy, added "Content Page Mapping" property collection.

Requirement: None. VC: 0015446.

Attachments

This change was made to clarify existing information:

In File Location Policy, added nodes configured OOB for functionality affected by this Policy. With specific regard to Attachments, installed links to the Attachment Manager page for the Reference, Store, and Upload and Reference Attachment Types.

Requirement: LV-18269. VC: 0015110.

Batch Management

This change was made as a document correction:

In Batch Operations → Batch List Pages → To be Released List Page → Buttons, added details for "Review and Release" and "Reject" concerning when the "Released By" field is filled (or blank), depending on which process is used to Reject the Batch.

Requirement: LV-18522. VC: 0015263.

Calculations

This change was made to clarify existing information:

In Expression Library and Expression Editor → Expression Editor → LabVantage Aggregate Expressions → astmround( [x], n ), revised the introductory description of this function to clarify that only the decimal-based rounding methods in paragraph 6 of ASTM E29 apply.

Requirement: None. VC: 0064328.

Data Entry

This change was made as a document correction:

In Data Entry Pages → Data Entry Views → Overview, removed a note stating that copy/paste is supported only in Internet Explorer.

Requirement: LV-19262. VC: 0014807.

JavaScript Global API

This change was made as a document correction:

In JavaScript Global API → sapphire.ajax object, changed the description of the errorCallback parameter for the callClass, callService, and callCommand methods to note that errors are shown only in the browser console.

Requirement: None. VC: 0064333.

Parameter Lists

This change was made as a document correction:

In Parameter Lists → Description → Parameter List and Sample Maintenance → Sample Details → Data Sets, changed the description of the "Modifiable" flag. Also changed the behavior of the arrow buttons on the Sample Maintenance Data Set detail.

Requirement: None.

Reporting

These changes were made to describe new functionality:

In Reports and Execute Reports → Reports, noted that "Location" is determined by the File Location Policy.

Requirement: LV-15526. VC: 0015154.

In File Location Policy, added Reports to list of affected functionality. Also added nodes configured OOB.

Requirement: LV-15526. VC: 0015154.

Storage

These changes were made as document corrections:

In Trackable Items → Overview, in the "ASL" section of the table, added "Sample (In Biobanking, only when Study Id is assigned)" to note when Trackable Items are created for Samples in BioBanking.

Requirement: LV-18300. VC: 0015146.

In the "Users" section of Contacts → Addresses in Biobanking, specified that Contact information must be defined in User Preferences through the User icon in the upper right of the Layout. Removed text suggesting that Contact information can be changed on the User Maintenance page.

Requirement: LV-18927. VC: 0015020.

Changes Made in Document Revision 170111-82