Content

Document Revisions

Changes Made in Document Revision 141111-60

Changes Made in Document Revision 140214-60

Changes Made in Document Revision 131115-60

Changes Made in Document Revision 121207-60

Changes Made in Document Revision X120618-60
Changes Made in Document Revision X120216-60

Changes Made in Document Revision X111223-60

History of changes from V1.1 (11/02/1999) through R5.2 (03/15/2011)
 
 

 

   

 

 

Document Revisions

Top
Revision Date Description
141111-60 11/11/2014 Seventh document revision to provide a general maintenance release.
140214-60 02/14/2014 Sixth document revision to provide a general maintenance release.
131115-60 11/15/2013 Fifth document revision to address 6/6.0.1 updates and 6.0.2 changes.
121207-60 12/07/2012 Fourth document revision to implement HTML5/XHTML1/CSS3 compatibility changes and provide a general maintenance release.
X120618-60 06/18/2012 Third document revision to address pending items, enhancements, and bugs.
X120216-60 02/16/2012 Second document revision to address pending items from the initial release.
X111223-60 12/23/2011 First document revision to support initial release of LABVANTAGE 6.

 

Changes Made in Document Revision 141111-60

Top
This document revision contains changes affecting these areas of LABVANTAGE functionality:
Data Entry
Event Plans
LABVANTAGE Enterprise Connector
Reagents
 
Scheduler
Test Methods (Workitems)
Web Page Designer
  
These are links to changes made in previous document revisions:
Changes Made in Document Revision 140214-60
Changes Made in Document Revision 131115-60
Changes Made in Document Revision 121207-60
Changes Made in Document Revision X120618-60
Changes Made in Document Revision X120216-60
Changes Made in Document Revision X111223-60
History of changes from V1.1 (11/02/1999) through R5.2 (03/15/2011)
 

Data Entry

 

This change was made to clarify page behavior:

In Enhanced Data Entry Pages, added Data Item Display Rules to note that display of Cancelled, Untested, and Unavailable Data Sets are controlled by the "Data Item Display" Rule property in the gwtdataentrygrid Element.

DevItem: None.

This change was made to address a DevItem:

In Classic Data Entry Pages → Data Entry Views and Modes, added a note to indicate that display of Cancelled, Untested, and Unavailable Data Sets are always visible during Data Entry.

DevItem: DI22871 (VC: 0012845).

Event Plans

 

These changes were made as a document correction:

In Data Entry Policy, changed description of "Generate Release Events on Edit" to note that this captures events fired from SDC Rules and Event Plans generated from Data Entry pages (they are generated in the same code line).

In Event Plans → Event Types → Event Type Maintenance Page, added an example that explains the unexpected behavior of the "SampleSpecFailDataRelease" Event Type.

DevItems: DI20819 (VC: 0012281) and DI20824 (VC: 0012281). The Parent DevItem is DI20818 (VC: 0012281).

LABVANTAGE Enterprise Connector

 

This change was made as a document correction:

In LABVANTAGE Enterprise Connector, added <MsgVersion> element to all header (<Zheader>) examples.

DevItem: None.

Reagents

 

This change was made as a document enhancement:

In Reagent Lots → Adding Reagent Lots → Reagent Params, added a note to indicate that the Reagent Lot's SDIData data structure does not define multiple Replicates per Parameter.

DevItem: DI21041 (VC: 0012312) - The issue was diagnosed as "Way It Works".

This change was made as an update to reflect current product functionality:

In Reagent Lots → Adding Reagent Lots → Containers, updated to change "Check In" and "Check Out" (to/from TISM page) to "Assign Storage" and "Clear Storage" (for selection of Storage Location).

DevItem: None.

Scheduler

 

This change was made as a document correction:

In Scheduler → Schedule Tasks → Create SDI, added description of the "Apply Workitem" property.

DevItem: None.

Test Methods (Workitems)

 

This change was made as a document enhancement:

In Test Methods → Description → Test Method, added a note to "Responsible Laboratory" to indicate the relationship that exists among the Department, Stability Protocol, and AdvancedSamplePull Task.

DevItem: None.

Web Page Designer

 

This change was made as a document correction:

In Generic Layout, noted that the "Favorites" functionality has been deprecated. Also removed references to "Favorites" from Request Controller and LABVANTAGE Custom Tags.

DevItem: None.

 

Changes Made in Document Revision 140214-60

Top
This document revision contains changes affecting these areas of LABVANTAGE functionality:
Calculations
Configuration Transfer Tools
Event Plans
Labels
 
Reporting
Security
Specifications
Web Page Designer Elements
These are links to changes made in previous document revisions:
Changes Made in Document Revision 131115-60
Changes Made in Document Revision 121207-60
Changes Made in Document Revision X120618-60
Changes Made in Document Revision X120216-60
Changes Made in Document Revision X111223-60
History of changes from V1.1 (11/02/1999) through R5.2 (03/15/2011)
 

Calculations

 

Document enhancement: 

In Expression Editor → Expression Library, added a note to explain that "x" is the operand and [this] is user input, accompanied by a link to examples provided in the section concerning the Parameter List Maintenance page.

DevItem or Issue: None.

Additions and changes reported:

In Concepts of Transformations and Calculations → Internal Calculations → Passing Other Data Types into a Calculation, added a note to indicate that an empty string is returned for "Text" Data Type if no value is entered for a Parameter.

DevItem: 20259.

Document correction:

In Maximum Numeric Data Values, corrected typographical error (changed SDIDataItem.EnteredText to SDIDataItem.Entered Value to denote the column that holds the calculated numeric value).

DevItem or Issue: None.

Document correction: 

In Expression Editor → Expression Library → astmround example, corrected typographical error in astmround rule. This previously stated that the second place rounds-up if the third place is >= 5 (should be >5).

DevItem or Issue: None.

Configuration Transfer Tools

 

Additional warning added:

In Configuration Transfer Tools → Importing Items, added an additional warning to specify entities not removed from the target database by the CTT.

