IBM Support

Rational Host On-Demand html parameters

Question & Answer


Question

Where are the IBM Rational Host On-Demand html parameter documented?

Cause

Most html parameters are documented in the Deployment Wizard help documentation. Any html parameters added to the product through service is not included in the help documentation.

Answer

The following is a complete list of parameters and definitions that can be coded in the Host On-Demand client using the Deployment Wizard, including those added in Refresh Packs.


Name: AdditionalArchives
Values: Names of Java 2 archives, without file extensions separated by commas. For example, if the archives are the following Java 2 archives:

myCustomForNetscape.jar
myCustomForInternetExplorer.jar
myCustomForMozilla.jar

then you should specify them like this:
myCustomForNetscape,myCustomForInternetExplorer,myCustomForMozilla


Description: This HTML parameter causes the Host On-Demand client code to download the named Java archives file from the Host On-Demand server's publish directory to the workstation. This parameter works for both the cached emulator client and the download emulator client.
You must place the Java archives in the Host On-Demand publish directory. Be aware that the archives will be downloaded every time a user connects to the HTML file.

Back to top


Name: AltScreenSize
Value: nnxnn which represents row by column
Description: This parameter allows you to specify screen sizes for 3270 sessions.

Back to top



Name: ArabicTerm
Value: Alis or DEC
Description: This parameter allows you to enable Alis Specs in an Arabic VT 7-bit session. With Alis specs, you get the following behavior
1. GLCC characters switching between Arabic/Latin Layer: Host On-Demand uses the character "}" for switching to Arabic layer and " { " for switching to Latin. A new line switches back to the default layer regardless of which switching character is used in the previous line. In other words, in LTR screen a new line will switch to Latin layer and in RTL screen a new line will switch to Arabic layer. 
2. New escape sequences for screen reverse: The screen reverse escape sequence will be introduced as " <ESC> [1;1 ~ "escape sequence. 
3. Suppression of the GLCC characters while display special characters "}" , "{" will be shown as an empty space. 

The default value is DEC.

Back to top


Name: AssociateEmbeddedMenuBar
Value: true or false
Description: This HTML parameter allows embedded Host On-Demand sessions running as portlets to display a menu bar. Host On-Demand ignores this parameter for sessions that are not portlets. Users must be running a Windows operating system and have a Java 2-enabled browser in order to use this HTML parameter.

The default value is true.

Back to top


Name: AutoBackOff
Value: true or false
Description: This parameter allows you to uninstall a cached client update and restore a previous version on the cached client. You can uninstall the Host On-Demand server, reinstall a previous version, then using this html parameter force the cached clients to go back to this older version.

The default value is false.

Back to top


Name: AutoStartJavaConsole
Value: true or false
Description: This parameter allows you to prevent the Java console from starting automatically when using DebugCachedClient="true" with the Web Start client. If you set the value to false, the Java console for the Web Start client will not start automatically even if the HTML parameter DebugCachedClient is also specified with a value of true.

The default value is true.

Back to top


Name: AvoidAvailableCheck
Value: true or false
Description: This HTML parameter has been added in HOD 11.0.9 to work around an expected behavior in Java API that reduces the waiting time of the I/O threads. This work around results in faster JSSE session connections. It can be set to false to revert to the old behavior.

The default value is true, making JSSE connections faster.

Back to top



Name: CachedClientDirectoryName
Value: Directory location
Description: This parameter allows you to specify or modify the default Host On-demand cached client install path and the location for saving user preferences. This can be achieved by with the following HTML parameters: CachedClientDirectoryName and Save.

This HTML parameter allows the customer to specify the directory location where the cached client will be installed. You can input the Environment variable or Relative path or Absolute path. Here is the syntax:
  • CachedClientDirectoryName = <Absolute path>
  • CachedClientDirectoryName = <\Relative path>
  • CachedClientDirectoryName = <%Environment Variable%>

Host On Demand already provides HTML parameter for specifying a base location for storing user preferences.

Back to top

Name: CertKeyUsage
Value:
Description: This parameter can be used to filter the list of personal certificates when server is requesting a client certificate for client authentication.

For example: If CertKeyUsage=DigitalSignature is defined, only Digital Signature certificates defined in the key usage field show up in the list of available certificates when "Browser or Security Device" is selected as the source. The nine key usages that can be defined in a certificate are:

  • DigitalSignature
  • NonRepudiation
  • KeyEncipherment
  • DataEncipherment
  • KeyAgreement
  • KeyCertSign
  • CRLSign
  • EncipherOnly
  • DecipherOnly

Back to top


Name: Constrain
Value: true or false
Description: Using this parameter constrain=false can potentially reduce the login time when you use Host On-Demand with LDAP as some repetitive queries have been optimized. This can be used only when Host On-Demand user groups have been migrated to an LDAP server.

Set the value to false to use the parameter. To do this, navigate to the Host On-Demand installation folder: /HostOnDemand/private/ and edit the domainInfo.properties file and add the parameter: contrain=false. Save and close the file, and restart the Host On-Demand service manager. Default value is true

Note: The reduction in login time varies depending on the amount of data stored as part of user and group definitions on LDAP server.


