Administrator's Console
Managing the ScreenSurfer Service

The ScreenSurfer Service which provides both the ScreenSurfer Web Gateway and ScreenSurfer Administrator's Port consists of a single executable which is installed as a Windows/NT Service. Following installation, you start the service using the ScreenSurfer Service Control Panel or the Control Panel Services Dialog. The ScreenSurfer service must be started prior to accessing any of its functionality.

To have the service start every time that NT is booted, change its properties in the Services dialog to Automatic startup if you didn't select this option during installation.

When the ScreenSurfer service is started as a service all informational, warning and error messages are logged to the Windows/NT Event Log. To view any messages, from the Start button, choose Programs/Administrative Tools/Event Viewer. ScreenSurfer is an "Application", which is one of three categories selectable from the Event Viewer menu bar.

Should you desire to execute the ScreenSurfer service from a command line in order to view messages as they occur, or for diagnostic purposes, you can do so from the ScreenSurfer\BIN directory. The program name is IELUA.EXE, and to execute from the command line you should use the IELUA –START command.

Accessing The ScreenSurfer Console Port from a Web Browser

To access the console port, the easiest way is on the machine that ScreenSurfer is installed on: from the Start Button, select /ScreenSurfer/ScreenSurfer Console. This will display an HTML page with a link customized by the ScreenSurfer installation program based on the Console port you specified during installation.

Version 3.0 provides the ability to access the Console and DevCenter through an SSL Filter. Once you have downloaded the surfprox executable file, found at ScreenSurfer, you can access the web server with the special resource of "/ss_adm/" which will route the request to the Console Port, in a fully secure SSL environment.

If you want to access the Console Port from any browser at any time, the Console port number will be part of the URL when using the browser. For example, on the same machine as ScreenSurfer, assuming a Console Installation port of 81, the URL will be:

http://localhost:81 or http://127.0.0.1:81 if DNS is not active on your machine

To access the Console Port from a different machine, simply include the machine name:Port of the machine ScreenSurfer is installed on, such as http://surferboy:83

As previously mentioned, when started from the Services Dialog, ScreenSurfer will log error messages to the Event Viewer. These messages can be viewed from the Programs/Administrative Tools/EventViewer. Choose Log/Applications and all messages will be logged with the Source of "ScreenSurfer".


Possible ScreenSurfer Startup errors

When initially starting ScreenSurfer, you may see the following:

      Starting ScreenSurfer V1.0

      Error: During Primary Socket Bind, return code=2740

      Description=WSAEADDRINUSE: The specified address is already in use. (See the SO_REUSEADDR socket option under setsockopt.)

      Suggestion: Please specify a different port using the Console Settings Page

      This type of error occurs if you have a conflict with an already existing port in use from another HTTP server.

    1. In addition, you may also see:
    2. Warning: Validating Console User (The Console is currently unprotected – you should enter valid IP addresses in registry!)

      This is because you currently have no security for remote users to access the ScreenSurfer Console Port on your system. The registry entry, Valid Console Ports, has the wildcard *, specified for anyone to access it. You can instead enter specific IP addresses separated by commas, to restrict remote access, or specify Password-based security by adding Console Users from the Settings page.

Note: Information on where to find the Valid Console Ports registry entry is documented in step 6 of the next section: Getting Started with ScreenSurfer .

If any error should occur that refers to WINRUI32.DLL when using ScreenSurfer, then try the following:

1. Make sure you have WINRUI32.DLL. This file should be located in your SNA\SYSTEM directory.

2. If you have this file, make sure SNA\SYSTEM is in your PATH.

3. If you have two copies of WINRUI32.DLL (from another terminal emulation product such as
Wall Data’s Rumba), make sure SNA\SYSTEM appears first.

4. Now, you may have to reboot for these changes to take effect.

 


Getting started with ScreenSurfer

This section describes how to start the ScreenSurfer.

        1. Open the Services Dialog from the System Control Panel
        2. Highlight the ScreenSurfer Service and then choose Startup
        3. Choose This Account and enter your Userid/Password.

        Starting ScreenSurfer From the Command Prompt:

        At times, you may need to view informational, warning and error events as they occur instead of through the Administrative Event Viewer. In this case, you can start ScreenSurfer from a command prompt as follows:

        1. D:\>CD \screensurfer\bin
        2. D:\screensurfer\Bin>Start ielua -start

      3. Start an Internet browser of your choice and use

    4. You should see the ScreenSurfer Console Home Page

    5. Choose Change ScreenSurfer Service Settings or Click on the Settings button

    6. Choose Submit to make the changes to update the Registry entries under:

 


Terminating the ScreenSurfer Web Gateway

