LES Worksheet Generation |
Content |
||||||||||||||||||||||||||||
|
LabVantage LES Implementation |
|
|
The LabVantage implementation of "Laboratory Execution System" (LES) generates a Worksheet based on a Global LES Worksheet Template and any of these SDIs:
• | Test Method | • | Instrument Model or Instrument Type | • | Consumable Type | ||
• | QC Method | • | Sample Type or Sample SubType |
For the purposes of this discussion, the "Master Object" contains information used by the LES Worksheet Template to generate the LES Worksheet. The Worksheet is generated by executing an operation on one of the "Instance Objects".
![]() |
![]() |
|
![]() |
![]() |
|
![]() |
Objects (SDC/SDI) | High-Level Description of LES Worksheet Generation | ||||||||||||||||||||
|
Test Method The Test Method is input to a Global Worksheet Template for LES Worksheets. The Test Method defines these items that are used by the Template to generate the LES Worksheet:
Optionally, the Test Method can also define:
LES Worksheet Template The LES Worksheet Template uses information in the Test Method to generate the LES Worksheet (such as Attributes Controls that act as placeholders for LES Text, and Sections/Controls required to fulfill the purpose of the Worksheet). Test A Test based on the Test Method is added to the Sample. LES Worksheet The Worksheet is generated on the Test in accordance with the chosen Create LES Worksheet Rule and Author Rule. |
||||||||||||||||||||
|
QC Method The QC Method is input to a Global Worksheet Template for LES Worksheets. The QC Method defines these items that are used by the Template to generate the LES Worksheet:
Optionally, the Test Method can also define:
LES Worksheet Template The LES Worksheet Template uses information in the QC Method to generate the LES Worksheet (such as Attributes Controls that act as placeholders for LES Text, and Sections/Controls required to fulfill the purpose of the Worksheet). QC Batch The QC Method is associated with the QC Batch. LES Worksheet The Worksheet is generated on the QC Batch in accordance with the chosen Create LES Worksheet Rule and Author Rule. |
||||||||||||||||||||
|
Instrument Model or Instrument Type The Instrument Model or Instrument Type is input to a Global Worksheet Template for LES Worksheets. When Worksheets are generated, an attempt is made to use the LES configuration in the Instrument Model. If no configuration exists for the Instrument Model, the Instrument Type is used (providing it has an LES configuration). The Instrument Model or Type defines these items that are used by the Template to generate the LES Worksheet:
LES Worksheet Template The LES Worksheet Template uses information in the Instrument Model (or Type) to generate the LES Worksheet (such as Attributes Controls that act as placeholders for LES Text, and Sections/Controls required to fulfill the purpose of the Worksheet). SDICertification Schedule Task The Instrument's Schedule Plan for Calibration or Maintenance at the specified Calibration Interval executes an SDICertification Schedule Task. Workorder The SDICertification Schedule Task generates the Instrument Certification Workorder. LES Worksheet The Worksheet is generated on the Instrument Certification Workorder in accordance with the chosen Create LES Worksheet Rule and Author Rule. |
||||||||||||||||||||
|
Sample Type or Sample SubType
The Sample Type or Sample SubType is input to a Global Worksheet Template for LES Worksheets. When Worksheets are generated for multiple Samples, all must be of the same Type or SubType. If all Samples are of the same SubType, an attempt is made to use the LES configuration in the Sample SubType. Otherwise, all Sample Types are checked. If all Samples are of the same Sample Type, the Sample Type is used (providing it has an LES configuration). The Sample Type or SubType defines these items that are used by the Template to generate the LES Worksheet:
LES Worksheet Template The LES Worksheet Template uses information in the Sample Type (or SubType) to generate the LES Worksheet (such as Attributes Controls that act as placeholders for LES Text, and Sections/Controls required to fulfill the purpose of the Worksheet). Sample The Sample Type (or SubType) is associated with a Sample. LES Worksheet The Worksheet is generated on the Sample in accordance with the chosen Create LES Worksheet Rule and Author Rule. |
||||||||||||||||||||
|
Consumable Type
The Consumable Type is input to a Global Worksheet Template for LES Worksheets. The Consumable Type defines these items that are used by the Template to generate the LES Worksheet:
LES Worksheet Template The LES Worksheet Template uses information in the Consumable Type to generate the LES Worksheet (such as Attributes Controls that act as placeholders for LES Text, and Sections/Controls required to fulfill the purpose of the Worksheet). Consumable Lot The Consumable Type is associated with the Consumable Lot. LES Worksheet The Worksheet is generated on the Consumable Lot in accordance with the chosen Create LES Worksheet Rule and Author Rule. |
Create LES Worksheet Rule |
|
|
"Create LES Worksheet Rule" lets you choose how you want to generate the Worksheet:
Create LES Worksheet Rule | Description | |||||||||||||||||||||
On Creation | Automatically generates the LES Worksheet when an event
occurs as shown below (also see Author Rule
below).
|
|||||||||||||||||||||
On Demand | Manually generates the Worksheet when the button on the
relevant page is clicked as shown below (also see Author
Rule below).
|
|||||||||||||||||||||
On Assignment | Automatically generates the Worksheet when an Analyst
is assigned (also see Author Rule below).
|
|||||||||||||||||||||
On Receive |
Automatically generates the Worksheet when a Sample is Received (also
see Author Rule below).
|
Author Rule |
|
|
The "Author Rule" lets you define the "Author" of the LES Worksheet. The "Author" is the User who is granted "Author" User Privileges for the Worksheet. In the database, the Author is persisted in Worksheet.AuthorId. This allows operations such as querying to show all Worksheets having no Author. This is how it works:
Master Object | Create LES Worksheet Rule | Operation | Author Rule | Worksheet Author |
Test Method | On Demand | LIMS → Tests → Manage Tests →
SDIWorkitem List → Create LES Worksheet |
Current User | User who created the Worksheet. |
Assigned User | If the selected Tests are not assigned to any Users,
the Author is (null). The first User who opens the Worksheet becomes the
Author.
If the selected Tests are assigned to a single User, that User becomes the Author. If the selected Tests are assigned to multiple Users (and/or some Tests are not assigned to any Users), an error is generated. The same Analyst (User) must be assigned to all selected Tests. |
|||
LIMS → Tests → Manage Tests →
SDIWorkitem List → Create & Assign LES Worksheet |
Current User | If the selected Tests are not assigned to any Users,
a dialog prompts you to choose a User. The chosen User becomes the Author,
and all selected Tests are assigned to that User.
If the selected Tests are assigned to one or more Users (and/or some Tests are not assigned to any Users), a dialog prompts with the message "Workitems already assigned. Would you like to reassign?". If "Yes", the newly selected User becomes the Author, and all selected Tests are assigned to that User. If "No", no action is taken. |
||
Assigned User | Same as "Current User" above. In this case, the Author Rule makes no difference. | |||
On Creation | Add Test to Sample. | Current User | User who created the Worksheet. | |
Assigned User | Always (null), since you cannot assign a User to a Test before you add the Test. The first User who opens the Worksheet becomes the Author. | |||
On Assignment | LIMS → Tests → Manage Tests →
SDIWorkitem List → Assign Analyst |
Current User | User who created the Worksheet, regardless of the User who is actually assigned to the Test. | |
Assigned User | User (Analyst) assigned to the Test. |
Master Object | Create LES Worksheet Rule | Operation | Author Rule | Worksheet Author |
QC Method | On Demand | LIMS → AQC → QC Batches →
Create LES Worksheet |
Current User | User who created the Worksheet. |
Assigned User | If the selected QC Batch is assigned to a User, that User becomes the Author of the Worksheet; otherwise, the Author remains (null). The first User who opens the Worksheet becomes the Author. | |||
On Creation | Create QC Batch (based on QC Method). | Current User | User who created the Worksheet. | |
Assigned User | Always (null), since you cannot assign a User to a QC Batch before you create the QC Batch. The first User who opens the Worksheet becomes the Author. | |||
On Assignment | LIMS → AQC → QC Batches →
Assign Analyst |
Current User | User who created the Worksheet, regardless of the User who is actually assigned to the QC Batch. | |
Assigned User | User (Analyst) assigned to the QC Batch. |
Master Object | Create LES Worksheet Rule | Operation | Author Rule | Worksheet Author |
Instrument Model Instrument Type |
On Demand | LIMS → Instrument Certification →
Pending Certifications → Create LES Worksheet |
Current User | User who created the Worksheet. |
Assigned User | If the selected Workorder is assigned to a User, that User becomes the Author of the Worksheet; otherwise, the Author remains (null). The first User who opens the Worksheet becomes the Author. | |||
On Creation | Create Instrument Certification Workorder (System Admin → Schedule Plan List → Scheduling). |
Current User | User who created the Worksheet. | |
Assigned User | If the selected Workorder is assigned to a User, that User becomes the Author of the Worksheet; otherwise, the Author remains (null). The first User who opens the Worksheet becomes the Author. | |||
On Assignment | Assign Instrument Certification Workorder to a User by editing the Workorder (LIMS → Instrument Certification → Workorder List → Edit). | Current User | User who created the Workorder, regardless of the User who is actually assigned to the Workorder. | |
Assigned User | User assigned to the Workorder (in the Edit Workorder page). |
Master Object | Create LES Worksheet Rule | Operation | Author Rule | Worksheet Author |
Sample Type | On Demand | LIMS → Samples → Manage →
Create LES Worksheet |
Current User | User who created the Worksheet. |
Assigned User | This choice is not available, since there is nothing to assign. | |||
LIMS → Samples → Manage →
Create & Assign LES Worksheet |
Current User | A dialog prompts you to choose a User. The chosen User becomes the Author. | ||
Assigned User | This choice is not available, since there is nothing to assign. | |||
On Receive | Sample is Received. | Current User | User who Received the Sample and thereby created the Worksheet. | |
Assigned User | This choice is not available, since there is nothing to assign. |
Master Object | Create LES Worksheet Rule | Operation | Author Rule | Worksheet Author |
Consumable Type | None (all are created on demand) | Consumables → New Consumable Lot
List → Mix Consumable Using Worksheet |
Current User | User who created the Worksheet. |
Assigned User | This choice is not available, since there is nothing to assign. | |||
Consumables → New Consumable Lot
List → Create LES Worksheet |
Current User | User who created the Worksheet. | ||
Assigned User | This choice is not available, since there is nothing to assign. | |||
Consumables → New Consumable Lot
List → Create & Assign LES Worksheet |
Current User | A dialog prompts you to choose a User. The chosen User becomes the Author. | ||
Assigned User | This choice is not available, since there is nothing to assign. |
LES Worksheet Template Detail |
|
|
The sdidetailmaint Element in the SDI Maintenance page for the Definition SDI contains a "worksheettemplates" property list, which renders a "Worksheet Templates" detail tab. This allows selection of the Template used to generate the LES Worksheet. The example below shows the detail in the Test Method Maintenance Page.
![]() |
Operation | Description | |||||||||||||
Add | Opens a lookup that lets you choose a Global LES Worksheet
Template that is relevant to the Master Object. The "Version"
is automatically populated with the Version of this Template. These Global
LES Worksheet Templates are provided OOB and configured for the specified
OOB Master Object:
A "Base LES Worksheet" OOB LES Worksheet Template is also provided. This creates a basic LES Worksheet for an SDI. See QC Batch Viewer Control for an example.
|
|||||||||||||
Remove | Removes the selected Worksheets and dissociates them from the Master Object. | |||||||||||||
Use Current | Changes the Template Version to the current Version (see Concepts of SDI Versioning and Approval), which is then identified as (Ver: C). | |||||||||||||
Select Workbook | Opens a lookup that lets you choose the Workbook that will host this Worksheet. This is populated by the WorkbookId. The "Workbook Name" is automatically populated with the Workbook "Description". | |||||||||||||
View Template | Opens a structural preview of the selected Worksheet Template. This is available only in the Test Method Maintenance page. | |||||||||||||
Preview | Creates an LES Worksheet based on the SDIs listed in the "Preview Samples(s)" field.
|
Field | Description |
Template Id
Version Template Name |
Identifier, Version, and name of the Worksheet Template. |
Workbook Id
Workbook Name |
Identifier and name of the Workbook that hosts the Worksheet. |
Author Rule | Specifies the Author Rule for Worksheet generation. |
Default | Indicates the Worksheet that is used if none is specified at time of creation. |
Max per Worksheet | This is available in the Test Method Maintenance page
and Sample Type Maintenance page. When generating Worksheets "On
Demand" for selected SDIs in the Manage
Tests page (or Sample List
page), this specifies the maximum number of Tests (or Samples) to
be included in each generated Worksheet.
When a Worksheet is generated in the Manage Tests page, Samples are displayed in the Worksheet in the order in which the Tests are passed to the GenerateTestMethodWorkSheet Action. For example, if Tests are passed in the order 1283; 1282; 1284; 1281 for 4 samples S-180205-00003, S-180205-00002, S-180205-00004, S-180205-00001 respectively and "Max per Worksheet" is set to 3 in the Test Method, the first Worksheet will contain the Tests for the 3 Samples S-180205-00003, S-180205-00002, S-180205-00004 and the second Worksheet will contain the Test for the last Sample S-180205-00001. When a Worksheet is generated in the Sample List page, Samples are displayed in the Worksheet in the order in which the Samples are passed to the GenerateSampleWorkSheet Action. For example, if 5 Samples S-180125-00003;S-180125-00001;S-180125-00005;S-180125-00002;S-180125-00004 are passed into the Action and "Max per Worksheet" is set to 2 in the Sample Type, the first Worksheet will contain Samples S-180125-00003 and S-180125-00001, the second Worksheet will contain Samples S-180125-00005 and S-180125-00002, and the third will contain Sample S-180125-00004. |
Preview Samples | Define a semi-colon separated list of Samples with which this Test Method is associated. This list is used to provide a preview of an LES Worksheet based on those Workitems (Preview button). |
LES Text |
|
|
The maintattribute Element in the SDI Maintenance page for the Definition SDI contains a "linkattributes" property list, which renders an "LES Text" detail tab as shown in the example below.
![]() |
The "LES Text" detail defines:
• | "Information" such as methodology, warnings, directives, and so on. |
• | "Instructions" such as a stepped Task to be completed and acknowledged by clicking a checkbox at runtime. |
• | "Attributes" that collect information to be stored in the Worksheet (as opposed to information that is stored against the Samples and Tests themselves). |
This is essentially a collection of Attributes, each Attribute defining Instructions and Information that will be rendered by each Attributes Control in the Worksheet. Where applicable, some Definition SDCs also have specialized operations in the detail. For example, Test Methods include the "Linked To" dropdown that allows linking the Attribute to a specific Parameter List. Note that in this example Worksheet, separate Attribute Information in the form of bulleted lists is provided for each Parameter List.
This is configured in a manner similar to that shown in Attributes → Adding Attributes to Tests → Creating Attributes Not Defined in the Attributes Master List. However, a key difference when dealing with LES Text is the behavior of the "Create Attribute" button. In the context of LES Text, "Create Attribute" asks for the Attribute "Type" (below left). Choosing an "Instruction" or "Information" Type inserts a row of that Type and defaults the Data Type to S (String). If you choose a "Standard" Type (below center), you can also choose the Data Type for the Standard Attribute. If you want to apply an Editor Style (below right), the lookup is filtered by the chosen Attribute type (see Editor Styles if you are not familiar with them).Also note selecting an attribute type of Information or Instruction will
![]() |
The "Position" dropdown allows setting the position of each Attributes collection in the LES Worksheet. The "Position" of each Attribute in this detail corresponds to Attributes Controls in the Worksheet that are defined with the same Position. This is how it knows where to put each Attribute in the Worksheet.
The best example of how these LES Text Attributes are inserted into the Worksheet can be found in the OOB configuration for the Alkali Metals Test Method (see LES Global Worksheet Template based on Test Methods → LES Text Content and Positioning). This also has example of Repeating Sections, which repeat Sections based on conditions in the Worksheet.
Specialized Worksheet Options |
|
|
Among the numerous Worksheet options described in ELN Worksheet Manager → Detail Panels → Actions → Worksheet Options, two can be used to provide specialized direction for to LES Worksheets:
• | In the "Worksheet" tab of Worksheet Options, the "Policy" option can point to a specific node of the ELN Policy, thereby assuming the property definitions for that node. |
• | In the "LES" tab of Worksheet Options, checking "LES" identifies the Worksheet as an LES Worksheet. Options can be exercised such as excluding Sections that have no included/visible Controls and/or Controls with no data. |
Basic OOB LES Worksheet Generation Examples |
|
|
Here are some basic examples of how LES Worksheets can be quickly generated using preconfigured functionality provided by the OOB configuration. For more variations, see Create LES Worksheet Rule and Author Rule.
NOTE: | An LES Worksheet can be created only if the Instance Object does not already have a Worksheet. |
The "Alkali Metals" Test Method is preconfigured for the "Standard WorkItem LES Worksheet (Verbose)" Worksheet as follows:
Item | Description |
Create LES Worksheet Rule | On Demand |
Worksheet Template | Standard WorkItem LES Worksheet (Verbose) |
Workbook | Defaults to the current Workbook. |
Author Rule | Current User |
Add a Sample, then add the "Alkali Metals" Test Method to the Sample. In this example:
a. | Select the Test in the Manage Tests page. | |
b. | Click the "Create LES Worksheet" button. | |
c. |
Click the Worksheet icon that is shown for the selected Test. The Worksheet
opens in the Worksheet Manager.
|
If the "Create LES Worksheet Rule" is "On Creation", the Worksheet is generated when the Test Method is added to the Sample (and saved).
If the "Create LES Worksheet Rule" is "On Assignment" and the "Author Rule" is "Assigned User", the Worksheet is generated when you click the "Assign Analyst" button in the Manage Tests page, then choose the Analyst to which the Test will be assigned.
NOTE: | For more variations, see Create LES Worksheet Rule and Author Rule. |
The "Precious Metals" QC Method is preconfigured OOB as follows:
Item | OOB Configuration Setting |
Create LES Worksheet Rule | On Demand |
Worksheet Template | QCBatch LES Worksheet |
Workbook | Defaults to the current Workbook. |
Author Rule | Current User |
Add a QC Batch that is associated with the "Precious Metals" QC Method. In this example:
a. | Select the QC Batch in the QC Batch List page. | |
b. | Click the "Create LES Worksheet" button. | |
c. | Click the Worksheet icon that is shown for the selected QC Batch. The
Worksheet opens in the Worksheet Manager.
|
If the "Create LES Worksheet Rule" is "On Creation", the Worksheet is generated when the QC Batch is created.
If the "Create LES Worksheet Rule" is "On Assignment" and the "Author Rule" is "Assigned User", the Worksheet is generated when you click the "Assign Analyst" button in the QC Batch List page, then choose the Analyst to which the QC Batch will be assigned.
NOTE: | For more variations, see Create LES Worksheet Rule and Author Rule. |
The "pH Meter" Instrument Type is preconfigured OOB as follows:
Item | OOB Configuration Setting |
Create LES Worksheet Rule | On Demand |
Worksheet Template | Instrument Certification LES Worksheet |
Workbook | Defaults to the current Workbook. |
Author Rule | Current User |
Generate a Workorder for Daily Calibration using the SDICertification Schedule Task in the "Calibration" Schedule Plan. In this example:
a. | Select the Workorder in the Pending Certifications page (LIMS →
Instrument Certification → Pending Certifications). |
|
b. | Click the "Create LES Worksheet" button. | |
c. | Click the Worksheet icon that is shown for the selected Workorder.
The Worksheet opens in the Worksheet
Manager.
|
If the "Create LES Worksheet Rule" is "On Creation", the Worksheet is generated when the Instrument Certification Workorder is created (System Admin → Schedule Plan List → Scheduling).
If the "Create LES Worksheet Rule" is "On Assignment" and the "Author Rule" is "Assigned User", the Worksheet is created when the Instrument Certification Workorder is assigned to a User by editing the Workorder (LIMS → Instrument Certification → Workorder List → Edit).
NOTE: | For more variations, see Create LES Worksheet Rule and Author Rule. |
The "Finished" Sample Type is preconfigured OOB as follows:
Item | OOB Configuration Setting |
Create LES Worksheet Rule | On Demand |
Worksheet Template | Finished Product Sample LES Worksheet |
Workbook | Defaults to the current Workbook. |
Author Rule | Current User |
Associate the "Finished" Sample Type with a Sample. In this example:
a. | Select the Sample in the Sample List page. | |
b. | Click the "Create LES Worksheet" button. | |
c. | Click the Worksheet icon that is shown for the selected Workorder.
The Worksheet opens in the Worksheet
Manager.
|
If the "Create LES Worksheet Rule" is "On Receive", the Worksheet is generated when the Sample is Received.
NOTE: | For more variations, see Create LES Worksheet Rule and Author Rule. |
There is no preconfigured Consumable Type. Add a Worksheet Template to a Consumable Type as follows:
Item | Configuration Setting |
Create LES Worksheet Rule | Consumable Types do not have this option. All LES Worksheets are created on demand. |
Worksheet Template | Mix Consumable LES Worksheet |
Workbook | Defaults to the current Workbook. |
Author Rule | Current User |
Add a Consumable Lot that is associated with the Consumable Type, then:
a. | Select the Consumable Lot in the New Consumable Lots List page. | |
b. | Click the "Create LES Worksheet" button. | |
c. | Click the Worksheet icon that is shown for the selected Consumable
Lot. The Worksheet opens in the Worksheet
Manager.
|
NOTE: | For more variations, see Create LES Worksheet Rule and Author Rule. |