Common elements and attributes : Command element
Command element
The Command element describes a single task that the device can perform and has the attributes defined in this section.
Compiler attribute
The Compiler attribute contains a bitmask that represents the actions that the task performs on the labware.
To determine which value to use, perform a bitwise inclusive OR operation on the actions to be enabled for the task.
Possible values:
0 = Compiler_No_Action (Take no action)
1 = Compiler_Disallow_Sealed_Plates
2 = Compiler_Disallow_Unsealed_Plates
4 = Compiler_Seals_Plate
8 = Compiler_Unseals_Plate
16 = Compiler_Disallow_Lidded_Plates
32 = Compiler_Disallow_Unlidded_Plates
64 = Compiler_Lids_Plate
128 = Compiler_Unlids_Plate
MAXDWORD = Compiler_All (VWorks software does not use this value)
Example
Before a Seal Piercer performs a Pierce Plate task, VWorks software needs to know the following:
•
If the device allows a sealed labware, but disallows an unsealed labware
•
If the labware is unsealed after the Pierce Plate task is completed
To determine the value of the Compiler attribute for the Pierce Plate task, perform a bitwise inclusive OR operation on 2 (disallow unsealed labware) and 8 (unseals labware) to get 10.
If the user selects an invalid condition, VWorks software returns a compiler error.
For a task that seals a labware, performing a bitwise inclusive OR operation on 1 (disallow sealed labware) and 4 (seals labware) to get 5 returns a compiler error.
Required: No
Default value: 0
Description attribute
The Description attribute contains the description of the task.
Required: No
Default value: None
DisplayName attribute
The DisplayName attribute contains the task name that is displayed in the user interface. If this attribute is not specified, the value of the Name attribute is displayed.
Required: No
Default value: None
See “Name attribute” .
Editor attribute
The Editor attribute contains a bitmask that represents the part of a protocol in which the task is available.
To determine the value to use, perform a bitwise inclusive OR operation on the options to be enabled.
Possible values:
0 = Disregard all values for this attribute (Editor_None)
1 = Hide the task in the Available Tasks area (Editor_Hidden)
2 = Make the task available in the Main Protocol (Editor_Primary)
4 = Make the task available in a sub-process in the Main Protocol. (Editor_Secondary)
8 = Make the task available in the Startup Protocol and in the Cleanup Protocol (Editor_PrePost)
16 = Make the task available in all editors. This value is the same as the result of performing a bitwise inclusive OR operation on 2, 4, and 8 to get 14 (Editor_Omnipresent)
MAXDWORD = This value is the same as Editor_Omnipresent (Editor_All)
Example
To determine the value of the Editor attribute for a task that is available in the Main Protocol and in the Startup Protocol and Cleanup Protocol, perform a bitwise inclusive OR operation on 2 and 8 to get 10.
If the value 1 is not specified, the task is always available in the Available Tasks area.
Required: No
Default value: 0
Name attribute
The Name attribute contains the name of the task.
Required: No
Default value: None
NextTaskToExecute attribute
The NextTaskToExecute attribute indicates whether this task is the next one to be executed.
Possible values:
0 = The task is not the next one to be executed
1 = The task is the next one to be executed
Required: No
Default value: 1
PreferredTab attribute
The PreferredTab attribute contains an option in the Navigation Pane associated with the type of task that the device performs. If the device has more than one task, the PreferredTab attribute can be used to specify a different option for each task.
If the PreferredTab attribute is specified for the Command element, its value overrides the value of the Device element’s PreferredTab attribute.
Possible values:
•
IO Device Handling
•
Plate Handling
•
Plate Storage
•
Liquid Handling
•
Reading
•
Other
To change the quick access buttons from large to small, drag the splitter bar up or down.
In the following figure, the Navigation Pane on the left has small quick access buttons that are displayed horizontally. The Navigation Pane on the right has large quick access buttons that are displayed vertically.
 
 
Item
Description
Purpose
1 
Horizontal splitter bar
Changes the appearance of the quick access buttons
2 
Large quick access button
Displays a list of tasks in the Available Tasks area
3 
Small quick access buttons
Displays a list of tasks in the Available Tasks area
Required: No
Default value: None
ProtocolName attribute
The ProtocolName attribute contains the name of the protocol that contains the task.
If the protocol has been saved, the value of this attribute is the protocol’s file path. If the protocol has not been saved, the value is the default protocol name.
Required: Yes
RequiresRefresh attribute
The RequiresRefresh attribute indicates whether VWorks software should always request command metadata from the plugin rather than use cached command metadata.
Possible values:
0 = VWorks software should not request command metadata from the plugin
1 = VWorks software should request command metadata from the plugin
For a plugin that provides commands with dynamically changing parameter ranges, the value 1 should be used. Because the plugin does not smartly notify VWorks software of these changes, VWorks software does not know when to request the new command metadata.
Required: No
Default value: 0
TaskRequiresLocation attribute
The TaskRequiresLocation attribute indicates whether the task requires a location.
Possible values:
0 = The task does not require a location
1 = The task requires a location
Required: No
Default value: 1
VisibleAvailability attribute
The VisibleAvailability attribute indicates whether the task is displayed in the Available Tasks area.
Possible values:
0 = The task is not displayed in the Available Tasks area
1 = The task is displayed in the Available Tasks area
To hide deprecated tasks, set the value of the VisibleAvailability attribute to 0.
Required: No
Default value: 1