VWorks Software Setup Guide : Using the Experiments Editor : Experiment IDs and Experiments database overview
Experiment IDs and Experiments database overview
About this topic
This topic describes the Experiments Editor and how data entered in a form or protocol can be recorded in the Experiments database.
Experiment IDs defined
An experiment ID is a database record that captures the steps executed and the settings used during each run of a protocol. Any errors that may have occurred during a run are also recorded. An experiment ID can be used to record the steps performed and settings used during the course of a sample prep workflow.
You use the Experiments Editor to create experiment IDs, which are stored in the Experiments database, and to generate experiment ID reports (.pdf file).
Prerequisites 
The Experiments Editor uses a PostgreSQL database, which is installed as part of the VWorks software. Before the Experiments Editor is available for use, the data source must be configured and a connection to the Experiments database must be established. For instructions, see Setting up and connecting VWorks Experiments database.
Note: If you are upgrading from VWorks 14.0, you may import any exported experiment IDs after installing VWorks 14.1 and establishing a connection to the new Experiments database. VWorks 14.1 uses a PostgreSQL instead of MySQL database and has a new schema.
How to tag the data to be recorded 
The Experiments Editor feature is designed for use with VWorks forms. VWorks forms have built-in features that expedite how the form’s author tags the data to be tracked. The data tags in the form determine which data to record for the associated protocol. For details, see Workflow overviews for using a form to track experiment IDs.
Alternatively, if you know how to write programs in JavaScript or have a basic understanding of programming, you can use the built-in object in the VWorks JavaScript interpreter instead of using VWorks forms. For details, see Experiments database objects.
The software uses the following tags to track the data of interest. For each run (iteration) of a given application for an experiment ID, the software records the values assigned to each of the specified fields and the time when the data was recorded in the Experiments database.
 
Tag
Description
Experiment ID
The name of the experiment (microplate or group of microplates) that you want to track.
An experiment can include one or more applications.
Application
The name of the protocol and form.
Iteration
The number of times the application has been run for this Experiment ID.
Step name
A tagged task sequence or task in the protocol relevant to a given application run. For example, a Wash step might contain a tagged task sequence of Aspirate, Mix, Dispense to Waste.
In the protocol, the task sequence is bracketed by a pair of tasks that indicate the starting and stopping points of interest.
Field name
The name of a parameter setting within the tagged task sequence for a given step. For example, a Wash step that contains Aspirate, Mix, Dispense to Waste tasks might have field names such as, Aspirate Volume, Mix Volume, Dispense Volume, and so forth.
Field value
The setting for a given field name. For example, a field name of Dispense Volume (µL) might have a value or 10 or 0.5.
Workflow overviews for using a form to track experiment IDs 
Use the following workflow if you are creating a form for an operator to use when running a protocol to be associated with an experiment ID.
 
Step
For this task...
See...
1 
Create a protocol for your application.
Workflow for creating a basic protocol
2 
Create a form for the protocol that contains the experiment ID tags for the data to be recorded and the controls for the form’s operator to use.
Configuring a form for experiment IDs and Experiments database
3 
Edit the protocol associated with the form to include the Step Started/Completed task before and after each task sequence to be tracked.
Configuring a protocol to track experiment data
The following example provides an example of a typical experiment ID workflow for a form that has already been tagged for the Experiments database.
Table Example of typical experiment ID workflow
 
Step
For this task...
See...
1 
Create an experiment ID.
Creating and managing experiment IDs
2 
In the form, select the experiment ID and application settings or method, and then start the run.
During the protocol run, the software updates the database with the specified information for the selected experiment ID.
Documentation for the form
3 
Add notes while the experiment ID has an Open status.
Adding notes to an experiment ID
4 
Generate an experiment ID report at any point in the workflow.
Creating an experiment ID report
5 
Close the experiment ID. An experiment ID report is automatically generated.
VWorks Plus only. If e-signatures are enabled, the status changes to close only after the signatures are completed.
Closing an experiment ID
6 
Archive closed experiments to help prevent the Experiments database from being overloaded.
Closing and archiving an experiment ID
7 
Periodically make a backup copy of the Experiments database and store the backup in a secure location. Ensure that the backup copy includes:
• Exported data currently in the Experiments database.
• Archived experiment ID data.
Exporting and importing experiment IDs