To terminate the ScreenSurfer service do the following:

  1. If there are active users, use the Console Shutdown Command to allow existing users to end their sessions prior to stopping the service itself.
  2. Stop the ScreenSurfer Service by selecting the ScreenSurfer Service Control Panel and clicking on the Stop Button
    1. (If  ScreenSurfer was started as a console application from the Command Prompt using the IELUA command, use the mouse to put focus on the command window displaying the ScreenSurfer process and  hit Ctrl-C or Ctrl-Break to stop IELUA.EXE)

  3. If you are using SNA Server connections, you may need to Stop the SNA Service in order to clear any "stuck" error conditions.
  4. Go back into SNA Server Admin/Manager. Highlight the Server you want to stop. Then, use the menu item Service/Stop Service… (or just Service/Stop for SNA Server V3) to close the connection to all LUs for this Server.


ScreenSurfer Console features accessible from a Web browser


Console Home PageConsole Home Page

When bringing up the ScreenSurfer Console Home Page, you should see a column of buttons down the left side of the page along with some status information at the top of the right side and some additional links.

For example:

Where the number 50 is the Total Sessions allowed based on your licensing level, and 23 is the number of sessions with a Session Status of Active.

Service Status: which will be either Normal, Shutting Down, or Shut Down.

The buttons on the left equate to some of the text on the right as noted below by a ‘/’. For example, choosing Defined produces the same results as choosing List all Defined Sessions


Quick Picture: all SessionsQuick Picture: All Sessions

This shows a single-page view of all existing sessions based on session number. If you click on the session number, it will give you detailed status information, and the current screen if the session is Active.

If a session is Active, then it will appear green or blue in the Picture.  Red indicates an error.
 

You may also display a picture of specific session ranges directly using the "picture" command. For example, to display a picture of sessions 100 through 150 on a ScreenSurfer machine named "portal":


Active SessionsList all Active Sessions

This lists the current active ScreenSurfer sessions. Sessions become active following a user clicking on a /surfer/connect link pointing at the ScreenSurfer Web Gateway port. They may also be sessions that have had the Start command performed on them when used in a pool of sessions used to service specific ScreenSurfer transactions.

You may also list specific active sessions directly using the "list" command. For example, to list sessions 1 through 20 on a machine named "portal":


List All Defined SessionsList all Defined Sessions / Defined

This lists all defined sessions and status information in a ScreenSurfer Defined Session status screen.

From Commands, you can Start or Stop a session. Starting a session makes it connected to a LU and available to be used in a transaction pool. You can use Details to view the Active Session Screen.

To list specific sessions use the "list" command. For example, to list all defined sessions from 50 through 100:


Settings (Changing configuration options)Change ScreenSurfer Service Settings

This feature allows settings to be defined for your environment which include the LU, LU Pool and TN3270 information. The following properties and settings are available on this screen:
 

 

Registry Access

New for Version 3.0 is the Full Configuration and Tuning button. This allows the user or developer to make changes directly to the Registry, rather than having to open the Registry itself as in previous versions. A complete description is associated with each entry as well as the ability to view the registry settings in full after making any changes.

Total Sessions

This is the total number of sessions available for use.  It is governed by your licensing level, and controlled by the access key you were given when receiving the product.
 

Sessions to AutoStart

Number of sessions to restart after a Shutdown has occurred -- Note that the Sessions to AutoStart cannot be greater than the Total Sessions.

Session group definitions

This release of the ScreenSurfer Web Gateway includes up to 10 different connection groups which may be defined.  This is an arbitrary number which is expected to become fully user-defined in a future release (greater than 10 groups).

For many installations, a single group will provide all the definition needed, where a single TN3270 port or single SNA Server LU Pool will provide access for a full application area.
 

User Session Timeout

Enter the period of time (in minutes) that the ScreenSurfer should use in order to consider a user "timed-out".  Note that the timeout of users in the ScreenSurfer is "passive" in that a user will lose a connection only when a new user has made a "CONNECT" request and all defined sessions are already connected.

The first session found that has been inactive equal to this amount (in minutes) will be "bounced" and the current connection request will take ownership of the session.

Strict User IP Address

If you wish to activate address-based session security, change this value to "yes". By default, this is installed with a value of "no".

Strict session address security ensures that a user, once connected to a session, can only access that session from the same workstation. This option is compatible with dynamically assigned addresses (DHCP), but is NOT compatible with access through a proxy that uses a "pool" of addresses and where each socket open and close through the proxy can end-up using a different IP address.

Generally, you would not set this value to "yes" for any "Internet" style application, since many large organizations use the kind of proxy server that would give a user problems with a "yes" value.

Console Port Number

TCP/IP Port Number for the ScreenSurfer console web server port.  By changing this value, you will change which TCP/IP port ScreenSurfer "listens" on for Console HTTP requests.  For example, by changing from the default install value of "81" to "83", your URL for accessing the console on a machine named "myserver.yoohoo.drink" would be "http://myserver.yoohoo.drink:83".

