Tutorials

Session Manager API

To know more about the configuration details and list of API's supported, refer to the blog on Session Manager API in HCL Software Blog.

Function updateHTMLParameters()

Steps to set the parameters:

Option-1:

Option-2:

Dynamically modifying session properties:

For more information, refer to the blog on Dynamically modifying session properties in HCL Software Blog.

Add Parameters in Deployment wizard:

The list of session properties that can be overridden is given below:

Parameter name
Description
Valid Values
Host Host name or IP address of the target server. Appears as "Destination address" on property panels. Applies to all session types
Host Name or IP address
HostBackup1 Host name or IP address of the backup1 server. Appears as "Destination address" of backup1on property panels. Applies to all session types. Host Name or IP address
HostBackup2 Host name or IP address of the backup2 server. Appears as "Destination address" of backup2on property panels. Applies to all session types. Host Name or IP address
Port The port number on which the target server is listening. Appears as "Destination port" on property panels. Applies to all session types. Any valid TCP/IP port number.
PortBackup1 The port number on which the backup1 server is listening. Appears as "Destination port" of backup1 on property panels. Applies to all session types. Any valid TCP/IP port number.
PortBackup2 The port number on which the backup2 server is listening. Appears as "Destination port" of backup2 on property panels. Applies to all session types. Any valid TCP/IP port number.
CodePage The codepage of the server to which the session will connect. Appears as "Host Code-Page" on property panels. Applies to all session types except FTP. The numeric portion (for example, 037) of the supported host codepage listed in the session property panel.
LUName The name of the LU or LU Pool, defined at the target server, to which you want this session to connect. Appears as "LU or Pool Name" on property panels. Applies to 3270 Display and 3270 Printer session types. The name of an LU or LU Pool.
LUNameBackup1 The name of the LU or LU Pool, defined at the backup1 server, to which you want this session to connect. Appears as "LU or Pool Name" of backup1 on property panels. Applies to 3270 Display and 3270 Printer session types. The name of an LU or LU Pool.
LUNameBackup2 The name of the LU or LU Pool, defined at the backup2 server, to which you want this session to connect. Appears as "LU or Pool Name" of backup2 on property panels. Applies to 3270 Display and 3270 Printer session types. The name of an LU or LU Pool.
WorkstationID The name of this workstation. Appears as "Workstation ID" on property panels. Applies to 5250 Display and 5250 Print session types. A unique name for this workstation.
ScreenSize Defines the number of rows and columns on the screen. Appears as "Screen Size" on property panels. Applies to 3270 Display, 5250 Display, and VT Display session types.
  • value=rows x columns
  • 2=24x80 (3270, 5250, VT)
  • 3=32x80 (3270)
  • 4=43x80 (3270)
  • 5=27x132 (3270, 5250)
  • 6=24x132 (VT)
  • 7=36x80 (VT)
  • 8=36x132 (VT)
  • 9=48x80 (VT)
  • 10=48x132 (VT)
  • 11=72x80 (VT)
  • 12=72x132 (VT)
  • 13=144x80 (VT)
  • 14=144x132 (VT)
  • 15=25x80 (VT)
  • 16=25x132 (VT)

An administrator can set the custom parameters using 1 of the following methods.

  1. By Setting all the parameters in the Deployment Wizard;
  2. OR, By Using custom JSP code (feature delivered as part of custom UX). In template file update hHod_AppletParams variable with all the custom parameters.
    For Example: hHod_AppletParams[“host”] = “host_address”;
    hHod_AppletParams[“port”] = “port_number”;

  3. OR, By Setting parameters via Session managers API using one of the below ways.
    • Option-1:
      • Create json array and pass it to the below method.

        Var hod_applet = new hod_session();
        Var json_object = {“host”:”host_address”, ”port”:”23”}
        hod_applet.setHTMLParametersToOverride(json_object);

    • Option-2:
      • Step 1: create json array repetitively calling below function.
      • Step 2: pass json object to ZIEWeb-Client using below api.

      • Var hod_applet = new hod_session();
        hod_applet.setHTMLParametersToOverride(“HOST”,”HOST ADDRESS”);
        hod_applet.setHTMLParametersToOverride (“port”,”12175”); etc
        hod_applet.setHTMLParametersToOverride(); //finally this to call set method

        Limitation: with session manager API (Application Programming Interfaces) this will not work with auto start sessions.