Content

Document Revisions

Changes Made in Document Revision 190621-83
Changes Made in Document Revision 181117-83
Changes Made in Document Revision 180703-83
Changes Made in Document Revision 180111-83
Changes Made in Document Revision 170927-83
 
 

 

   

 

Document Revisions

Top
Revision Date Description
190621-83 21-Jun-2019 Fifth revision to provide a LabVantage 8.3.x document maintenance release.
181117-83 17-Nov-2018 Fourth revision to provide a LabVantage 8.3.x document maintenance release.
180703-83 03-Jul-2018 Third revision to provide a LabVantage 8.3.x document maintenance release.
180111-83 11-Jan-2018 Second revision to provide a LabVantage 8.3.x document maintenance release.
170927-83 27-Sep-2017 Initial document release to support LabVantage 8.3.0.

 

Changes Made in Revision 190621-83

Top
This document revision contains changes affecting these areas of LabVantage functionality:
Attachments
Auditing
System Configuration
 
   
   
     
           
   
   
                      
To examine changes made in document revisions prior to LabVantage 8.3.x, follow this link:
History of changes from V1.1 (02-Nov-1999) through LabVantage 8.2.x (01-Sep-2017)

 

Attachments

 

This change was made to describe functionality that has been added in LabVantage 8.3.5:

In Attachment Policy, added "Thumbnails" property collection.

Requirement: LV-39423. VC: 0018539.

Auditing

 

This change was made to describe functionality that has been modified in LabVantage 8.3.5:

In advancedtoolbar Element, added details concerning the setDSESigReason call in the "Buttons → Electronic Signature → Set Audit Reason Callback" property.

Requirement: LV-40870. VC: 0018887.

System Configuration

 

This change was made to describe functionality that has been added in LabVantage 8.3.5:

In System Configuration → Miscellaneous Options → Mail Settings, added "Additional Mail Server Connection Properties", "Mail Server User Name", and "Mail Server Password" properties.

Requirement: LV-38743. VC: 0012398.

 

Changes Made in Revision 181117-83

Top
This document revision contains changes affecting these areas of LabVantage functionality:
Expressions
Certifications
JavaScript Global API
Specifications
Storage
Versioning and Approval
User Interface (Miscellaneous)
 
   
   
     
   
           
   
   
   
                      
To examine changes made in document revisions prior to LabVantage 8.3.x, follow this link:
History of changes from V1.1 (02-Nov-1999) through LabVantage 8.2.x (01-Sep-2017)

 

Expressions

 

This change was made as a document correction:

In Expression Library and Expression Editor → Expression Library, removed "Days Between".

Requirement: None. VC: 0077867.

Certifications

 

These changes were made as document corrections:

In Instrument Certification:
Removed "Rejected" from the list of Workorder Statuses.

Requirement: LV-33761 VC: 0016802.

Removed "Maintain Certifications" information.

Requirement: LV-33771 VC: 0017772.

JavaScript Global API

 

This change was made as a document correction:

In Object: sapphire.connection, removed the connectionId property.

Requirement: LV-28225. VC: 0016779.

Specifications

 

This change was made as a document correction:

In Data Entry Policy, added "Spec Condition Display Option".

Requirement: LV-32940. VC: 0017888.

Storage

 

This change was made as a document correction:

In Assign Storage, noted that Users having the ASL module assigned cannot Assign Storage using the Sample Maintenance page.

Requirement: LV-29995. VC: 0017249.

Versioning and Approval

 

These changes were made as document corrections:

In Concepts of Versioning → SDI Approval Without Approval Types, removed reference to "Reset Approvals".

Requirements: LV-33183. VC: 0017918.

In Approval Types → Description → Approval Steps, removed SysUser.CreateBy and SysUser.ModBy from "Peer Required" as Users who are prevented from approving data.

Requirement: LV-34082. VC: 0018043.

User Interface (Miscellaneous)

 

This change was made as a document correction:

In Active and Inactive SDIs, removed statement concerning Enabled/Disabled Users, as it is irrelevant.

Requirements: LV-33342. VC: 0017498.

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

In GUI Policy, listed variables that can be used with Status Bar Properties → Session Text.

Requirement: None. VC: I000078113.

In Date Format Policy, added additional information regarding "Calendar Lookup" defaults.

Requirement: None. VC: 0017154.

Changes Made in Document Revision 180703-83

Top
This document revision contains changes affecting these areas of LabVantage functionality:
Batch Management
BioBanking
Configuration Transfer Tools
Data Entry
eForms
ELN/LES
JavaScript Global API
Notes
Parameter Lists
 
Reagents
Sample Monitoring
Scheduler        
Security Policy
System Configuration
User Interface (Miscellaneous)
Web Page Designer (Miscellaneous)
Workflows
           
   
   
   
                      
To examine changes made in document revisions prior to LabVantage 8.3.x, follow this link:
History of changes from V1.1 (02-Nov-1999) through LabVantage 8.2.x (01-Sep-2017)

 

Batch Management

 

This change was made to include more information concerning existing functionality:

In Batch Sample Policy, added Requests to the "Cancel Action Behavior" property.

Requirement: None.

BioBanking

 

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

In BioBanking Policy, added "Storage Explorer → Refresh Statistics" property.

Requirement: LV-30429. VC: 0017338.

Configuration Transfer Tools

 

This change was made to include more information concerning existing functionality:

In Configuration Transfer Tools, added Exporting Workflow Definitions.

Requirement: None.

Data Entry

 

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

In Data Entry Policy, added new property "Entered Optional Result Require Release".

Requirement: LV-29314. VC: 0016575.

These changes were made as document corrections: 

In Data Entry Pages:
In Toolbar, changed "Show" to refer to item 24.

Requirement: None.

Removed an erroneous bulleted list in the "Data Trend" section resulting from topic reorganization in the previous document revision.

Requirement: None.

eForms

 

This change was made as a document correction: 

In Form Definitions → Form Maintenance → Form Options, changed description of "Validate Data when Drafting".

Requirement: None.

ELN/LES

 

This change was made as a document correction: 

In LES Worksheet Generation → Basic OOB LES Worksheet Generation Examples → Example: Definition SDI = Instrument Type, changed Worksheet Template to Instrument Certification LES Worksheet.

Requirement: LV-31056. VC: 0017434.

In SDI Viewer Control → Description, removed an illegal character that incorrectly rendered a sentence.

Requirement: None.

JavaScript Global API

 

This change was made to update existing functionality: 

In JavaScript Guide → Preventing Memory Leaks, changed the circular reference example to use window.addEventListener rather than window.attachEvent.

Requirement: None.

Notes

 

These changes were made as document corrections: 

In Notes:
In Overview, removed the requirement that Follow-Up and Statement Notes required resolution before processing can continue.
In Adding Follow-Up Notes, removed the requirement that resolution is required before Sample can transition to complete.

Requirement: None.

Parameter Lists

 

These changes were made as document corrections:

In Parameter Lists → Specifying Parameter Limit Values, changed the opening statement to clarify that Parameter Limit Types are used.

Requirement: None.

In Expression Library and Expression Editor → Expression Editor → Expression Helpers, added missing link to "Filtering" in the Parameter List Helper and "AQC" in the Cross SDI Helper.

Requirement: None.

Reagents

 

This change was made to include more information concerning existing functionality:

In Reagent Lots → Adding Reagent Lots → General Information ("Expiry Date" field) and Reagent Tasks, added information concerning how (and to whom) notifications are sent when expiration or reorder is reached.

Requirement: None.

Sample Monitoring

 

This change was made to include more information concerning existing functionality:

In Overview → Introduction, noted that Sample Monitoring requires a site-wide license.

Requirement: None.

Scheduler

 

This change was made as a document correction:

In Location → Add a Location → Randomized Scheduling, changed the "Rolling" option to "Random".

Requirement: None.

Security Policy

 

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

In Security Policy:
Added new "Share History Entries" property to the "Session Management" collection.

Requirement: LV-30998. VC: 0017457.

Added new "Query Where Filter" property.

Requirement: LV-30991. VC: 0017460.

System Configuration

 

This change was made to include more information concerning existing functionality:

In System Configuration → API Options, added Custom SQL Register with examples.

Requirement: LV-31788. VC: 0017659.

User Interface (Miscellaneous)

 

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

In GUI Policy, added new "Adapt For Touch" property.

Requirement: LV-29334. VC: 0017114.

Web Page Designer (Miscellaneous)

 

These changes were made as document corrections: 

In maintattribute Element → Adding a maintattribute Element, changed "Maintenance Mode" in step 6 of the example to "Linked".

Requirement: None.

In advancedtoolbar Element:
In Buttons → Action Button Properties → Actions → Identifier, removed the requirement that this must match the Identifier property for the Button.
In Buttons → Action Button Properties → Actions → Input Properties (and corresponding Output Properties), added the "Identifier" property.

Requirement: None.

Workflows

 

These changes were made to include more information concerning existing functionality: 

Added more information concerning System Tasks and User Tasks in these areas:
In Introduction to Workflows, noted that The Basics of Building a Workflow and The Basics of Executing a Workflow utilize User Tasks.
In Workflow Task Definition Maintenance Page → New Task Details → Task Detail, added more information concerning System Tasks.
In Workflow Task Definitions → Workflow Task Definition Index, identified System Tasks and User Tasks.
Added a note to identify these as User Tasks: AddBatch, AddRequest, AddSample, AddSampleDataset, AddSampleSpecification, AddSampleTest, ChangeSampleStatus, CreateQCBatchForPreciousMetals, EditBatch, EditSample, EnterSampleData, ImportArrayResults, LoadArray, LoginSample, ManageBatchAttributes, ManageRequestAttributes, ManageSample, ManageSampleAttachments, ManageSampleAttributes, ReviewQCBatch, ReviewSample, ViewSampleAttachments, ViewSampleReport.

Requirement: LV-30869. VC: 0016998.

 

 

Changes Made in Document Revision 180111-83

Top
This document revision contains changes affecting these areas of LabVantage functionality:
Array Management
Certifications
Chain of Custody
Date Format Policy
 
eForms
ELN/LES
JavaScript Global API
Reporting
           
   
   
   
                      
To examine changes made in document revisions prior to LabVantage 8.3.x, follow this link:
History of changes from V1.1 (02-Nov-1999) through LabVantage 8.2.x (01-Sep-2017)

 

Array Management

 

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

In Arrays Policy, added "Child Sample Storage Status" property.

Requirement: LV-28237. VC: 0016793.

Certifications

 

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

In By Analyst, added information regarding adding a Witness into the Chain of Custody when certifying a User for a Controlled Substance.