Back to top

Name: CopyFieldsAsTable

This new enhancement allows you to copy text as a table from a 3270 session screen. The table is created based on input fields. As a result, when text copied as a table is pasted into an Excel sheet, and data from every subsequent input field is pasted in a new column. The prerequisite for the feature to work properly is that the field arrangement needs to be the same across all rows that are selected for copying. Please note this works only in SBCS environment.
Value: true or false

To use this feature, set the above HTML parameter. Select the option Edit->CopyAsTable in the session. By default, if the HTML parameter is not entered, the feature is disabled.

Back to top


Name: CustomKeyFunctionX
Value: function identifier|function data
Description: This HTML parameter customizes the list of functions that a key or key combination can be mapped to using Keyboard Remap.

Keyboard Remap allows you to remap key functions by selecting the key you want to remap, then selecting the new function you want that key to perform. The list of available key functions is limited, by default, to a set of predefined key functions; however, you can customize this list with additional functions. When this file is loaded, you can go to the Keyboard Remap window, choose Custom Functions from the Category list, and your custom functions will appear in the list for you to map to a key.

Here is an example of parameters that add key functions to display, respectively, a character that you cannot normally display, automate a login with user ID and password, and automate a logout.


Name: CustomKeyFunction1 Value: Ctrl-A|^A
Name: CustomKeyFunction2 Value: Login|myuserid[tab]mypw[enter]
Name: CustomKeyFunction3 Value: Logout|logout[enter]

The value for the NAME field is always CustomKeyFunctionX, where X is the ordinal of the defined function. Host On-Demand iterates through the custom key function list, starting with 1 and continuing until no CustomKeyFunction value is found.

You must begin with CustomKeyFunction1 and continue in increments of 1. If the list is broken, for example, skips from CustomKeyFunction2 to CustomKeyFunction4, all values after CustomKeyFunction2 are discarded.

The VALUE consists of both the function identifier to the left side of the | and the function data to the right. The identifier displays in the Keyboard Remap function list box. The data is what the emulator processes when the remapped key is pressed.

There are three rules to keep in mind when encoding the value field.

  • Bracket encoding
    Host On-Demand supports the ability to process SendKeys mnemonics, so to send a bracket, you must use all double brackets [[ ]]. Single open and close brackets [ ] are translated as field boundaries for SendKeys mnemonics.
  • Carat encoding
    The carat (^) is used to send characters that cannot be displayed. Place a ^ in front of any character with a value greater than or equal to A (hex 41, decimal 65) to translate to that value minus hex 40 or decimal 64; for example, "^A" = = hex 01, "^B = = hex 02, and so on. The only way to get a ^ into the datastream is to double it. In other words, ^^ is equal to ^ in the datastream.
  • Unicode encoding
    You can use Unicode encoding to put displayable and non-displayable characters into the datastream. Unicode encoding uses the format \uxxxx where xxxx is two hex bytes. The value for the escape character is \u001b.

Back to top



Name: CustomTable
Value: text file name
Description: For each session that you create or edit in Deployment Wizard, this HTML parameter allows you to specify character mapping tables that translate between local (client) and host code, facilitating interaction between users and the host application. You can create four different types of mapping tables:
  • Keyboard: remaps user's keyboard characters as input customized for host application
  • Display: remaps host display characters into screen output customized for user
  • File upload: translates client file into host code while uploading file
  • File download: translates host application file into local (client) code while downloading file
You create these tables as text files and store them in the Host On-Demand Publish Directory (or your alternate publish directory, if you have already designated a different publish directory on your Web server). To add the tables as HTML parameters for a session, you simply input parameter and file name in the appropriate fields of the Advanced Options window:

Your custom table files can contain any number of tables, in any combination of type (keyboard, display, etc.). The file format is similar to that of Java properties files. For example (lines starting with # are comments; variables n and N are hexadecimal values):

##### Start of file
# Map Local nn to EBCDIC NN in keyboard table
sbcs.keyboard.0xnn=0xNN
.....


# Map EBCDIC NN to Local nn in display table
sbcs.display.0xNN=0xnn
.....


# Map Local nn to EBCDIC NN in 3270 file transfer upload table
sbcs.xfer_up.0xnn=0xNN
.....


# Map EBCDIC NN to Local nn in 3270 file transfer download table
sbcs.xfer_dn.0xNN=0xnn
.....
##### End of file

Note that the CustomTable parameter applies to the single-byte character set (SBCS) only.

Back to top


Name: DBCS support for CustomTable
Value: (NOTE: please add value here; not sure based on description)
Description: In earlier versions of Host On-demand, the CustomTable parameter applied to the single-byte character set (SBCS) only. Starting in Version 10.0.4, the CustomTable also applies to the double-byte character set (DBCS) except for File upload and File download.

Back to top

Name: useDBCSInDBCSUnicodeField
Currently DBCS characters in 5250 Unicode fields are displayed correctly only when the session is configured with a DBCS host code page, like Japanese 939. If you want Host On-Demand to display DBCS characters in 5250 Unicode fields on a session configured with an SBCS host code page, like US 037, you can do so by using the new HTML Parameter useDBCSInDBCSUnicodeField.

Value: true or false
If True, Display DBCS characters in 5250 Unicode fields even on a session configured with an SBCS host code page.

If False, Display DBCS characters in 5250 Unicode fields only on a session configured with a DBCS host code page. This is the default value.

Back to top


Name: DebugCode
Value: 65535
Description: This HTML parameter turns on debug tracing for the client.

Back to top


Name: Disable
Values: lum
Description: This HTML parameter disables the license use counting feature.

Setting the value of this parameter to lum disables license use counting and reporting for the particular HTML file. By default, the Host On-Demand client sends a report to the configuration server when a session is launched and periodically while the session is open. (The client requires direct port access to the configuration server for its reporting.) The Host On-Demand server uses the reports to maintain a count of connected clients. If you specify the lum value for the Disable parameter, then the Host On-Demand client does not send these reports.


Back to top


Name: DisableCachingInJSSE
Parameter values: true or false
Default value: false
Description: In an attempt to avoid multiple downloads of the truststore from the Host On-Demand server, Host On-Demand client support for JSSE uses a caching mechanism to store the truststore, CustomizedCAs.jks. You can use this HTML parameter to disable this function. When this parameter is set to true, Host On-Demand disables caching of the truststore in JSSE mode.

Back to top


Name: disableHODMenuBar
This new enhancement to the Host On-Demand menu options enables you to disable the entire Host On-Demand menu. Use the following HTML parameter:

Values: true or false

The default value is false. Set the value to true to remove the HOD menu bar.

Back to top


Name: DisableSupport
Value: true
Description: This HTML parameter causes the Support option of the Help menu item for the Session window to be disabled. This is useful in cases where customers do not wish to have their users contacting IBM support directly. A related parameter, SupportHTML, can be used to specify an alternate set of text to display when the user selects the Help/Support option.

Back to top


Name: DisableXANTOrder
Value: true or false
Description: When this parameter is set to true, Host On-Demand will ignore XANT order and when 2B is encountered which is a non-displayable character, it will be taken as a blank space. The default value is false.

Back to top


Name: DoNotPrefillUser
When using the configuration server-based model and logging on to Host On-Demand, this parameter can be used to prevent having the Userid field be automatically prefilled with the client system logon userid. Possible values for this parameter include the following:


True: The Userid field in the Host On-Demand logon panel is not prefilled.

False: The Userid field in the Host On-Demand logon panel is prefilled with the client system logon userid. This is the default value.

________________________________________________________

Back to top

Name: DownloadAdditionalCodepages
True: true or false


Description: This parameter is provided for Download clients only. In the deployment wizard, the administrator has an option to select the necessary codepages to be downloaded. It is recommended to select all the codepages if the clients are using Sun 1.6.0_19 / IBM 1.6 and above.

If the administrator selects the only necessary codepages, then we will not be downloading all the other codepage jars. This may cause the client to receive a security pop up warning in case the client uses a codepage not added by the administrator in the preload options. To provide an option for the administrator to add all the codepage jars only if the client is using Sun Java 1.6.0_19 / IBM 1.6 and above, the following parameter is provided - DownloadAdditionalCodepages.

The default value is false for the Deployment wizard generated files.

For the default HTML files (download clients), like HOD.html, this parameter will be set to 'true' and it will download all the codepage jars. This is because, if the administrator has selected a codepage for the sessions, and the client is using a different locale (other than the codepage that is selected), you will see the security warning popup. Since there is no option for the administrator clients to select only the necessary codepage jars for the default HTML files, the Host On-Demand client will download all the codepage jars.

Note:

If any custom unsigned jar is added using AdditionalArchives html parameter, the user will receive security warning pop up. To avoid this, it is recommended to add only signed jars.

For administrator clients, all the codepage and fonts jars are downloaded if it is a full client.


Back to top


Name: Enable26LineVT
Value: true or false
Description: This parameter allows you to select an additional screen size of 26 lines for VT sessions.

Back to top


Name: EnableLicenseCountForVM
Value: true or false
Description: When this parameter is set to true, Host On-Demand logs the user ID and client machine IP address in the LicenseCount log.

Back to top


Name: EnablePrintCMSFile
This support allows you to print the CMS files available on the VM/CMS system using ZipPrint. This feature works only for the VM/CMS system and not work for MVS/TSO or CICS systems.

Note: This feature does not provide Bidi, DBCS or Thai support. Also, the associated menu items and messages are in English only.


Value: If the value is "true", the option File->ZipPrint->Print CMS File will be available in the menu, and will allow you to use ZipPrint for print the CMS files.

Back to top


Name: enableTrimmedPaste
Values: true or false.
Description: Set the HTML parameter to true, enable field-wrap and line-wrap in the 3270 session settings to enable the new paste functionality. Default value is false.

Back to top


Name: EnableVTFunctionKeypad
Value: true or false
Description: This parameter allows you to change the Host On-Demand Keypad for VT to have the F1 - F8 keys.


Back to top


Name: extendFFTEntriesLimit
Value: yes or no
Description: If the parameter valueis set to 'yes', the field format table(fft) maximum entry limit value is set to 600. The default value for this parameter is 'no'. This parameter is new with HOD 11.0.9.


Back to top


Name: FipsMode
Values: true or false
Default value: true
Description: FIPS mode is supported only in IBM Java. When using IBM Java, Host On-Demand enables FIPS mode by default. The FIPS function is implemented by the JRE. When this parameter is set to false, Host On-Demand does not enable FIPS mode in IBM Java. When FIPS mode is enabled, the following FIPS ciphers are set by Host On-Demand:
  • SSL_RSA_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_FIPS_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_AES_128_CBC_SHA
  • SSL_DHE_RSA_WITH_AES_128_CBC_SHA
  • SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • SSL_DHE_DSS_WITH_AES_128_CBC_SHA
  • SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA


Back to top


Name: ForceJREInstall
Value: true
Description: If you set this parameter to true, the Host On-Demand client will not display the pop-up message but instead will immediately display the window that allows the user to download the IBM Java 2 plug-in version 1.6 for Windows.

Back to top


Name: ForceUpgradeLogic
Value: true or false
Description: There are a set of upgrade control options that Administrators can set in the Deployment Wizard. Currently, if a new jar is added into the preload list then Host On Demand automatically ignores these upgrade options and downloads the jar. If you have set upgrade options and want Host On Demand to honor these options, even if a new jar is included in the preload list, you can do so using this parameter.

Back to top


Name: ForceJava2
Value: false, true
Description: When this parameter is used, all Java 2 detection is bypassed and the Host On-Demand web page is built assuming that a Java 2 plug-in is available. Possible values for this parameter include the following:

false: All Java 2 detection proceeds as before.


true: Page is generated using the default Java 2 plug-in.

The default value is false.

Back to top


Name: GenericLogonFailureMsg
Value: true or false
Description: For config server model, this parameter with a value of "true" changes the logon failed message which previously said whether the userid was bad or the password was bad to just say "Logon failed"

The default value is false.

Back to top


Name: HidePort990Msg
Value: true or false
Description: This parameter allows you to prevent error messages when using port 990 for secure FTP connections. If the value is set to true, the port 990 error message is never displayed.

Back to top


Name: HideHODDesktop
Value: true or false
Description: When this parameter is set to True, the Host On-Demand desktop will be hidden when an embedded session is launched. Default is false.

Back to top


Name: IgnoreWellKnownTrustedCAs
Value: true
Description: This HTML parameter prevents Host On-Demand from loading the WellKnownTrustedCAs.class/.p12 file.

Back to top


Name: IPMonitor
Value: SessionName=My Session,TraceFile=c:\MyDirectory\trace.trc

  • Set SessionName to the name of a session visible on the Host On-Demand desktop, such as My Session or 3270 Display. The session name must be spelled exactly as it appears in the session properties, and as it is displayed below the session icon, including spaces.
  • Set TraceFile to any valid file name.
Description: This HTML parameter allows the session to be started automatically with the IPMonitor utility. The IPMonitor utility traces and saves the data flowing between the client and the host. To start the session with IPMonitor:
  • Float the mouse pointer icon over the session name.
  • Click the right mouse button.
  • Click Start Session with IPMonitor.

Back to top

Name: JSSECustomCiphers

Values: The value is divided into two parts separated by a colon (:), for example, Part1:Part2.

A third part, which is optional, can be added with another colon (:), for example, Part1:Part2:Part3.

Valid values for Part1:Part2:Part3 are described below.

Part1 : One of the following values:

  • Add
    Use this value to indicate that the ciphers specified in this HTML parameter are to be added to the existing ciphers that are used by default. That is, JSSE will use its pre-configured ciphers, in addition to the ones specified in this HTML parameter.
  • UseOnly
    Use this value to indicate that the ciphers specified in this HTML parameter are the only ciphers to be used. In this case, the default pre-configured ciphers are replaced with the ones specified in this parameter.
Note: If none of the specified ciphers are supported by JSSE, and the Part 3 value is not specified, the cipher list enabled in the client will be empty, and the session might not connect.

Part 2 : A comma (,) separated list of ciphers to be used by JSSE.

Part 3 : (Optional) The following value:

  • SkipValidation
    Use this value to indicate not to validate the specified ciphers against the supported list in the client JSSE library. In other words, each cipher specified in this HTML parameter is set in JSSE in the Host On-Demand client regardless of whether it is supported by JSSE. In this case, if an unsupported cipher is included, any resulting error is thrown by Java and the session might not connect.

Examples:
  • Add:SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA,SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
    This adds the two ciphers SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA and SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA to the pre-configured list of ciphers in the JSSE for the client.
  • UseOnly:SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA,SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
    This specifies that the two listed ciphers SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA and SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA are the only ciphers enabled to be used by JSSE for the client.
    Note : If for any reason these two ciphers are not supported by JSSE, an empty list of ciphers is set in JSSE resulting in the session possibly getting disconnected.
  • Add:SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA,SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA:SkipValidation
    This adds the two ciphers SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA and SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA to the pre-configured list of ciphers in the JSSE client. Here, since SkipValidation is also added, the ciphers are not validated to ensure support in JSSE.

Default value: Not applicable. When this parameter is not set, every JSSE client uses its pre-configured list of ciphers.

Description: By default, a JSSE client uses a pre-configured set of ciphers when connecting to a server over TLS/SSL. Using this HTML parameter, you can customize the set of ciphers that are enabled by JSSE in the client.

You can specify ciphers to be added to the default set that are already used by the JSSE client, or specify to use only those ciphers that are listed by the administrator.

In each case, Host On-Demand validates each cipher specified in this HTML parameter to ensure that the JSSE client supports the cipher. Only the ones supported by the JSSE client are used. An option to skip this validation is also supported.


Back to top

Name: LockMacroSaveLocations, RemovecurrentSessionOption

The lockMacroSaveLocations and RemovecurrentSessionOption HTML parameters allow you to customize the Play or Record Macro panel.

Using the HTML parameter lockMacroSaveLocations allows the administrator to add macro locations to that particular Host On-Demand client. This HTML parameter takes input as a string. The value for this parameter is the location/path that appears in the Macro Location. If the administrator decides to add more than one location or path, it is a list of locations separated by semicolon. Also, if both path name and Path have to be specified, the path name should appear first and the path should be separated by a '*' character.

Using the HTML parameter RemovecurrentSessionOption allows the administrator to exclude the "CurrentSession" option appearing in the MacroLocation list.

Value: true or false.

The default value is true. If the value is set to true, "currentSession" appears in the macro Locations list. If the value is set to false, the current Session does not appear in the macro Location.

Back to top


Name: PCCodePageForEHLLAPI
Value: Value of PC Codepage used by the EHLLAPI application. Examples are Cp437 or Cp1252 or Cp037
Description: For each Host On-Demand display session, this HTML parameter configures the Java Encoding set (PC code page) that is to be used to map Strings from the application to appropriate host codes on the PC for an EHLLAPI application. Host On Demand requires that the international version of Java 2 JRE should be installed in the client PC for this feature to work properly. In order to install the international version of JRE, user must choose the support for additional languages option in customized installation of the JRE. The international version (which includes the lib/charsets.jar file) of JVM supports all encodings. Please refer Supported Encodings.

Back to top


Name: persistConnectedStatusMessage

Value: true or false

Description: This HTML parameter will allow the Connected status message on the Host On-Demand session status bar remain until the next message arrives. This applies to 3270 sessions only.

To use this feature, set the HTML parameter 'persistConnectedStatusMessage' to 'true'. The default value is 'false', which means the Connected status message will continue to be removed  from the status bar after a predefined time-out value.

Back to top


Name: PreserveAppendEOFChar
Value: yes
Description: This HTML parameter applies to 3270 Display sessions and 5250 Display sessions. If you specify this parameter with a value of yes, then Host On-Demand preserves an EOF character (x'1A') at the end of a file to which a downloaded file is being appended, by moving the EOF character to a position immediately after the appended data.

This HTML parameter is used in the following circumstances:

  • A 3270 Display session or a 5250 Display session is in progress.
  • A file download is occurring.
  • APPEND is specified in the Receive Text options, meaning that the downloaded file is to be appended to an already existing file on the client.
  • The last character of the existing file is the EOF character x'1A'.

Normally, when PreserveAppendEOFChar is not specified (this is the default situation) or is set to no (same effect as default situation), then Host On-Demand:
  • Removes the x'1A' from the end of the existing file before appending the downloaded data.
  • Does not add the removed x'1A' back to the end of the file after appending the downloaded data.

But if you specify PreserveAppendEOFChar with a value of yes, then Host On-Demand:
  • Removes the x'1A' from the end of the existing file before appending the downloaded data.
  • Also adds the removed x'1A' back to the end of the file after appending the downloaded data.

For more information see the tables in Treatment of EOF character (x'1A') during file download in Text mode . For 3270 Display sessions, the HTML parameter RemoveEOFChar=yes overrides and PreserveAppendEOFChar=yes.

Back to top

Name: RemoveEOFChar
Value: yes
Description: When this HTML parameter is set to yes, it applies only to 3270 Display sessions. If you specify this parameter with a value of yes, then for 3270 Display sessions only, Host On-Demand deletes an EOF character (x'1A') from the end of a file being downloaded and, if APPEND is specified in the Receive Text Options, also deletes x'1A' from the end of the existing file being appended to.

This HTML parameter is used in the following circumstances:

  • A 3270 Display session is in progress.
  • A file download is occurring.
  • The last character of the file being downloaded is the EOF character x'1A'.
  • APPEND may or may not be specified in the Receive Text options.
  • If APPEND is specified, the last character of the existing file being appended to is x'1A'.

Normally, when RemoveEOFChar is not specified (this is the default situation) or is set to no (same effect as default situation), then for both 3270 Display sessions and 5250 Display sessions, Host On-Demand does not delete x'1A' when it occurs as the last character of a file being downloaded.

But if you specify RemoveEOFChar with a value of yes, then for 3270 Display sessions only, Host On-Demand takes the following actions:

  • If the APPEND option is not specified in the Receive Text options, (3270 Display Session), Host On-Demand:
  • Removes x'1A' from the end of the file being downloaded.
  • In contrast, if the APPEND option is specified in the Receive Text options, Host On-Demand:
  • Removes x'1A' from the end of the file being downloaded.
  • Removes the x'1A' from the end of the existing file before appending the downloaded data.
  • Does not add the removed x'1A' back to the end of the file after appending the downloaded data.

For more information see the tables in Treatment of EOF character (x'1A') during file download in Text mode . For 3270 Display sessions, the HTML parameter RemoveEOFChar=yes overrides PreserveAppendEOFChar=yes.

Back to top


Name: reorderToolbar
Value : true or false, default is false
Description: When HTML parameter reorderToolbar=true is set in HOD V11.0.10, the ScratchPad button is not added to the toolbar by default.

Back to top


Name: Save
Value: directory location
Description: This HTML parameter is for the HTML-based and Combined models only. This parameter specifies the base directory location where local user preferences are stored. If the directory does not exist Host On-Demand displays an error message.

Valid Save directories

Examples of valid Save directories are as follows:

  • Absolute paths (for example, C:\hod\prefs on a Windows operating system or /hod/prefs on a UNIX-based operating system) are allowed. Mapped network drive letters can also be used in the absolute path.
  • Remote computer names or IP addresses are allowed as long as the following condition is met: the user's computer must already be remotely connected and authenticated to the computer in the Save parameter (for example, when network drives are mapped; however, a mapped drive is not a prerequisite for the Save parameter to work).

Following are two examples of Save values to remote computers:
  • \\DevGroup1\prefs, where prefs is a shared folder on a computer named DevGroup1.
  • \\123.45.67.89\prefs, where prefs is a shared folder on a computer with an IP address of 123.45.67.89.
  • Relative paths (for example, \users\preferences on a Windows operating system or ../preferences on a UNIX-based operating system) are also valid. On Windows operating systems, the relative path is appended to the home directory to make an absolute path. On UNIX-based operating systems, the relative path is relative to the user's current working directory.

The Save directory is only a base location for storing user preferences. Preferences will be stored in the following subdirectories within the Save directory (these folders are created dynamically): user login/profile ID/HODData/web page name.

Back to top

Name: SaveCertificate
Value: true or false
Description: On SSL client authentication using browser or security device, the certificate selected in the Client Auth GUI will not be updated in the session properties object and thus not saved for any model. Value other than false will persist the certificate selection.

The default value is true.

Back to top


Name: ServerNameOverride
Value: Determines the installation directory for the Host On-Demand Java 2 cached client or Web Start client instead of the hostname.
Description: This parameter allows you to have separate instances of cached client for different levels of Host On-Demand even if they all reside on the same server with same IP address.

Back to top


Name: SetDetectTimer
Value: Value is in seconds
Description: This parameter allows the administrator to control the period of time used to detect whether the Java 2 plug-in is installed on the client. In certain cases, the client might require more time to detect the presence of the Java 2 plug-in. For example, if the client is using a dialup connection to the Host On-Demand web server. Use this parameter if clients are falsely reporting that the plug-in is not installed. The default is 15 seconds and a value of 0 indicates an infinite period of time.

Back to top


Name: setSendBufferSizeToScreenSize
Value: true
Description: When using 62x160 or large screen size it fixes the send buffer being too small.


The sendbuffer size will now be calculated taking into account the screen size (Sendbuffer size = screenSize X 2 + 1024). This behavior will only be used when the administrator sets this HTML parameter.

Back to top

Name: ShareCachedClient
Value: true
Description: This HTML parameter enables users on Windows 2000 and 2003, and Windows XP multi-user machines, using either Internet Explorer with the Microsoft Java 1 JVM or else a browser with a Java 2 plug-in, to share a single image of the cached client. The first sharing user downloads a single copy of the cached client code. Subsequent sharing users run or update the same single copy of the cached client code, without requiring a full download.

Back to top


Name: SharedCachedDirectory
Value: fully qualified path
Description: This HTML parameter allows the customer to specify the directory location where the cached client will be installed

For users who are running Windows operating systems and either Internet Explorer or a browser with a Java 2 plug-in, administrators can now specify the install directory of the shared cached client instead of accepting the default location of %SystemRoot%\Documents and Settings\All Users. You must give Read, Modify, and Write access to this directory. Host On-Demand ignores the SharedCachedDirectory parameter unless the ShareCachedClient is set to true.

You must provide a fully qualified path of the directory where you want to install the cached client, for example, c:\Program Files\IBM. The Host On-Demand cached client appends IBMHOD\HODCC to this string.

Back to top


Name: ShowDateTime
Value: yes or no Default: no
Description: When this parameter is set to Yes in the Deployment Wizard, the date and time information is available in the Host On-Demand client on the Textual OIA of the session. The Textual OIA bar is opened by selecting View > Textual OIA on the Host On-Demand session menu bar.

Format:

<month> <date>, <year>

<time> <am/pm>, <timezone>

The format for the date and time information is not configurable, and this feature is currently not supported in Host Access Toolkit and Host On-Demand container environments.

Back to top


Name: SkipConfigProperties
Value: true
Description: This HTML parameter prevents the reading of HTML parameters from the config.properties file.

Any parameters in the config.properties file (in the Host On-Demand publish directory) will apply to all HTML files, unless the HTML file specifically overrides the parameter value. If for some reason you want to prevent the HTML file from reading values in config.properties, you can use this option.

Setting global values: If you want to set global values that apply to all HTML files, you can specify any of these additional parameters in the config.properties file in the Host On-Demand publish directory. All Host On-Demand applets read the config.properties file. This provides an easier way of setting global HTML parameters than specifying them in each HTML file. Any of these HTML parameter can be set this way, and as long as the value is not specified in the HTML file, the value from the config.properties will be used.

Back to top


Name: SkipCustomizedCAs
Value: true or false
Description: Setting this to a value of true instructs the SSL code to not request CustomizedCAs.p12/class file from the Web server preventing unnecessary 404 errors.

Back to top


Name: SkipJavaDownload
Value: true or false
Description: When this parameter is set to true, and no JRE is detected on a client machine, Host On-Demand issues a message to contact the administrator instead of asking whether you want to download a JRE. This parameter can be specified for download or cached clients. It applies when using Internet Explorer on Windows. The default is false.

Back to top


Name: SkipObjectTag
Value: true or false
Description: This parameter provides added control over how Java 2 detection is performed. Java 2 detection is performed by loading a small Java applet. This applet is normally loaded using the HTML APPLET tag. This assumes that the client browser has some level of Java installed as the default Java Runtime Environment (JRE). There are some cases, however, where the Java 2 plugin is installed but there is no default JRE specified for the browser. In this case, the Java support must be invoked using the HTML OBJECT tag. For example, some versions of Microsoft Windows XP were shipped without a Java Virtual Machine built into the Internet Explorer browser. If a Java 2 plugin was downloaded but not installed as the default JRE, then Java 2 detection will not work, and you are informed that there is no suitable Java on the system. This parameter allows an administrator to enhance the Java 2 detection by loading the detection applet using the OBJECT tag. This makes it possible to detect the plugin, and the Java 2 client is loaded onto the computer. The default for this parameter is true. Therefore, to use this functionality, the parameter must be set to false.

If you specify SkipObjectTag=false, and your clients do not have the Java 2 plugin installed, you might be prompted to enter a user ID and password if you are behind a firewall. This happens when Internet Explorer encounters an OBJECT tag for a plugin that is not installed. If Internet Explorer is unable to locate the plugin, it might send a POST command to the Microsoft plugins website, resulting in the prompt from the firewall.

__________________________________________________________
New html

Back to top


Name: SkipSecurityPopupSuppress
Value: true or false
Description: This parameter is provided for Download clients only. The customers who are willing to use the other work arounds or able to disable this feature in Java control panel can forego this fix by setting the value for this parameter to 'true'. If this parameter is set to 'true', then the above jars will not be added even if the clients are using Sun Java 1.6.0_19 / IBM 1.6 and above.
The default value is 'false'.


Back to top


Name: SupportHTML
Value: URL of HTML file to display when user selects Support option of Help menu item
Description: This HTML parameter causes the specified HTML file to be displayed when the Support option of the Help menu item for the Session window is selected.

If this parameter is not specified, the help page, which provides IBM contact information, is displayed. A related parameter, DisableSupport, can be used to disable the Help/Support option.

Back to top


Name: SuppressCachedClientInstallMessage
Value: true or false
Description: Normally, a user is prompted to install the cached client. If this parameter is true, the user is no longer prompted when the new cached client is installed. Note that if this parameter is specified as true, it will be implemented regardless of whether or not AutoBackOff is specified.

Back to top


Name: TraceOptions
Value: SaveLocation=MyLocation,OutputFile=MyOutputFile,NumberOfTraceEntries=MyNumber, traceoption1=value1,traceoption2=value2, traceoption3=option3, and so on.

  • SaveLocation=MyLocation. This parameter specifies whether the trace file is saved on the server or on the client. Instead of MyLocation, you must write either Server or Local.
  • OutputFile=MyOutputFile. This parameter specifies the trace file name when the SaveLocation is set to local. MyOutputFile is a valid path and file name on the client, such as c:\tracefile\trace1.trc.
  • NumberOfTraceEntries=MyNumber. This optional parameter specifies the maximum number of trace entries that will be saved. Instead of MyNumber, you must write an integer, such as 1024.
  • traceoption1=value1, and on. This parameter may be repeated as many times as necessary. Each repetition should specify a particular trace type and a particular value for that type, such as the following:
    HOD.JNILoad=3

For more a complete list of trace types and values, refer to Configuring the TraceOptions HTML Parameter.

Description: This HTML parameter automatically starts the Trace Facility using the parameters and values that you specify.

Back to top




Name: UseAppData
Value: true or false
Description: The Administrator can configure Host On-Demand to store the cached client and user data in the Application Data directory of Windows clients. Normally on Windows clients, Host On-Demand puts data under the "Documents and Settings\<user name> \" directory. However, if the Application Data directory support is enabled, Host On-Demand will use the "Documents and Settings >user name<\Application Data\IBM\HostOnDemand\" directory for both the cached client and user preferences.

If the value is "true", the cached client will be installed at the Application Data directory of Windows clients.

Back to top




Name: useCCSIDMinValue
Value: true or false
Description: If set to true, you can access (CCSID,*MIN) specifications. HOD will calculates the number of characters to be displayed. It may be DBCS or SBCS, then compares with the Field length on Presentation Space rather than comparing field length with Data stream buffer length. If it fits within the
field then we will show on the PS else return error message saying data too long to write on PS. Default value is false.


Back to top

Name: UseHodCDRA1399
Value: true or false
Description: This parameter allows you to enable Host On-Demand to use the same conversion table as IBM Personal Communications when it is set as false for Japanese codepages 1390 and 1399. The default is false.

Back to top


Name: UseJSSEforiSeries
Value: true or false
Description: This HTML parameter tells clients whether or not to use Java Secure Socket Extension (JSSE) when connecting to the iSeries host for secure data transfer or file transfer. JSSE is a set of Java packages that provide a secure connection to a host and must be used in environments that require FIPS-certified components/modules. For more information about FIPS (Federal Information Processing Standards), refer to FIPS environments in the Security chapter of the Planning, Installing, and Configuring Host On-Demand guide.

Back to top




Name: UseSpecialCharsIn3270NumericField
Values: Any Special characters or even alphabets that need to be treated as numeric characters on numeric only fields on 3270 sessions.
Description: This allows you to enter special alpha characters on numeric only field on 3270 sessions. This is helpful where a 3270 application can accept special characters and numeric values to process user requests. This is not enabled by default. To enable this feature, add the HTML parameter with values given below:

If you want the characters !, @, #,$,%,^ and so on to be entered on numeric only fields, then the list of characters can be specified as the value for the above HTML Parameter. It is assumed that the Numeric Field Lock is selected for this feature to be enabled.


Back to top

Name: UseWinLookAndFeelInPortal
Value: true or false
Description: This HTML parameter allows users to interact with both embedded and non-embedded Host On-Demand portlet sessions using Windows system settings for colors and fonts instead of the settings provided with WebSphere Portal. Host On-Demand ignores this parameter for sessions that are not portlets. Users must be running a Windows operating system and have a Java 2-enabled browser in order to use this HTML parameter.

The default value is false.


Back to top

Name: VerifyComponents
Value: true or false
Description: This HTML parameter allows users to bypass the MD5 checksum checking when downloading a cached or Web Start client.

The default value is true.


Back to top

Name: WebServerHostname
Value: The hostname of the Host On-Demand server that the user will connect to after installing the Host On-Demand Java 2 cached client from a LAN or CD. For example, if the user will attach to the file http://myHODServer/hod/myFileA.html then the hostname is myHODServer.

Description: This HTML parameter prevents the user from having to type in the hostname when installing the Java 2 cached client from a LAN or CD. This parameter is useful only for the Java 2 cached client.

The Java 2 cached client stores downloaded components into different directories depending on which Host On-Demand server the components are downloaded from. When the components are copied from a LAN or CD drive rather than being downloaded from a Host On-Demand server, the Java 2 cached client needs to be told the hostname of the Host On-Demand server to which these components belong. If this parameter is not present, the user is prompted for the hostname of the Host On-Demand server.

The hostname that you supply for the value of this parameter must be spelled exactly the same, character-for-character, as the hostname that the user will later use to access this HTML file on the Host On-Demand server. For example, if the user will access the file as
http://myHODServer/hod/myFileA.html
then you should use this very same hostname myHODServer for the value of this parameter. Likewise, if the user will access the file as http://myHODServer.mycompany.com/hod/myFileA.html, then you should use this very same hostname myHODServer.mycompany.com for the value of this parameter. The cached client code treats myHODServer and myHODServer.mycompany.com as different hostnames. Dotted decimal IP addresses such as 9.xx.xx.xx are also valid if the user will be accessing the file as
http://9.xx.xx.xx/hod/myFileA.html.

Back to top


Name: WebStartDesktopVisible
Value: Always, Never, and Control
Description: The following values can be used for this parameter:
Always : HODDesktop always visible (default)
Never : No way to make desktop visible
Control : Desktop can be toggled to show or hide via menu item on running session

Back to top


Name: WindowsDomain
Value: Windows Domain(s)
Description: Host On-Demand will use native code to obtain a users local Windows domain ID when User Identity Type is set to Local System ID in the Express Logon session properties panel. To use this option, this HTML parameter must be set to contain the name of the Windows Domain(s) to which your end users belong. Multiple domains must be separated by commas.

[{"Product":{"code":"SSS9FA","label":"IBM Host On-Demand"},"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Component":"Documentation","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF012","label":"IBM i"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"},{"code":"PF035","label":"z\/OS"}],"Version":"11.0;11.0.1.0;11.0.2.0;11.0.3.0;11.0.4.0;11.0.5.0;11.0.5.1;11.0.6;11.0.6.1;11.0.7;11.0.8;11.0.9","Edition":"","Line of Business":{"code":"LOB35","label":"Mainframe SW"}}]

Document Information

Modified date:
02 August 2018

UID

swg21499829

Page Feedback