2.1 Using ECL

Static page

Your user’s access the HTML page and deploy the session using the URL you provide them.

Frameset

Modifying the Applet tag

To enable the JSEventNotifier module, add the following parameter to the APPLET tag of the web page that launches your Reflection terminal session:

<param name="onStartupJavaClass" value="com.wrq.eNetwork.ECL.modules.JSEventNotifier">

In addition, add the MAYSCRIPT attribute to the APPLET tag. The MAYSCRIPT attribute allows a Java applet (Reflection, in this case) to communicate with JavaScript, in addition to the JavaScript-to-Java communication that's always available.

Depending on how your session is generated, you might add these values using the Applet Parameters section of the Manage Sessions panel in the Administrative Console, or by manually editing the HTML page that launches your session.

An applet tag for an IBM 3270 session might look something like this:

<APPLET name="JSSession" CODE="com.wrq.rweb.Launcher" codebase="./ex"
      width=800 height=600 archive="Launcher.jar" MAYSCRIPT>
   <param name="launcher.sessions" value="IBM3270">
   <param name="prefsName" value="myIBMsession">
   <param name="hostURL" value="tn3270://myhost.mycorp.com">
   <param name="onStartupJavaClass" value="com.wrq.eNetwork.ECL.modules.JSEventNotifier">
</APPLET>

Accessing the ECL API

When an HTML page that contains an APPLET tag like the one above is loaded by the web browser, the Reflection session launches. When the session has completed its initialization, it loads the module specified by the onStartupJavaClass parameter, in this case, JSEventNotifier.

After the JSEventNotifier module is loaded, it invokes a JavaScript function on your web page called ECLInitComplete, and it passes a reference to the JSEventNotifier class itself. (If you prefer to call the JavaScript function that receives the initial notification something different, specify the function name using the initCallback parameter in the Reflection APPLET tag.)

Once your JavaScript function receives a reference to the JSEventNotifier object, it can obtain the JavaScript API object by calling the getJSAPI() method. It can also use other methods available though the JSEventNotifier module for registering event listeners and setting up screen recognition systems.

The power in using the JSEventNotifier module is that when the ECLInitComplete function in your JavaScript gets invoked, you're assured that the Reflection terminal session is fully initialized and ready for scripting. This means you do not have to poll your Reflection session using the getInitialized() method to determine when Reflection is ready for scripting, making your scripts much more robust and efficient.

Example

The following example shows how to write a simple JavaScript that receives initialization notification, then sets up a listener to receive connection state changes.

<script language="JavaScript">
<!--
    var mJSNotifier = null;
    var mJSAPI = null;

    /*
     *  This function receives the initial notification when the
     *  Reflection session is initialized and the JSEventNotifier
     *  module is done loading. It stores references to the
     *  notifier module itself and the JSAPI object,
     *  sets up the connection listener, then starts the host
     *  communications.
     */
    function ECLInitComplete(jsNotifier)
    {
        mJSNotifier = jsNotifier;
        mJSAPI = mJSNotifier.getJSAPI();
        registerConnectionListener();
        mJSAPI.connect();
    }

    /*
     *  Adds a listener to receive connection state changes. The
     *  parameter "connectionCallback" specifies the name of the
     *  JavaScript function that should be invoked when the
     *  connection state listener is invoked.
     */
    function registerConnectionListener()
    {
        mJSNotifier.addConnectionCallback("connectionCallback");
    }

    /*
     *  Callback function for connection state changes. This is the
     *  function defined above in the registerConnectionListener()
     *  function. This function will be invoked by the JSEventNotifier
     *  module when the connection state changes. The "state" parameter
     *  will contain the current state of the connection, either "true"
     *  if connected, or "false" if disconnected. The parameter is a boolean,
   *  but Firefox seems to see it as a string, while Internet Explorer sees
	 *  it as a boolean.
     */
    function connectionCallback(state)
    {
	    if ( state == true || state == "true" )        // session became connected
      {
	        alert( "Session is connected!" );
      }
        else if ( state == false || state == "false" )  // session became disconnected 
	    {
          alert( "Session is disconnected!" );
	    }
    }
//-->
</script>

The JSEventNotifier module is part of the ECL API and its methods are detailed in the ECL documentation that's part of the ECL development kit.

Using JavaScript in the same HTML file as Reflection

In this example, JavaScript is used to interact with an IBM 3270 applet embedded in the browser window, where both the applet and the JavaScript code are in the same HTML file. Comments in the JavaScript explain the action. Also see the example of using JavaScript in a different HTML file than Reflection.

To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>API Sample: JavaScript in the Same HTML File as Reflection</title>
</head>
<body>

<!--
   The <applet> tag defines a simple Reflection applet for
   IBM 3270 emulation. To use this example, change the hostURL
   parameter to one appropriate for your network.
-->
<applet mayscript name="IBM3270Applet"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="800" height="500"
        archive="Launcher.jar">
    <param name="hostURL" value="tn3270://payroll">
    <param name="autoconnect" value="true">
    <param name="frame" value="false">
    <param name="launcher.sessions" value="IBM3270">
    <param name="preloadJSAPI" value="true">
</applet> 
<!-- 
   <Form> buttons give the user access to the Color Setup and
   Button Palette Setup dialog boxes. The onClick event handler
   is used to invoke the API methods without requiring separate
   JavaScript functions. The Reflection applet is referenced
   on the page using the same name as defined above in the <applet> tag.
-->
<form>
<input type="button" Name="ColorSetup" Value="Color Setup"
       onClick='document.IBM3270Applet.getAPI("JSAPI","IBM3270").showDialog( "colorConfigure" )'>
<input type="button" Name="ButtonPalette" Value="Button Palette Setup"
       onClick='document.IBM3270Applet.getAPI("JSAPI","IBM3270").showDialog( "buttonPaletteConfigure" )'>
</form>
</body>
</html>

Using JavaScript in a different HTML file than Reflection

In this example, JavaScript is used to interact with a Reflection terminal session applet embedded in a browser window frameset. The applet is in one HTML file, which is displayed in the lower frame of the frameset file, and the JavaScript code is in a different HTML file, which is displayed in the upper frame. Comments in the JavaScript explain the action. Also see the example of using JavaScript in the same HTML file as Reflection.

First, here's the HTML for the frameset file:

   <html>
   <frameset rows="50,*">
       <frame name="codeframe" src="codeframe.html">
       <frame name="appletframe" src="appletframe.html">
   </frameset>
   </html>

Next, here's the HTML for the codeframe.html file, which is the upper frame of the frameset and contains the JavaScript code:

   <html>
   <head>
   <title>Code Frame</title>
   <script language="JavaScript">
   <!--
         /*
          The variable "target" holds a reference to the terminal session
          applet in the lower frame. When the script first runs, the setTarget() function
          executes to set the target variable.
       */
       var target;
       setTarget();

       /*
          This function sets the variable "target" to refer to the terminal
          session applet in the lower frame. The full window and document hierarchy
          that identifies the location of the applet is required. If the applet is
          not yet loaded and the target is null, a timeout is used to continually
          check for the applet again, waiting 1 second between tries.
       */
       function setTarget()
       {
           target = parent.appletframe.document.IBM3270Applet;
           if ( target == null )
           {
               setTimeout( "setTarget()", 1000 );
           }
       }
      
       /*
          This function opens Reflection's Color Setup dalog box
          when the user clicks the Color Setup button. The notation
          "target.showDialog( "colorConfigure" )" uses the target variable
          defined earlier, providing an easier way of specifying
          "parent.appletframe.document.IBM3270Applet.getAPI("JSAPI","IBM3270").showDialog( "colorConfigure" )".
       */
       function doColorSetup()
       {
           target.getAPI("JSAPI","IBM3270").showDialog( "colorConfigure" );
       }
   
       /*
          This function opens Reflection's Button Palette Setup dialog box when the user clicks the Button Setup button. The notation
          "target.showDialog( "buttonPaletteConfigure" )" uses the target variable
          defined earlier, providing an easier way of specifying
          "parent.appletframe.document.IBM3270Applet.getAPI("JSAPI","IBM3270").showDialog( "buttonPaletteConfigure" )".
       */
       function doButtonSetup()
       {
           target.getAPI("JSAPI","IBM3270").showDialog( "buttonPaletteConfigure" );
       }
   // -->
   </script>
   </head>
   <body>
   
   <!-- 
      <Form> buttons give the user access to the Color Setup and
      Button Palette Setup dialog boxes. When the onClick event handler
      is invoked, one of the JavaScript functions defined above is
      called.
   -->
   <form>
   <input type="button" Name="ColorSetup" Value="Color Setup" onClick="doColorSetup()">
   <input type="button" Name="ButtonSetup" Value="Button Setup" onClick="doButtonSetup()">
   </form>
    </body>
   </html>

