runset object

The VWorks JavaScript interpreter provides the following objects that can be accessed by a script.

This topic describes the runset object properties and methods.

runset enables control of the Runset Manager through JavaScript. You can use the runset object to clear the runs from a runset or append protocols to a runset. You can also query the Runset Manager and retrieve various fields of interest, such as barcodes. For more information on runsets, see Managing runsets.

Note: If you are using the VWorks Watcher, the runset object can be used in a script that is called by Watcher to create runsets automatically. For details, see Setting up and using the Watcher tool.

Method	Description
clear()	Clears all of the entries in the runset manager, except for currently executing protocols, which are not affected. Example: runset.clear()
appendProtocolFileToRunset(string ProtocolPath, int RunTimes, string ProtocolNotes, string formToUse)	Appends the specified protocol file at ProtocolPath to the Runset Manager. Specifies the number of RunTimes, and provides any ProtocolNotes. To specify a VWorks form to be associated with the protocol, formToUse must specify the file name of the form without the path, for example, C:\MyDir\MyForm.VWForm must be specified as "MyForm.VWForm". Returns true if successful or false upon failure. If a failure occurs, for example, the .pro file is missing, errors are written to the log.
Example: runset.appendProtocolFileToRunset("c:/some dir/someprotocol.pro", 10, "", "FormName1.VWForm");
appendProtocolFileToRunsetAtTime(string ProtocolPath, int RunTimes, string ProtocolNotes, string formToUse, string AtTime)	Appends the specified protocol file at ProtocolPath to the Runset Manager at the date and time (local time) specified by AtTime. Specifies the number of RunTimes, provides any ProtocolNotes that will appear in the Runset Manager pane. To specify a VWorks form to be associated with the protocol, formToUse must specify the file name of the form without the path, for example, C:\MyDir\MyForm.VWForm must be specified as "MyForm.VWForm". Returns true if successful or false upon failure. If a failure occurs, for example, the protocol file (.pro) is missing, errors are written to the log.
Example: var d = new Date(); ProtocolStartTime = d.toString(); runset.appendProtocolFileToRunsetAtTime("c:/VWorks Workspace/Protocol Files/Protocol File - 1.pro", 10, "", "FormName1.VWForm", ProtocolStartTime);
appendRunsetFileToRunset (string runsetPath, string formToUse)	Appends the contents of a runset file, located at runsetPath, to the Runset Manager. To specify a VWorks form to be associated with the protocol, formToUse must specify the file name of the form without the path, for example, C:\MyDir\MyForm.VWForm must be specified as "MyForm.VWForm". Returns true if successful or false upon failure. If a failure occurs, for example, the .rst file is missing, errors are written to the log.
Examples: runset.appendRunsetFileToRunset("c:/runset.rst"); runset.appendRunsetFileToRunset("c:/runset.rst", "FormName1.VWForm");
openRunsetFile(string runsetPath, string formToUse)	Opens the runset located at runsetPath. Optionally, opens the form to use to run the runsetformToUse must specify the file name of the form without the path, for example, C:\MyDir\MyForm.VWForm must be specified as "MyForm.VWForm". Returns true if successful or false upon failure. If a failure occurs, for example, the .rst file is missing, errors are written to the log.
Examples: runset.openRunsetFile("c:/temp/my_runset.rst"); runset.openRunsetFile("c:/temp/my_runset.rst", "FormName1.VWForm");
getRunsetXML()	Returns the XML contents of a runset file (.rst).
Example for getRunsetXML() // Note: In this example, runsetParser is a hypothetical JavaScript function. var runsetXML = runset.getRunsetXML() var runsetParser = new runsetParser(runsetXML) var numRunningProtocols = runsetParser.GetNumberOfRunningProtocols() for( var running_protocol_idx = 0; running_protocol_idx < numRunningProtocols; running_protocol_idx++){ print(runsetParser.GetRunningProtocol(running_protocol_idx).GetFilename()) print(runsetParser.GetRunningProtocol(running_protocol_idx).GetRunsetNotes()) //The runset notes might include items such as barcodes. }

Method

Description

clear()

Clears all of the entries in the runset manager, except for currently executing protocols, which are not affected.

Example:

runset.clear()

appendProtocolFileToRunset(string ProtocolPath, int RunTimes, string ProtocolNotes, string formToUse)

Appends the specified protocol file at ProtocolPath to the Runset Manager. Specifies the number of RunTimes, and provides any ProtocolNotes.

To specify a VWorks form to be associated with the protocol, formToUse must specify the file name of the form without the path, for example, C:\MyDir\MyForm.VWForm must be specified as "MyForm.VWForm".

Returns true if successful or false upon failure. If a failure occurs, for example, the .pro file is missing, errors are written to the log.

Example:

runset.appendProtocolFileToRunset("c:/some dir/someprotocol.pro", 10, "", "FormName1.VWForm");

appendProtocolFileToRunsetAtTime(string ProtocolPath, int RunTimes, string ProtocolNotes, string formToUse, string AtTime)

Appends the specified protocol file at ProtocolPath to the Runset Manager at the date and time (local time) specified by AtTime. Specifies the number of RunTimes, provides any ProtocolNotes that will appear in the Runset Manager pane.

Returns true if successful or false upon failure. If a failure occurs, for example, the protocol file (.pro) is missing, errors are written to the log.

Example:

var d = new Date();

ProtocolStartTime = d.toString();

runset.appendProtocolFileToRunsetAtTime("c:/VWorks Workspace/Protocol Files/Protocol File - 1.pro", 10, "", "FormName1.VWForm", ProtocolStartTime);

appendRunsetFileToRunset (string runsetPath, string formToUse)

Appends the contents of a runset file, located at runsetPath, to the Runset Manager.

Returns true if successful or false upon failure. If a failure occurs, for example, the .rst file is missing, errors are written to the log.

Examples:

runset.appendRunsetFileToRunset("c:/runset.rst");

runset.appendRunsetFileToRunset("c:/runset.rst", "FormName1.VWForm");

openRunsetFile(string runsetPath, string formToUse)

Opens the runset located at runsetPath.

Optionally, opens the form to use to run the runsetformToUse must specify the file name of the form without the path, for example, C:\MyDir\MyForm.VWForm must be specified as "MyForm.VWForm".

Returns true if successful or false upon failure. If a failure occurs, for example, the .rst file is missing, errors are written to the log.

Examples:

runset.openRunsetFile("c:/temp/my_runset.rst");

runset.openRunsetFile("c:/temp/my_runset.rst", "FormName1.VWForm");

getRunsetXML()

Returns the XML contents of a runset file (.rst).

Example for getRunsetXML()

// Note: In this example, runsetParser is a hypothetical JavaScript function.

var runsetXML = runset.getRunsetXML()

var runsetParser = new runsetParser(runsetXML)

var numRunningProtocols = runsetParser.GetNumberOfRunningProtocols()

for( var running_protocol_idx = 0;

running_protocol_idx < numRunningProtocols;

running_protocol_idx++){

print(runsetParser.GetRunningProtocol(running_protocol_idx).GetFilename())

print(runsetParser.GetRunningProtocol(running_protocol_idx).GetRunsetNotes())

//The runset notes might include items such as barcodes.

}