Requirement: None.

Chain of Custody

 

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

Moved Chain of Custody into its own topic and updated to include most recent functionality.

Requirement: None.

Date Format Policy

 

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

In Date Format Policy, added a note to indicate that changes made to the Policy require a server restart.

Requirement: None.

eForms

 

This change was made to provide advance notice of feature deprecation: 

In Introduction to eForms → eForms Functionality Module Exclusions, added a note concerning the deprecation of eForm Worksheets in a future LabVantage release. This was previously stated only in the Release Notes.

Requirement: None.

ELN/LES

 

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

Added missing substitution tokens in the following areas:
LES Global Worksheet Template for Test Methods → LES Worksheet Template OOB Configuration → Template Structure.
LES Global Worksheet Template for QC Methods → LES Worksheet Template OOB Configuration → Template Structure.
LES Global Worksheet Template for Instrument Model/Type → LES Worksheet Template OOB Configuration → Template Structure.
LES Global Worksheet Template for Sample Type/Sub Type → LES Worksheet Template OOB Configuration → Template Structure.

Requirement: None.

JavaScript Global API

 

This change was made to update the API:

Added the "open" method to the sapphire.lookup object.

Requirement: None.

Reporting

 

This change was made as a document correction:

In Using Jaspersoft Studio with LabVantage → Using Unicode in Jasper Reports, removed steps related to uploading the font JAR to the Jaspersoft library and including the JAR in the LabVantage EAR library.

Requirement: None.

 

Changes Made in Document Revision 170927-83

Top
This document revision contains changes affecting these areas of LabVantage functionality:
Action Public Interfaces
AQC
Array Management
Attachments
Auditing
BioBanking
Document Maintenance (General)
eForms
ELN/LES
Empower Connector
Event Plans
 
External Authentication 
Gizmo Notifications
Indexing and Searching
Java Public API
JavaScript Global API
Job Types
Labels
Languages and Translation
Maintenance Pages (General)
Notes
Phrases
Query Management
Reagents
Reporting
Stability
Storage
User Interface (Miscellaneous)
Validation
Web Page Designer (Miscellaneous)
Web Services
                      
To examine changes made in document revisions prior to LabVantage 8.3.x, follow this link:
History of changes from V1.1 (02-Nov-1999) through LabVantage 8.2.x (01-Sep-2017)

 

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.

AQC

 

The AQC documentation has been reworked to generally add more information, as well as describe new and modified functionality:

Added QC Batch Overview as a starting point for using AQC.

Requirement: None.

In QC Rules, provided more details about adding a QC Rule.

Requirement: None.

In Entering Data For QC Batches, added information about choosing Instruments and Reagents.

Requirement: None.

In Reviewing QC Batches, added more information about the process of reviewing a QC Batch (including the Historical QC Batch List page).

Requirement: None.

In QC Calculations, detailed the additional Parameters required for each QC Calculation.

Requirement: None.

In QC Methods and QC Batches, added Amount Scope as well as more detailed information about defining QC Methods and managing existing QC Batches.

Requirement: LV-23575.

Array Management

 

These changes were made to describe new and modified functionality: 

In Array Operations:
Noted that the Load Array and Cherry Picking pages now provide an advancedsearch Element.

Requirement: LV-19729.

Added the Take Custody and Ship operations.

Requirement: LV-20362.

In Array Management API Usage Examples → Custom Plate Transfer and Transfer Methods → Method Details, added new Target Volume fields.

Requirement: LV-20369.

In Master Data Setup, documented changes to the Content Type Editor.

Requirement: LV-19730.

In Array Transfers → Cherry Picking, added new available Source Array "list" and search capabilities.

Requirement: LV-20410.

In childsampleplan Element, added new Plan Type property.

Requirement: LV-22334.

Attachments

 

These changes were made to describe new functionality:

Rewrote Attachments in its entirety to reflect new functionality driven by the attachment Element.
In attachment Element:
Added "Default File View", "View Only", "Tab → Group", "Columns → Mode", "Columns → Dropdown RefType", "Columns → DropDdown SQL", "Attachment Types", "Paste From Clipboard", "Attachment Class", and "Attachment Policy Node".
Deprecated "Selector", "Columns → Width", "Buttons", "Button Placement", and "Texts".
In Attachment Policy, added "Upload Attachment Storage Node", "Attachment Types", "Upload Location Policy Node", "Upload Location Location Policy Item", "Server-Side Browsing", "Phrases For Rich Text", and "Maximum Upload Size". Changed descriptions of related properties (such as "File Reference" for the new Storage Modes) to reflect new behavior as required. Added "System Contolled" option to "Rename On Upload" (with example in Attachments → File Rename).
In File Location Policy, changed note concerning Attachments to reference only "File" types.
In Formatted Text Editor → Attachments, added lv_insertphrase to the "Insert" menu.
In AttachmentManager Page Type, added a note to indicate that functionality provided by the AttachmentManager Page Type has been superseded by the new implementation that uses the attachment Element.

Requirements: LV-19800, LV-19803, LV-19804, LV-19805, LV-19806, LV-19807, LV-19808, LV-19809.

Auditing

 

These changes were made to describe new functionality:

In Concepts of Auditing, added Dynamic Auditing.

Requirements: LV-19653, LV-19654, LV-19655, LV-19656, LV-19657, LV-19658, LV-21205.