Lastly, here's the HTML for the appletframe.html file, which appears in the lower frame of the frameset and contains the Reflection terminal session applet--make sure to change the hostURL parameter in the <applet> tag to a host appropriate for your network:

   <html>
   <head>
   <title>Applet Frame</title>
   </head>
   <body>
   
   <!-- 
      The <applet> tag defines a simple Reflection applet for
      IBM 3270 emulation. To use this example, change the hostURL
      parameter to one appropriate for your network.
   -->
   <applet mayscript name="IBM3270Applet"
           codebase="./ex/" 
           code="com.wrq.rweb.Launcher.class" width="800" height="500"
           archive="Launcher.jar">
       <param name="hostURL" value="tn3270://payroll">
       <param name="autoconnect" value="true">
       <param name="frame" value="false">
     <param name="launcher.sessions" value="IBM3270">
       <param name="preloadJSAPI" value="true">
   </applet> 
   
   </body>
   </html>

Using an onLoad handler to determine when Reflection is initialized

If you want to automate a task immediately after a Reflection terminal session loads, you must first ensure that the session is available and initialized before invoking other API methods. You can do this by using the JavaScript onLoad event handler in the web page's BODY tag, or by waiting for notification when the session is done with initialization. (See Timing issues when scripting Reflection for more information about script timing.)

The following JavaScript example shows how to use an onLoad handler to determine if a Reflection session is initialized. It also uses an error handler, so if Reflection is not initialized enough to access the getInitialized method, the function that performs the initialization check can retry the check after a short delay. Once Reflection is initialized, the Session Setup dialog box opens so the user can enter connection information and proceed with the session. In this example, both the Reflection terminal session applet and the JavaScript code are in the same HTML file.

See Using notification to determine when Reflection is initialized for an example of the notification method.

To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>Example of an onLoad Handler to Determine Reflection Initialization</title>
<script language="JavaScript">
<!--
    /*
       Set an error handler for the window.
    */
    window.onerror = errHandler;

    /*
       Create a few variables to hold the target applet, the API, the 
       initialization state, and a couple of counters.
    */
    var appletTarget = null;
    
    var inited = 0;
    var count = 0;
    var errcount = 0;
    
    /*
       The error handler is invoked if an attempt to get the applet
       initialization state fails (because Reflection is not yet available),
       or if the api is null and the getInitialized() method is invoked.
       The handler will retry the attempt to get the session's 
       initialization state up to 10 more times, waiting 2 seconds between
       attempts. By returning a value of true from the error handler, no
       JavaScript error alert appears.
    */
    function errHandler( msg, url, line )
    {
        // To ensure that the error handler was invoked because the
        // initialization state is not available and not because some
        // other code failed, first check the "inited" variable before
        // setting the timeout.
        if ( inited <= 0 ) {
            if ( errcount < 10 ) {
                errcount++;
                setTimeout( "tryInit()", 2000 );
            }
            else {
                alert( "Unable to initialize Reflection." );
            }
        }
        return true;
    }

    /*
       This function first gets a reference to the Reflection applet on the
       page and stores it in "appletTarget". Then the function tries to get
       the Reflection API, and then the initialization state, using the getAPI()
       and getInitialized() methods. It then sets the "inited" variable 
       to the return value of getInitialized(). If the "inited" variable 
       is true, the function that opens the Session Setup dialog box is called. 
       If the call to Reflection's getInitialized method fails (because the session 
       or API isn't available yet), the error handler is invoked to repeat the 
       attempt. If the session is available but not yet initialized, a timeout 
       is set to retry this same function every 2 seconds, for up to 10 
       attempts or until "inited" is true.
    */
    function tryInit()
    {
        appletTarget = document.IBM3270;
        api = appletTarget.getAPI("JSAPI","IBM3270");
        inited = api.getInitialized();
        if ( inited > 0 )
        {
            doSessionSetup();
        }
        else if ( inited < 0 )
        {
            alert( "Reflection initialization failed." );
        }
        else if ( count < 10 )
        {
            count++;
            setTimeout( "tryInit()", 2000 );
        }
        else
        {
            alert( "Unable to initialize Reflection." );
        }
    }

    /*
       This function calls Reflection's showDialog method to
       open the Session Setup dialog box. This function is invoked
       only after the terminal session has been initialized.
    */
    function doSessionSetup()
    {
       api.showDialog( "sessionConfigure" );
    }
// -->
</script>
</head>
<!-- 
   The onLoad event handler is used to execute the JavaScript code
   after the page is loaded.
-->
<body onLoad="tryInit()">
<!--
   This is the tag that launches a Reflection IBM 3270 applet.
   To use this example, change the hostURL parameter to one
   appropriate for your network.
-->
<applet mayscript name="IBM3270"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="666" height="448"
        archive="Launcher.jar">
    <param name="hostURL" value="tn3270://accounts">
    <param name="autoconnect" value="false">
    <param name="launcher.sessions" value="IBM3270">
    <param name="preloadJSAPI" value="true">
</applet>

</body>
</html>

Using notification to determine when Reflection is initialized

If you want to automate a task immediately after a Reflection terminal session loads, you must first ensure that the session is available and initialized before invoking other API methods. You can do this using some built-in features of the API in which the Reflection session sends notification to a JavaScript function on your web page when session initialization is complete, or by using an onLoad event handler in the web page's BODY tag. (See Timing issues when scripting Reflection for more information about script timing.)

Allowing Reflection to send a notification message to your JavaScript is much simpler and is more reliable than using an onLoad event handler, but there are some situations, such as when using VBScript, where the event handler method is needed. See Using an onLoad Handler to Determine When Reflection Is Initialized for an example of the polling method from an onLoad event handler.

There are two ways to use notification to determine Reflection's initialization state:

Unless you need access to ECL API functions, the first method described above is recommended, since it requires a smaller download from the Reflection Management Server than when using the JSEventNotifier module.

The following JavaScript example shows how to use the jsapiInitialized function to receive notification when Reflection initialization is complete. Once notification is received, the Session Setup dialog box opens so the user can enter connection information and proceed with the session. In this example, both the Reflection terminal session applet and the JavaScript code are in the same HTML file.

To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>Example of using Notification to Determine Reflection Initialization</title>
<script language="JavaScript">
<!--

   /*
      Variable to hold the API reference when it is retrieved.
   */
   var api = null;
   
   /*
      jsapiInitialized is the name of the function that Reflection calls when
      Reflection initialization is complete. It passes a reference to the
      JSAPI, which is stored in a variable for subsequent use by other script
      functions.
   */
   function jsapiInitialized( inapi )
   {
      api = inapi;
      if ( api == null )
      {
         alert( "Reflection API initialization failed." );
      }
      else
      {
         doSessionSetup();
      }
   }

    /*
       This function calls Reflection's showDialog method to
       open the Session Setup dialog box. This function is invoked
       only after notification is received that the terminal 
       session has been initialized.
    */
    function doSessionSetup()
    {
       api.showDialog( "sessionConfigure" );
    }
// -->
</script>
</head>
<!-- 
   The onLoad event handler is used to execute the JavaScript code
   after the page is loaded.
-->
<body>
<!--
   This is the tag that launches a Reflection IBM 3270 applet.
   To use this example, change the hostURL parameter to
   one appropriate for your network.
-->
<applet mayscript name="IBM3270"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="666" height="448"
        archive="Launcher.jar">
    <param name="hostURL" value="tn3270://accounts">
    <param name="autoconnect" value="false">
    <param name="launcher.sessions" value="IBM3270">
    <param name="preloadJSAPI" value="true">
</applet>

</body>
</html>

Logging on to an IBM host

In this example, JavaScript is used to launch an IBM 3270 session and log on to the host computer.

The logon procedure for an AS/400 computer is quite similar to an IBM mainframe, and you could easily modify this script to use an IBM 5250 session.

Two <form> fields on the web page are used to get the user's ID and password before creating the Reflection session applet and performing the logon. The Reflection session is created in a new browser window that has only a status bar. This is done so the JavaScript writeln statements don't replace the contents of the current window and make the rest of the script unavailable. A related example shows a VBScript version of this script for Internet Explorer.

To use this example, you must change the hostURL parameter in the <applet> tag that's part of the writeApplet() function below to a host appropriate for your network.

