IVHooks interface methods output

When VWorks software calls an IVHooks method, the plugin can return the following XML metadata as a string in the output parameters:

•	An XML element

•	A HookResults XML block

•	An XML block other than a HookResults XML block

In some IVHooks methods, the plugin can return either an XML element or a HookResults XML block.

XML elements and other blocks

The XML elements and XML blocks (other than the HookResults XML block) contained in the output parameters of IVHooks methods are defined in the methods that return them.

HookResults XML block

The HookResults XML block contains the HookResults element and all its children. This XML block can do one or both of the following:

•	Tell VWorks software to write a specified message to the Main Log

•	Command the scheduler to pause or abort a runset or a protocol

All HookResults XML blocks returned in the output parameter of IVHooks methods have the same structure, as defined in this section.

XML structure

The HookResults XML block has the following XML structure. The value of the file attribute for the Velocity11 element is MetaData.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11> <HookResults> <Results> <HookResult /> ... </Results> </HookResults> </Velocity11>

Velocity11 element

In addition to the file, md5sum, and version attributes, the Velocity11 element contains the Action attribute for the following methods only:

•	“BarCodeMisread method”

•	“BarCodeRead method”

•	“CompileComplete method”

HookResults element

The HookResults element contains one Results element.

Results element

The Results element contains one or more HookResult elements.

HookResult element

The HookResult element has the following pairs of ResultType and ResultValue attributes:

 

Name

Description/Name-Value

ResultType/ResultValue

The output to return to VWorks software. • Writes an Info-type message to the Main Log. ResultType: The value LogMessage. ResultValue: A text string that describes the message. • Writes an Error-type message to the Main Log. ResultType: The value LogError. ResultValue: A text string that describes the message. • Commands the scheduler to pause a runset. ResultType: The value PauseExecution. ResultValue: The value of this attribute must be True. • Prepends a message string with Plugin pause: followed by a space and then writes the results to the Main Log as an Info-type message. The message is written to the log in the following format: 'Plugin pause: ' + ResultValue ResultType: The value PauseMessage. ResultValue: A text string that describes the pause message. • Commands the scheduler to abort a protocol. ResultType: The value AbortExecution. ResultValue: The value of this attribute must be True. • Prepends a message string with Plugin abort: followed by a space and then writes the results to the Main Log as an Info-type message. The message is written to the log in the following format: 'Plugin abort: ' + ResultValue ResultType: The value AbortMessage. ResultValue: A text string that describes the abort message.

Related information

 

For information about...	See...
Overview of IVHooks interface methods	“IVHooks methods overview”