ProcessStarting method

Event

A process started.

Description

VWorks software calls the ProcessStarting method after a process starts.

Syntax

 

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

Parameters

 

sXML	[in] A ProcessStarting XML element containing information about the process that started.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

ProcessStarting method input

VWorks software passes a ProcessStarting XML element into the sXML parameter of the ProcessStarting method. This XML element provides information about the process that started.

ProcessStarting element

The ProcessStarting element has the following attributes:

 

Name	Value
DatabaseID	The database ID of the labware.
ProcessName	The process name.
InstanceNumber	The labware instance number.
PlateName	The process name. This attribute has the same value as the ProcessName attribute.
Labware	The labware type.
TaskCount	The count of the tasks within the process.
Path	The name of the protocol that generated the event. 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.
ProtocolPath	The name of the protocol that generated the event. This attribute has the same value as the Path attribute.
ProtocolType	Represents the protocol type. Possible values: 1 = Startup 2 = Main 3 = Cleanup
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.
EastSideBarcode	The barcode if it is located on the east 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.

Example of ProcessStarting method input

The following sample code is a ProcessStarting XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the ProcessStarting method. VWorks software tells the plugin that the process named process ‑ 1 started in the Main Protocol.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='74d4f5229fbb5f52ddc0e9e2b9a2739f' version='1.0' > <ProcessStarting DatabaseID='-1' EastSideBarcode='No bar code' InstanceNumber='1' Labware='1536 Black Greiner' NorthSideBarcode='No bar code' Path='C:\V11\MyProtocol.pro' PlateName='process - 1' ProcessName='process - 1' ProtocolPath='C:\V11\MyProtocol.pro' ProtocolType='2' SouthSideBarcode='No bar code' TaskCount='4' WestSideBarcode='No bar code' /> </Velocity11>

ProcessStarting method output

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

Example of ProcessStarting 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 ProcessStarting method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

process ‑ 1 started.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' ResultValue='process - 1 started.' /> </Results> </HookResults> </Velocity11>

Related information

 

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