Relationship of components in VWorks software
The VWorks software uses different components (files and databases) to run protocols. It is important to understand the relationships between each of the components in the software. Changing settings or options in one component will affect one or more of the other components.
Component descriptions
The following table lists and describes the primary VWorks software components.
Note: VWorks treats these as records of interest. For details on records of interest, see VWorks records of interest.
Component | Description | File extension | Opening this component loads... |
|---|---|---|---|
Global settings | |||
 | A file that contains a collection of labware properties that the VWorks software uses to handle a labware type in the automation system. | .xml | Labware definitions |
 | A file used by the Hit Pick Replication task that specifies the dispense pattern in destination microplates. | .xml | Dispense information in destination microplates |
 | A file that contains pipetting settings for different liquid types. | .xml | Liquid class information |
 | A file that specifies the x- and y-axis offset when pipetting. | .xml | Pipette x- and y-axis offset information |
Device-related files | |||
 | A file that contains: • The list of devices the software will communicate with and control • Configuration information of each device • Communication settings (profile) | .dev | • Device profile • Teachpoint file (BenchCel device) |
 | A file that contains a collection of settings that the VWorks software uses to control a specific device. | .xml | Teachpoints or teachpoint file (applicable to some devices such as the BenchCel device) |
 | A device-dependent file that contains your teachpoint settings. | .xml | Teachpoint definitions |
Protocol-related files | |||
 | A file that contains instructions for performing a run. | .pro | • VWorks software (if it is not already open) • Device file • VWorks form (if configured in Protocol Options) |
 | A simplified user-interface that can be linked to a protocol for operators to use when running the protocol. | .VWForm | VWorks form and associated protocol |
Relationships of VWorks components
The following figure summarizes the relationship of the components. Notice the following:
• Labware definitions are used by all protocols.
• Liquid classes, pipetting techniques, and hit-pick formats are used by protocols containing liquid-handling tasks. In particular, hit-pick formats are used by the Hit Pick Replication task.
• Each protocol references a single device file that contains one or more devices.
• More than one protocol can reference the same device file.
• Each device (or robot) references a single device profile.
• Some devices, such as the BenchCel device, reference a single teachpoint file
 |
The following table describes how changes to one component impact other components.
If you... | Then... |
|---|---|
Make a change to the teachpoint file | • All profiles that use that teachpoint file are affected • All device files that use those profiles are affected • All protocols that use those device files are affected |
Create a new profile | You must specify the new profile in your device file |
Want to use two different teachpoint files | You must create two: • Device files • Profiles • Teachpoint files • Protocol files |
Want to copy a protocol to another system or computer | Use the File > Export VZP command to export all components: • Protocol file • Device file • Device profiles • Labware definitions and classes • Liquid classes • Pipette techniques • Hit-pick format or input files • Plate map database The exported .vzp file can be imported in VWorks running on another computer. |
VWorks Plus only. Change the state of a record of interest that has dependencies, for example, if you change a protocol from In Development to In Validation. | The dependent records of interest must be set to an equivalent state or higher. For example, if the protocol is In Validation, the device file and other files that protocol references must also be In Validation or Released. |
Miscellaneous input files
Files created in software other than the VWorks software, such as barcode input files (.bar, .csv, or .txt), hitpick input files (.csv), inventory files (.sql), JavaScript files (.js), and so forth, must be imported into Shared Services storage before the files are available for use in the VWorks software. For details, see Importing and exporting miscellaneous files.
Related information
For information about... | See... |
|---|---|
VWorks software description | |
VWorks software user interface | |
Supported devices | |
VWorks Plus, Control Panel, Shared Services, and Secure Storage | |
VWorks Standard, Control Panel and Shared Services | |
Device setup, including creating profiles and setting teachpoints | Device user guide |
Labware definitions | |
Liquid classes | |
Audit trails | |
Using VWorks ActiveX control | Device ActiveX control user guide |
Exporting protocols and associated components |