<html>
<head>
<title>Sample Logon Script for IBM 3270 (JavaScript)</title>
<script language="JavaScript">
<!--
    var userid;
    var pword;
    var targetdoc;
    var targetwin;
    var appletTarget = null;
    var api = null;
    var count = 0;
    var errcount = 0;
    var inited = 0;

    /* 
       Copy relevant symbolic constants from
       api_ibm3270_constants.js and modify as needed for VBScript.
    */
    var ANY_COLUMN = -1;
    var IBM3270_ENTER_KEY = 35;
    var IBM3270_TAB_KEY = 52;
    
    /*
       Set an error handler. The error handler function is at the end of
       the script.
    */
    window.onerror = errHandler;

    /*
       This is the main function that performs the logon tasks.
    */
    function handleLogonButton()
    {
        // Validate the userid and password.
        if ( validateInputs() )
        {
            writeApplet();
        }
    }

    /*
       This function checks for a user ID and password, and if either is
       not present, displays an alert message.
    */
    function validateInputs()
    {
        userid = document.LogonForm.UserID.value;
        pword = document.LogonForm.Password.value;
        if ( userid == "" )
        {
            alert( "You must enter a User ID to log on!" );
            document.LogonForm.UserID.focus();
            return false;
        }
        if ( pword == "" )
        {
            alert( "You must enter a Password to log on!" );
            document.LogonForm.Password.focus();
            return false;
        }
        return true;
    }

    /*
       This function writes the applet tag to launch an IBM 3270 session in
       a new browser window called "IBM3270Applet."
    */
    function writeApplet()
    {
        targetwin = window.open( "", "IBM3270Applet", 
                                 "status=yes, width=650, height=550" );
        targetdoc = targetwin.document;
        
        // Use the "with (object)" statement to simplify the following lines.
        with ( targetdoc ) {
            writeln( '<html>' );
            writeln( '<body onLoad="window.opener.doLogon()">' );
            writeln( '<h1>Reflection for the Web -- IBM 3270</h1>' );
            writeln( '<applet mayscript name="IBM3270"' );
            writeln( '       codebase="./ex/"' );
            writeln( '       code="com.wrq.rweb.Launcher.class"' );
            writeln( '       width="600" height="400"' );
            writeln( '       archive="Launcher.jar">' );
            // Change the hostURL to a value appropriate for your network.
            writeln( '   <param name="hostURL" value="tn3270://payroll">' );
            writeln( '   <param name="autoconnect" value="false">' );
            writeln( '   <param name="frame" value="false">' );
            writeln( '   <param name="launcher.sessions" value="IBM3270">' );
            writeln( '   <param name="preloadJSAPI" value="true">' );
            writeln( '</applet>' );
            writeln( '<form>' );
            writeln( '<input type="button" ' );
            writeln( '       name="Close" value="Close Window" ' );
            writeln( '       onClick="window.close()"></form>' );
            writeln( '</body>' );
            writeln( '</html>' );
            close();
        }
    }

    /*
       This function is called by the applet window's onLoad event 
       handler after the new child window has been loaded. This function
       is the main entry point for the rest of the logon processing. It 
       works similar to the tryInit() function in the example
       Using an onLoad Handler to Determine When Reflection Is Initialized.
       Once Reflection is initialized, the logon procedure continues.
    */
    function doLogon()
    {
        appletTarget = targetdoc.IBM3270;
        api = appletTarget.getAPI("JSAPI","IBM3270");
        if ( api != null )
        {
            inited = api.getInitialized();
            if ( inited > 0 )
            {
                doConnect();
            }
            else if ( inited < 0 )
            {
                alert( "Reflection initialization failed." );
            }
        }
        else
        {
            if ( count < 10 )
            {
                count++;
                setTimeout( "doLogon()", 1000 );
            }
            else
            {
                alert( "Unable to initialize Reflection." );
            }
        }
    }
    
    /*
       This function starts the actual logon tasks. It determines if the session
       is connected, and if so, calls the function that finds the userid and 
       password prompts on the display and transmits the user's data.
    */
    function doConnect()
    {
        // If there's no connection, try to connect.
        if ( !api.isConnected() )
        {
            targetwin.status = "Connecting...";
            api.connect();
        }
        else
        {
            alert( "You're already connected!" );
            return;
        }

        // Use the status line to display an informational message, and then
        // wait 5 seconds for the USERID prompt to appear on the display.
        // The coordinates in which to start looking are any column in 
        // row 19. The API uses 0-based coordinates, in contrast to
        // the 1-based coordinates that are used for the status line.
        targetwin.status = "Finding USERID prompt.";
        if ( !api.waitForDisplayString( "USERID", 19,
                               ANY_COLUMN, 5000 ) )
        {
            targetwin.alert( "Unable to find USERID prompt. The " +
                   "script will stop, but you may continue manually." );
            return;
        }
        
        // Wait 5 seconds for the cursor to appear in row 19, column 16.
        // This is the location for the user's ID.
        targetwin.status = "Waiting for cursor to enter USERID field.";
        if ( !api.waitForCursorEntered( 19, 16, 5000 ) )
        {
            targetwin.alert( "Cursor was not found in the USERID field. " +
                   "The script will stop, but you can try completing the " +
                   "logon manually." );
            return;
        }
        
        // userid field was found, and cursor is in place, so transmit the 
        // user's ID, followed by the Tab key to move to the next field.
        api.transmitString( userid );
        api.transmitTerminalKey( IBM3270_TAB_KEY );
        
        // Wait for the cursor to enter the password field.
        targetwin.status = "Waiting for the cursor to enter the Password field.";
        if ( !api.waitForCursorEntered( 20, 16, 5000 ) )
        {
            targetwin.alert( "Cursor was not found in the Password field. " +
                     "The script will stop, but you can try completing " + 
                     "the logon manually." );
            return;
        }

        // Cursor is in Password field, so transmit the user's password, 
        // followed by the Enter key.
        api.transmitString( pword );
        api.transmitTerminalKey( IBM3270_ENTER_KEY );
        
        // Wait 5 seconds for the "Ready" message to appear on the display.
        // If the "Ready" message is not found, display an alert message.
        targetwin.status = "Waiting for Ready prompt.";
        if ( !api.waitForDisplayString( "Ready;", 5000 ) )
        {
            targetwin.alert( "Ready signal not found. The session may not " +
                             "be ready for input." );
            targetwin.status = "";
            return;
        }

        // Done with logon, so display final status message and set
        // focus to the terminal display.
        targetwin.status = "Ready to proceed.";
        api.requestDisplayFocus();
    }
    
    /*
       This is the error handler function that will catch script errors.
       The error we're most interested in may occur when trying to
       get Reflection's initialized state in the doLogon() function.
    */
    function errHandler( msg, url, line )
    {
        if ( inited <= 0 ) {
            if ( errcount < 10 ) {
                errcount++;
                setTimeout( "doLogon()", 2000 );
            }
            else {
                alert( "Unable to initialize Reflection." );
            }
        }
        return true;
    }
// -->
</script>
</head>
<body>
<h1>Reflection for the Web -- IBM 3270 Logon</h1>
<!--
   Use <form> items to accept the User ID and Password, and to create
   a Logon button.
-->
<form name="LogonForm">
<p>User ID: <input type="text" name="UserID" default size="25"></p>
<p>Password: <input type="password" name="Password" size="25"></p>
<p><input type="button" Name="Logon" value="Logon" onClick="handleLogonButton()"></p>
</form>
</body>
</html>

Logging on to a VMS host

In this example, a VT terminal session is embedded in the browser window, and JavaScript is used to log on to the host computer. Two <form> fields on the web page are used to get the user's name and password before performing the logon. A related example shows a VBScript version of this script for Internet Explorer.To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>Sample Logon Script for VT (JavaScript)</title>
<script language="JavaScript">
<!--
    var uname;
    var pword;
    var api = null;

    /*
       The jsapiInitialized function is called by Reflection
       when it has finished its initialization. Reflection
       passes the function a reference to the JavaScript API.
    */
    function jsapiInitialized( jsapi )
    {
       api = jsapi; 
    }

    /*
       This is the main function that performs the logon tasks.
    */
    function handleLogonButton()
    {
        // Validate the username and password.
        if ( validateInputs() )
        {
            doConnect();
        }
    }

    /*
       This function checks for a username and password, and if either is
       not present, displays an alert message.
    */
    function validateInputs()
    {
        uname = document.LogonForm.Username.value;
        pword = document.LogonForm.Password.value;
        if ( uname == "" )
        {
            alert( "You must enter a Username to log on!" );
            document.LogonForm.Username.focus();
            return false;
        }
        if ( pword == "" )
        {
            alert( "You must enter a Password to log on!" );
            document.LogonForm.Password.focus();
            return false;
        }
        return true;
    }
    
    /*
       This function starts the actual logon tasks. It determines if the session
       is connected, and if so, calls the function that finds the Username and 
       Password prompts on the display and transmits the user's data.
    */
    function doConnect()
    {
        // If there's no connection, try to connect.
        if ( !api.isConnected() )
        {
            self.status = "Connecting...";
            api.connect();
        }
        else
        {
            alert( "You're already connected!" );
            return;
        }

        // Wait 5 seconds for the Username prompt.
        self.status = "Waiting for Username prompt.";
        if ( !api.waitForString( "Username:", 5000 ) )
        {
            alert( "Unable to find Username prompt. The script will stop, " + 
                   "but you may continue manually." );
            return;
        }
        
        // Username prompt was found, so transmit the user's username,
        // followed by a carriage return. The octal representation of the
        // carriage return character--which is decimal 13--is used. You 
        // can also use the carriage return symbol \r or the hex value
        // \x0D. You CANNOT use the decimal value 13, because this will be
        // converted to a string and appended to the username.
        api.transmitString( uname + "\015" );
        
        // Wait 5 seconds for the Password prompt.
        self.status = "Waiting for Password prompt.";
        if ( !api.waitForString( "Password:", 5000 ) )
        {
             alert( "Unable to find Password prompt. The script will stop, " + 
                   "but you can try completing the logon manually." );
            return;
        }

        // Password prompt was found, so transmit the user's password,
        // followed by a carriage return. As above, the octal
        // representation of the carriage return character is used.
        api.transmitString( pword + "\015" );
        
        // Done with logon, so display final status message, and set
        // focus to the terminal display.
        self.status = "Ready to proceed.";
        api.requestDisplayFocus();
    }
