Test Methods
Test methods are used to define the requirements for data collecting during the processing of analytical data. Test methods contain inputs for data entry and outputs for reporting of results to customers.
Test inputs can be used in printable workbooks to aid the data entry process. Test outputs can be included or excluded from certificates on the edit dialog. The test outputs can be used to calculate results based upon the inputted results.
Test methods may be grouped together to form a test suite, a routine testing regimen for a product.
Contents
Version Control for Test Methods
Creating a Test Method
To create a new test method:
- Select Setup Test methods menu from the sidebar.
- Select the [ Create Test Method ] button in the top right.
- In the Name field, enter a name for the new test method. If the name has already been used by another test method then an error will show under the input field.
ℹ️ The test method name is used for reporting data on the standard sample certificate.
- In the Description field, enter an optional description to further describe the test method.
ℹ️ The test method description is for information only and not used for reporting data on the standard sample certificate.
- In the Workbook notes field, enter optional notes that will be displayed on the workbook.
Adding Test Method Inputs
Test inputs are used for recording results in LabHQ. At least one test method input is required to save a test method. To create a new test method input:
- Under the Inputs section, select the [ Create Input ] button to add a new test method input.
- In the Name field, enter a name for the test input.
ℹ️ Input names are displayed in the printed workbook and at Enter Results.
- From the Units field, select the units of measurement associated with the test input.
ℹ️ If your test input does not have any units, either leave the field unpopulated or you can replace previously selected units with the blank option at the top of the list.
ℹ️ If you can’t see the appropriate units in the list, you can modify the Result Units system list via list configuration. See Lists > Editing System/Custom lists for more information.
- From the Field Type field, select the type of data you would expect to record in the input:
- String – Accepts all characters. Recommended for text result statements, e.g. Pass/Fail, or Complies/Does not comply.
- Numeric – Accepts numeric characters only. Recommended for numeric results which are required in calculations.
- List – Allows users to select from a drop down list. See Lists > Assigning lists to test method inputs for more information.
- The Default Value field can be used to record an optional default value that will be automatically populated during result entry. These are recommended for information only data which rarely change and is reported to customers on the sample certificate.
ℹ️ Default values are editable and may be modified during result entry.
- The Display On field is used to select whether the input is shown within the LabHQ lifecycle, in the printed workbook, or on both.
- All – Displayed within the LabHQ lifecycle and in the printed workbook (default option)
- Electronic – Displayed only within the LabHQ lifecycle
- Workbook – Displayed only in the printed workbook
ℹ️ Inputs that do not facilitate LabHQ results entry can be added with a Display On property of 'Workbook'.
📒 A test method cannot be saved if all inputs have their Display On property set to 'Workbook', as at least one input must be set to a non-workbook value for proper functionality.
- If you wish to make the test input a mandatory field when entering results, ensure that the Mandatory box is checked.
- If you would like to leave the input optional, ensure the Mandatory box is unchecked.
ℹ️ Inputs that have the Display On property set to 'Workbook' cannot be made mandatory.
- Select the [ OK ] button to save the test input.
Adding Test Method Outputs
Outputs are based upon calculations from the inputs. At least one test method output is required to save a test method. To create a new test method output:
- Under the Outputs section, select the [ Create Output ] button to add a new test method output.
- In the Name field, enter a name for the test output.
ℹ️ Output names will be displayed on the sample certificate as the unique identifier for each result reported to the customer.
- From the Units field, select the units of measurement associated with the test output.
- Use the Show On Report checkbox to determine if this output will be shown to customers in reports.
Output Result Calculations
- In the Result Calculation field, enter the calculation formula for the result you wish to report. Inputs should be identified using ‘$’ followed by the input number.
- For results where the output should report the input exactly, you should use a single input number where the input number represents the input you wish to report, e.g. $1 for input number 1.
- For more complex calculation formulas, the following syntax may be used:
| Syntax | Description |
|---|---|
| + | Addition operator |
| - | Subtraction operator |
| * | Multiplication operator |
| / | Right-division operator |
| POW() | Exponentiation operator, e.g POW($1, 2) to square $1 |
| SQRT() | Square root operator, e.g. SQRT($1) to get square root of $1 |
| :: | Within a range, e.g. MAX($1 :: $5) |
| () | Parentheses, encloses function arguments |
| . | Decimal point |
| , | Comma, separates statements |
| = | Assignment operator |
| < | Less than |
| <= | Less than or equal to |
| > | Greater than |
| >= | Greater than or equal to |
| == | Equal to |
| != | Not equal to |
| MIN | Minimum value of a group of input values |
| MAX | Maximum value of a group of input values |
| AVG | Mean of a group of input values |
| SUM | Sum of a group of input values |
| STDEV | Estimate of standard deviation based on a sample using input values |
| STDEVP | Standard deviation based on a population using input values |
Example Result Calculation 1 (Simple)
A test with a single input and output where both values are equal.
Input 1: Appearance (String field type)
Output 1: Appearance (Result calculation: $1)
Scenario: A value of “Complies” is entered and a value of “Complies” is the reported value.
Example Result Calculation 2 (Simple)
A test with two inputs and a single output where a basic calculation is required.
Input 1: Weight of capsule + contents (Numeric field type)
Input 2: Weight of capsule (Numeric field type)
Output 1: Capsule fill weight (Result calculation: $1-$2)
Scenario: The two numeric values are entered and the calculation of input 1 minus input 2 is output.
Example Result Calculation 3 (Moderate)
A test with three inputs and three outputs.
Input 1: pH value 1 (Numeric field type)
Input 2: pH value 2 (Numeric field type)
Input 3: pH value 3 (Numeric field type)
Output 1: Average pH (Result calculation: AVG($1::$3) or AVG($1,$2,$3))
Output 2: Maximum pH (Result calculation: MAX($1::$3) or MAX($1,$2,$3))
Output 3: Minimum pH (Result calculation: MIN($1::$3) or MIN($1,$2,$3))
Scenario: User enters three pH values and the average, maximum and minimum values are returned.
Output Rounding
📒 By default, all calculations are rounded to 10 fractional-digits.
Further rounding can be optionally applied to output results to a defined number of decimal places. If you don’t apply rounding to a result, the raw result will be used. To apply rounding to a test method output:
- Select the test output you wish to modify.
- Select the [ Add Rounding ] button.
- In the Decimals field, enter the number of decimal places you would like to round to.
Rounded and display results will preserve trailing zeros up to the rounding value. For example, if a result is calculated at '1.2' but the rounding was set to 3dp, then, the actual result will be '1.200'.
Output Display Calculations
Display calculations can be used in addition to the result calculation to capture ‘if’ statements. The display calculations can be used to report an alternative value based upon a calculated result.
To apply a display formula to a calculate result, you can use ‘$R’ to reference the calculated result of the initial result calculation.
To apply a display calculation in addition to the result calculation:
- Select the test output you wish to modify.
- Select the [ Add Display Calculation ] field.
- In the Display Calculation field, enter the formula for the display calculation.
Example Display Result Calculation 1 (Difficult)
An ‘if’ statement based upon a calculated result.
Input 1: Assay result 1 (Numeric field type)
Input 2: Assay result 2 (Numeric field type)
Input 3: Assay result 3 (Numeric field type)
Output 1: Assay average (Result calculation: AVG($1::$3)) (Display calculation: $R < 0.1 ? “Less than LOQ”: $R)
Scenario 1: A value of 1.5 is obtained from the initial result calculation and 1.5 is output in the display calculation.
Scenario 2: A value of 0.02 is obtained from the initial result calculation and “Less than LOQ” is output in the display calculation.
📒 Inputs with a Display On property of 'Workbook' should never be used in any output calculation.
Cloning Inputs & Outputs
If your test method has a number of inputs or outputs with similar properties, e.g., units and field type, you can clone an existing input or output to create a new one.
To clone a test method input:
- Select the options menu to the right of the input you wish to clone and select the Clone option.
- Enter a new input name in the Name field.
- The name will default to the existing input name followed by ‘Copy’.
ℹ️ The same input name cannot be used across more than one input on the same test method.
- The units, field type and mandatory setting will be set based on the existing input. You may modify these values where necessary.
- Select the [ OK ] button to confirm the new input settings.
To clone a test method output:
Select the options menu to the right of the output you wish to clone and select the Clone option.
Enter a new output name in the Name field.
- The name will default to the existing output name followed by ‘Copy’.
ℹ️ The same output name cannot be used across more than one output on the same test method.
- The units, decimals and calculation settings will be set based on the existing output. You may modify these values where necessary.
- Select the [ OK ] button to confirm the new input settings.
Creating Matching Outputs
If you wish to report results as found, with no calculations or conversions applied, you can create matching outputs automatically based on your input configuration.
To create a matching output while creating an input:
- Enter the input details as required. See 'Adding Test Method Inputs' for more information.
- Ensure that the Create Matching Output checkbox is checked.
- Select the [ OK ] button to confirm the input setup.
- The matching output will be added to the output list.
- The name and units are copied over to the output.
- The matching output will be shown on reports by default.
- The result calculation is automatically applied based on the matching input identifier. For example, if you were to create a matching output for input number 2 (Identifier: $2), the result calculation for the matching output would be automatically set to ‘$2’.
To create a matching output based on an input that already exists:
- Select the options menu to the right of the input you wish to create a matching output for and select the Create Matching Output option.
- The setup for the matching output will be shown.
- The name and units are copied over to the output and the result calculation is automatically applied based on the matching input identifier.
- Select the [ OK ] button to confirm the output setup.
If you do not wish to report raw values and only need to report calculated results, you can deselect the Create Matching Output checkbox and this will create the input only, leaving the user to create any required outputs manually.
ℹ️ A matching output should never be created for test inputs with a Display on property of 'Workbook'.
Testing Output Calculations
If you wish to test a result calculation before you publish a test method for use, you can use a set of test input values to validate the calculation and check that the expected result is given.
To run a test calculation:
- Click on the output you wish to test the calculation for.
- Select the [ Test Calculations ] button on the left of the setup window. Input fields will appear for all test inputs used in the result calculation.
- Enter values in each of the input fields.
- At the bottom of the result calculation field, the system will provide a Test Raw Result and a Test Rounded Result.
- The first value provides the raw result with no rounding applied and the second value provides the result to the number of decimal places set above.
- If the output also has a display calculation, the Test Display Result will also be given.
Related Test Suites
The related test suites function allows you to view which test suites a test method is used in. It also allows you to assign test methods to existing test suites, where a new test method has been added after the test suite(s) were created.
To view a list of test suites a test method is used in:
- Select the [ Related Test Suites ] button at the bottom of the edit test method screen.
- The Selected Test Suites box will display a list of test suites that the test method is currently assigned to.
To assign a test method to an existing test suite:
- Select the [ Related Test Suites ] button at the bottom of the edit test method screen.
- From the Available Test Suites box, locate the test suite you wish to assign to, or you can use the Search field to filter down the list.
- You can use the search box to filter the test suite list showing in the Available Test Suites box
- Select the [ > ] button to assign the test suite.
- The double arrow [ >> ] button can be used to assign all test suites from the current filtered selection or all test suites if no filter is active
- Select the [ OK ] button to save the test suite selection.
View Related Products
The View Related Products function helps you identify which products a test method is associated with. This can be particularly helpful to determine whether any product specifications need to be regenerated after making changes to the test method.
How to Use
- Open the dialog: Click the [ View Related Products ] button at the bottom of the screen to open a dialog window displaying the related products.
- View product details: The dialog presents a table with:
- Products associated with the test method.
- Test suites from which each product is derived.
- Navigate to edit screens: You can click on any product or test suite in the table to open a new tab to the product or test suite edit screens.
📒 Any changes made to the test suites on a test method (e.g., selecting or removing them) will automatically take effect on the View Related Products screen prior to saving the test method.
Publishing Test Methods
When creating a new test method or editing an existing test method, you can either choose to save the test method in draft or publish the test method for use. Once published, the test method will be available to assign to samples in the lifecycle.
If you still have further changes to make to a test method, or the setup requires a review before it can be used, you can save the test method in a draft state by selecting the [ Save ] button.
If your test method is ready for use, you can publish the test method along with any changes made by selecting the [ Save and Publish ] button.
Version Control for Test Methods
Samples already submitted through the lifecycle and any samples submitted following these changes will continue to use the most recent published version of the test method.
Once a new test method version has been published, any samples already in the lifecycle using this test method will continue to use the version they were assigned at the point of submission. The new test method version will only be used by samples submitted after the changes were published.
For more information, see Versioning.
Cloning Test Methods
If you wish to create a new test method but many of the properties, including test method inputs and outputs, are the same or similar to an existing test method, you can clone an existing test method to create a new one.
To clone a test method from the main Test methods screen:
- Locate the test method you wish to clone.
- Select the options menu to the right of the test method and select the Clone option.
- Enter a new test method name and select the [ OK ] button to proceed.
ℹ️ The same name cannot be used across more than one test method. If you assign the same name as the cloned test method, an error will be displayed, 'Test method already exists'.
- The Edit Test Method screen will be displayed and the description, inputs and outputs will have been copied across to the new test method but changes can be made where necessary.
ℹ️ Test suites are not copied as part of the test method clone. Related test suites must be assigned separately.
- Cloned test methods are saved automatically, but if you have made additional changes to the test method you will need to select the [ Save ] button to save these, or you can select the [ Publish ] button to publish the test method for use.
To clone a test method from the Edit Test Method screen:
- Select the options menu in the top right and select the Clone option.
- Enter a new test method name and select the [ OK ] button to proceed.
- The Edit Test Method screen will be displayed and the description, inputs and outputs will have been copied across to the new test method but changes can be made where necessary.
- Cloned test methods are saved automatically, but if you have made additional changes to the test method you will need to select the [ Save ] button to save these, or you can select the [ Publish ] button to publish the test method for use.
Deleting Test Methods
If you no longer require a test method, you can delete it from the system. Once deleted, the test method will be automatically removed from all associated test suites.
Deleting a test method does not impact data already in the lifecycle, but it will mean that the test method is no longer available for use when submitting new samples.
To delete a test method from the main Test Methods screen:
- Select the options menu to the right of the test method and select the Delete option.
- The Delete test method screen will be displayed, listing the test suites that will be impacted by the test method deletion.
- To proceed with deletion, select the [ Delete ] button.
- If you have selected to delete a test method in error, select the Back button to cancel the request.
To delete a test method from the Edit Test Method screen:
- Select the options menu in the top right and select the Delete option.
- The Delete test method screen will be displayed, listing the test suites that will be impacted by the test method deletion.
- To proceed with deletion, select the [ Delete ] button.