DevItem or Issue: None.

Event Plans

 

Additions and changes reported:

In Event Plans → Event Types → Event Type Maintenance Page, added the asterisk as a wildcard character.

DevItem or Issue: None.

Labels

 

Third-party product licensing change:

In Labels, changed licensing status of Seagull Scientifc Bartender to indicate that it can be acquired through LABVANTAGE.

DevItem or Issue: None.

Reporting

 

Additions and changes reported:

In Report Maintenance Pages (Reports and Execute Reports → Using Unicode in Jasper Reports):

These requirements have been removed because they have been reported as no longer required:

Copy TTF file into iReport fonts directory (previously item 2).
Set PDF Embedded to true (previously item 3b).
Include TTF font in classpath (previously item 4).

This requirement was added in LABVANTAGE 6, but has been modified because the functionality has changed:

The Unicode font previously had to be packaged in the root of LABVANTAGE EAR (previously item 5). It now works only if it is in the custom project JAR (now item 3).

DevItem or Issue: None.

Security

 

Document Correction:

In Concepts of Security → Interaction Between Role Level Access and Departmental Security and SDCs → Security Update Options, corrected typographical error (changed "SDC" to "SDI" as the entity to which Roles are assigned).

DevItem or Issue: None.

Specifications

 

Additions and changes reported:

In Specification Maintenance Page (Specifications → Parameter Details), added descriptions of "Any ParamList" and "AnyParamList Version".

DevItem or Issue: None.

Document Correction:

In Concepts of Specifications (Concepts of Specifications → Spec SDI Checking Process → Rules Engines), removed references to "LVX" and "Jaguar".

DevItem or Issue: None.

Web Page Designer Elements

 

Additions and changes reported:

In list Element, added new details concerning "Sort By" functionality (all columns are now used for sorting based on the first).

Devitem: DI17576.

  

Changes Made in Document Revision 131115-60

Top
This document revision contains changes affecting these areas of LABVANTAGE functionality:
Action Block Editor
Action Public Interfaces
Actions Not Implemented by Public Interfaces
Adhoc Queries
AQC
ASL
Attachments
Attributes
Calculations
Classic Data Entry Pages
Compare Configurations
Configuration Transfer Tools
Departmental Security and SDC Access
Document Mechanics
eForms
Event Plans
Java Public API
 
Job Types
Limit Rules
Logging
NWA
Reagents
Reporting
Request Management
Scheduler
SDI Security
SDC Maintenance
SDC Rules
Simple Instruments
SMS
Stability
System Configuration
User Maintenance
Web Page Designer Elements

Action Block Editor

 

Document correction:

In Script Editor → Overview, noted that the "Test" button in the Script Editor works the same as it does in the Graphical Editor, i.e., it actually executes the script.

DevItem: DI19087.

Action Public Interfaces

 

General updates:

Updated the Javadoc for the System Action Public Interfaces.

Parent Requirement: None.

Added Printing Javadocs to describe print behavior of Javadocs generated by the JDK Doclet class.

Parent Requirement: None.

Interface corrections:

In DeleteSDIWorkitem, deleted propsmatch example in the Interface code.

Issue: VC0011387.

In DeleteSDIAttachment, corrected typographical error in the Interface code regarding multiple Attachments.

Issue: None.

Actions Not Implemented by Public Interfaces

 

Additional information added:

Added information to the CreateStorageUnit Action to explain why it is not for use as a configurable System Action.

DevItem: DI19113.

Adhoc Queries

 

Additions and changes to support new functionality:

In Adhoc Queries → Building AdHoc Queries → Choosing SDC Columns to Query → Supported Detail Tables of Searchable SDCs, added support for SDIAttachment, CategoryItem, SDIAddress, SDIDataApproval, SDIDataRelation, SDIDataItemSpec, SDIDataItemLimit, SDISpec, SDIWorkItemItem, SDIApproval, SDIApprovalStep, and D-type (detail) tables. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01271.

In Adhoc Queries → Building Adhoc Queries → Building a Query → Query Operations, added "Search and Export All" option to run the query and export the returned records to an MS Excel spreadsheet in a single operation. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01446.

AQC

 

Document correction:

In QC Batch Life Cycle → QC Batch Status Transitions, changed the description of "InProgress → DataEntered" to note that this transition will occur only when data are entered at the QC Batch level, not at the Sample level.

Issue: VC0011085.

New functionality and document enhancement:

In QC Methods → QC Method Sample Types Detail → Position Type, regenerated all examples using the latest build. Also added "Random Anchored" type and modified "Randomly Distributed" type. "Randomly Distributed" now maintains the specified start/end positions, while "Random Anchored" selects a random starting position between the specified start/end positions.

Issue: VC0011298.

New functionality added to LABVANTAGE 6.0.2:

In QC Batches → QC Batch List Page, added "Release Block" button.

Parent Requirement: None.

In QC Batches → QC Sample Types and Reagents Details, added "Standard Level" field.

Parent Requirement: None.

ASL

 

New functionality added to LABVANTAGE 6.0.2:

In Custodial Domains and Shipping Locations → Custodial Domains, updated the Department Maintenance page to include new options that have been added to LABVANTAGE 6.0.2 ("Retain Department Access", "Current Custodian Security Set", and "Relinquish Custody Security Set").

Parent Requirement: R02093.

Attachments

 

Additions and changes to support new functionality:

In Attachments → Using Attachment Manager Pages → Upload and Reference, added Upload and Reference with File Rename. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01499.

In Policies → Attachment Policy, added "File Reference" property for renaming Attachments with "Upload and Reference" Attachment Types. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01499.

In Attachments → Using Attachment Manager Pages → Icons (and the accompanying description of Edit Attachment Inline), noted the reason why this feature is available only with Microsoft Internet Explorer.

DevItem or Issue: None.

In Attachments → Using Attachment Manager Pages → Icons (and the accompanying description of View Attachment), aded a note describing View Attachment behavior with XML files in Web browsers.

