Script Host Compatibility Mode

RWeb ECL Support

The following is a list of RWeb ECL Methods and Properties that are supported by the BlueZone Host Automation Object.  Support for the following RWeb methods has been incorporated into BlueZone strictly as a way make existing RWeb macros compatible with the BlueZone automation environment.  It is not our intention for BlueZone automation authors to use RWeb methods going forward.

For complete details please refer to the RWeb documentation.

Very important!  Please read the following section on exceptions to the standard RWeb methods.

Exceptions

The following two methods had to be modified from the standard RWeb methods.  The reason for this is because methods with the same names already existed in the context of the BlueZone Host Automation Object.  In order for an existing RWeb macro to work with BlueZone, you will have to change any occurrences of connect( ) and disconnect( ) as noted below.

connect( ) has changed to...

connectToHost( ) in BlueZone Host Automation Object

Method

Used to establish a connection to the host.

disconnect( ) has changed to...

disconnectFromHost( ) in BlueZone Host Automation Object

Method

Used to disconnect the current host session.

Standard

The following are standard RWeb methods.  No modifications to your existing macros are necessary in order for BlueZone Host Automation Object to support these methods.

addConnectionCallback( )

???

display( )

Method

Used to display a string of text in the emulator window at the cursor location.

findText( )

Method

Used to find a text string in the emulator window.

getCursorColumn( )

Method

Used to get the column that the cursor is currently positioned in the emulator window.

getCursorRow( )

Used to get the row that the cursor is currently positioned in the emulator window.

getDisplayText( )

Method

Used to get text from the emulator window.

getInteger( )

Property Accessor Method

Used to get the value of an integer property.

getString( )

Property Accessor Method

Used to get the value of a string property.

isConnected( )

Method

Used to indicate whether the session currently has a host connection.???

makeVector( )

???

removeConnectionCallback( )

???

requestDisplayFocus( )

Method

Used to request that the emulator terminal window receive the input focus.

setCursorBase( )

Property Accessor Method

Used to set the base number used in Row and Column parameters.  By default setCursorBase is set to 0 (zero based), which means that in methods that use Rows or Columns, you would pass in a 0 for either Row 1 or Column 1.  When setCursorBase is set to 1 (one based), then you would pass in a 1 for either Row 1 or Column 1.

setHostURL( )

Method

Used to set the host URL for the current session, including the transport, host name, and port.

setString( )

Property Accessor Method

Used to set the value of a String property.

transmitString( )

Method

Used to transmit a string of characters to the host as if the user had typed the string at the current cursor position.

waitForCursorEntered( )

Method

Used to wait for the cursor to enter a specific row and column location in the emulator window.

waitForDisplayString( )

Method

Used to wait for a string of characters to appear in the emulator window, and optionally, at a specific row and column.

waitForDisplayStrings( )

Method

Used to wait for one or more strings of characters to appear in the emulator window.