About forms for running protocols

About this topic

To create or edit forms, you must have VWorks Technician- or Administrator-level access. You should also have an understanding of how to create protocols in the VWorks software.

This topic describes the VWorks forms and the Form Designer window.

Forms defined

A form is a customized user interface that enables operators to run an associated VWorks protocol. A VWorks user who creates protocols (Technician or Administrator access) can design forms to simplify the operator duties when it comes time to run the associated protocols.

The form can be simple or relatively complex, depending on the requirements of a target group of operators. At a minimum, the form should have buttons for starting and pausing the associated protocol. You may also want to include the Full Screen On/Off button (default) to enable the form users to toggle the VWorks window between a full screen form view and the normal tabbed view. The form design can allow the operator to enter task parameter values for the associated protocol or limit the operator to a read-only display of task parameter values, progress, and other protocol data that the form’s author wants to display.

Figure. Example of VWorks window displaying a form in full screen view without the logs

 

Form Designer overview

The following figure shows four primary areas in the Form Designer window, and the table describes these four areas.

Figure. Form Designer window

 

 

Item	Area	Description
1	Available Controls	The control palette, which includes three categories from which to select controls and indicators.
2	Form Canvas	The work area where the form’s author arranges the form controls while viewing a representation of the form. Three buttons are included in this area by default: Run Protocol, Pause, and Full Screen on/off. As you drag controls into position in the Form Canvas, invisible grid lines assist with the alignment based on the controls that are already in the form. Note: To disable the autogrid, press ALT while dragging the controls into place.
3	Control Properties	The properties associated with a control that is currently selected in the Form Canvas. The figure shows the Run Protocol Properties because the Run Protocol button is selected.
4	Form properties	The properties that apply to the entire form, such as the background color and the context for JavaScript variables that are used in the form.

Available controls overview

The Available Controls area of the Form Designer window contains the following areas, each of which provides different types of controls that you can use in your form design:

•	General Controls area

•	Specialized Buttons area

•	Specialized Display Controls area

General Controls area

Most of the controls in the General Controls area can be assigned a JavaScript variable. By assigning a JavaScript variable, you can allow form users to edit task parameter values or enable the display of runtime data. The JavaScript variable must be assigned in both the control properties and in the corresponding task parameter in the protocol.

The following table provides an overview of the general controls. For more details about the general controls and how to configure them, see Adding form controls that allow editing or runtime data display.

 

Control	Description
Static (text)	Displays read-only text in the form. The Static control can be used to: • Provide a caption for another control. • Display runtime data if a JavaScript variable is assigned in the control properties and in the corresponding task parameter in the protocol.
Edit control	Allows the form users to enter or edit data for a task parameter.
Droplist	Presents a drop-down list of choices for a task parameter.
Dropdown	Allows the form users to type arbitrary text into the edit field or choose from a drop-down list of choices for a task parameter.
Slider	Lets users set a value on a continuous range of possible values for a task parameter.
Progress bar	Provides a visual indication of progress for a task.
Pushbutton	Allows you to write your own script for the action the button will perform for the form users.
Checkbox	Allows users to enable or disable the corresponding actions for a task parameter.
Date and Time	Displays the preset date and time or a date that the user can set for a task.
Image	Displays a static image.
File Browsing	Enables form users to select a file.
Radio Button	Allows you to present options for a task parameter.
Group Box	Displays a rectangle that can be resized and labeled to visually group other controls together.
Line	Provides a vertical or horizontal line that you can use to visually separate items on the form.

Specialized Buttons area

The Specialized Buttons area contains button controls that are already programmed to perform specific commands, which are currently available elsewhere in the VWorks window.

The following table provides an overview of the specialized buttons. For more details about the buttons and how to configure them, see Configuring a run button and other specialized buttons in a form.

 

Button	Description
Toggle Full Screen	Changes the display of the VWorks window from a normal view to a full-screen view and back again. In the normal view, the form is a tab within the protocol area of the VWorks window. In the full-screen view, the VWorks window displays only the form, and optionally the logs.
Save Data Entry values	Saves all data entry values associated with the form’s controls in the form file (.VWForm).
Reset Data Entry values	Resets all data entry values, which are associated with the controls in the form, to the default values.
Print Data Entry values	Prints all data entry values associated with the controls in the form.
Initialize All Devices	Opens the device file (.dev) specified by the button, and establishes communication with the corresponding devices. The following run buttons also initialize the devices for the corresponding protocol if simulation mode is off.
Run Protocol Run Specified Protocol Run Runset	Provide a choice of preprogrammed buttons for starting the protocol or runset.
Pause Run	Pauses the run and opens the Scheduler Paused dialog box, which is the same function as the Pause all button on the toolbar in the VWorks window.
Menu Action	Performs a command that the form designer selects from a list of commands, which are also available in the Tools menu of the VWorks window. This button control can enable a user with VWorks Operator-level access the ability to perform a command that normally requires VWorks Technician-level access.

Specialized Display Controls area

The controls in the Specialized Display Controls area display data that is not drawn from a JavaScript variable.

The following table provides an overview of the specialized display controls. For more details about the specialized display controls and how to configure them, see Adding indicators for elapsed time and progress to a form.

 

Control	Description
Elapsed Time	Displays the duration (hours:minutes:seconds) of the corresponding protocol or runset that the form is running.
Overall Progress	Displays a visual progress indicator for the corresponding protocol or runset that the form is running.

Related information

 

For information about...	See...
Creating or editing a form	Workflow for creating or editing a form
Controls under General Controls in the Form Designer window	Adding form controls that allow editing or runtime data display
Controls under Specialized Buttons in the Form Designer window	Configuring a run button and other specialized buttons in a form
Controls under Specialized Display Controls in the Form Designer window	Adding indicators for elapsed time and progress to a form
Form properties in the Form Designer window	Setting the form properties
Creating a basic protocol	Workflow for creating or editing a form
Working with JavaScript	Creating a protocol: advanced topics