DevItem or Issue: None.

Attributes

 

Document correction:

In Attributes → Adding Linked Attributes → Example, added a link to the maintattribute Element to explain behavior of the "Required" option.
In maintattribute Element, corrected the behavior of the "Required as Mandatory" property.

DevItem: DI18118.

Calculations

 

Caveat added:

In Concepts of Transformations and Calculations → Overview, added About Parsing and Locale to document unexpected behavior related to thousands separator.

DevItem: DI17456.

Classic Data Entry Pages

 

Noted differences in the way certain operations are handled by Enhanced Data Entry pages (the most recent Data Entry pages that were introduced in LABVANTAGE R5.1 as a replacement for the "Classic" Data Entry pages) and Classic Data Entry pages (the old Data Entry pages that were used prior to LABVANTAGE R5.1 and maintained for backward-compatibility):

In Manage Data Sets, Manage Tests, and Manage Worksheets → Cancelling and Uncancelling Data Sets, noted how the behavior of the "Cancel" function differs between Enhanced Data Entry pages and Classic Data Entry pages.

In Adding and Maintaining Tests, deleted information concerning Cancelling/Uncancelling Data Sets. Replaced this with a link to Manage Data Sets, Manage Tests, and Manage Worksheets → Cancelling and Uncancelling Data Sets.

Updated navigation link in the Data Entry branch page.

DevItem: DI19449.

In Approve Tests → Approval in Classic Data Entry Pages, added a note to indicate that Classic Data Entry pages do not enforce unique Approvals for each Approval Step.

DevItem: DI18963.

Compare Configurations

 

Notice added:

In Compare Configurations, added a note stating that this feature has been deprecated (it was deprecated in LABVANTAGE 6.0.1), and the Configuration Report → Diff Report feature supersedes it.

DevItem: DI19129.

Configuration Transfer Tools

 

Additional warning added:

In Configuration Transfer Tools → Overview, added another warning stating that you must export from and import to the same LABVANTAGE version.

DevItem or Issue: None.

Departmental Security and SDC Access

 

Additions and changes to support new functionality and add information regarding existing functionality:

In Concepts of LABVANTAGE Security → Departmental Security and SDC Access:
  Added Departmental Security for Data Sets and SDIWorkitems (Tests) with new Access Control options for selective enforcement of primary/DataSet/SDIWorkitem SDCs (added to LABVANTAGE 6.0.2). Also added links to this info in SDCs → SDC Primary → Security/Update Options → SDC Access Control.

Parent Requirement: R01337.

  Added more detail concerning the "Departmental" Access Control option for the DataSet SDC.

Parent Requirement: R00469.

  In the example Configuration, made these changes that have been added to LABVANTAGE 6.0.2:
Updated SDC Maintenance page.
Updated Department Maintenance page to show new fields.
Updated User Maintenance page to show change of "Default Department" to "Last Department". Since "Default Department" has been removed, changed example to set "Base Department" rather than "Default Department".
Ammended the example of Departmental View to show both Users.

DevItem: DI16978

  Added Granting SDI Access to Multiple Departments to describe new Actions added to LABVANTAGE 6.0.2 that allow multiple Departments to access to the same SDI.

Parent Requirement: R02093.

  Added About Departments and Custody to reference the "Retain Department Access" option in the Department Maintenance page (added to LABVANTAGE 6.0.2).

Parent Requirement: R02093.

In Department Maintenance, added three new options that have been added in LABVANTAGE 6.0.2 ("Retain Department Access", "Current Custodian Security Set", and "Relinquish Custody Security Set").

Parent Requirement: R02093.

Document Mechanics

 

Modification for server-side deployment with WebLogic and IE 9/10:

When the document was deployed as a WAR in WebLogic, WebLogic did not send back the content header. As an additional bonus, WebLogic also ignored all declared mime-types. To work around this, modified the document's deployment descriptor to explicitly declare only the application xml and javascript mime types, and declare them in an order that is accepted by WebLogic, JBoss, and WebSphere. The deployed document now opens properly in WebLogic as it always has in JBoss and WebSphere. Tested with IE 9/10 on all three supported servers. This was reported to MadCap Software as issue 47519.

DevItem: DI16189.

Modification for IE 9/10:

Forced the document to open in edge mode, thus preventing IE compatibility settings from taking effect in any version of IE. Tested on IE 10, Chrome 30, Safari 5, Firefox 17, and Opera 11.

DevItem or Issue: None.

eForms

 

Document correction:

In Form Definitions → Form Processing → Variables Exposed During Form Processing, corrected typographical error (changed class in example from getSQLDataSet() to getSqlDataSet() ).

DevItem: DI17283.

Event Plans

 

Additional information missing from previous document revisions:

In Event Plans → Event Types → Event Type Maintenance Page, added (any) and (blank) options to specify any/nonexistent values for [ new value ] and [ old value ].

Issue: VC0038780.

Caveat added:

In Event Plans → Basic Examples: Creating Event Plans, added caveat to make "inputs" prefix mandatory for input properties in Conditional Action Blocks. Also added this caveat to Action Block Editor → Conditional Blocks (with a note about the Ctrl-Space typing aid).

DevItem or Issue: None.

Java Public API

 

General updates:

Updated the Javadoc for the Java Public API.

Parent Requirement: None.

Added Printing Javadocs to describe print behavior of Javadocs generated by the JDK Doclet class.

Parent Requirement: None.

Job Types

 

Additions and changes to support new functionality:

In Concepts of LABVANTAGE Security → Job Types, made these changes that have been added to LABVANTAGE 6.0.2:
  In the example Configuration:
Updated SDC Maintenance page.
Updated User Maintenance page to show change of "Default Department" to "Last Department". Since "Default Department" has been removed, changed example to set "Base Department" rather than "Default Department".
  In Default Departments and Job Type Departments:
Changed functionality to reflect change of "Default Department" to "Last Department".

DevItem: DI16978

Limit Rules

 

