VWorks Protocol Authors Quick Guide

Workflow Overview

To create protocols in the VWorks software, follow these general steps:

1. Add devices.
2. Create a protocol.
3. Add tasks.
4. Compile the protocol and simulate the protocol run.
5. Run the protocol.
6. Optional: Create a form for operators to use to run the protocol.

Step 1. Add Devices

To add devices to your protocol:

1. In the VWorks window, navigate to File > New > Device. A new device file tab will appear.
2. Add a device to the device file tab:
   • Double-click the desired device icon in the Available Devices area. If you are in the Workspace tab, click the Available Devices tab to display the devices.
   • Type a name for the device and configure its properties in the Agilent Bravo Properties panel.

Visual Description: The VWorks interface displays a list of available devices on the left, including 'Agilent BenchCel' and 'Agilent Bravo'. The main area shows the device file tab with the selected 'Agilent Bravo' device. The 'Agilent Bravo Properties' panel on the right allows naming the device (e.g., 'Agilent Bravo 96LT') and setting its profile. A log area at the bottom shows activity, such as changing the device name.

Step 2. Create a Protocol

To create a protocol:

1. Select File > New > Protocol.
2. Click Protocol Options to verify the device file location, provide a description, add notes, and set other options. If using a VWorks form, specify the form and loading behavior.
3. For VWorks 14.0 and later, if using external files, select File > Import Misc Files to import them into VWorks storage.
4. Click Main Protocol.
5. Click Configure Labware to set the starting locations for labware within a device. Note: Configured labware returns to its starting location after the protocol run. Repeat this for each device.
6. Set up a process by clicking the process - n icon and configuring the process plate parameters in the Task Parameters area. A process is a sequence of tasks for specific labware.
7. Repeat step 6 to add more processes.

To create a profile for a device:

1. Click the device name in the device file tab and then click Device diagnostics.
2. In the diagnostics window:
   • Name the profile, select the connection type (Ethernet or serial), and connect to the device via the Discovered Bionet Devices dialog.
   • Set the teachpoints. For devices like the BenchCel Microplate Handler, reference the teachpoint file.
3. Select the profile in the device properties area.
4. Click File > Save and repeat steps 1-4 for other devices. If an Audit Comments dialog appears, enter a reason and click OK.
5. In the Devices area, click Initialize all devices.

Visual Description: The VWorks interface shows the 'Protocol File' with sections for 'Startup Protocol', 'Main Protocol', and 'Cleanup Protocol'. The 'Task Parameters' panel allows setting plate identity, name, and type. The 'Protocol Options' dialog allows setting the device file path, description, and notes. The 'Form Designer' is also previewed, showing controls like 'Run Protocol' and 'Pause'.

Step 3. Add Tasks

To add tasks to the protocol:

1. Drag tasks from the Available Tasks area to the protocol area.
2. Set the parameters for each task in the Task Parameters area.
3. Optionally, click Startup Protocol or Cleanup Protocol to add processes that run before or after the main protocol.
4. Select File > Save. If an Audit Comments dialog appears, enter a reason and click OK.

Visual Description: The VWorks interface displays the 'Protocol File' with the 'Main Protocol' area. The 'Available Tasks' list includes items like 'Define Plate Set', 'Delid', 'Dismount', and specific tasks like 'Tips for Dilution'. Users drag these tasks into the protocol sequence. The 'Task Parameters' panel on the right shows settings for selected tasks, such as 'Plate identity' and 'Process control'.

Step 4. Compile the Protocol and Simulate a Run

To compile the protocol and check for errors:

1. Click the Compile button.
2. View and fix any errors or warnings listed in the Main Log tab.
3. Repeat steps 1 and 2 until the protocol compiles without errors.
4. Save changes. If an Audit Comments dialog appears, enter a reason and click OK.

To simulate the protocol run and check for deadlocks:

1. Click the Simulation is off button to enable simulation mode (it changes to Simulation is on), then click the Start button.
2. View and fix any deadlock errors in the Main Log tab.
3. Repeat steps 1 and 2 until all deadlock errors are resolved.
4. Save changes. If an Audit Comments dialog appears, enter a reason and click OK.

Visual Description: The VWorks interface shows the 'Compile' button and the 'Start' button. The 'Main Log' area displays messages, including errors like 'Attempt to over-dispense past 0 µl' or 'An excess of -30 µL is dispensed'. The simulation status is indicated by a button that toggles between 'Simulation is off' and 'Simulation is on'.

Step 5. Run the Protocol

To run a live protocol:

1. Turn off simulation mode by clicking the Simulation is on button (it changes to Simulation is off).
2. Click the Start button on the toolbar. Alternatively, if a runset is open, view scheduled start times in the Runset Manager tab.

To pause the protocol run:

Click the Pause all button. The Scheduler Paused dialog allows resuming, finishing current labware processing, or aborting the run. Device diagnostics can also be accessed from here.

To stop a run in an emergency:

Use the hardware emergency-stop button. Refer to the device user guide for details. Note: A protocol run may not be resumable after an emergency stop.

Visual Description: The VWorks interface shows the 'Simulation is on' button, which can be clicked to turn it off. The 'Start' button is highlighted for initiating a run. The 'Pause all' button is also shown for stopping the protocol temporarily. A caution message warns about the consequences of using the emergency stop button.

Creating a Protocol Form

A form provides a simplified user interface, beneficial for users with limited experience with VWorks.

To create a new form:

1. In the VWorks window, select File > New > Form to open the Form Designer.
2. Drag desired controls (e.g., 'Run Protocol', 'Pause') onto the form canvas and configure their properties.
3. For VWorks 14.0 and later, use File > Import Misc Files to import images or icons stored in Shared Services.
4. Set the form properties and click OK to save. If an Audit Comments dialog appears, enter a reason and click OK.
5. Open the protocol the form will run and specify the form in the Protocol Options area.
6. Save any changes. If an Audit Comments dialog appears, enter a reason and click OK.

Visual Description: The 'Form Designer' window is shown, featuring 'Available Controls' on the left (e.g., General Controls, Specialized Buttons) and the 'Form Canvas' in the center. The 'Form Canvas' allows placing controls like 'Run Protocol' and 'Pause'. The right panel shows 'Run Protocol Properties' where control names, icons, and captions can be set. Options for global context and background color are also visible.

Where to Find Help

To open the knowledge base:

• From within VWorks software, click Help > Knowledge Base or press F1.
• From the Windows desktop, navigate to Start > All apps > Agilent Technologies > VWorks Knowledge Base.

To open context-sensitive help in the VWorks window:

1. In the VWorks window, click the [Help icon] button on the toolbar. The pointer will change to a question mark.
2. Click an icon or area of interest within VWorks to open the relevant help topic or guide.

Visual Description: The VWorks interface is shown with the toolbar. The 'Help icon' (a question mark symbol) is highlighted on the toolbar. The pointer is depicted as changing to a question mark. The 'Main Log' area shows a message indicating a protocol was aborted by the user.

Contacting Agilent

Web: https://www.agilent.com

Contact page: https://www.agilent.com/en/contact-us/page

Documentation feedback: documentation.automation@agilent.com

Document D0004379, Revision A, November 2020. Copyright © Agilent Technologies, Inc. 2020. All rights reserved.