Content |
||||||||||||||||||
|
Prerequisites |
|
|
Before attempting to use or configure this LES Worksheet, you must be familiar with the mechanics of ELN/LES (particularly LES Worksheet Generation), Samples, Parameter Lists, and Test Methods.
|
Test Method Configuration |
|
|
Overview |
The "Alkali Metals" Test Method is configured OOB to provide input to several OOB LES Global Worksheet Templates. Key configuration elements of the Alkali Metals Test Method are shown below.
|
|
Test Method LES Worksheet Definition |
This example uses the "Standard WorkItem LES Worksheet (Verbose)" Template. The "Worksheet Templates" detail is described in LES Worksheet Template Detail. The "LES Text" detail is described in LES Text, with a configuration example in LES Text Content and Positioning below.
Parameter List Detail: Data Set Definition |
Make certain you are comfortable with the configuration options offered by Test Method Rules. Since there is a "Preparation" and "Procedural" Parameter List, the "Availability Rule" for the "Procedural" Parameter List is set to "Make Available when all Data Sets of all Parameter Lists of Type Preparation are Completed" (as described in Test Methods → Rules → Rules for Parameter Lists → Availability Rules and Add Rules). This enforces the system Rule that states if a Sample has Preparation and Procedural Data Sets, Data Entry on the Procedural Data Sets is prevented until data for the corresponding Preparation Data Sets have been entered/saved/Released (as described in Data Entry for Preparational and Procedural Data Sets).
Equipment and Consumable Types Detail |
These are straightforward assignment of Equipment (Instruments) and Consumable Types to the Test Method. As we will see later, these will be rendered in the Worksheet by Equipment Controls and Consumables Controls, respectively.
Note that a "Linked To" dropdown similar to that shown in Associating Instruments with Test Methods and Associating Consumable Types With Test Methods allows the Equipment or Consumable Type to be associated with a specific Parameter List. In this Worksheet, note that:
| • | For Equipment, the Balance is associated with the Preparation Parameter List. The GC is blank, so it applies to the Test Method as a whole. |
| • | For Consumable Types, both are associated with the Procedural Parameter List. |
LES Worksheet Template OOB Configuration |
|
|
Overview |
This example describes the "Standard WorkItem LES Worksheet (Verbose)" Core LES Worksheet Template that is provided in the OOB configuration. These Worksheet options are most notable with regard to this specific Template:
| • | In the "Worksheet SDCs" tab of Worksheet Options, the SDC is set to "SDIWorkitem". This is the SDC associated with the Worksheet. |
| • | In the "LES" tab of Worksheet Options, "LES" is set to exclude Sections that have no included/visible Controls and Controls with no data. |
Template Structure |
The high-level structure of the "Standard WorkItem LES Worksheet (Verbose)" LES Worksheet Template is described below. LES Text and other superfluous content (such as most Attribute Controls and Rich Text Controls) have been omitted for clarity. The emphasis is directed toward LIMS data (such as SDI Maintenance and Data Entry).
| Section | Control | ||||||||||
| Introduction | SDI Viewer Controls to show the Sample and Test. | ||||||||||
| 1. $S{workitemid} Test | |||||||||||
|
|||||||||||
| 2. $S{paramlistid} - $S{variantid} | This is configured as a "Repeating Section" to repeat the Section once for each Data Set defined in the Test (see Repeating Sections Over Workitem Parameter Lists). | ||||||||||
|
|||||||||||
| 3. Additional Observations and Remarks | Information and Instruction Attributes associated with the Worksheet. |
This Worksheet is executed using the GenerateTestMethodWorksheet Action.
This Worksheet accepts the following substitution tokens:
| Context | Substitution Tokens |
| Worksheet Name | The $S{sdiworkitemid} token can be used to substitute values in the Worksheet Name. |
| General | These tokens can be used to substitute values throughout
the Worksheet:
$S{paramlistid}, $S{paramlistversionid}, $S{variantid}, $S{dataset}, $S{workitemid}, $S{workitemversionid}, and $S{sdiworkitemid}. Additionally, any column of the SDIWorkitem or SDIWorkitemItem table can be used by specifying the column in the format $S{tableid.columnid}. |
Worksheet Generated from Template |
This describes the Worksheet generated OOB from the Template. LES Text and other superfluous content (such as most Attribute Controls and Rich Text Controls) have been omitted for clarity. The emphasis is directed toward LIMS data (such as SDI Maintenance and Data Entry).
|
The SDI Viewer Controls identify the Sample and Test.
 |
In the opening SDI Viewer Control, "Edit" allows interaction with the Information and Instruction Attributes associated with the Test.
 |
In the next SDI Viewer Control, "Edit" allows the Instrument to be chosen for the Test.
 |
