ScriptPlateError method

Event

VWorks software received an error message for the plugin from a script associated with a labware.

Description

VWorks software calls the ScriptPlateError method to send an error message to the plugin from a script associated with a labware.

In JavaScript, the following function invokes the ScriptPlateError method:

plate.reportErrorToPlugin("message to plugin");

Syntax

 

HRESULT ScriptPlateError( [in] BSTR sXML, [in, out] BSTR* sResultXML );

Parameters

 

sXML	[in] A ScriptPlateError XML element that contains information about the labware and the error message from the script.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

ScriptPlateError method input

VWorks software passes a ScriptPlateError XML element into the sXML parameter of the ScriptPlateError method. This XML element provides information about the labware and the error message from the script.

ScriptPlateError element

The ScriptPlateError element has the following attributes:

 

Name	Value
Message	The error message from the script.
PlateName	The labware name.
NorthSideBarcode	The barcode if it is located on the north side of the labware, or else the value No bar code.
SouthSideBarcode	The barcode if it is located on the south side of the labware, or else the value No bar code.
WestSideBarcode	The barcode if it is located on the west side of the labware, or else the value No bar code.
EastSideBarcode	The barcode if it is located on the east side of the labware, or else the value No bar code.
Labware	The labware type.

Example of ScriptPlateError method input

The following sample code is a ScriptPlateError XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the ScriptPlateError method. VWorks software passes the following error message, which is from a script associated with the microplate named process ‑ 1 1:

This is a test error about the microplate.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='d09b4626b67d2290f1197da7a7198ba2' version='1.0' > <ScriptPlateError EastSideBarcode='No bar code' Labware='1536 Black Greiner' Message='This is a test error about the microplate.' NorthSideBarcode='No bar code' PlateName='process - 1 1' SouthSideBarcode='No bar code' WestSideBarcode='No bar code' /> </Velocity11>

ScriptPlateError method output

The plugin returns a HookResults XML block in the sResultXML parameter of the ScriptPlateError method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of ScriptPlateError method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the ScriptPlateError method. The plugin tells VWorks software to pause the protocol.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Pause Execution' ResultValue='True' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”