// -->
</script>
</head>
<body>
<h1>Reflection for the Web -- VT Logon</h1>
<p>
<!--
   Create a basic VT applet on the page, but don't connect until
   the user fills in the username and password information. 
   To use this example, change the hostURL parameter to one 
   appropriate for your network.
-->
<applet mayscript name="VT"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="600" height="400"
        archive="Launcher.jar">
    <param name="hostURL" value="telnet://accounts">
    <param name="autoconnect" value="false">
    <param name="frame" value="false">
    <param name="launcher.sessions" value="VT">
    <param name="preloadJSAPI" value="true">
</applet>
</p>
<!--
   Use <form> items to accept the Username and Password, and to create
   a Logon button.
-->
<form name="LogonForm">
<p>Username: <input type="text" name="Username" default size="25"></p>
<p>Password: <input type="password" name="Password" size="25"></p>
<p><input type="button" name="Logon" value="Logon" onClick="handleLogonButton()"></p>
</form>
</body>
</html>

Logging on to an HP3000 host

In this example, an HP terminal session applet is embedded in the browser window, and JavaScript is used to log on to the host computer. Four <form> fields on the web page are used to get the user's name, group, account, and password before performing the logon.

To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>Sample Logon Script for HP (JavaScript)</title>
<script language="JavaScript">
<!--
    var uname, group, account, pword;
    var api = null;

    /*
       The jsapiInitialized function is called by Reflection
       when it has finished its initialization. Reflection
       passes the function a reference to the JavaScript API.
    */
    function jsapiInitialized( jsapi )
    {
       api = jsapi; 
    }

    /*
       This is the main function that performs the logon tasks.
    */
    function handleLogonButton()
    {
        // Validate the username and password.
        if ( validateInputs() )
        {
            doConnect();
        }
    }

    /*
       This function checks for a group, account, and password, and 
       if any of these is not present, displays an alert message.
    */
    function validateInputs()
    {
        uname = document.LogonForm.Username.value;
        pword = document.LogonForm.Password.value;
        group = document.LogonForm.Group.value;
        account = document.LogonForm.Account.value;

        // For the host in this example, a username is not required, 
        // but a group and account are.
        if ( group == "" )
        {
            alert( "You must enter a Group to log on!" );
            document.LogonForm.Group.focus();
            return false;
        }
        if ( account == "" )
        {
            alert( "You must enter an Account to log on!" );
            document.LogonForm.Account.focus();
            return false;
        }
        
        if ( pword == "" )
        {
            alert( "You must enter a Password to log on!" );
            document.LogonForm.Password.focus();
            return false;
        }
        return true;
    }
    
    /*
       This function starts the actual logon tasks. It determines if the session
       is connected, and if so, calls the function that finds the Username and 
       Password prompts on the display and transmits the user's data.
    */
    function doConnect()
    {
        // If there's no connection, try to connect.
        if ( !api.isConnected() )
        {
            self.status = "Connecting...";
            api.connect();
        }
        else
        {
            alert( "You're already connected!" );
            return;
        }

        // Wait 5 seconds for the MPE XL prompt to appear in the datacomm stream.
        // By using the HP-specific waitForHostPrompt method, the wait will be 
        // for the string "MPE XL" plus the DC1 host prompt character.
        self.status = "Waiting for host prompt.";
        if ( !api.waitForHostPrompt( "MPE XL:", 5000 ) )
        {
            alert( "Unable to find MPE XL prompt. The script will stop, " + 
                   "but you may continue manually." );
            return;
        }
        
        // MPE XL prompt was found, so transmit the username, group, and
        // account, followed by a carriage return. The octal representation
        // of the carriage return character--which is decimal 13--is used. You
        // can also use the carriage return symbol \r or the hex value
        // \x0D. You CANNOT use the decimal value 13, because this will be
        // converted to a string and appended to the username.
        var helloStr = "hello ";
        if ( uname != "" )
        {
            helloStr += uname + ",";
        }
        helloStr += group + "." + account;
        api.transmitString( helloStr + "\015" );
        
        // Wait 5 seconds for the Password prompt.
        self.status = "Waiting for Password prompt.";
        if ( !api.waitForHostPrompt( "Password:", 5000 ) )
        {
             alert( "Unable to find Password prompt. The script will stop, " + 
                   "but you can try completing the logon manually." );
            return;
        }

        // Password prompt was found, so transmit the user's password,
        // followed by a carriage return. As above, the octal
        // representation of the carriage return character is used.
        api.transmitString( pword + "\015" );
        
        // Done with logon, so display final status message, and set
        // focus to the terminal display.
        self.status = "Ready to proceed.";
        api.requestDisplayFocus();
    }
// -->
</script>
</head>
<body>
<h1>Reflection for the Web -- HP Logon</h1>
<p>
<!--
   Create a basic HP applet on the page, but don't connect until
   the user fills in the username, group, account, and password 
   information. A default group (DOCS) and account (WRITERS) are 
   already in the text fields, so the minimum information the
   user needs to supply is the password, because the username is
   optional for the host in this example.
   
   To use this example, change the hostURL parameter to one 
   appropriate for your network, and change the default group and
   account in the form fields.
-->
<applet mayscript name="HP"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="640" height="400"
        archive="Launcher.jar">
    <param name="hostURL" value="nsvt://techpubs">
    <param name="autoconnect" value="false">
    <param name="frame" value="false">
    <param name="launcher.sessions" value="HP">
    <param name="preloadJSAPI" value="true">
</applet>
</p>
<!--
   Use <form> items to accept the Username, Group, Account, and Password, 
   and to create a Logon button.
-->
<form name="LogonForm">
<p>Username: <input type="text" name="Username" default size="25">
Group: <input type="text" name="Group" value="Docs" default size="25">
Account: <input type="text" name="Account" value="Writers" default size="25"></p>
<p>Password: <input type="password" name="Password" size="25">
<input type="button" name="logon" value="Logon" onClick="handleLogonButton()"></p>
</form>
</body>
</html>

Connecting a printer session

In this example, an IBM 3270 Printer session is embedded in the browser window, and JavaScript is used to connect to the host computer. An HTML form list lets the user select the name of the printer device to which to connect, and two buttons let the user connect and disconnect the session.

This example can easily be modified to connect to an AS/400 Printer session. One difference is that it is not necessary to specify a device name when connecting to an AS/400 Printer session (although the AS/400 Printer applet can be configured to require a device name from the user by setting the promptForDeviceName parameter to True).

To use this example, you must change the hostURL parameter (including the port number) in the <applet> tag below to a host appropriate for your network. You must also change the device names in the <form> tag to appropriate device names.

<html>
<head>
<title>Sample Script for IBM 3270 Printer Emulation (JavaScript)</title>
<script language="JavaScript">
<!--
    var api = null;
    var deviceName = "";

   /*
       The jsapiInitialized function is called by Reflection
       when it has finished its initialization. Reflection
       passes the function a reference to the JavaScript API.
    */
    function jsapiInitialized( jsapi )
    {
       api = jsapi;
    }

    /*
       This function handles a click in the Connect button.  If there's no
       connection already established, it calls the doConnect() function to
       make a connection attempt. If there is a connection already, an alert
       message is displayed.
    */
    function handleConnectButton()
    {
        if ( api.isConnected() )
        {
            alert( "You already have a connection to '" +
                   api.getString( "deviceName" ) + "'. You must first\n" +
                   "disconnect the current connection before " +
                   "establishing a new\nconnection.");
            return; 
        }
        doConnect();
    }

    /*
       This function handles a click in the Disconnect button. If there is
       no current connection, it does nothing. Otherwise, it disconnects
       the current session and displays a message in the form field.
    */
    function handleDisconnectButton()
    {
        if ( api.isConnected() )
        {
            api.disconnect();
            document.DevicePicker.ConnectedDevice.value = "<disconnected>";
        }
    }

    /*
       This function establishes the connection. It gets the name of the
       item selected in the form list, sets the Reflection session's device
       name to the same name, and then opens the connection. After the connection
       is opened, a timer is set to check the connection status after 2
       seconds (2000 milliseconds), using the setTimeout() method.
    */
    function doConnect()
    {
        var deviceList = document.DevicePicker.DeviceName;
        deviceName = deviceList.options[deviceList.selectedIndex].text;
        api.setString( "deviceName", deviceName );
        api.connect();
        setTimeout( "checkConnected()", 2000 );
    }

    /*
       This function checks whether the connection to the host using the
       selected device name was successful or not. If the connection failed,
       Reflection will display an alert message. This function will update
       the document's text field with either a success or failure message.
    */
    function checkConnected()
    {
        var isConnected = api.isConnected();
        var theDevice = document.DevicePicker.ConnectedDevice;
        if ( !isConnected )
        {
            theDevice.value = "<failed>";
        }
        else if ( isConnected )
        {
            theDevice.value = api.getString( "deviceName" );
        }
    }
// -->
</script>
</head>
<body>
<h1>Reflection for the Web -- IBM 3270 Printer: Session Picker</h1>
<p>
<!--
   Create a basic IBM 3270 Printer applet on the page, but don't
   connect until the user selects a device name and clicks the
   Connect button. 
   
   To use this example, change the hostURL parameter to one 
   appropriate for your network (including the port number), and
   change the names of the devices to devices for your host.