In Concepts of Auditing, added new AuditView Page.

Requirement: LV-19659.

In MaintenanceForm Page Type, maint Element, maintattribute Element, sdclinkmaint Element, sdidetailmanit Element, and MultiSDIAttributeMaint Page Type, added "Enable Dynamic Audit" property.

Requirements: LV-19653, LV-19654, LV-19655, LV-19656, LV-19657.

In Data Entry Policy, removed "Audit Results Entry" property. Added "Enable Dynamic Audit of Result Entry" property to support the new "Dynamic Auditing" mechanism.

Requirements: LV-19658, LV-21205.

BioBanking

 

These changes were made to describe new and modified functionality:

In Biobanking Samples Operations, Biobanking_Move Samples, and Proxy Packages, changed Perform CDT terminology to Transfer.

Requirement: LV-18738.

Added TakeCustody Page Type to detail properties used to configure the Take Custody dialog.

Requirements: LV-19608, LV-23869.

In Biobanking_Move Samples:
Updated the CDT Package lifecycle to include the option to perform a Transfer on "Received" Samples.

Requirement: LV-19839.

Added the option to select a Department when taking custody of items in the Take Custody dialog.

Requirement: LV-19840.

Added the Find Space option to Track Item Management Pages.

Requirement: LV-15590.

In Accession Samples → Accession Samples and Biobanking Accessioning Data Entry, added the new Accessioning Data Entry page.

Requirement: None.

Document Maintenance (General)

 

These changes were made to remove notes identifying functionality that was changed in the LabVantage 8.1.x and 8.2.x Maintenance Releases, as they are now part of the mainline LabVantage 8.3.x documentation:

In Data Entry Policy, removed the note regarding the "Default Value" change made to "Enter Default Values On Add" in LabVantage 8.2.1.

Requirement: None.

In Thread Logging Policy, removed the note regarding the "Log Mode" default change made in LabVantage 8.2.1.

Requirement: None.

In Data File Definition → Importing the Data, removed the note regarding use of the File Location Policy to determine the upload path in LabVantage 8.2.1 and higher.

Requirement: None.

In File Location Policy, removed the note regarding the Import Data File path change made in LabVantage 8.2.1, and the reference to LabVantage 8.2.1 in the Server-Side File Browser location default.

Requirement: None.

In Form Builder Overview → Editing Frame → Menus → Table, removed the note regarding the "Table Layout" menu item introduced in LabVantage 8.2.1.

Requirement: None.

In Form Builder Fields → Adding Fields to Forms → Overview, removed the note regarding the "Width" property introduced in LabVantage 8.2.1.

Requirement: None.

In TrackitemManagement Page Type, removed the note regarding the "View Pages" property collection introduced in LabVantage 8.2.2.

Requirement: None.

In Storage Unit Types, removed the note regarding the "Synchronize Content Custody" property collection introduced in LabVantage 8.2.2.

Requirement: None.

In Child Sample Policy, removed references to LabVantage 8.1.1 from the note describing default values.

Requirement: None.

eForms

 

This change was made to describe changed functionality:

In Form Builder Fields → Field Properties → Behavior, added a note to the "lookup" Field Type to describe new behavior when Editor style Id "Lookup" mode is set to "Dynamic Lookup".

Requirement: LV-22006.

This change was made to describe new functionality:

In Forms Policy, added the "Custom Buttons → Hide Form Buttons On Readonly" property.

Requirement: LV-9445.

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

In eForm Worksheet Principles → Creating Worksheets, added a note to indicate that "On Creation" Worksheets are created asynchronously using the ToDo List.

Requirement: None.

ELN/LES

 

These changes were made to describe new functionality and changes to existing functionality: 

In Introduction to LabVantage ELN/LES:
In LabVantage ELN/LES Implementation, added QC Methods and Instrument Models/Types to High-Level Definitions and LES Structural Components.

Requirement: LV-18017.

In Introduction to Templates, changed tramstop references to reflect new tramline.

Requirement: LV-18017.

In Example Worksheet Template → Creating the Worksheet Template:
Changed example screens to show QC Batch Control Templates and eliminate all cog icons in the Control toolbars.
Noted that the Data Entry grid is rendered only if Samples qualified for Data Entry exist.
Changed tramstop references to reflect new tramline.
Changed the "Add Content" dialog to reflect new cosmetics.

Requirements: LV-19813, LV-21520.

In Example Worksheet Template → Adding Sections, added a note stating that the appearance and rendering of the "Add Content" dialog depends on the ELN Policy node to which the Worksheet Template is linked.

Requirement: None.

In Example Worksheet:
Changed the procedural steps to reflect the new "Add" button and new "Add Worksheet" dialog. Updated the relevant example screens.

Requirement: LV-18017.

In ELN Worksheet Manager:
In Overview, updated the Worksheet Manager screen.

Requirement: LV-18017.

In Toolbar:
Changed the "Add Worksheet" and "Open Worksheet" descriptions to reflect new dialog options.

Requirement: LV-18017.

Added the "Copy" button.

Requirement: LV-18017.

Added the "Export to HTML option".

Requirement: LV-18026.

Changed "Show References" to reflect new dialog and functionality.

Requirement: None.

Changed "Show Activity Log" to update screen with Worksheet name.

Requirement: LV-18019.

In Section and Control Toolbars:
Removed the description and example of the Cog icon.

Requirement: LV-21520.