As previously noted, the Worksheet is set to exclude Sections that have no included/visible Controls and Controls with no data. In this example, the remaining SubSections defined by the Template for the Test are therefore not shown, since no data exists in the Test.
The next Section handles the Parameter Lists. Since Equipment is defined, the "Equipment" SubSection allows the Instrument to be chosen for the Data Sets.
 |
In the first Data Entry SubSection, "Edit" allows data to be entered for the Preparation Parameter List. As previously discussed, you must enter data for the Preparation Parameter List before proceeding to the Procedural Parameter List. You must "Mark as Complete" to Save and Release the data before proceeding to the next Section. You can do this in the Data Entry screen or on the Control Toolbar, in which case a "Revert to InProgress" button is then provided for the Control. See ELN/LES Life Cycles for descriptions of status transitions.
 |
In the SubSection for this Parameter List, "Edit" allows Consumables to be chosen for the Test.
 |
The next Data Entry SubSection allows data to be entered for the Procedural Parameter List. You must "Mark as Complete" to Save and Release the data before proceeding to the next Section. You can do this in the Data Entry screen or on the Control Toolbar, in which case a "Revert to InProgress" button is then provided for the Control. See ELN/LES Life Cycles for descriptions of status transitions.
 |
In the last Section, "Edit" allows interaction with the Information and Instruction Attributes associated with the Worksheet.
 |
LES Text Content and Positioning |
|
|
As indicated in LES Text, the "LES Text" detail uses the Attributes framework. Attribute content defined in the Test Method's "LES Text" detail are placed into the LES Worksheet Template using the "Position" dropdown. These map to the "Position" property in Attributes Controls in the Worksheet. As indicated in Attributes Control, the "Position" values in the Attributes Control can be defined for "Worksheet Attributes", which are Attributes added to the Control.
In the "Standard WorkItem LES Worksheet (Verbose)" Template, the content of the Worksheet Attribute positioned as "Preamble" is placed in the Attribute Control with the matching "Position" of "Preamble":
 |
In a similar manner, multiple contents of the Worksheet Attribute positioned as "Start Section " are placed in the Attribute Control with the matching "Position" of "Start Section":
 |
At the end of the Template, the content of the Worksheet Attributes positioned as "Postamble" are placed in the Attribute Control with the matching "Position" of "Postamble":
 |
|
Repeating Sections |
|
|
Overview |
Using the LES Section Option "Repeat Sections Over", LES Worksheet Templates can be configured to repeat Sections:
| • | Once for each Data Set defined in a Test (as in the "Standard WorkItem LES Worksheet (Verbose)" Template). This is the Repeat Sections Over Workitem Parameter Lists option. |
| or | |
| • | Once for each Child Test that is defined in a Test Group (as in the "Grouped Workitem LES Template (Verbose)" Template). This is the Repeat Sections Over Group Workitems option. |
Repeating Sections Over Workitem Parameter Lists |
The "Standard WorkItem LES Worksheet (Verbose)" LES Worksheet Template is configured to repeat the Parameter List Section once for each Data Set defined in the Test. The LES Section Option "Repeat Sections Over" property is set to "Workitem Parameter Lists". This repeats the Parameter List Section twice. The first repeat is for the "Preparation" Parameter List (1 and 2 below). The second repeat is for the "Procedural" Parameter List (3 and 4 below). This is in accordance with the Test Method's "Availability Rules" and "Add Rules", as described in Parameter List Detail: Data Set Definition. Each Attribute Control is placed at the beginning of its matching Section and Parameter List.
 |
In the Worksheet, the "GC" equipment is associated with the Test Method as a whole (as discussed in Equipment and Consumable Types Details). It is therefore rendered in the Test Section, immediately below the "Start Section" Attributes.
 |
The Preparation Parameter List is rendered first. As discussed in Equipment and Consumable Types Details, the Balance is associated with only this Parameter List.
 |
The Section is then repeated for the Procedural Parameter List. As discussed in Equipment and Consumable Types Details, both Consumable Types are associated with this Parameter List.
 |
Repeating Sections Over Group Workitems |
The "Grouped WorkItem LES Worksheet (Verbose)" Template is used with Test Method Groups that contain Child Test Methods. The fundamental principle is the same as Repeating Sections Over Workitem Parameter Lists:
| • | For Section 2 Details for Test $S{workitemid}, the LES Section Option "Repeat Sections Over" property is set to "Group Workitems". This repeats the Section once for each Child Test. |
| • | For Sub-Section 2.5 $S{paramlistid} - $S{variantid}, the "Repeat
Sections Over" property is set to "Workitem Parameter Lists"
(as in Repeating
Sections Over Workitem Parameter Lists) to repeat the Section once
for each Data Set in the Child Test.
As noted in Tokens for Parameterization and Substitution, the tokens will be substituted during the Worksheet generation phase and set to the current values. |
 |