-->
<applet mayscript name="IBM3287"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="450" height="160"
        archive="Launcher.jar">
    <param name="hostURL" value="tn3270e://ibmprinter:5002">
    <param name="autoconnect" value="false">
    <param name="frame" value="false">
    <param name="launcher.sessions" value="IBM3287">
    <param name="preloadJSAPI" value="true">
</applet>
</p>
<!--
   Use <form> items to display a list from which the user
   can select a device to connect to and buttons to connect and
   disconnect the session.
-->
<form name="DevicePicker">
<p>
Device name: <select name="DeviceName">
<option selected>PRINTDEV1</option>
<option>PRINTDEV2</option>
<option>PRINTDEV3</option>
<option>PRINTDEV4</option>
</select>
<input type="button" name="Connect" value="Connect" onClick="handleConnectButton()">
<input type="button" name="Disconnect" value="Disconnect"
                     onClick="handleDisconnectButton()">
</p>
<p>
Connection established to device: <input type="text" 
            name="ConnectedDevice" value="<disconnected>" disabled>
</p>
</form>
</body>
</html>

Transferring files to an IBM mainframe using FTP

In this example, an IBM 3270 session is in a separate browser window, and HTML form elements are used to provide controls for performing FTP file transfers between the desktop computer and the mainframe. The Transfer type radio buttons allow users to choose the method for sending or receiving files. Because the user is given access only to the basic menus, the administrator may want to preconfigure transfer options in the Connection Setup dialog box, then save those settings to a configuration file.

To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>FTP API Example</title>
<script language="JavaScript">
<!--

    var api = null;

    /*
        Copy relevant symbolic constants from file server_root/webapps/rweb/admin/en/html/advanced/api_constants/api_all_constants.js
    */
    var FTP_ASCII      = 0;
    var FTP_BINARY     = 1;
    var FTP_SMART      = 2;
    
    /*
        Returns the JSAPI for the terminal session.
    */
    function getJSAPI()
    {
       if ( api == null )
       {
         if ( document.ibm3270 != null )
         {
            api = document.ibm3270.getAPI( "JSAPI", "IBM3270" );
         }
       }  
       return api;
    }

    /*
        This function performs the login to the FTP server. It first checks for
        the presence of a hostname, username, and password, and displays an alert
        message if any of these entries is missing. An alert message displays
        the status of the login attempt.
    */
    function doftpLogin()
    {
        var hostname = document.ftp.hostname.value;
        var username = document.ftp.username.value;
        var password = document.ftp.password.value;
        if ( hostname == "" || username == "" || password == "" )
        {
            alert( "You must enter a hostname, username, and " +
                   "password to login. One of these entries is missing." );
            return;
        }
        var result = getJSAPI().ftpLogin(hostname, username, password, null, true);
        if ( result )
            alert( "FTP login was successful." );
        else
            alert( "FTP login failed." );
    }

    /*
        This function disconnects from the FTP server. An alert message
        displays the status of the disconnect attempt.    
     */
    function doftpDisconnect()
    {
        var result = getJSAPI().ftpDisconnect();
        if ( result ) 
            alert( "FTP disconnect was successful." );
        else
            alert( "FTP disconnect failed." );
    }

    /*
        This function sends a file to the FTP server. It does not perform any 
        validity checking of the file names other than ensuring that there
        are entries in the local and remote file name fields. The transfer 
        is performed as either ASCII, binary, or smart transfer, depending 
        on the state of the Transfer type radio buttons, and server directories 
        are created automatically if the "Automatically create directory" check
        box is selected. An alert message displays the status of the transfer.
     */
    function doftpSendFile()
    {
        var remotefile = document.ftp.remoteFile.value;
        var localfile = document.ftp.localFile.value;
        if ( !validateXferInputs(remotefile, localfile) )
            return;
        var makedir = document.ftp.makeDirectory.checked ? true : false;
        var xfertype = FTP_ASCII;   // default to ASCII
        if ( document.ftp.AsciiBinary[1].checked )
            xfertype = FTP_BINARY;   // binary
        else if ( document.ftp.AsciiBinary[2].checked )
            xfertype = FTP_SMART;   // smart transfer
        var result = getJSAPI().ftpSendFile(remotefile,localfile,makedir,xfertype);
        if ( result ) 
            alert( "FTP transfer to host was successful." );
        else
            alert( "FTP transfer to host failed." );
    }

    /*
        This function transfers a file from the FTP server to the local machine.
        No validity checking of file names is performed other than ensuring that
        there are entries in the local and remote file name fields. The transfer 
        is performed as either ASCII, Binary or smart transfer, depending on the
        state of the Transfer type radio buttons. An alert message displays the
        status of the transfer.
     */
    function doftpReceiveFile()
    {
        var remotefile = document.ftp.remoteFile.value;
        var localfile = document.ftp.localFile.value;
        if ( !validateXferInputs(remotefile, localfile) )
            return;
        var xfertype = FTP_ASCII;   // default to ASCII
        if ( document.ftp.AsciiBinary[1].checked )
            xfertype = FTP_BINARY;   // binary
        else if ( document.ftp.AsciiBinary[2].checked )
            xfertype = FTP_SMART;   // smart transfer
        var result = getJSAPI().ftpReceiveFile(remotefile,localfile,xfertype);
        if ( result ) 
            alert( "FTP transfer from host was successful." );
        else
            alert( "FTP transfer from host failed." );
    }

    /*
        This function validates the entries in the Local File and Remote File
        text fields. There must be entries in both of these fields before you
        can transfer files.
    */
    function validateXferInputs(remotefile, localfile)
    {
        if ( remotefile == "" || localfile == "" )
        {
            alert( "You must specify both a remote file name and a local file " +
                   "name before starting the transfer." );
            return false;
        }
        return true;
    }

    /*
        This function gets the last response from the FTP server. If one of the
        other functions fails to complete successfully, the last server response 
        contains the specific message.
     */
    function doftpGetLastServerResponse()
    {
        var result = getJSAPI().ftpGetLastServerResponse();
        alert( "Last response from FTP server:\n" + result );
    }

//-->
</script>
</head>
<body>
<h1>Reflection for the Web: FTP API Example</h1>
<hr>
<!-- 
    Use form items to collect the information needed to perform the FTP API
    functions.
-->
<form name="ftp">
<table>
    <tr>
        <td><b>Connection:</b></td>
        <td> </td>
    </tr>
    <tr>
        <td>Host name:</td>
        <td><input type="text" value="" name="hostname"></td>
    </tr>
    <tr>
        <td>User name:</td>
        <td><input type="text" value="" name="username"></td>
    </tr>
    <tr>
        <td>Password:</td>
        <td><input type="password" value="" name="password"></td>
    </tr>
</table>
<p><input type="button" name="ftplogin" value="Log In" onClick="doftpLogin()">
<input type="button" name="ftpdisconnect" value="Disconnect" onClick="doftpDisconnect()">
</p>
<table>
    <tr>
        <td><b>File to transfer:</b></td>
        <td> </td>
    </tr>
    <tr>
        <td>Local file:</td>
        <td><input type="text" value="" name="localFile"></td>
    </tr>
    <tr>
        <td>Remote file:</td>
        <td><input type="text" value="" name="remoteFile"></td>
    </tr>
    <tr>        
        <td> </td>
        <td><input type="checkbox" value="makeDirectory" 
            name="makeDirectory">Automatically create directory</td>
    </tr>
    <tr>
        <td>Transfer type:</td>
        <td><input type="radio" value="ascii" name="AsciiBinary" checked>ASCII 
            <input type="radio" value="binary" name="AsciiBinary">Binary 
            <input type="radio" value="smart" name="AsciiBinary">Smart</td> 
    </tr>
</table>
<p>
<input type="button" name="ftpSendFile" value="Send File" onClick="doftpSendFile()">
<input type="button" name="ftpReceiveFile" value="Receive File" onClick="doftpReceiveFile()">
</p>
<p>
<b>Last server response:</b><br>
<input type="button" name="ftpGetLastServerResponse" value="Display" onClick="doftpGetLastServerResponse()">
</p>
</form>
<p>
<!--
   Create a basic IBM 3270 applet in a separate frame, with Advanced user
   menus. To establish a connection, you need to change the hostURL
   parameter to one appropriate for your network.
-->   
<applet mayscript name="ibm3270" codebase="./ex" 
    code="com.wrq.rweb.Launcher.class" 
    width=0 height=0 archive="Launcher.jar">
    <param name="frame" value="true">
    <param name="menuType" value="advanced">
    <param name="hostURL" value="tn3270://mymainframe:23">
    <param name="ftpenabled" value="true">
    <param name="launcher.sessions" value="IBM3270">
    <param name="preloadJSAPI" value="true">
</applet>
</p>
</body>
</html>

Transferring files to an IBM mainframe using IND$FILE

