Using the Test Definitions Design Data Builder

The Design Data Builder feature allows Spec Data Admins to create and manage Spec Data and Test Definitions using a UI that makes the process faster and less error-prone. If a Vault Admin has configured this feature and you have the proper permissions, the Design Data Builder UI automatically appears when you create, edit, or view a Test Definition.

About the Design Data Builder UI

The Design Data Builder UI is split into a header, left panel, and right panel. The header lists the Test Definition’s Name, Mode of Entry, and other metadata. The left panel shows a summary of the configurable items, and the right panel is where you navigate through and make changes to those items.

The header includes the following metadata:

Name: The Test Definition’s name. You can edit this field inline.
Lifecycle State: A badge showing the current lifecycle state of the Test Definition.
Mode of Entry: Sample Result Entry or Test Execution. Some items in the UI differ based on this selection. You can edit this field inline.
IN Progress Tests: The number of non-cancelled tests for this version of the Test Definition. You can click this number to open a list view of the tests in a new tab.
In Progress Change Analysis: The number of in-progress Change Analyses for this Test Definition. This value can only be 0 or 1. You can click this number to open a list view of the Change Analysis in a new tab.
Effective Date:
- If the record is superseded, this shows the Previously Effective date range.
- If the record is not effective or superseded, this shows the date the record will be effective, if set.
- If the record is effective, this shows the date it was made effective.

Left Panel

You can collapse or expand the left panel as desired. Its contents vary based on the record’s Mode of Entry.

If the Mode of Entry is Test Execution, it lists:

Select Document
Define Steps
Define Variations

If the Mode of Entry is Sample Result Entry, it lists:

Define Results
Define Variation

Right Panel

As the main work area for configuring your Test Definition, this panel’s contents vary based on where you are in the configuration process. In addition to the work area, this panel includes the Next and Back buttons for navigating between sections and the Not Applicable checkbox. This checkbox is not available for some required subsections. Checking this box deletes any configuration records in the current subsection and marks it as complete. If you configure something in that subsection later, the Not Applicable checkbox is automatically cleared.

Creating a Test Definition Using the Design Data Builder

To begin the creation process, navigate to the All Test Definitions view and complete the following steps:

Click Create. This opens a simplified version of the Create Test Definition dialog that does not include custom fields.
Enter a Name.
Select a Mode of Entry.
Optional: Enter a Description.
Click Save & Next.
Select one or more Method Documents. If you do not need to include a Method Document, check Not Applicable.
Click Next.
Optional: Drag and drop the selected Method Documents to reorder them.
Click Next.
In the Define Steps section, repeat the following for each step you need to define. In this section, you can also edit, copy, or delete existing steps.
1. Click + Step and enter a Name.
2. Click Next.
3. To create an Input, click + Input and enter the relevant fields. Repeat as many times as needed. For more information on these fields, see the standard Vault UI instructions. You can check the Not Applicable box if the Step does not require any Inputs.
4. Click Next.
5. To create a Result, click + Result and enter the relevant fields. Repeat as many times as needed. The fields to be entered vary based on the Result Type. For more information on these fields, see the standard Vault UI instructions. You can check the Not Applicable box if the Step does not require any Results.
6. Optional: For each Result, You can also click + Criteria to add Test Definition Result Criteria.
7. Optional: For each Result, You can also click + Detection Limit to add Limits of Detection.
8. Optional: For each Result, You can also click + Quantification Limit to add Limits of Quantification.
Click Next.
Optional: In the Define Results section, click +Variation to create a new Test Definition Variation. You can only create Variations for Test Definitions with at least one Input or Result. If you do not need to include a Test Definition Variation, check Not Applicable.
Optional: If creating a Variation, you can enter the following fields:
1. Name
2. Mode of Entry. You can only modify this field if the base record’s Mode of Entry is Test Execution.
3. Quality Control Sample Type. This field is only visible if Mode of Entry is Test Execution.
4. Description
Optional: If you created a Test Definition Variation, the next screen shows a list of the base Test Definition’s Inputs and Results. You can check the boxes beside them to associate them with the Variation. Some limitations apply.

Limitations of Test Definition Variation Results & Inputs

Keep the following limitations in mind when creating Test Definition Variations:

Inputs:
- If the Test Definition Variation’s Mode of Entry is Sample Result Entry, you cannot associate any Inputs to the Variation.
Results:
- If the base Test Definition’s Mode of Entry is Test Execution and the Test Definition Variation’s Mode of Entry is Sample Result Entry, you cannot associate Results with aggregate or cross-test variables to the Variation.
- If the base Test Definition’s Mode of Entry is Sample Result Entry and the Test Definition Variation’s Mode of Entry is Test Execution, you can only associate Results from the Default Step to the Variation.

About Preview Mode

If you have completed at least one Step for a Test Definition, you can preview it at any time by clicking the Eye Icon icon. Click the icon again to exit Preview Mode.

Preview Mode shows what the Test Definition you have created will look like to Lab Analysts using it. However, you cannot enter data or interact with it.