The initial setting for the Console Port number is specified during installation.

Console User Security

Selecting this button displays a simple dialog which enables you control Console access by hard-coded console machine IP addresses or by UserID/Password security.

For more information, see ScreenSurfer Console User Security

Terminal Port Number

TCP/IP Port Number for the ScreenSurfer Web Gateway port.  By changing this value, you will change which TCP/IP port ScreenSurfer "listens" with for Terminal Emulation HTTP requests.  For example, by changing from the default install value of "84" to "80", your URL for accessing the Terminal Emulation on a machine named "myserver.yoohoo.drink" would be "http://myserver.yoohoo.drink" (note that port 80 is the default for HTTP requests, so no ":80" need be appended to your URL).

LogFile Name

Session(s) to Log

Clear Logfile On Submit

HTTP Log File Name Stub

HTTP Log File Name Frequency

Catch Exceptions

Console Settings Submit Button

Once the SUBMIT button is chosen, any changes will be updated in the registry entries under:

HKEY_LOCAL_MACHINE
  SOFTWARE
   iE
       ScreenSurfer
        Config

If the Registry entries do not appear to change as expected, then check the security. In the Registry Editor, highlight Config and select Security/Permissions…Then, change Type of Access to Full Control.

Note: You must now restart your browser and The ScreenSurfer Service itself for many changes to take effect--note that the status information following the submission of the settings page will inform you whether or not a service restart is required.


ScreenSurfer Console User Security

This page is presented following a click on the Console User Security Button on the main Console Settings page. It provides the ability to activate machine address-based security or userid/password security.

One of the latest features added to Version 3.0 is the ability for an Administrator to control access in ScreenSurfer by creating Console user accounts. The Console users are given specific rights based upon their level of product functionality. A user interface is provided for the Administrator for easy configuration of account rights, such as, recompiling, viewing a user session, and shutting down the server.

From the Administrators Console, select "Settings" then click on the "Update Console Users" button. As the Administrator, you can either click on an existing user to edit their profile and rights or add a new user to the current list. Once you have selected your choice, the window will convert into a user interface. When you have completed making your changes or edits, simply click "add".

Machine address-based security is generally not recommended, but is provided to maintain compatibility with prior versions of the ScreenSurfer base software.

Machine Address

Before activating user-password security for the console, you must disable the installation default for console security, which is "none" (!). To enable console security, edit this field and change the setting from "*" to either an empty string, or the hard-coded four-part TCP/IP address of a valid console machine. If you wish to have hard-coded machine address security for more than one machine, seperate the machine addresses with commas or spaces.

Once you have de-activated "wide-open" security (the installation default), you can start to use user-password security, which is managed with the following fields.

User ID

Enter a UserID to be used for Administration of ScreenSurfer. Both developers and administrators need to have Administrator's rights. To update the password of an existing user, enter that user's ID along with the new password.

Password

Enter the new password for the given UserID. The password will not be written to the registry; instead, a unique hash value is generated, which is then used at runtime to compare with the real password.


DevCenter Developer's PageDevCenter Console Button

The DevCenter button provides access for developers to the DevCenter page. The DevCenter page is a Frames-based HTML document currently only supported for Netscape Navigator Version 4 (and higher) and Microsoft Internet Explorer Veresion 4 (and higher). With ScreenSurfer Version 3, use IE 5.5 to fully utilize the Visual Surfer functionality in the DevCenter.

DevCenter provides administration functions for developers, such as re-compiling templates, generating new templates and a variety of related activities.


ScreenSurfer SupportScreenSurfer Support

The Support button provides access to all ScreenSurfer customer support functions, including product technical support, sales assistance as well as accounting information.

Upon clicking this button, a new browser window will be displayed containing the Support Pages, starting with a support roadmap and related links. For all ScreenSurfer customers (and you are a customer from the moment you download the product for a free trial), access to all submitted questions, problems and suggestions is provided through the Support Pages.


Sweep Timed-out sessionsSweep Timed-out Sessions

Clicking on this button will cause a "sweep" of all sessions, checking which ones have timed-out. If a session has been idle greater than the timeout minutes (specified in the settings page), it will be stopped and made available. You can implement your own logic for timed-out sessions by adding a "TIMEOUT" section to global.stml.


Normal ShutdownShutdown (normal) Console Command

This will not allow any new sessions to be started and will disconnect all existing sessions. Then, shutdown will occur. This is a soft shutdown which will only shutdown sessions that are not connected (eg. Those "In Progress…" or "LU_INIT_PENDING").

After this is done, you must do a Stop Shutdown! to be able to restart any sessions that were shutdown. This insures that any problems have been resolved with these sessions before continuing.


Immediate (hard) ShutdownShutdown Now (hard) -- Stops all sessions

This will immediately shutdown all existing sessions. This will shutdown all sessions regardless of their status.