In this example, an IBM 3270 session is embedded in the browser window, and HTML form elements are used to provide controls for performing IND$FILE file transfers between the desktop computer and the mainframe. A "file" type input field is used on the form; this provides both a text field and a Browse button for selecting the local file to send to the host. Because the user is not given access to any of the Reflection menus or dialog boxes in this example, the administrator may want to preconfigure all file transfer settings in the File Transfer Setup dialog box, then save those settings to a configuration file.

To use this example, you must change the hostURL parameter in the <applet> tag below to a host appropriate for your network.

<html>
<head>
<title>Example of Transferring Files to an IBM Mainframe Using IND$FILE</title>
<script language="JavaScript">
<!--
    /*
       This function handles a click in either the Send File or Receive
       File button. It first ensures that Reflection is available and
       initialized, and then it gets the values of the <form> elements into an
       array, determines the direction of the transfer, and transfers the
       specified file.
    */
    function transferFile( direction )
    {
       // Get the Reflection session applet and make sure it is initialized.
       var rw;
       if ( (rw = getRWebAPI()) == null )
       {
          alert( "Unable to find Reflection, or Reflection is not initialized." );
          return;
       }

       // Create an Array object to store the <form> values, and get
       // the values. If any of the required values could not be
       // returned, exit the function without transferring the file.
       var fields = new Array();
       if ( getFields( fields ) )
       {
          // Determine the direction of the transfer, and then issue the
          // appropriate API method, passing the four field values
          // as parameters.
          if ( direction == "send" )
             rw.indSendFile( fields[0], fields[1], fields[2], fields[3] );
          else if ( direction == "receive" )                    
             rw.indReceiveFile( fields[0], fields[1], fields[2], fields[3] );
          else
             alert( "Invalid parameter specified for transfer direction." );
        }

        // After the transfer, request the display focus for the session,
        // so the user can type in the terminal session window.
        rw.requestDisplayFocus();
    }

    /*
       This function gets a reference to the IBM 3270 applet on the
       page, and then gets a reference to the JSAPI for the session,
       and then ensures that it is initialized. The function returns
       the API reference if the session is available, or null if either
       the session or API is not available or not initialized.
    */
    function getRWebAPI()
    {
       var targetApplet = document.IBM3270;
       if ( targetApplet == null ) return null;
       var api = targetApplet.getAPI( "JSAPI", "IBM3270" );
       if ( api == null ) return null;
       if ( api.getInitialized() <= 0 ) return null;
       return api;
    }

    /*
       This function fills in the array object with the values from
       the <form> elements. The function returns true if all of the values
       are valid, or false if the data is not valid. In this example,
       both the local file and the host file are required information,
       so if either is missing, an alert message is displayed.
    */
    function getFields( fields )
    {
       var localFile, hostFile, isAscii, showStatus;
        
       if ( (localFile = document.FileTransfer.localfile.value) == "" )
       {
          alert( "You must enter a local file name." );
          return false;
       }
       if ( (hostFile = document.FileTransfer.hostfile.value) == "" )
       {
          alert( "You must enter a host file name." );
          return false;
       }

       var typeList = document.FileTransfer.FileType;
       isAscii = (typeList.options[typeList.selectedIndex].index == 0) ? true : false;

       showStatus = true; // Currently unused; can be either true or false.
                
       // Fill in the array with the valid data.
       fields[0] = localFile;
       fields[1] = hostFile;
       fields[2] = isAscii;
       fields[3] = showStatus;

       return true;
    }
//-->
</script>
</head>
<body>
<h1>Reflection for the Web -- IBM 3270</h1>
<p>
<!--
   This is the tag that launches an IBM 3270 terminal session.
   To use this example, change the hostURL parameter to one
   appropriate for your network.
-->
<applet mayscript name="IBM3270"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="600" height="400"
        archive="Launcher.jar">
   <param name="hostURL" value="tn3270://payroll">
   <param name="launcher.sessions" value="IBM3270">
   <param name="preloadJSAPI" value="true">
</applet>
</p>
<!--
   A series of <form> elements are created to let the user enter
   the name of the local file, the name of the host file, and
   the format for transferring the file (either ASCII or Binary).
   Two buttons trigger the file transfer. By using an INPUT type
   of "FILE", the local file name field looks like a text field,
   but also gets a Browse button for browsing for a local file.
   Note, however, that the Browse dialog box cannot be used to
   specify a file to save when receiving a file from the host.
-->
<form name="FileTransfer">
<p>Local File Name:&nbsp;<input type="file" size="40" name="localfile"></p>
<p>Host File Name:&nbsp;&nbsp;<input type="text" value="" size="40" name="hostfile"></p>
<p>File type: <select name="FileType">
<option selected>ASCII</option>
<option>Binary</option>
</select>
</p>
<p>
<input type="button" name="RecvFile" value="<< Receive File"       onClick="transferFile( 'receive' )">&nbsp;
<input type="button" name="SendFile" value="Send File >>"       onClick="transferFile( 'send' )">
</p>
</form>
</body>
</html>

Logging out of the host when closing a session

When a user closes a Reflection session window without first logging out of the host, a process may remain running on the host computer, preventing the user from logging on again. This example shows how to prevent this problem; it creates the Reflection session in a separate JavaScript window containing a script that logs the user out of the host computer when the new window is closed. In this example, the script simply checks whether the session is connected, and if it is, transmits the "logout" string.

To use this example, you must change the hostURL parameter in the <applet> tag that's part of the JavaScript function that writes out the Reflection session to a host appropriate for your network. You may also need to modify the code that transmits the "logout" string.

<html>
<head>
<title>Sample Logout on Close Script</title>
<script language="JavaScript">
<!--
    /* 
       Copy relevant symbolic constants from .js file.
    */
    var IBM3270_ENTER_KEY = 35;
    var VT_RETURN_KEY = 2;

    /*
       This function writes the applet tag to launch an IBM 3270 session in
       a new browser window called "IBM3270Applet." In addition to the 
       IBM 3270 session applet, some JavaScript functions are written to the
        tag in the new window: an "onLoad" event handler is added to
       give the terminal session the input focus when it is ready, and an
       "onUnload" event handler is added to logout of the host when the
       browser window is closed.
    */
    function launchIBMSession()
    {
        var targetwin = window.open( "", "IBM3270Applet", 
                                 "status=yes, width=650, height=550" );
        var targetdoc = targetwin.document;
        
        // Use the "with (object)" statement to simplify the following lines.
        with ( targetdoc ) {
            writeln( '<html>' );
            writeln( '<body onLoad="setSessionFocus()" onUnload="doDisconnect()">' );
            writeln( '<script language="JavaScript">' );
            writeln( '   window.onerror = errHandler;' );
            writeln( '   var api = null;' );
            writeln( '   function errHandler(msg, url, line) {' );
            writeln( '      setTimeout("setSessionFocus()",1000);' );
            writeln( '      return true;' );
            writeln( '   }' );
            writeln( '   function setSessionFocus() {' );
            writeln( '      api = document.IBM3270.getAPI("JSAPI","IBM3270");' );
            writeln( '      if ( api.getInitialized() <= 0  )' );
            writeln( '         setTimeout("setSessionFocus()",1000);' );
            writeln( '      else' );
            writeln( '         api.requestDisplayFocus();' );
            writeln( '   }' );
            writeln( '   function doDisconnect() {' );
            writeln( '      if ( api.isConnected() ) {' );
            writeln( '         api.transmitString("logout");' );
            writeln( '         api.transmitTerminalKey(" + IBM3270_ENTER_KEY + ");' );
            writeln( '      }' );
            writeln( '   }' );
            writeln( '</script>' );
            writeln( '<h1>Reflection for the Web -- IBM 3270</h1>' );
            writeln( '<applet mayscript name="IBM3270"' );
            writeln( '       codebase="./ex/"' );
            writeln( '       code="com.wrq.rweb.Launcher.class"' );
            writeln( '       width="600" height="400"' );
            writeln( '       archive="Launcher.jar">' );
            // Change the hostURL to a value appropriate for your network.
            writeln( '   <param name="hostURL" value="tn3270://payroll">' );
            writeln( '   <param name="autoconnect" value="true">' );
            writeln( '   <param name="frame" value="false">' );
            writeln( '   <param name="launcher.sessions" value="IBM3270">' );
            writeln( '</applet>' );
            writeln( '</body>' );
            writeln( '</html>' );
            close();
        }
    }

    /*
       This function writes the applet tag to launch a VT session in
       a new browser window called "VTApplet." In addition to the 
       VT session applet, some JavaScript functions are written to the
        tag in the new window: an "onLoad" event handler is added to
       give the terminal session the input focus when it is ready, and an
       "onUnload" event handler is added to logout of the host when the
       browser window is closed.
    */
    function launchVTSession()
    {
        var targetwin = window.open( "", "VTApplet", 
                                 "status=yes, width=650, height=550" );
        var targetdoc = targetwin.document;
        
        // Use the "with (object)" statement to simplify the following lines.
        with ( targetdoc ) {
            writeln( '<html>' );
            writeln( '<body onLoad="setSessionFocus()" onUnload="doDisconnect()">' );
            writeln( '<script language="JavaScript">' );
            writeln( '   window.onerror = errHandler;' );
            writeln( '   var api = null;' );
            writeln( '   function errHandler(msg, url, line) {' );
            writeln( '      setTimeout("setSessionFocus()",1000);' );
            writeln( '      return true;' );
            writeln( '   }' );
            writeln( '   function setSessionFocus() {' );
            writeln( '      api = document.VT.getAPI("JSAPI","VT");' );
            writeln( '      if ( api.getInitialized() <= 0  )' );
            writeln( '         setTimeout("setSessionFocus()",1000);' );
            writeln( '      else' );
            writeln( '         api.requestDisplayFocus();' );
            writeln( '   }' );
            writeln( '   function doDisconnect() {' );
            writeln( '      if ( api.isConnected() ) {' );
            writeln( '         api.transmitString("logout");' );
            writeln( '         api.transmitTerminalKey(" + VT_RETURN_KEY + ");' );
            writeln( '      }' );
            writeln( '   }' );
            writeln( '</script>' );
            writeln( '<h1>Reflection for the Web -- VT</h1>' );
            writeln( '<applet mayscript name="VT"' );
            writeln( '       codebase="./ex/"' );
            writeln( '       code="com.wrq.rweb.Launcher.class"' );
            writeln( '       width="600" height="400"' );
            writeln( '       archive="Launcher.jar">' );
            // Change the hostURL to a value appropriate for your network.
            writeln( '   <param name="hostURL" value="telnet://accounts">' );
            writeln( '   <param name="autoconnect" value="true">' );
            writeln( '   <param name="frame" value="false">' );
            writeln( '   <param name="launcher.sessions" value="VT">' );
            writeln( '</applet>' );
            writeln( '</body>' );
            writeln( '</html>' );
            close();
        }
    }
