HTML parameters

The most useful HTML parameters are described below. Use the Additional Parameters tab on the Advanced Options window of the Deployment Wizard to add these parameters to your deployment file.

AdditionalArchives
AltScreenSize
ArabicTerm
AssociateEmbeddedMenuBar
AutoStartJavaConsole
AvoidAvailableCheck
CertKeyUsage
CMS ZipPrint Support
Constrain
CopyFieldsAsTable
Customizing the "Play Macro" and "Record Macro" panels
CustomKeyFunction X
CustomTable
DBCS support in 5250 Unicode Field on SBCS Session
DebugCode
Disable
DisableCachingInJSSE
DisableMenuBar
DisableSupport
DisableXANTOrder
DoNotPrefillUser
DownloadAddtionalCodepages
Enable26LineVT
EnableLicenseCountForVM
EnablePrintCMSFile
EnableTrimmedPaste
EnableVTFunctionKeypad
ExtendFFTEntriesLimit
FipsMode
ForceUpgradeLogic
GenericLogonFailureMsg
HidePort990Msg
HideDesktop
IgnoreWellKnownTrustedCAs
IPMonitor
JSSECustomCiphers
InactivityLogoffTime
LockMacroSaveLocations,RemovecurrentSessionOption
MaximumJRELevel
MaximumJRELevel Obsolete
mergeToolbarConfigs
PCCodePageForEHLLAPI
PersistConnectedStatusMessage
PreserveAppendEOFChar
RemoveEOFChar
RecorderToolbar
ReplaceTabWithSpaces
Save
SaveCertificate
ServerNameOverride
SetDetectTimer
setSendBufferSizeToScreenSize
SetServerMacroLibraryPath
ShowDateTime
SkipConfigProperties
SkipCustomizedCAs
SkipObjectTag
SupportHTML
TraceOptions
UseAppData
useCCSIDMinValue
UseHodCDRA1399
UseJSSEforiSeries
UseSpecialCharsIn3270NumericField
UseWinLookAndFeelInPortal
VerifyComponents
WebServerHostname
WebStartDesktopVisible
WindowsDomain

Name: AdditionalArchives Values: Names of Java 1 or Java 2 archives, without file extensions (.cab or .jar), separated by commas. For example, if the archives are the following Java 1 archives:



   myCustomForNetscape.jar
   myCustomForInternetExplorer.cab
   myCustomForMozilla.jar

then you should specify them like this:



   myCustomForNetscape,myCustomForInternetExplorer,myCustomForMozilla

Description:

This HTML parameter causes the Z and I Emulator for Web client code to download the named Java archives file from the publish directory of the Z and I Emulator for Web server to the workstation. This parameter works:

For both the Java 1 version and the Java 2 version of the Z and I Emulator for Web client.
For both the cached emulator client and the download emulator client.

You must place the Java archives in the Z and I Emulator for Web publish directory. Be aware that the archives will be downloaded every time a user connects to the HTML file.

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

Name: ArabicTerm Value: Alis and 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

GLCC characters switching between Arabic/Latin Layer

Z and I Emulator for Web 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.
New escape sequences for screen reverse

The screen reverse escape sequence will be introduced as " <ESC> [1;1 ~ "escape sequence.
Suppression of the GLCC characters while display special characters "}" , "{" will be shown as an empty space.

The default value is DEC.

Name: AssociateEmbeddedMenuBar Value: true or false Description: This HTML parameter allows embedded Z and I Emulator for Web sessions running as portlets to display a menu bar. Z and I Emulator for Web 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.

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.

Name: Value: true or false Description: This HTML parameter allows 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.

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

Name:

CMS ZipPrint Support

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.

A new HTML parameter has been added for enabling/disabling this feature:

Name - EnablePrintCMSFile:

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.

Name:

Constrain

Value:

true or false

Description:

Using this parameter

constrain=false

can potentially reduce the login time when you use Z and I Emulator for Web with LDAP as some repetitive queries have been optimized. This can be used only when Z and I Emulator for Web user groups have been migrated to an LDAP server.

Set the value to false to use the parameter. To do this, navigate to the Z and I Emulator for Web installation folder: /ZIEForWeb/private/ and edit the domainInfo.properties file and add the parameter: contrain=false. Save and close the file, and restart the Z and I Emulator for Web 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.

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.

Name: Customizing the Play Macro and Record Macro panels

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 Z and I Emulator for Web 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 the * character.

