Start Options

Session ID
Start Automatically
Start in Separate Window
Auto-Start Options
     Applet/Macro
     Name
     Parameters (Optional)
Auto-start HLLAPI Enabler
Lock

Session ID
ID assigned to this session. Value options include Automatic (the default) or any letter of the English alphabet. The ID is displayed on the session window or tab.

If the value is Automatic, Host On-Demand automatically assigns a letter to the session in alphabetical order, and, if Start Automatically is set to Yes, starts sessions in the order they are created.

If you specify a letter value for the session, Host On-Demand assigns that letter to the session. However, if that letter is already being used by another session and you attempt to open a duplicate session, either from the Host On-Demand desktop or by selecting 'Run the Same' from the started session, you will get an error message stating that the session ID is already in use.

Start Automatically
Session is started and connected (if Auto-Connect is Yes) when the client is loaded.

If you are configuring sessions to run in a WebSphere Portal environment and you want the sessions to start automatically, set this option to Yes. For more information about how to use Host On-Demand as a portlet, refer to the Using Host On-Demand Clients with Portal Server section in the Planning, Installing, and Configuring Host On-Demand guide.

Start in Separate Window
If you select Yes, the session is started in a separate browser window. If you select No, the session is started in the Client window with the session name and ID displayed on a tab. Each session started in the Client window is tabbed for easy access.

To close a session that is started in the Client window, click the Close button (X) on the session tab. To disable this function, add the HTML parameter, showTabCloseButton with the value of false. The default is true. Also, to hide the Close button on the background session tabs, add the HTML parameter, hideTabCloseOnBackgroundTabs with the value of true. The default is false. See HTML parameters.

If you are configuring sessions to run in a WebSphere Portal environment and you want to embed the sessions in the portal page, set this option to No. For more information about how to use Host On-Demand as a portlet, refer to the Using Host On-Demand Clients with Portal Server section in the Planning, Installing, and Configuring Host On-Demand guide.

Auto-Start Options
The Auto-Start Options allow you to specify the name of either a Java applet or a Host On-Demand macro that you want the Host On-Demand client to launch automatically when the session is started.

The Auto-Start Options are valid only for the following session types:

• 3270 Display session
• 5250 Display session
• VT Display session
• CICS Gateway session

Host On-Demand provides a Run Applet that can set a user-defined screen size for a 3270 session. The class name for this applet is com.ibm.HOD.ScreenSize and the parameter needs to be size=nnxyy where nn is the number of rows and yy is the number of columns. For example, size=43x80 results in a screen with 43 rows and 80 columns.

Here is an overview of the configuration process:

1. Expand the Applet/Macro listbox and click either Applet to auto-start an applet or Macro to auto-start a macro.
2. In the Name field, type the name of the applet or macro.
3. In the Parameters (Optional) field, type the parameters, if any, that you want to pass to the applet or macro.

For more detailed information, see the description below under the name of each field: Applet/Macro, Name, and Parameters (Optional).

Applet/Macro
Select Applet or Macro.

• Applet:
  

  The applet must implement either the ECLAppletInterface class or the CustomInterface class (see the Host Access Beans for Java online book in the IBM Host Access Toolkit, which is distributed with Host On-Demand).

  The Host On-Demand client launches the applet immediately, without waiting for the session to connect to the host. If the applet is in some way dependent on the session having made a successful connection, then the applet itself must detect that the session has connected. To detect that the session has connected, use methods such as Terminal.addCommListener() or Session.getCommStatus() (see the Host Access Beans for Java online book in the IBM Host Access Toolkit, which is distributed with Host On-Demand).

  If the session disconnects and then reconnects, then the Host On-Demand client does not launch another instance of the applet.

  For information on deploying a customer-supplied applet to clients, see Deploying customer-supplied Java archives and classes in Planning, Installing, and Configuring Host On-Demand.

• Macro:
  

  The Host On-Demand client does not launch the macro until the session has successfully connected with the host.

  If the session disconnects and then reconnects, then the Host On-Demand client terminates the macro, waits until the session has re-connected, and then launches the macro again.

Name

• Applet:

  Type the class name of the applet that you want the Host On-Demand client to launch.

• Macro:

  Type the name of the macro that you want the Host On-Demand client to launch.

  Be sure that you spell the macro name correctly, including the case of the letters. Macro names are case-sensitive! Therefore, mymacro is a different name than MyMacro, MyMacrO, myMacro, and so on.

  The macro can exist in any one of the following places:

  • In the session.
  • In the user's Personal Library on the client workstation.
  • In a macro server library.
  • In any user-defined location

  The Host On-Demand client searches for the macro as described below. When the client finds a macro having the name that it is searching for (such as mac02), then the client immediately stops searching and uses that macro.

  • If you specify a macro name WITH the extension .mac (for example, if you specify mac02.mac), then the Host On-Demand client:
    1. Searches for the macro name only (mac02) in the session.
    2. Searches for the macro file (mac02.mac):
       1. In the user's Personal Library, if the Personal Macro Library option is enabled in the Disable Functions window (see Disable Functions: Macro).
       2. In the server macro library, if one is specified (see Creating and deploying server macro libraries in the Planning, Installing, and Configuring Host On-Demand).
       3. In all of the user-defined locations. See Searching user-defined macro locations for more information about searching user locations.
    3. Adds a second extension .mac to the file name (mac02.mac.mac) and searches for the macro file again:
       1. In the user's Personal Library, if enabled.
       2. In the server macro library, if one is specified.
  • If you specify a macro name WITHOUT the extension .mac (for example, if you specify mac02), then the Host On-Demand client:
    1. Searches for the macro name (mac02) in the session.
    2. Adds the extension .mac to the macro name (mac02.mac) and searches for the macro file:
       1. In the user's Personal Library, if the Personal Macro Library option is enabled in the Disable Functions window (see Disable Functions: Macro).
       2. In the server macro library, if one is specified (see Creating and deploying server macro libraries in the Planning, Installing, and Configuring Host On-Demand).

Parameters (Optional)

• Applet:

  The name of the parameter that is passed to the applet when the session starts. In order for an applet to receive parameters, the applet must implement the following method: public void initParam(String param). The variable name, param, may be any valid variable name.

• Macro:

  If the macro requires or permits a parameter list, type the parameter list into this input field.

  • The parameter list is saved as part of the session configuration.
  • For information on how to specify a parameter list see Specifying a parameter list for a macro.
  • For information on other locations where you can specify a parameter list for a macro see Locations where you can specify a parameter list for a macro.
  • For a more detailed treatment of parameter lists for macros Passing a parameter list to a macro in the Macro Programming Guide (primarily for session administrators and macro writers).

Auto-start HLLAPI Enabler
Select Yes to enable EHLLAPI (Emulator High Level Language Application Programming Interface) for the session. Enabling EHLLAPI is required if the session will be the target of an EHLLAPI Application. You can only enable EHLLAPI if you have installed the EHLLAPI Bridge, which is available at this download site.

Lock
Check Lock to prevent users from changing the associated startup value for a session. Users can not change values for most fields because the fields are unavailable. However, functions accessed from the session menu bar or tool bar can be changed.

Related topics