// -->
</script>
</head>
<body>
<h1>Reflection for the Web -- Logout on Close Example</h1>
<p>

<form name="LaunchSession">
<input type="button" name="LaunchIBM" value="Launch IBM 3270" onClick="launchIBMSession()">
<input type="button" name="LaunchVT" value="Launch VT" onClick="launchVTSession()">
</p>
</form>
</body>
</html>

Logging on to an IBM 3270 host (VBScript)

In this example, which runs only in Internet Explorer, Microsoft's VBScript is used to launch an IBM 3270 session and log on to the host computer. Two <form> fields on the web page are used to get the user's name and password before creating the Reflection session applet and performing the logon. The Reflection session is created in a new browser window that has only a status bar. This is done so the VBScript WriteLn statements don't replace the contents of the current window and make the rest of the script unavailable. A related example shows a JavaScript version of this script.

To use this example, you must change the hostURL parameter in the <applet> tag that's part of the DoWriteApplet() function below to a host appropriate for your network. In addition, the HTML page must be placed in the session folder rather than in the ReflectionData/deploy folder. If the session were delivered from the deploy folder as a protected session, dynamically generated code that gets added to the applet tag written out by the WriteLn statements would contain nested double quotation marks and would generate a syntax error.

<html>
<head>
<title>Sample Logon Script for IBM 3270 (VBScript)</title>
<script language="VBScript">
<!--
    ' Script-level variables shared by various functions.
    Dim strUserid
    Dim strPword
    Dim intInited
    Dim intCount
    Dim objAppletTarget
    Dim objAPI
    Dim objTargetdoc
    Dim objTargetwin

    ' Copy relevant symbolic constants from
    ' api_ibm3270_constants.js and modify as needed for VBScript.
    Dim ANY_COLUMN
    Dim IBM3270_ENTER_KEY
    Dim IBM3270_TAB_KEY
    ANY_COLUMN = -1
    IBM3270_ENTER_KEY = 35
    IBM3270_TAB_KEY = 52

    '****************************************************
    ' Handle a click on the Logon button. This first
    ' initializes the script-level variables, and then validates
    ' the form inputs. If the form inputs are okay, the
    ' procedure DoWriteApplet is called to write the applet
    ' tag to a new browser window.
    '****************************************************
    Sub Logon_OnClick()
        Call DoInitVariables()
        If blnValidateInputs() = True Then
            Call DoWriteApplet()
        End If
    End Sub
    
    '****************************************************
    ' Initialize the script-level variables.
    '****************************************************
    Sub DoInitVariables()
        strUserid = ""
        strPword = ""
        intInited = 0
        intCount = 0
        objAppletTarget = Null
        objAPI = Null
        objTargetdoc = ""
        objTargetwin = ""
    End Sub
    
    '****************************************************
    ' Check for a username and password, and if either is
    ' not present, display a message box and return False.
    ' If the User ID and Password are filled in, return
    ' True.
    '****************************************************
    Function blnValidateInputs()
        strUserid = Document.LogonForm.Userid.Value
        strPword = Document.LogonForm.Password.Value
        If strUserid = "" Then
            Alert "You must enter a User ID to log on!"
            Document.LogonForm.Username.Focus()
            blnValidateInputs = False
            Exit Function
        End If
        
        If strPword = "" Then
            Alert "You must enter a Password to log on!"
            Document.LogonForm.Password.Focus()
            blnValidateInputs = False
            Exit Function
        End If
        blnValidateInputs = True
    End Function

    '****************************************************
    ' This function writes the applet tag to launch an 
    ' IBM 3270 session in a new browser window called 
    ' "IBM3270Applet." When the new window is done loading
    ' the new window's onLoad event handler is invoked,
    ' which calls the DoLogon procedure in this script.
    '****************************************************
    Sub DoWriteApplet()
        Set objTargetwin = Window.Open( "", "IBM3270Applet", "status=yes, width=650, height=550" )
        Set objTargetdoc = objTargetwin.Document

        objTargetdoc.Open
        objTargetdoc.WriteLn "<html>"
        objTargetdoc.WriteLn "<body language='VBScript' OnLoad='Window.Opener.DoLogon'>"
        objTargetdoc.WriteLn "<h1>Reflection for the Web -- IBM 3270</h1>"
        objTargetdoc.WriteLn "<applet mayscript name='IBM3270'"
        objTargetdoc.WriteLn "        codebase='../ex/'"
        objTargetdoc.WriteLn "        code='com.wrq.rweb.Launcher.class'"
        objTargetdoc.WriteLn "        width='600' height='400'"
        objTargetdoc.WriteLn "        archive='Launcher.jar'>"
        ' Change the hostURL parameter to a host appropriate for your network.
        objTargetdoc.WriteLn "    <param name='hostURL' value='tn3270://payroll'>"
        objTargetdoc.WriteLn "    <param name='autoconnect' value='false'>"
        objTargetdoc.WriteLn "    <param name='frame' value='false'>"
        objTargetdoc.WriteLn "    <param name='preloadJSAPI' value='true'>" 
        objTargetdoc.WriteLn "    <param name='launcher.sessions' value='IBM3270'>"
        objTargetdoc.WriteLn "</applet>"
        objTargetdoc.WriteLn "<form><input type='button' name='Close' value='Close Window' "
        objTargetdoc.WriteLn "OnClick='Window.Close()'></form>"
        objTargetdoc.WriteLn "</body>"
        objTargetdoc.WriteLn "</html>"
        objTargetdoc.Close()
    End Sub

    '****************************************************
    ' This procedure is called by the applet window's onLoad
    ' event handler after the new child window has been loaded.
    ' It gets a reference to the Reflection Launcher applet on the
    ' web page, and if the reference is null, it shuts the 
    ' child window. Otherwise, it calls the DoGetAPI() 
    ' procedure.
    '****************************************************
    Sub DoLogon()
        On Error Resume Next
        Set objAppletTarget = objTargetdoc.IBM3270
        If objAppletTarget = Null Then
            Alert "Could not get applet reference. The script is stopping now."
            objTargetwin.Close()
            Exit Sub
        Else
            DoGetAPI
        End If
    End Sub
       
    '***************************************************
    ' This procedure gets the Reflection JSAPI object for
    ' the terminal session on the web page. If the API
    ' object is null, it rechecks every 2 seconds. When
    ' the API object is available, the procedure then
    ' gets the Reflection session's initialization status,
    ' again pausing 2 seconds between attempts, before calling
    ' DoConnect. For more information about determining 
    ' Reflection's initialization status, see Using an onLoad
    ' Handler to Determine When Reflection Is Initialized.
    '****************************************************
    Sub DoGetAPI()
       Set objAPI = objAppletTarget.getAPI("JSAPI", "IBM3270")
       If objAPI = Null Then
          SetTimeout "DoGetAPI()", 2000
       Else
          On Error Resume Next
          intInited = objAPI.getInitialized()
          If intInited = 0 Then
             If intCount < 10 Then
                intCount = intCount + 1
                SetTimeout "DoGetAPI()", 2000
             Else
                Alert "Unable to initialize Reflection."
             End If
          ElseIf intInited > 0 Then
             DoConnect
          Else
             Alert "Reflection initialization failed."
          End If
       End If
    End Sub
    
    '****************************************************
    ' This procedure starts the actual logon tasks. It 
    ' determines if the session is connected, and if so, 
    ' finds the Userid and Password prompts on the display
    ' and transmits the user's data.
    '****************************************************
    Sub DoConnect()
        ' If there's no connection, try to connect.
        If objAPI.isConnected() = False Then
            objAPI.connect()
        Else
            objTargetwin.Alert "You're already connected!"
            Exit Sub
        End If
        
        ' Use the status line to display informational messages.
        objTargetwin.Status = "Waiting for USERID prompt."

        ' Wait 5 seconds for the USERID prompt to appear on the display.
        ' The coordinates in which to start looking are any column in
        ' row 19. The API uses 0-based coordinates, in contrast to the
        ' 1-based coordinates that are used for the status line.
        If objAPI.waitForDisplayString( "USERID", 19, _
                              ANY_COLUMN, 5000 ) = False Then
            objTargetwin.Alert "Unable to find USERID prompt. The script will stop, " & _
                   "but you may continue manually."
            Exit Sub
        End If
        
        ' Wait 5 seconds for the cursor to appear in row 19, column 16.
        ' This is the location for the user's ID.
        If objAPI.waitForCursorEntered( 19, 16, 5000 ) = False Then
            objTargetwin.Alert "Cursor was not found in the USERID field. The script " & _
                   "will stop, but you may continue manually."
            Exit Sub
        End If
        
        ' USERID field was found, and cursor is in place, so transmit the user's
        ' ID, followed by the Tab key to move to the next field.
        objAPI.transmitString( strUserid )
        objAPI.transmitTerminalKey( IBM3270_TAB_KEY )
        
        ' Wait for the cursor to enter the Password field.
        objTargetwin.Status = "Waiting for Password prompt."
        If objAPI.waitForCursorEntered( 20, 16, 5000 ) = False Then
            objTargetwin.Alert "Cursor was not found in the Password field. The script will " & _
                     "stop, but you can try completing the logon manually."
            Exit Sub
        End If

        ' Cursor is in Password field, so transmit the user's password, followed
        ' by the Enter key.
        objAPI.transmitString( strPword )
        objAPI.transmitTerminalKey( IBM3270_ENTER_KEY )
        
        
        ' Wait 5 seconds for the "Ready" message. If not found, display
        ' a message box.
        objTargetwin.Status = "Waiting for Ready prompt."
        If objAPI.waitForDisplayString( "Ready;", 5000 ) = False Then
            objTargetwin.Alert "Ready signal not found. The session may not be ready for input."
            Exit Sub
        End If
        
        ' Display a final status message, and set the focus to the
        ' terminal display.
        objTargetwin.Status = "Ready to proceed."
        objAPI.requestDisplayFocus()
        
    End Sub