Addition to Limit Rule Actions:

Added Limit Rules → Actions → Behavior of Action Properties to provide an explanation of unexpected behavior (and a work-around) when an Action is executed as a result of a Parameter Limit being met (or not met).

DevItem or Issue: None.

Logging

 

Moved the Table of Contents entry for LABVANTAGE Logging into the root of the "API Reference" section to increase visibility.

NWA

 

New feature added to LABVANTAGE 6.0.2:

NWA Analysis provides a sysadmin-level description of creating, editing, and running NWA Analyses. Added to LABVANTAGE 6.0.2.
Running NWA Analyses describes running an NWA Analysis from LABVANTAGE. Added to LABVANTAGE 6.0.2.
NWA Policy provides system-wide settings for NWA Analysis. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01295.

Reagents

 

Additions and changes to support new functionality (LABVANTAGE 6.0.2 changes are identified throughout the documents), plus general enhancements to provide more information:

Added Reagent Overview (general enhancement to provide more information concerning Reagents).
Added Reagent Container State Chart (general enhancement to provide more information concerning Reagents).
In Reagent Example, added LABVANTAGE 6.0.2 changes (identified throughout the document).
In Reagent Lots, added more detail, procedural topics, and LABVANTAGE 6.0.2 changes (identified throughout the document).
In Reagent Lot Status, updated the status chart and added "Rejecting Quality Samples" and "Cancelling a Reagent Lot".
In Reagent Types, added more detail, procedural topics, and LABVANTAGE 6.0.2 changes (identified throughout the document).
Combined existing UseReagent and new ReagentDataEntry Page Types into a single topic with LABVANTAGE 6.0.2 changes (identified throughout the document).

Parent Requirement: R01461.

Request Management

 

New feature added to LABVANTAGE 6.0.2:

Request Management describes adding, drafting, editing, approving, and releasing Requests. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01344 (includes DevItems DI18726 and DI19737).

Reporting

 

Changes to Request Controller parameter:

In Reports and Execute Reports → Business Objects Report Registration → Viewing Reports through the URL, changed the parameter for the "viewreport" RC command from "displayformat" to "displaytype" in the example URL.

DevItem: DI17093.

Additions and changes to support new functionality:

In Reports and Execute Reports → Reports, added new "SQL DropDown Combo" option in the "Report Parameter Type" field. Added to LABVANTAGE 6.0.2.
In Controlled Reports → Viewing an Event, added new "ReGenerate Report" option. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01491.

Scheduler

 

Change to column values:

In Scheduler → Basic Concepts → Schedule Tasks → CreateSDI Scheduled Task, deleted reference to the "PlanItemDesc" column in SchedulePlanItem table.

DevItem: DI17284.

In Scheduler → Editing Plan Items → Plan Item Information → Schedule Rules, installed a link from "Count" to Instrument Certification and Instrument Certification → Adding a Certification Schedule.

DevItem: DI19058.

SDI Security

 

New feature added to LABVANTAGE 6.0.2:

In Concepts of LABVANTAGE Security, added new SDI Security feature. Added to LABVANTAGE 6.0.2.
In Policies → Copy Down Policy, added "Copy Security Set" property for copying permissions to child SDCs of a parent SDC. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01318.

SDC Maintenance

 

Additions and changes to support new functionality:

In SDC Primary → Security/Update Options, added "Default Security Set" option. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01318.

SDC Rules

 

Additions and changes to support new functionality:

In SDC Rules → Creating SDC Rules, added support for multiple custom packages. Also added link in System Configuration → API Options. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01372.

Document correction:

In SDC Rules, changed four links to the sapphire.action.BaseSDCRules class. They were pointing to the Action Javadoc page, which contains only an index. The new links point to the complete Java API Javadoc page.

Simple Instruments

 

Additions and changes to support new functionality:

In EForm Page Type, added the "Tools → Instrument Interface" property collection to configure the default behavior of the Simple Instrument interface. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01503.

In Simple Instruments → Instrument Models → Add Model Commands, changed "Has Response" to "Response Type" dropdown and replaced image. Added to LABVANTAGE 6.0.2.

Parent Requirement: R01446.

In Certifications → Instruments, deleted obsolete information and replaced it with a link to the "Instrument Certification" topic.

Parent Requirement: None.

Deleted obsolete "Instrument" topic, as it is no longer relevant.

Parent Requirement: None.

SMS

 

Added caveat:

In BioBanking Sample Operations → Basic Operations → Edit and View → Sample Details, noted that the hierarchical Sample Family details are not displayed if you are using a SQL Server DBMS.

DevItem: DI19360.

Stability

 

Clarification of deprecated functionality:

In Stability Tasks, added Pull Sample, noting that it was deprecated in LABVANTAGE R4.6 and exists only to maintain backward-compatibility.

Parent Requirement: None.

System Configuration

 

Change to support new functionality:

In System Configuration → Miscellaneous Options → RSet Options, noted that "Max rows per RSET query" can be used with both Oracle and MS SQL Server DBMS in LABVANTAGE 6.0.2. Added to LABVANTAGE 6.0.2.

Parent Requirement: None.

User Maintenance

 

Change to support new functionality:

In Users and Roles → Users → UserMaintenancePage, updated User Maintenance page to show change of "Default Department" to "Last Department" in LABVANTAGE 6.0.2.

DevItem: DI16978.

Web Page Designer Elements

 

Additions and changes found:

