Tutorials

Session Manager API

• ZIEWeb-Client also supports specialized APIs, called Session Manager APIs. These JavaScript-based APIs help application developers manage host sessions and text-based interactions with host sessions.

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 update HTMLParameters()

• The purpose of this function is to modify the session properties dynamically. This function is called before the create connection is established. The overridden values take precedence over the initial session properties setup by the administrator. The overridden property is locked so the user cannot change it.

Steps to set the parameters:

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:

• Create json array repetitively calling below function

• Pass a 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
  

Dynamically modifying session properties:

• By default the session definitions are defined by the administrator. By Overriding HTML parameters, can modify the session properties in the client side. Only a particular session properties can be override. They are Host, Port , Code page, LUName, Workstation ID and Screensize.
• The overridden values takes precedence over both the initial session properties setup by the administrator.
• The overridden property is locked so the user cannot change it.

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

Add Parameters in Deployment wizard:

• Need to include an HTML parameter

  EnableHTMLOverrides and set it to true (In Deployment Wizard, Advanced options à HTML parameters).

• Need to include an HTML parameter

  TargetedSessionList, having a value of exact name of the session to accept overrides (In Deployment Wizard, Advanced options à HTML parameters).

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

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
                                       

Limitations:

Web.properties:

While adding a path for printedFileLocation in Printer Session or templateURL in Custom UI in web.properties at the private directory, use a double backslash instead of a single backslash.

Example: D:\\FolderName\\FileName.jsp instead of D:\Foldername\FileName.jsp

Instead of that, it will be saved in the Application Server location.

Illegal Filename Characters for customize attributes