UMRA Automation - COM interface

The UMRA COM object supports interface functions to:

Execute form scripts on the UMRA Service
Retrieve information from form scripts, for instance tables, maintained on the UMRA Service.

The UMRA COM object software is contained in a single DLL installed as part of the UMRA Automation module. The DLL is called UmraCom.dll. The DLL is a so called type library and contains the code that implements the COM objects and interfaces. The DLL is referenced in script environments as UMRAcom 1.0 Type Library.

The UMRA COM software consists of 3 objects, all contained in UmraCom.dll. These objects are used in script- and programming languages. The objects are described below:

COM object name	Type library	Description
Umra	UMRAcom	Base object, used to connect to the UMRA Service, execute form project scripts, setup variable values and access forms.
UmraFormProject	UMRAcom	Form project object. Used to access the contents of form fields of form projects.
UmraFormTable	UMRAcom	Form table object. Used to access the fields of a table contained in form project.

Each of the UMRA COM software objects supports a number of methods and properties that define the interface of the object. A summary of the form object interfaces is shown in the table below:

COM object	Interface method	Description
Umra	GetVersionInfo	Get the version information and build number of the interface
Umra	Connect	Connect to an UMRA Service
Umra	GetHostName	Get the name of the connected UMRA Service
Umra	GetHostPortNumber	Get the port number of the connected UMRA Service
Umra	GetLogMsg	Get the log message last generated
Umra	SetVariableText	Set the variable name and variable value of a text variable
Umra	SetVariableLong	Set the variable name and variable value of a numeric variable
Umra	SetVariableBool	Set the variable name and variable value of a boolean variable
Umra	ClearVariables	Clear all variables maintained by the interface
Umra	ClearVariable	Clear (delete) a variable with the specified name
Umra	ExecuteProjectScript	Execute the specificed script at the connected UMRA Service
Umra	GetVariableText	Get the text value of the specified variable
Umra	LoadFormProject	Load the specified form project from the connected UMRA Service.
Umra	GetConnectionInfo	Get the host name and port number of the connected UMRA Service
Umra	GetScriptExecutionInfo	Get the status information of the executed script
UmraFormProject	GetFormTable	Access the specified table
UmraFormTable	GetCellText	Retrieve the text of the specified row-column from the table