In advancedtoolbar Element, changed the name of the "Departmental Security" property to "Security".
In auditdetails Element, added all supported SDI detail tables.
In detailmaint Element, added these properties: "Tab → Group" and "Columns → Dropdown Definition". Removed "Buttons → ID" property.
In gwtdataentrygrid Element, added these properties: "Auto Popup Instrument Connection", "Visual Policies to Apply → Show", "Column header → Sort by Data Set User Sequence", "Column header → Sort by Data Item User Sequence", "Row header → Sort by Data Set User Sequence", "Row header → Sort by Data Item User Sequence", "Columns → Mode → retrievedata", and added 10 properties to "Details → Columns → Lookup URL". Removed 10 properties from "Columns → Mode".
In linkedsdimaint Element, added these properties: "Tab → Group" and "Columns → Dropdown Definition". Removed "Buttons → ID" property.
In maint Element, added these properties: "Columns → Lookup URL → Default Query → ('Query From', 'Query Where', and 'Dyanmic Lookup')", "Columns → Lookup URL → Lookup Columns → ('Width' and 'Searchable')", and "Columns → Dropdown Definition".
In sdclinkmaint Element, added these properties: "Dropdown Definition" (per DevItem DI17287) and "Dynamic Lookup" property.
In sdidetailmaint Element, added these properties: "Tab → Group" and "Columns → Dropdown Definition".

Parent Requirement: None.

Addition to support Dynamic Lookup properties in these Elements:

Also added new Dynamic Lookups topic and installed links to this new topic from Elements that contain the Dynamic Lookup configuration options.

Parent Requirement: None.

Addition to correct indexing error during the last document build:

Replaced and updated the chartgizmo, googlegadgetgizmo, listgizmo, metergizmo, and urlgizmo Elements.

 

Changes Made in Document Revision 121207-60

Top
This document revision contains changes made to these areas of LABVANTAGE functionality:
AQC (QC Methods) 
JavaScript Global API    
AQM (Batch Management) 
Logging    
Calculations 
Password Validation    
Document Mechanics 
Test Maintenance    
Instrument Certification        
Changes Made in Document Revision X120618-60
Changes Made in Document Revision X120216-60
Changes Made in Document Revision X111223-60

History of changes from V1.1 (11/02/1999) through R5.2 (03/15/2011)

AQC (QC Methods)

 

In QC Methods, updated new functionality of QCBatch Selection Query in QC Method Form to add QC Charting and change default when no query is selected. Reference: VC10889/DI16708.

AQM (Batch Management)

 

In Batch Sample Policy, added examples to the "Sample Creation Policy" to clarify the behavior of "Using Product", "Using Sampling Plan", and "Using Both".

Calculations

 

In Concepts of Transformations and Calculations → Internal Calculations → Referencing an SDI Column, corrected the basic example expression (changed | to arithmetic operator) and simplified the Attributes example.

Document Mechanics

 

Instituted HTML5/XHTML1/CSS3 document compatibility changes as follows:

Modified all files to be compliant with HTML5/XHTML1/CSS3 standards (except where multi-browser compatibility could possibly be compromised).
Converted the document rendering engine to HTML5/XHTML1/CSS3 standards.
Installed a new search engine that displays descriptions of returned search results.
Tested rendering framework, search engine, page layouts, and scripts in:
Apple Safari 5.1.7 (7534.57.2)
Google Chrome 23.0.1271.95 m
Microsoft Internet Explorer 9.0.8112.16421 and 8.0.6001.18702
Mozilla Firefox 17.0.1
Opera Browser 11.01 (1190)

Instrument Certification

 

In Adding Instruments: UsageTab, changed description of functionality to indicate that "count" can be both use-based and time-based (one checkbox indicates usage tracking, the other indicates time versus uses)

JavaScript Global API

 

Added page titles to all JavaScript Global API objects to enable descriptions to be returned with search results. Also corrected the object description in Object: sapphire.page.

Logging

 

In LABVANTAGE Logging, updated the locations of log files to reflect new locations in LABVANTAGE_HOME.

Password Validation

 

In Password Validation, updated the locations of successful/unsuccesful TraceLog options in the System Configuration Security Options.

Test Maintenance

 

Deleted the last remnants of "Concepts of Data Entry" and incorporated current functionality into Adding and Maintaining Tests. The two topics originally covered functionality differences among the last few LABVANTAGE versions and was therefore becoming too confusing to follow.

 

Changes Made in Document Revision X120618-60

Top
This document revision contains changes made to these areas of LABVANTAGE functionality:
Action Public Interfaces 
JavaScript Global API      
Attachments 
Labels      
BioBanking 
Reagents      
Calculations 
Reporting      
Child Pool Samples 
SDC Maintenance       
Configuration Reports  
Web Services                     
Java Public API 
Pending Items      
Changes Made in Document Revision X120216-60
Changes Made in Document Revision X111223-60

History of changes from V1.1 (11/02/1999) through R5.2 (03/15/2011)

Action Public Interfaces

 

Updated the Javadoc for the System Action Public Interfaces.

Addresses

 

In the AddSDIAddress, DeleteSDIAddress, and EditSDIAddress Actions, changed the "addresstype" and "contactfunction" properties from conditional (mandatory only if one exists) to mandatory (mandatory whether or not it exists).

Attachments

 

In Attachments, added SDIAttachment Table Columns for mapping the SDIAttachment table to the Attachment UI.

BioBanking

 

Added/modified these topics to describe new functionality (added to LABVANTAGE 6.0.1):

In treelist Element, added default "Hierarchy Expand Level" field, updated query information, and added security updates.
In TrackItemManagement Page Type, added property to hide "Allow Moving Target Storage Unit" button and documented "Favorite Storage Unit" link.
In TISM Page, added "Favorite Storage Unit".
In BioBanking_Sample_Operations, changed functionality with regard to Treatments (a lab user can no longer edit Samples for Treatments and Discrepancies, and Treatments can be added only to Samples of the same Sample Type).
Updated images in In BioBanking_Studies and Alias Search.

Calculations

 

Minor additions per requests:

In Concepts of Transformations and Calculations, added Standard Operators.
In Expression Library, added a note to explain that e is the base of natural logarithms.

Added a new feature (added to LABVANTAGE 6.0.1) that determines how the if(b, t, f) function evaluates null values:

In the Data Entry Policy, added "Honor Null in Relational Expressions" and "Honor Null in AND/OR Conditional Expressions" properties. In the Expression Editor, also changed the description of the if(b, t, f) function to point to these new Policy properties.