// -->
</script>
</head>
<body bgcolor="#FFFFFF">
<h1>Reflection for the Web -- IBM 3270 Logon</h1>
<!--
   Use <form> items to accept the User ID and Password, and to create
   a Logon button.
-->
<form name="LogonForm">
<p>User ID: <input type="text" name="UserID" default size="25"></p>
<p>Password: <input type="password" name="Password" size="25"></p>
<p><input type="button" name="logon" value="Logon"></p>
</form>
</body>
</html>

Logging on to a VMS host (VBScript)

In this example, a VT session is embedded in the browser window, and VBScript, which is available only in Internet Explorer, is used to log on to the host computer. Two <form> fields on the web page are used to get the user's name and password before performing the logon. Before the logon is actually initiated, a loop with a time delay is used to determine if Reflection is initialized and ready for additional commands. A related example shows a JavaScript version of this script.

<html>
<head>
<title>Sample Logon Script for VT (VBScript)</title>
<script language="VBScript">
<!--
    ' Script-level variables shared by various functions.
    Dim strUname
    Dim strPword
    Dim intInited
    Dim intCount
    Dim objAppletTarget
    Dim objAPI
    
    '****************************************************
    ' Handle a click on the Logon button. This first 
    ' initializes the script-level variables, and then validates
    ' the form inputs. If the form inputs are okay, 
    ' DoTryInit is called to start the action.
    '****************************************************
    Sub Logon_OnClick()
        Call DoInitVariables()
        If blnValidateInputs() = True Then
            Call DoTryInit()
        Else
            Exit Sub
        End If
    End Sub
    
    '****************************************************
    ' Initialize the script-level variables.
    '****************************************************
    Sub DoInitVariables()
        strUname = ""
        strPword = ""
        intInited = 0
        intCount = 0
        objAppletTarget = Null
        objAPI = Null
    End Sub
    
    '****************************************************
    ' Check for a username and password, and if either is
    ' not present, display a message box and return False.
    ' If the username and password are filled in, return
    ' True.
    '****************************************************
    Function blnValidateInputs()
        strUname = Document.LogonForm.Username.Value
        strPword = Document.LogonForm.Password.Value
        If strUname = "" Then
            Alert "You must enter a Username to log on!"
            Document.LogonForm.Username.Focus()
            validateInputs = False
            Exit Function
        End If
        
        If strPword = "" Then
            Alert "You must enter a Password to log on!"
            Document.LogonForm.Password.Focus()
            blnValidateInputs = False
            Exit Function
        End If
        blnValidateInputs = True
    End Function

    '****************************************************
    ' This procedure gets a reference to the Reflection
    ' applet on the page and stores it in "objAppletTarget".
    ' If that succeeds, it then calls DoGetAPI() to get
    ' the Reflection API.
    Sub DoTryInit()
        On Error Resume Next
        Set objAppletTarget = Document.VT
        If objAppletTarget = Null Then
            Alert "Could not get applet reference. The script is stopping now."
            Exit Sub
        Else
            DoGetAPI
        End If
    End Sub
    
    '***************************************************
    ' This procedure gets the Reflection JSAPI object for
    ' the terminal session on the web page. If the API
    ' object is null, it rechecks every 2 seconds. When
    ' the API object is available, the procedure then
    ' gets the Reflection session's initialization status,
    ' again pausing 2 seconds between attempts, before calling
    ' DoConnect. For more information about determining
    ' Reflection's initialization status, see Using an onLoad
    ' Handler to Determine When Reflection Is Initialized.
    '****************************************************
    Sub DoGetAPI()
       Set objAPI = objAppletTarget.getAPI("JSAPI", "VT")
       If objAPI = Null Then
          SetTimeout "DoGetAPI()", 2000
       Else
          On Error Resume Next
          intInited = objAPI.getInitialized()
          If intInited = 0 Then
             If intCount < 10 Then
                intCount = intCount + 1
                SetTimeout "DoGetAPI()", 2000
             Else
                Alert "Reflection is not initialized. Unable to continue."
             End If
          ElseIf intInited > 0 Then
             DoConnect
          Else
             Alert "Reflection initialization failed. Unable to continue."
          End If
       End If
    End Sub
    
    '****************************************************
    ' This function starts the actual logon tasks. It 
    ' determines if Reflection is connected, and if so, 
    ' calls the function that finds the Username and 
    ' Password prompts on the display and transmits the 
    ' user's data.
    '****************************************************
    Sub DoConnect()

        ' If there's no connection, try to connect.
        If objAPI.isConnected() = False Then
            objAPI.connect()
        Else
            Alert "You're already connected!"
            Exit Sub
        End If

        ' Wait 5 seconds for the Username prompt.
        If objAPI.waitForString( "Username:", 5000 ) = False Then
            Alert "Unable to find Username prompt. The script will stop, " & _ 
                    "but you may continue manually."
            Exit Sub
        End If

        ' Username prompt was found, so transmit the user's username
        ' followed by a carriage return. The VBScript string constant
        ' "vbCR" is used to represent the carriage return. You can
        ' also use the expression "Chr(13)," which is the decimal 
        ' representation of the carriage return character.
        objAPI.transmitString( strUname & vbCR )

        ' Wait 5 seconds for the Password prompt.
        If objAPI.waitForString( "Password:", 5000 ) = False Then
            Alert "Unable to find Password prompt. The script will stop, " & _
                    "but you can try completing the logon manually."
            Exit Sub
        End If

        ' Password prompt was found, so transmit the user's password,
        ' followed by a carriage return. As above, the VBScript constant
        ' "vbCR" is used for the carriage return character.
        objAPI.transmitString( strPword & vbCR )
        
        ' Set the focus to the terminal display.
        objAPI.requestDisplayFocus()

    End Sub
    
// -->
</script>
</head>
<body>
<h1>Reflection for the Web -- VT Logon</h1>
<p>
<!--
   Create a basic VT applet on the page but don't connect until
   the user fills in the username and password information.
   To use this example, change the hostURL parameter to one 
   appropriate for your network.
-->
<applet mayscript name="VT"
        codebase="./ex/"
        code="com.wrq.rweb.Launcher.class"
        width="600" height="400"
        archive="Launcher.jar">
    <param name="hostURL" value="telnet://payroll">
    <param name="autoconnect" value="false">
    <param name="frame" value="false">
    <param name="launcher.sessions" value="VT">
</applet>
</p>
<!--
   Use <form> items to accept the Username and Password, and to create
   a Logon button.
-->
<form name="LogonForm">
<p>Username: <input type="text" name="Username" default size="25"></p>
<p>Password: <input type="password" name="Password" size="25"></p>
<p><input type="button" name="logon" value="Logon"></p>
</form>
</body>
</html>