In Detail Panels:
In Overview, updated panels to include Reset Details.

Requirement: LV-19836.

  In Actions, noted items that are shown in view-only mode if the User does have the security to edit them.

Requirement: LV-21189.

In Actions → Save as Template, changed dialogs to reflect new "LIMS Data" and "Contributors" options.

Requirement: LV-18016.

Added Actions → Reset Details.

Requirement: LV-19836.

In Actions → Worksheet Options → Worksheet, added "Show reset details" and "Snapshot Control contents on" options.

Requirements: LV-19836, LV-21530.

In Actions → Worksheet Options → Worksheet, changed the "Policy Node" option to "Policy" and the "ELN" node to "ELN/LES".

Requirement: None.

In Actions → Worksheet Options → LES, noted that options apply only to LES Worksheets.

Requirement: None.

In Actions → Worksheet Options → Section Defaults, added "Exclude from export" option.

Requirement: LV-21013.

In Actions → Worksheet Options → Control Defaults, added "Exclude from export", "Refresh on save", and "Refresh on state change" options.

Requirements: LV-21013, LV-21531.

In Actions → Section Options, added "Exclude from export" option.

Requirement: LV-21013.

In Actions → Section Options, added "All Workitems" and "QC Batch Parameter Lists" options to the LES "Repeat Sections Over" option.

Requirement: None.

In Actions → Control Options, added "Exclude from export", "Refresh on save", and "Refresh on state change" options.

Requirement: LV-21013, LV-21531.

In Detail Panels → Actions → Notes, changed Notes functionality to reflect new features.

Requirement: None.

In Detail Panel → Actions → User Privileges → Overview of User Privileges, added feature that notifies of overriding ELN Policy settings.

Requirement: LV-23671.

In Dock, added "Revert" icon.

Requirement: LV-18020.

In ELN/LES General Maintenance Pages:
Added Worksheets.

Requirement: LV-18012.

In Workbook Maintenance:
Added "Status" and "Worksheet Templates" options. Changed the "Add Worksheet" dialog to reflect new functionality.

Requirements: LV-18012, LV-18011, LV-18017.

In Global Template Maintenance → Worksheets, Global Template Maintenance → Controls, Private Template Maintenance → Worksheets, and Private Template Maintenance → Controls:
Added "Copy" button.

Requirement: LV-18012.

In Historical Worksheets, removed "Other Tasks".

Requirement: None.

Changed all tramstop references to reflect new tramline.

Requirement: None.

In ELN/LES Life Cycles, added Workbook Status.

Requirement: LV-18012.

In ELN Policy:
Removed "Worksheet Type" property collection.

Requirement: None.

Added "Show" property to the "Add Content → Controls" and "Add Content → Controls → Controls" collections.

Requirement: LV-21112.

Added a note to the "Add Content → Controls" collection to note that the items rendered in the "Add Content" dialog depend on the ELN Policy node to which the Worksheet Template points.

Requirement: None.

Added "Export Format → Export Options → Export Filename" property.

Requirement: LV-21014.

Added "ChemAxon Settings" collection.

Requirement: LV-22535.

Added "Add Content → Controls → Group Name" property.

Requirement: None.

Added "Allow MS Word", "Allow PDF", and "Allow HTML" properties to the "Export Format → Export Options → Export Filename" collection.

Requirement: LV-26914.

Added new LES Worksheet Generation topic to accommodate new Master Objects, LES Worksheet generation mechanics, OOB Worksheet Templates, and OOB LES functionality. Removed the old "LES Worksheets" topic (which pertained to only Test Methods).

Requirements: LV-19817, LV-19813, LV-21022, LV-19821, LV-19814, LV-22002, LV-21018, LV-21019, LV-17866, LV-22033, LV-20636, LV-19823, LV-15826, LV-24886, LV-24078, LV-24156, LV-24157, LV-24158, LV-24229.

Added new LES Global Worksheet Templates provided OOB:
LES Global Worksheet Template for Instrument Model/Type.

Requirements: LV-20636, LV-19823, LV-15826, LV-24886.

LES Global Worksheet Template for QC Methods.

Requirements: LV-19817, LV-19813, LV-21022, LV-19821, LV-19814, LV-22002, LV-21018, LV-21019, LV-17866, LV-22033.

LES Global Worksheet Template for Sample Type/SubType.

Requirements: LV-24078, LV-24156, LV-24157, LV-24158.

Rewrote LES Global Worksheet Template for Test Methods for consistency with new Templates.

Requirement: LV-24229.

In Instrument Certification Certification Workorders, changed SDICertification Schedule Task to include new "Certification Interval", and added LES Worksheets.

In Schedule Tasks → SDICertification, added "Certification Interval" property.

Requirements: LV-20636, LV-19823, LV-15826, LV-24886.

In Data Entry Policy, added the "Auto Add Instrument to Calibration Dataset" property.

Requirement: LV-24886.

In Copy-Down Policy, added a note in the introduction to describe new feature that supports copy-down of Security Department from QC Method to QC Batch.

Requirement: LV-17866.

In AQC Policy, added the "Copy QC Batch Security Department To QC Samples".

Requirement: LV-17866.

In Test Methods:
In Test Method Form → Test Method, removed "Worksheet Template", "Version", "Workbook", "Workbook Name", and "LES Author Rule".
In Detail Elements, added "Worksheet Templates".