Note that this may take a few minutes to complete depending on the status of your sessions and the number of sessions to be shutdown. After this is performed, you must do a Restart to be able to start any sessions. This guarantees that any system problems have been addressed before any more session access is allowed. The Service Status will change to Shut Down and 0 Sessions Active on the ScreenSurfer Console Home Page.

For example, if you have the following sessions:
 

ID SNA LU Term Status…
1 DEMOLK1 Active
2 BOZO In Progress..

If you do a Shutdown (normal), then just BOZO will be Stopped.

If you do a Shutdown Now (hard), then both DEMOLK1 and BOZO will be stopped.


Additional menu items

These items will appear after a Shutdown is selected.

Restart (Accept Connects)

This menu item will only appear after a Shutdown Now (hard). This will allow Autostart session to be restarted. This will allow sessions that were just shutdown to now be accessible.

Stop Shutdown!

This menu item will appear after a Shutdown (normal). This will allow sessions that were just shutdown to now be accessible.

About ScreenSurfer

This displays the current version of ScreenSurfer that you are using.

ScreenSurfer Release Notes

This displays information about the current version of ScreenSurfer in use. This includes such information as the features currently available and improvement over the previous version.

ScreenSurfer Documentation

The ScreenSurfer Documentation table of contents page is displayed.


Status Information for "List all Active", "List all Defined" and on the Details screen:

The following columns of information are listed on these displays:

ID

LU

Term Status

Session Status

Activity

Idle Time

Errors

For future use. Intended to contain HardErrorCount/SoftErrorCount.

Command

Start/Stop/Details. These commands are used to either Start a session, Stop a session, or view the details of the session. When you select Stop for an active session, a confirmation screen will be displayed giving you the opportunity to cancel the stop request. If you stop an active session, the user on that session will receive a session not connected or timeout error on his or her next request to the ScreenSurfer Web Gateway port.

Status example:
 

ID SNA LU Term Status Session Status Activity  Idle Time Errors Command
1 DEMOLK1 Active Available 0 1 minute 0/0 Start/Stop/Details
2 IELUPOOL Stopped Available 0 18 minute 0/0 Start/Stop/Details

If you choose Stop for DEMOLK1, then the SNA LU will change back to the starting LU which is IELUPOOL in this case.


Additional detail screen columns

Additional columns on the Details (see the standard list items) screen are:

StartupLU

Cursor

Last AID Request

RUI SID

For example, additional fields for DEMOLK1 if you have already hit Enter to get onto the second screen may be:
 

Startup LU Cursor Last AID Request RUI SID
IELUPOOL 1760 Enter 2

 


Using SNA server trace

Due to the wide variety of host communications and application systems, there can be circumstances where certain screens or combinations of screens are incorrectly interpreted by ScreenSurfer. When this happens, Teamstudio support personnel may request that you provide an SNA Server trace of the connection during the execution of the screen sequence that is in error.

The following describes how to start and use SNA server trace facilities for

To activate SNA Server version 2.11 trace:

1. Choose Microsoft SNA Server (Common) / SNA Server Trace

2. Locate the SNA Server installation directory (eg. E:\sna) and delete the files sna\traces\climsg*.trc. The SNA Server Admin must be closed and all Services stopped in order to delete these files successfully.

3. In the SNA Server Trace Options dialog box, select ONLY the "3270 Messages" checkbox, and make sure that the "Internal Tracing" scrollbar is at "disabled". The Service Name should be SNA Applications.

4. There should be no active ScreenSurfer users or connections.

5. Select the "APPLY" button in the SNA Server Trace Options Dialog Box.

6. Access the ScreenSurfer Web Gateway port from a browser and "exercise" the screens which are causing problems.

7. Wait one minute (to insure the trace has been flushed to disk).

8. In the sna\traces directory, you should now have new climsg*.trc files.

9. You may also be requested to repeat the above steps using the SNA Server 3270 Applet (after saving the trace files created with ScreenSurfer). This can provide ScreenSurfer support personnel with comparitive data.

Using SNA Server V3 trace

1. Choose Microsoft SNA Server (Common) / Trace

2. Locate the SNA Server installation directory (eg. E:\sna) and delete the files sna\traces\climsg*.atf. The SNA Server Manager must be closed and all Services stopped in order to delete these files successfully.

3. Highlight SNA Applications and Choose the Properties.. button. In Message Trace, check 3270 Messages and hit Apply.

4. There should be no active ScreenSurfer users or connections.

5. Access the ScreenSurfer Web Gateway port from a browser and "exercise" the screens which are causing problems.

6. Wait one minute (to insure the trace has been flushed to disk).

7. In the sna\traces directory, you should now have new climsg*.atf files.

8. Use the View Trace file facility in SNA Server and save the viewed data as climsg.trc ASCII text files for use by ScreenSurfer Support personnel.