Using the HTML parameter RemovecurrentSessionOption allows the administrator to exclude the CurrentSession option appearing in the MacroLocation list. Possible values are true or false. The default value is true. If the value is set as 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.

Refer to Playing a macro or Recording a macro for more information.

Name: CustomKeyFunctionX X 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. Z and I Emulator for Web 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 Z and I Emulator for Web 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. For more information, refer to 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 \u xxxx where xxxx is two hex bytes. The value for the escape character is \u001b.

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 the keyboard characters of the user 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 Z and I Emulator for Web 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.

Name: DBCS Support in 5250 Unicode Field on SBCS Session 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 Z and I Emulator for Web 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. Possible values for this parameter include the following:

True: Display DBCS characters in 5250 Unicode fields even on a session configured with an SBCS host code page. False: Display DBCS characters in 5250 Unicode fields only on a session configured with a DBCS host code page. This is the default value.

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

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 Z and I Emulator for Web 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 Z and I Emulator for Web server uses the reports to maintain a count of connected clients. If you specify the lum value for the Disable parameter, then the Z and I Emulator for Web client does not send these reports.

Name: DisableCachingInJSSE Prameter values: true or false Default value: false Description: In an attempt to avoid multiple downloads of the truststore from the Z and I Emulator for Web server, Z and I Emulator for Web 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, Z and I Emulator for Web disables caching of the truststore in JSSE mode.

Name: Disable Z and I Emulator for Web menu bar This new enhancement to the Z and I Emulator for Web menu options enables you to disable the entire Z and I Emulator for Web menu. Use the following HTML parameter:

Name: disableMenuBar

Possible Values: true or false

Default Value: false

Set the value to

true

to remove the menu bar.

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 HCL 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.

Name:

DoNotPrefillUser html parameter

When using the configuration server-based model and logging on to Z and I Emulator for Web, 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 Z and I Emulator for Web logon panel is not prefilled. False: The Userid field in the Z and I Emulator for Web logon panel is prefilled with the client system logon userid. This is the default value.

Name:

DisableXANTorder

Value:

true or false

Description:

When this parameter is set to true, Z and I Emulator for Web 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

Name:

DoNotPrefillUser

True: The Userid field in the Z and I Emulator for Web logon panel is not prefilled.

False: The Userid field in the Z and I Emulator for Web logon panel is prefilled with the client system logon userid. This is the default value.

Name:

DownloadAdditionalCodePages

Value:

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 or IBM 1.8 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 or IBM 1.8 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 default.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 Z and I Emulator for Web 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.

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

Name: EnableLicenseCountForVM Value: true or false Description: When this parameter is set to true, Z and I Emulator for Web logs the user ID and client machine IP address in the LicenseCount log.

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.

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

Name: EnableVTFunctionKeypad Value: true or false Description: This parameter allows you to change the Z and I Emulator for Web Keypad for VT to have the F1 - F8 keys.

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.

Name: FipsMode Value: true or false Default value: true Description: FIPS mode is supported only in IBM Java. When using IBM Java, Z and I Emulator for Web enables FIPS mode by default. The FIPS function is implemented by the JRE. When this parameter is set to false, Z and I Emulator for Web does not enable FIPS mode in IBM Java. When FIPS mode is enabled, the following FIPS ciphers are set by Z and I Emulator for Web:

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

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 Z and I Emulator for Web automatically ignores these upgrade options and downloads the jar. If you have set upgrade options and want Z and I Emulator for Web to honor these options, even if a new jar is included in the preload list, you can do so using this parameter.

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.

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 does not display.

Name: HideDesktop Value: true or false Description: When this parameter is set to True, the Z and I Emulator for Web desktop will be hidden when an embedded session is launched. Default is false.

Name: IgnoreWellKnownTrustedCAs Value: true Description: This HTML parameter prevents Z and I Emulator for Web from loading the WellKnownTrustedCAs.class/.p12 file.

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

Set SessionName to the name of a session visible on the Z and I Emulator for Web 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.

Name: InactivityLogoffTime Prameter value: The time in minutes. Minimum: 1; Maximum: 120. Description: For configuration server-based model pages that prompt users to enter a Z and I Emulator for Web User ID to login, if all sessions are closed or in disconnect state, the length of time to wait before triggering automatic logoff of the session.

Name: JSSECustomCiphers Value: 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:

hi
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 Z and I Emulator for Web 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, Z and I Emulator for Web 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.

Name: LockMacroSaveLocations, RemovecurrentSessionOption

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

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.

Name: MaximumJRELevel Parameter value: A string that follows standard JRE version naming conventions described in the Oracle Java website in the Version String Naming Convention section. This is also the format returned by the java -version command entered in a Windows command prompt. Description: If this parameter is specified, Z and I Emulator for Web compares the specified level with the version of the JRE installed on the client machine. If the installed version exceeds the MaximumJRELevel parameter, Z and I Emulator for Web issues the error message:

You are running a level of Java that exceeds the value of MaximumJRELevel. Please contact your administrator, or return to a supported level.

The MaximumJRELevel parameter is set by an administrator to ensure that clients are running a level of Java supported by Z and I Emulator for Web.

The MaximumJRELevel parameter includes the update level of Sun JREs but does not include the service release or SR level of IBM JREs. This is consistent with the output of the java -version command. This means that the SR level of IBM JREs will be ignored when checking the MaximumJRELevel parameter.

This parameter can be specified for download and Web Start clients. It is only supported for custom HTMLs defined through the Deployment Wizard, not for predefined HTMLs shipped with Z and I Emulator for Web. By default, Z and I Emulator for Web does not check if the level of the client JRE exceeds the MaximumJRELevel parameter.

Clients with or without the offline feature are only downloaded and installed if the maximum JRE level is not exceeded. Once a client is installed, Z and I Emulator for Web checks whether the maximum JRE level is exceeded each time it is used.

Web Start applications are only launched if the maximum JRE level is not exceeded.

When using Z and I Emulator for Web with WebSphere Portal, clients can be configured as either download or clients in the Deployment Wizard. For both types of clients, Z and I Emulator for Web checks whether the maximum JRE level is exceeded.

Example:

MaximumJRELevel parameter is set to 1.6.0.

As you can see, the service release level of IBM JREs is ignored when comparing the client JRE version with the MaximumJRELevel parameter.

Name: MaximumJRELevel Obsolete Value: Value of PC Codepage used by the EHLLAPI application. Examples are Cp437, Cp1252, or Cp037. Description: For each Z and I Emulator for Web 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. Z and I Emulator for Web 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. For more information, refer to Supported Encodings.

Name: mergeToolbarConfigs Parameter value: true or false Default value: true Description: Setting the HTML parameter to false will disable the buttonBar merge logic for that particular ZIEWeb client. By setting it to false; however, you may need to reset the buttonBar once in the client system to see the server buttons if they do not appear. This is due to a difference between the old and the new buttonBar setting formats. Resetting the client buttonBar clears the client button settings. To do this, right-click with a mouse on buttonBar and click Set to Default.

Name: PCCodePageForEHLLAPI Value: Value of PC Codepage used by the EHLLAPI application. Examples are Cp437, Cp1252, or Cp037. Description: For each Z and I Emulator for Web 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. Z and I Emulator for Web 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 the following link for more information on Java Encoding sets, http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html

Name: PersistConnectedStatusMessage Value: true or false Description: This HTML parameter will allow the Connected status message on the Z and I Emulator for Web 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.

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 Z and I Emulator for Web 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 Z and I Emulator for Web:

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 Z and I Emulator for Web:

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 PreserveAppendEOFChar=yes. See RemoveEOFChar .

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, Z and I Emulator for Web 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, Z and I Emulator for Web 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, Z and I Emulator for Web takes the following actions:

If the APPEND option is not specified in the Receive Text options, (3270 Display Session), Z and I Emulator for Web:
- Removes x'1A' from the end of the file being downloaded.
In contrast, if the APPEND option is specified in the Receive Text options, Z and I Emulator for Web:
- 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.

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

Name: replaceTabWithSpaces Value: true or false, default is false. Description: A file transferred through FTP session, if the HTML parameter is true, the TABS are replaced with a single space. Available from v15.

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 Z and I Emulator for Web displays an error message.

Valid Save directories

Examples of valid Save directories are as follows:

Absolute paths (for example, C:\zieweb\prefs on a Windows operating system or /zieweb/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 client 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 current working directory of the user.

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/ZIEWebData/ web page name.

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.

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

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 Z and I Emulator for Web 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.

Name: setSendBufferSizeToScreenSize 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 Z and I Emulator for Web 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.

Name: SetServerMacroLibraryPath Parameter values: The URL or path of the server macro library. The value can take either of the following forms:

The fully qualified URL of a macro list file that contains the names of all the macros for use by the session, for example http://servername/zieweb/macrolist.txt. In this example, macrolist.txt is a simple text file that contains the list of macros.
The full path of a directory located on a shared drive. Use a valid format for the directory path. Follow the rules described for the Save HTML parameter in the online help. All the macro files located in the specified directory are available to the session.

Description:

You can use this parameter to specify the location of the server macro library to use for this session. If a URL or path is specified for this session in either the Deployment Wizard or Administration Utility graphical user interface, it takes priority over a URL or path specified using this HTML parameter. For more information about configuring the location of the server macro libraries, see the

Creating and deploying server macro libraries

chapter in

Planning, Installing, and Configuring Z and I Emulator for Web

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 Z and I Emulator for Web client on the Textual OIA of the session. The Textual OIA bar is opened by selecting View > Textual OIA on the Z and I Emulator for Web 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 ZIE Host Access Toolkit and Z and I Emulator for Web container environments.

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 Z and I Emulator for Web 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 Z and I Emulator for Web publish directory. All Z and I Emulator for Web 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.

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.

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.

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 HCL contact information, is displayed. A related parameter, DisableSupport, can be used to disable the Help/Support option.

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. For more information, refer to

Configuring the TraceOptions HTML Parameter

Name: UseAppData Value: true of false Description: The Administrator can configure Z and I Emulator for Web to store the client and user data in the Application Data directory of Windows clients. Normally on Windows clients, Z and I Emulator for Web puts data under the Documents and Settings\<user name>\ directory. However, if the Application Data directory support is enabled, Z and I Emulator for Web will use the Documents and Settings > user name<\Application Data\HCL\ZIEForWeb\ directory for both the client and user preferences.

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

Name: useCCSIDMinValue Vlue: true or false Description: If set to true, you can access (CCSID,*MIN) specifications. ZIEWeb 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.

Name: UseHodCDRA1399 Value: true or false Description: This parameter allows you to enable Z and I Emulator for Web to use the same conversion table as HCL Z and I Emulator for Windows when it is set as false for Japanese codepages 1390 and 1399. The default is false. See Japanese information for more information.

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 Z and I Emulator for Web

guide.

Name: UseSpeicalCharsIn3270NumericField Value: 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.

Name: UseWinLookAndFeelInPortal

Value:

true or false

Description:

This HTML parameter allows users to interact with both embedded and non-embedded Z and I Emulator for Web portlet sessions using Windows system settings for colors and fonts instead of the settings provided with WebSphere Portal. Z and I Emulator for Web 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.

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

The default value is true.

Name: WebServerHostname Value: The hostname of the Z and I Emulator for Web server that the user will connect to after installing the Z and I Emulator for Web Java 2 client from a LAN or CD. For example, if the user will attach to the file http://myZIEWebServer/zieweb/myFileA.html then the hostname is myZIEWebServer. Description: This HTML parameter prevents the user from having to type in the hostname when installing the Java 2 client from a LAN or CD. This parameter is useful only for the Java 2 client. It is not needed for the Java 1 client.

The Java 2 client stores downloaded components into different directories depending on which Z and I Emulator for Web server the components are downloaded from. When the components are copied from a LAN or CD drive rather than being downloaded from a Z and I Emulator for Web server, the Java 2 client needs to be told the hostname of the Z and I Emulator for Web server to which these components belong. If this parameter is not present, the user is prompted for the hostname of the Z and I Emulator for Web 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 Z and I Emulator for Web server. For example, if the user will access the file as http://myZIEWebServer/zieweb/myFileA.html then you should use this very same hostname myZIEWebServer for the value of this parameter. Likewise, if the user will access the file as http://myZIEWebServer.mycompany.com/zieweb/myFileA.html, then you should use this very same hostname myZIEWebServer.mycompany.com for the value of this parameter. The client code treats myZIEWebServer and myZIEWebServer.mycompany.com as different hostnames. Dotted decimal IP addresses such as 9.32.44.177 are also valid if the user will be accessing the file as http://9.32.44.177/zieweb/myFileA.html.

Name: WebStartDesktopVisible Value: Always, Never, and Control Description: The following values can be used for this parameter: Always : ZIEWebDesktop 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

Name: WindowsDomain Value: Windows Domain(s) Description: Z and I Emulator for Web 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.