Requirement: LV-24229.

In Sample Types, added "Create LES Worksheet Rule", "Worksheet Templates" detail, and "LES Text" detail.

Requirements: LV-20636, LV-19823, LV-15826, LV-24886.

These additions and modifications have been made to individual Controls:
Added the "Operation Data Source" and "Refresh" properties to the "Operations" collection in these Controls: Attributes, Data Entry, Data Trend, Equipment, Reagents, and SDI Viewer. Note that these properties have also been included in the new QC Batch Viewer and Workorder Viewer Controls.

Requirement: LV-18024.

Added the "ActionBlock" Operation Type and the "Includes" property to these controls: Attributes, Data Entry, Data Trend, Equipment, File Viewer, Reagents, and SDI Viewer. Note that these properties have also been included in the new Chemical Viewer, QC Batch Viewer, and Workorder Viewer Controls.

Requirements: LV-22016, LV-22017.

Added references to new OOB Global Control Templates in these Controls: Attributes, Data Entry, Data Trend, Equipment, QC Batch Viewer, Reagents, SDI Viewer, and Workorder Viewer.

Requirements: LV-19817, LV-19813, LV-21022, LV-19821, LV-19814, LV-22002, LV-21018, LV-21019, LV-17866, LV-22033, LV-20636, LV-19823, LV-15826.

Added Attachments Control.

Requirement: LV-24077.

In Attributes Control, added "Attribute Source" property.

Requirement: LV-22425.

Added Chemical Viewer Control.

Requirements: LV-20624, LV-20625, LV-20626, LV-20627, LV-20628, LV-20629, LV-20630, LV-21500, LV-20631.

In Data Entry Control, added "Auto Release On Save" property, "Query" Data Source option, and "Query Params".

Requirement: None.

In Equipment Control, added feature to identify Instruments defined in Parameter Lists (SDIData) using asterisks, "Equipment Columns" collection, "Primary Sort By" collection, and updated screens.

Requirements: LV-23868, LV-21986.

In File Viewer Control, added new file types (Excel, PowerPoint, and PDF), changed all properties to reflect the latest configuration options, and changed the text file screen to show non-proportional font.

Requirement: LV-19761.

Added Marvin Editor Control.

Requirements: LV-21499, LV-22537, LV-22538.

Added QC Batch Viewer Control.

Requirements: LV-19817, LV-19813, LV-21022, LV-19821, LV-19814, LV-22002, LV-21018, LV-21019, LV-17866, LV-22033.

In Reagents Control, added "Reagent Columns" collection, "Alternative Column title" property, and "Primary Sort By" collection. Updated example screens.

Requirements: LV-23868, LV-21986.

In Rich Text Control, added "Phrase Type" and "Phrase Lookup" properties. Also added reference to Formatted Text Editor sections in the Overview.

Requirement: None.

In SDI Viewer Control, added "Sort By" collection.

Requirement: LV-21986.

In Spreadsheet Control, added new feature to "Data Orientation" and "Date Axis Range Orientation" (for the "Insert Line Chart / Edit Line Chart" collection ) that automatically sets the property when you drag-select the data range (depending on the selected range orientation).

Requirement: LV-21525.

Added Workorder Viewer Control.

Requirements: LV-20636, LV-19823, LV-15826.

In Worksheet Reference Control, added new feature (for both Linked and Copied references) that opens the Worksheet in a new tab and selects the Control or Section.

Requirement: LV-18010.

In ELN/LES APIs → JavaScript API for ELN/LES Worksheets → Worksheet Manager Context, added refreshSection() and refreshWorksheet() methods.

Requirement: LV-18024.

Empower Connector

 

These changes were made to describe new and modified functionality: 

In Empower Connector:
Added a new policy option that lets users decide whether or not to delete reprocessed SDIDataItems.

Requirement: LV-18447.

Added a new Download Rule to allow the SDIWorkItem column to be downloaded to the Empower SampleSetLine Column.

Requirement: LV-22013.

Added new section detailing how to connect to alternative LV LIMS systems in the EmpowerDownload.props and EmpowerUpload.props section.

Requirement: LV-23520.

Added the "Handling Released Results" property to the "LabVantage Configuration → Uploading Peak Options" section.

Requirement: LV-22014.

Event Plans

 

These changes were made to describe new functionality:

In Event Plans → Event Types → Event Type Maintenance Page, added eight Event Types (NoteCreated, SendBulletin, SetBulletinStatus, TaskCompleted, WorkflowCompleted, UserDisabled, UserEnabled, and WorksheetStatusChanged).

Requirement: LV-21519 applies to WorksheetStatusChanged. No requirements for others.

These changes were made as document corrections:

In Event Plans → Event Types → Event Type Maintenance Page, changed "Batch" to "Sample" as the SDC for SampleStatusChanged and SampleValueChanged.

Requirement: None.

External Authentication

 

These changes were made to describe new functionality:

In External Authentication → Authentication Property Manager, renamed the "Default User To Create" collection to "LDAP To LV User Mapping". In "LDAP To LV User Mapping", added "User Mapping Option", "User Column Value Mappings", and "Advanced User Mappings" collections. Also included these new features in the Overview.

Requirement: LV-15828.

Gizmo Notifications

 

These changes were made to describe new functionality:

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

Requirement: LV-24241.

Indexing and Searching

 

These changes were made to describe new functionality:

In Search Policy, added "Analyzer", "Stop Words", and "Extend Standard Stop Words" properties.

Requirement: LV-22011.

Java Public API

 

This change was made to update the 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.

JavaScript Global API

 

These changes were made as document corrections:

In the open method for object sapphire.lookup.date and the openWindow method for object sapphire.lookup.util, changed the lLabVantage property to lSapphire.

Requirement: None.

In the description of object sapphire.page.request, changed the labvantage object to sapphire.

Requirement: None.

In the open method for object sapphire.lookup.reftype, and the openPage, openDefault, and open methods for object sapphire.lookup.sdi, changed the lUseLabVantageDialog property to lUseSapphireDialog.

Requirement: None.

Job Types

 

These changes were made to describe new functionality:

In Concepts of Security → Job Types, added Default Menu and Sidebar. Also updated all screens to reflect this change.

Requirement: LV-18449.

In GUI Policy, added "Do Not Use Job Type Start URL" property.

Requirement: LV-18449.

Labels

 

These changes were made to update references to third-party software:

In Labels, removed references to Commander and procedures applicable to Bartender 10.x.

Requirement: LV-20058. VC: 0015750.

Languages and Translation

 

These changes were made to describe new functionality:

In Translations → Translation Maintenance Page → Basic Translation and Language Maintenance, added description of RTL (right-to-left) option.

Requirement: LV-15827.

In maint Element and sdclinkmaint Element, added "Columns → Language Direction" property.

Requirement: LV-18698.

Added a note describing new translation rules for Reference Types in these areas:
"Columns → Dropdown RefType" property in the maint Element and sdclinkmaint Element.
"Dropdown RefType" property in Editor styles → Modes → Dropdownlist.
"Editor Ref Type" property for "Dropdown" Editor style in Attributes → Prerequisites → Setup the Attributes Master List.
Web Page Designer: Properties Overview → Translating Properties.

Requirement: LV-19652.

Maintenance Pages (General)

 

These changes were made to describe new functionality:

In maint Element:
Added the "GridWithTabGroups" option to the style collection.

Requirement: LV-1924.

Added Tab Groups in Maintenance Grids.

Requirement: LV-1924.

Added Editable Foreign Key Columns.

Requirements: LV-1920, LV-1921, LV-1922.

Added Editable TrackItem Columns.

Requirements: LV-18377, LV-1925, LV-22232.

Added Editable SDIAlias Columns.

Requirement: LV-1923.

Added Dynamic Dropdowns. Also added a link to this in the "DropDown SQL" and "Dropdown Definition" properties of the sdclinkmaint Element (the feature applies to both Elements).

Requirement: LV-18378.

Added Virtual Columns.

Requirement: LV-23834.

Added Nested Selects.

Requirement: LV-23784

In Navigator Policy → Using the Edit Set Navigator (Step 6), added column selection and fill features, plus shortcut key support for clipboard operations for Chrome and Internet Explorer.

In Maintenance Grid Copy and Fill Features, added "Select Column" and "Related Fill-Down" features, plus links to the above Navigator section to cover browser-dependent behavior.

Requirements: LV-20338, LV-22491, LV-22494, LV-21601.

Added dropdownlistvalidated mode to explicitly mark an existing Reference Value that does not exist in the current dropdownlist.

Requirement: LV-26665.

Added a note to "checkbox" mode for setting the Display Value to Y;N (or similar) if the column is not linked to a Reference Type.

Requirement: None.

In sdclinkmaint Element, added Select Column and Related Fill-Down.

Requirements: LV-20338, LV-22491, LV-22494.

In the "Columns → title" property of the detailmaint, sdidetailmaint, and linkedsdimaint Elements, added feature that selects all fields in a column when the header is clicked.

Requirement: LV-25809.

In Web Page Designer: Properties Overview → Property Controls → General Editing Functions, added new lookup dialogs to filter columns.

Requirement: LV-22589.

Notes

 

These changes were made to describe new and modified functionality: 

In Notes:
Added new Follow-Up and Statement Note Types.

Requirement: LV-18460.

Added ability to add Notes using the Formatted Text Editor.

Requirement: LV-18463.

In Notes Policy, added property to Note Tags for enabling Tags for Note Types.

Requirement: LV-None.

In sdinotesElement:
Added configuration options for resolving Follow-Up and Statements Notes.

Requirement: LV-18459.

Added configuration options to define conditions under which Follow-Up and Statements Notes can be added, edited or resolved.

Requirements: LV-18457, LV-18458.

Phrases

 

These changes were made to describe new functionality:

In Phrases:
Rewrote the Overview to clarify that "Phase Type" is a Reference Type, while the "Type" referred to in the interface is actually a Reference Value for which multiple Phrases can be defined.

Requirement: None.

In Adding Phrases, added "Rich Text Phrase" and "Generate Plain Text Automatically".

Requirement: LV-18467.

In Formatted Text Editor, added Phrases and Phrase Suggestion.

Requirement: LV-21988.

Query Management

 

These changes were made to describe new functionality:

In Queries, added "Union Query" checkbox to Query form and Additional Union Clauses detail for Query SDIs that include a union between two separate from and where clauses.

Requirement: LV-23521.

Reagents

 

This change was made to describe new functionality:

In Reagent Lots, updated screens to represent new error message when quantity entered exceeds available quantity.

Requirements: LV-20339, LV-20340.

Reporting

 