Update:

In Expression Library, updated descriptions of the "fist", "last", "min", and" sum" aggregate functions to reflect the way they currently work. Also changed the description of "max" (it now returns the largest of multiple values).

Child Pool Samples

 

Added/modified these topics to describe new functionality (added to LABVANTAGE 6.0.1):

Added Child Pool Samples to describe "Add Child" and "Pool Samples" buttons and functionality on Manage Sample List page.
In Manage Samples, added "Add Child" and "Pool Sample" buttons.
In CreatePooledSample Page Type, added new properties "Pooling Mode", "Enable Quantity Calculation", and "Forward Page after Save".
In MultiSampleChild Page Type, added properties "Child Sample Templates", "Forward Page after Save", "Child Template", and "Parent Columns". Further details concerning "Enable Quantity Calculation" are to be determined.

Configuration Reports

 

In Configuration Report, changed wizard to reflect new navigation, updated form fields, and added most recent changes to diff reports. Added to LABVANTAGE 6.0.1.

Java Public API

 

Updated the Javadoc for the Java Public API.

JavaScript Global API

 

Added/modified objects in the JavaScript Global API (added to or changed in LABVANTAGE 6.0.1):

sapphire.connection: Added new property "isLoggingOff".
sapphire.events: Added new method "cancelEvent".
sapphire.events.util: New object.
sapphire.lookup: Added new property "blankUrl".
sapphire.lookup.reftype: New object.
sapphire.navigator: New object.
sapphire.page: Added new property"disabled". Added new method "toggleDisable".
sapphire.page.elements.dataView: Added new function "getFieldValue".
sapphire.page.maint: Added new property "style". Added new method "isGrid".
sapphire.sdc: New object.
sapphire.style: Added new method "setDisplay".
sapphire.ui.button: Added new property "clicked".
sapphire.ui.util: Added new methods "scrollTo" and "createPopup".
sapphire.util.dataset:New object.
sapphire.util.dom: Added new methods "findFrame", "focusElement", "createDocumentFragment", "getChildren", "createFormField", and "moveTableRow".
sapphire.util.script: Added new method "getRequestArguments".

Labels

 

In Labels, added "Categories" tab to Label Methods and updated images.

Reagents

 

Added descriptions of Reagent Tasks.

Reporting

 

As part of a general review of Reporting changes:

Reviewed and checked functionality of build DM0601.004.01_00 against DM0600 documentation (Concepts of Reporting and Reports) and changed images to reflect new screens.
In Reports, changed the description of "Multiple List" Report Type. Also changed parameter prefixes from "LABVANTAGE" back to "SAPPHIRE" (this should be the last of the fallout caused by product renaming).

SDC Maintenance

 

In the SDC Link descriptions, removed "Link Name" from the Linking Procedures and provided a link to "Delete Rule" for Foreign Key Link Types.

Web Services

 

Updated Web Services to provide new guidelines for WSDL and WSDL2Java file generation, plus functional source code for example classes that demonstrate the latest functionality.

Pending Items

 

These items are currently under investigation and will be addressed in a future document release:

Batch (AQM) Life Cycle Review
Reagents Life Cycle Review
Stability Life Cycle Review
HTML5/CSS3 Document Engine

 

Changes Made in Document Revision X120216-60

Top
This document revision contains changes made to these areas of LABVANTAGE 6 functionality:
Active/Inactive SDIs 
Policies      
Adhoc Queries 
Reagents      
AQM (Batch Management) 
Specifications      
Attributes 
Stability                    
Auditing 
Test Methods      
Calculations 
Versioning           
Document Mechanics 
WPD Elements         
Editor styles 
Web Security           
Empower Connector 
Workitems (Generic)         
Changes Made in Document Revision X111223-60

History of changes from V1.1 (11/02/1999) through R5.2 (03/15/2011)

 

Active/Inactive SDIs

 

Additions and changes to support new functionality:

Added new topic for Active and Inactive SDIs.
Added "Allow Activate/Deactivate" option to SDC Definition Options.

Parent Requirement: R00397.

Adhoc Queries

 

Additions and changes to support new functionality:

In Adhoc Queries: Added "Make Shareable and Lock" option to Maintaining Queries, added "Make Shareable and Lock" option, added new ability to click column in Tools, added SDI Attributes to Relationship Display.
In AdhocQuery Page Type, added "Attributes" serachable option with guidelines in Adding Attribute Fields.

Parent Requirement: R00398.

AQM (Batch Management)

 

Additions and changes to support new functionality and address screen changes:

Changed image and a few typos in Batch Genealogy
Added Cancel/Uncancel operations to Batch Operations and Batch Stages.

Parent Requirement: R00404.

Attributes

 

Additions and changes to support new functionality:

Added new topic for Attributes.
Changes in Concepts of Transformations and Calculations to support Attributes (see Calculations).
In Expression Editor, added Primary Helper to all helper screens.
Added new topic for maintattribute Element.
Added "Allow Attributes" option to SDC Definition Options.

Parent Requirement: R00391.

Auditing

 

Additions and changes to support new functionality:

Added Mechanics section to TraceLog Table section of Concepts of Auditing.
Added "Save Button Activity" property to advancedtoolbar Element with a section Concerning Save Button Activity.

Parent Requirement: R00396.

Calculations

 

Reworked Calculations sections and added/changed information to support new and changed functionality:

In Concepts of Transformations and Calculations:
Added Attribute and SDIData options to Parameter Syntax.
In General section of Internal Calculations, modified syntax to include SDIDataItem option.
Added new section for Referencing Data Items by an SDIDataItem Column.
In Referencing Data Sets by an SDIData Column, added new sections for Column Name Reference and Attribute Reference.
Added new section for Referencing an SDI Column.
In Maximum Numeric Data Values, added new feature that returns zeros as placeholders beyond 13 digits.
In Expression Editor, added Primary Helper to all helper screens.

Parent Requirement: R00391.

Document Mechanics

 