These changes were made to reference newly supported versions of third-party applications:

In Concepts of Reporting and Reports and Execute Reports, updated third-party vendor references to Jaspersoft and SAP products. Also changed Reports and Execute Reports → Overview to introduce new information.

Requirement: LV-13844.

In Reports and Execute Reports → Execute Reports → Run Report:
Added docx, xlsx, and csv formats.

Requirement: LV-15818.

Added new default filename for Reports.

Requirement: LV-15821.

Added Using Jaspersoft Studio with LabVantage to cover Report development operations such as Installing Jaspersoft Studio, Creating a Data Adapter, Configuring a Project, Importing LabVantage Templates into your Library, Importing LabVantage OOB Reports into a Project, Using the Wizard to Create a New Report, PDF/A Support for Jasper Reports, Using Unicode in Jasper Reports, and Rich Text Support in Jasper Reports.

Requirement: LV-20690.

In Concepts of Reporting → Business Objects → Overview, removed references to specific BO Report types, referencing the LabVantage Installation Documentation to determine the most current versions.

Requirement: None.

In System Configuration → User Options → Business Objects Options, updated global defaults for Business Objects.

Requirement: LV-13844.

In Users and Roles → User Profile → Overview, updated links to System Configuration options.

Requirement: LV-13844.

Stability

 

These changes were made to describe new and modified functionality: 

In Stability Plans:
Added Edit Plan option including Scheduler Execute Ahead details at the Plan and Timepoint levels.

Requirements: LV-18033, LV-19785.

Added new Environment Label details.

Requirement: LV-19783.

In Stability Protocols and Stability Inventory Calculation, detailed new Pull Type dropdown including new Partial Distribution option.

In Stability Inventory Calculations, added Partial Distribution information where applicable.

Requirement: LV-18364.

Storage

 

These changes were made to describe new and modified functionality:

In Environments, added new Environmental Label details.

Requirement: LV-19783

In Track Item Management Pages, added new Find Space capabilities.

In Biobanking Policy, added new property "Storage Location Search".

Requirement: LV-15590.

In Move Samples (Custodial Management), CDTs, Custodial Departments and Shipping Locations and ASL, addressed change from CDT terminology to Transfer terminology.

Requirements: LV-18738, LV-19839.

In Move Samples (Custodial Management), added the ability to select a Department while Taking Custody.

Requirement: LV-19840.

Added TakeCustody Page Type to detail properties for the Take Custody Dialog.

Requirement: LV-23869.

In Storage Locations:
Added count and Trackitem link to identify Samples placed directly in a Storage Location.

Requirement: LV-24569.

Added Consolidate operation.

Requirements: LV-20816, LV-20365.

In Plates, added the Take Custody and Ship operations.

Requirement: LV-20362.

In Boxes, added the new Consolidate Boxes functionality.

Requirements: LV-20365, LV-20810, LV-20811, LV-20812, LV-20813, LV-20814, LV-20815.

Added StorageConsolidate Page Type.

Requirement: None.

User Interface (Miscellaneous)

 

These changes were made to describe new functionality:

Changed "Breadcrumb Bar" to "Navigation Bar" in LabVantage User Interface, GUI Policy, recentitemsgizmo, and menugizmo.

In LabVantage User Interface → Layout → Navigation Bar, noted that modes are now configurable using the "Navigation Bar" collection in the GUI Policy.

In GUI Policy, added "Navigation Bar → Mode" options. In "GUI Modes" collection, added "Show Navigation Bar" and "Navigation Bar Mode".

Requirement: LV-22004.

These changes were made to describe new functionality:

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

Requirement: LV-24241.

This change was made to describe new functionality:

In advancedsearch Element, added a note to the "Scan in IDs" collection describing scanning in the SDIWorkitem List and Dataset List pages by the alternate column KeyId1 (Sample Id).

Requirement: LV-4728.

These changes were made to describe new functionality:

In GUI Policy,:
Added "Use Full Unminified Includes" property.

Requirement: LV-18744.

Added "Navigation Refresh" property.

Requirement: LV-19742.

Added "Core Font style" property.

Requirement: LV-24868.

Validation

 

These changes were made to describe new functionality:

In maint Element → Columns → Validation and sdclinkmaint Element → Columns → Validation, added new behavior for Date and Number Data Type validation, and new OOB validation defaults.

Requirements: LV-18750, LV-21879.

In Editor styles → Common Properties → Validation, added new OOB defaults for Date and Number Data Type Validation rules.

Requirements: LV-18750, LV-21879.

In Data Entry Pages → Editing Features → Live Feedback, added statements concerning Date and Number Data Type validation to distinguish it from maint/sdclinkmaint and Editor style validation behavior.

Requirements: LV-18750, LV-21879.

Web Page Designer (Miscellaneous)

 

These changes were made to describe new functionality:

In sdidetailmaint Element, added the "Detail Types" SDISecurityDepartment, SDISecuritySet, SDIWorkflow, SDIWorkflowRule, and SDIWorksheetRule.

Requirement: None.

In dynamicmultimaint Element, added the "Detail collection → Inverse rotation in RTL mode" property.

Requirement: None.

Web Services

 

These changes were made to describe new functionality:

In helpgizmo, added "REST API Role" property.

In LabVantage REST Web Services → LabVantage REST API → Built-In API Documentation, added a reference to this new property.

Requirement: LV-18448.