Additions and changes to address browser and OS issues:

Added declarations to compensate for differences in IE8 and IE9 implementations of HTML5/CSS5 (does not affect Chrome, Firefox, Opera, and Safari).
Replaced any discrete backslash references inserted by Windows with forward-slashes to provide full support on Unix-based operating systems.

Editor styles

 

Added new topic for Editor styles.

Parent Requirement: R00427.

Empower Connector

 

Added new topic for Empower Connector.

Parent Requirement: R00281.

Policies

 

Additions and changes to support new functionality:

In Copy-Down Policy, added a note concerning special functionality when used with SDI Templates.
In Batch Sample Policy, added behavior for Batches and Samples to "Cancel Action Behavior" property.
In Manage Samples, added a note to the "Cancel Samples" operation concerning the "Cancel Action Behavior" property of the Batch Sample Policy.
In Data Entry Policy, added "Reset Approvals on UnRelease", "Translate Validated Reference Type", "Rule for Undetermined Spec Limits", and "Rule for Undetermined Param Limits" properties. Also added link in When a Specification Cannot be Evaluated.

Parent Requirements: R00690, R00392, R00302.

Reagents

 

Additions and changes to support new functionality:

In Reagent Types, added Manage Container Inventory Flag info, updated all fields, columns, and images.
In Reagent Lots, updated all fields, columns, and images.
In Reagent Example, updated all fields, columns, and images.
In Reagent Lot Status, updated images.
Added new UseReagent Page Type.

Parent Requirement: R00721.

Specifications

 

Additions and changes to support new functionality:

Added Reporting Labels for Specification Limits.
Added a link in When a Specification Cannot be Evaluated to the "Rule for Undetermined Spec Limits" property in the Data Entry Policy .

Parent Requirement: R00302.

Stability

 

Additions and changes to support new functionality:

Added new document for Unit Validation. Added reference for Unit Validation to Studies, Protocols, Inventory Calculation, and Tasks.
Updated images in Studies, Protocols, Plans, and Tasks.

Parent Requirement: R00076.

Test Methods

 

Reworked these sections and added/changed information to support new and changed functionality:

Updated Concepts of Workitems to focus on features now visible through the Test Method interface.
Rewrote Test Methods (Workitems) to incorporate the most recent functional changes and anything that remained relevant from "Concepts of Workitems":
Overview section now contains Basic Workitem Concepts.
Updated Workitem Details section.
Added link to Concepts of Versioning to describe new Versioning functionality.
Deleted "Concepts of Data Entry" and used the intro for a new topic called Adding and Maintaining Tests, which now includes:
Intro to Workitem configuration for Test Methods
Data Entry Structure
Adding Tests to Samples
Test Maintenance (includes new features for Workitem Groups)
Data Set and Test Status Transitions (includes new Workitem rollup rules)
In Manage Data Sets and Manage Tests, added separate sections for Cancelling and Uncancelling Data Sets and Cancelling and Uncancelling Tests (respectively).
In Data Entry Common Functionality, updated description of "Retest" and "Remeasure".

Parent Requirement: R00605.

Versioning

 

Additions and changes to support new functionality:

In Concepts of Versioning, deleted information that is no longer relevant in LABVANTAGE 6, added "New Version" and "Approve Version" to describe new Versioning functionality, and added link to "Select Current" Version in Sample Templates in Products.
In Concepts of Versioning, added Product Test Method and QCMethod Versioning.
In Test Methods and Products, added a link to "New Version" and "Approve Version" to describe new Versioning functionality.
In Products, added "Select Current" Version in Sample Templates (feature is available only with Products and Sample Templates).
Added Version Filter to advancedsearch Element and added link from MaintenanceList Page Type Version property.

Parent Requirement: R00096.

WPD Elements

 

Additions and changes to support new functionality:

In gwtdataentrygrid Element, added "Options After Instrument Fill" and "Error Status Option" properties (with link to Limit Rule information concerning handling of Absurd Limits).
In advancedtoolbar Element, added "Display style", "Ribbon style", "Large Image", "Group", "Show title in Ribbon", and "Keyboard Shortcut" properties. Also added a section on preconfigured Keyboard Shortcuts.

Web Security

 

Additions and changes to support new functionality:

Added new Security Policy to specify the level of security to which the system is configured.
In Concepts of Security, changed the description of how the ConnectionId is generated (now is purely random that is not generated in any defined sequence) and added information and link to the new Security Policy.

Parent Requirement: R00873.

Workitems (Generic)

 

General maintenance and updates to Concepts of Workitems:

Rewrote Concepts of Workitems to more closely align with Test Methods and updated to eliminate features that were available only in LVX.
Rewrote the examples for Add and Apply.

 

Changes Made in Document Revision X111223-60

Top
This document revision contains changes made to these areas of LABVANTAGE 6 functionality:
Action Public Interfaces 
External Authentication 
Specifications     
AQM (Batch Management) 
40 Character SDI KeyId 
Users and Roles     
Attachments 
Instrument Certification 
Work Assignment     
Departmental Security and SDC Access 
Java Public API           
Document Restructuring and Repackaging 
Job Types           
Event Plans 
Policies           

 

Action Public Interfaces

 

Updated the Javadoc for the System Action Public Interfaces.

Parent Requirement: None.

AQM (Batch Management)

 

Added new functionality for Batch Genealogy and Batch Stages:

Added Batch Genealogy
Added Batch Stages.
Modified Batch Operations to incorporate Genealogy and Stages.
Modified Sampling Plans to incorporate Stage functionality.
Added genealogyviewer Element.
Added Product Formulation tab to Product Maintenance page.

Parent Requirement: R00404.

Attachments

 

Added new Attachments functionality:

In Attachments:
Added "URL", "Plain Text", "Linked Reference", "Copy-Down Policy" link, and "Attachment Class".
Reorganized to accommodate new divisions of functionality among the options.
In AttachmentManager Page Type, added enhancement to Viewing and Downloading Attachments.

Parent Requirement: R00399.

Departmental Security and SDC Access

 

Modified Departmental Security to support Job Types:

Rewrote sections of Concepts of LABVANTAGE Security concerning Departmental Security and SDC Access to reflect functionality changed with respect to Job Types.
Added reference from SDC Operations link to Departmental Security and SDC Access and Job Types.
Modified advancedtoolbar Element to add Departmental Security button property.

Parent Requirement: R00390.

Document Restructuring and Repackaging

 

This document has been restructured and converted from a scratchbuilt Web site to MadCap Flare. Functionality no longer supported by LABVANTAGE 6 has been removed. These actions were taken to accomplish this restructuring:

Deleted legacy and orphaned files.
Removed all LVX files and references.
Removed all Client-Side Action files and references.
Removed all references to Workflows and Workflow-specific Actions.
Removed all LVX images and image references.
Changed all instances of LabVantage to LABVANTAGE. Added anchor named references to prepare for next name change.
Removed all Jaguar references and Jaguar-specific instructions.
Changed all character encoding to UTF-8.
Built Flare packaging and rendering framework for LABVANTAGE 6.
Tested rendering framework in:
Apple Safari 5.05 (7533)
Google Chrome 16.0 (912.63)
Microsoft Internet Explorer 8.0 (7601) and 9.0 (8112)
Mozilla Firefox 5.0
Opera 11.01 (1190)

Parent Requirements: DOC001, DOC002, DOC003.

Event Plans

 

Added new "Event Plan" functionality:

Added Event Plans
Added sdieventplanmaint Element (with example linked to Local Event Plans).

Parent Requirement: R00393.

External Authentication

 

In External Authentication, modified the "Enable LDAP Authentication" property to specify choice of External or Internal Authentication (rather than just enabling or disabling authentication through the LDAP server).

Parent Requirement: None.

40 Character SDI KeyId

 

Added new "40 character SDI KeyId" option:

In the primary form of the SDC Maintenance page, added "Usable Key Length" field.
In Naming Restictions, changed maximum key lengths.

Parent Requirement: R00412.

Instrument Certification

 

Added new "Instrument Certification" functionality:

Added Instrument Certification.
In Parameter Lists, added "Default Usage Time per Use" to indicate the typical time an Instrument is in use each time it is used.
Added planitemmanager Element.

Parent Requirement: R00403.

Java Public API

 

Updated the Javadoc for the Java Public API.

Parent Requirement: None.

Job Types

 

Added new Job Types functionality to Concepts of LABVANTAGE Security.

Parent Requirement: R00390.

Policies

 

Added and modified Policy functionality:

Added new Attachment Policy.
Updated Batch Sample Policy to include Sync Batch Release to Batch Stage, Sample Creation Policy, Max Split Count, Sampling Plan Version, Release Stages Open Incidents, and Cancel Action Behavior.
Added new Copy-Down Policy.
Deleted examples of CSS Visual Policies in Data Entry Policy pending determination of supported styles. 
Added new Navigator Policy with worked example (referenced by link in Policies).

Parent Requirements: R00394, R00399, R00404, R00690.

Specifications

 

Modified Specifications to incorporate enhancements:

In the Specification Maintenance page:
Added Using Limit Type Rules for associating non-numeric tags with Spec Conditions. Also added link to this in Examples of Textual Operators and Values.
In Examples of Numeric Operators and Values, added "In" and "Not In" operators and noted the auto-population of Operator field on tab out. Also added a note to indicate that you can enter the entire expression in the Value1 field and auto-populate when tabbing out.
Added Default Condition to report a Spec Condition when no values match criteria.

Parent Requirement R00302.

Users and Roles

 

In User Maintenance Page, added "Security Type", "Base Department", "Default Job Type", "Last Logon Job Type", "Default Department", and "Authentication Type" with links to examples in Departmental Security and SDC Access and Job Types.

Parent Requirement: R00390.

Work Assignment

 

Added changes to support new Work Assignment functionality:

In the Department Maintenance page:
Added the new options "Is Testing Lab", "Can Receive Bulletin", "Can Have Custody", "Can Be Assigned Work", and "Can Take Ownership".
Added links to new information in Manage Data Sets, Manage Tests, and Manage Worksheets, QC Batches, Stability Workorders, and CAPA Workorders, Departmental Security and SDC Access and Job Types.
In the Test Method Maintenance page, added the "Responsible Laboratory" field.
In eForm Worksheet Principles: Creating Worksheets, modified Worksheet creation instructions to use new buttons on the Data Set List and Maintenance pages, Workitem (Test Method) List and Maintenance pages, OC Batch List page, and Workorder List pages for Stability and CAPA. Updated screen captures.
In Manage Data Sets, Manage Tests, and Manage Worksheets:
In the Data Set List page: Renamed "Create and Assign Worksheet" button to "Create Worksheet & Assign User", added "Create Worksheet & Assign Department" and "Assign Department" buttons, modified "Assign Analyst" button to include filter by Department.
In the Data Set Maintenance page: Renamed "Create and Assign Worksheet" to "Create Worksheet & Assign User", added "Create Worksheet & Assign Department" button.
In the Workitem List page: Renamed "Create and Assign Worksheet" button to "Create Worksheet & Assign User", added "Create Worksheet & Assign Department", "Assign Department", and "Assign Analyst" buttons.
In the Test Method (Workitem) Maintenance page: Renamed "Create and Assign Worksheet" to "Create Worksheet & Assign User", added "Create Worksheet & Assign Department" button.
In the QC Batch List page: Renamed "Create and Assign Worksheet" button to "Create Worksheet & Assign User", added "Create Worksheet & Assign Department", "Assign Department", and "Assign Analyst" buttons.
In Stability Workorders, and CAPA Workorders: Added "Assign Department", and "Assign Analyst" buttons.

Parent Requirement: R00392.

Items Under Investigation (for future document release):

Departmental Bulletins
SDIData Departmental Security
SDIWorkitem Departmental Security