docmain.css" /> Index of Attributes and Parameters - Reflection for the Web Reference Guide

3.3 Index of Attributes and Parameters

Use this index to locate detailed information about the Reflection terminal emulation applet attributes and parameters. For general information about which names and values are case sensitive, go to Case Sensitivity in Attributes and Parameters.

NOTE:Attribute values are case sensitive, all other attributes and parameters are not. The one exception is a parameter value that references a file or Java class. In that case the parameter value is case sensitive.

A-B-C | D-E-F | G-H-I | J-K-L | M-N-O | P-Q-R | S-T-U | V-W-X-Y-Z | Numbers

3.3.1 A-B-C

allowStoredMacroPassword

This parameter determines if a user can store passwords or other hidden variables. If set to true, the user can change the macro variable from Always prompt User for Value to Embed fixed user response in macro on the Save Macro dialog box after recording a macro. You must configure this parameter for each individual session you create.

NOTE:This parameter only affects the behavior of the Save Macro dialog box. If you have existing macros with passwords or hidden variables embedded in them, their behavior will not change.

This parameter does not apply to single sign-on macros or express logon macros for IBM 3270 sessions.

Value

true (Default)

false

Example

<param name="allowStoredMacroPassword" value="true">

answerback

see declans parameter

archive

This optional attribute specifies the JAR (Java Archive) file containing the applet code. The archive attribute is supported by browsers using the Java Plug-in.

When applet code is packaged into a JAR file for running in the Java Plug-in, the archive attribute is used to specify the name and location of the archive. Although the archive attribute is optional in the applet tag, all Reflection for the Web applet code is packaged into JAR files, and to run Reflection using the Java Plug-in, the archive attribute is required.

Value

Launcher.jar

Example

<applet mayscript name="IBM3270"
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300"
        archive="Launcher.jar">
</applet>

Autoconnect

This parameter specifies whether the Reflection session should connect to the host specified in the host URL parameter when the session starts. If you choose not to connect automatically, you can connect to a specified host using the Reflection menu (if it is available). For embedded emulations, it is recommended that you automatically connect to the host when you start the session.

NOTE: The recommended method for configuring most settings is to use the dialog box equivalents where available. In these cases, parameters should be restricted to static pages or scripted sessions. The equivalent setting for the autoconnect parameter is Connect at startup.

Value

true (Default)

false

Example

<param name="autoconnect" value="true">

BackgroundColor

This parameter determines the color of the background on the login and links list interface. The default background color is white.

Value

You can specify a color in one of three ways:

  • Hexadecimal - <param name="backgroundColor" value="#CCCCCC">

  • RGB (red, green, blue) - <param name="backgroundColor" value="204,204,204">

  • One of 13 named colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white, and yellow - <param name="backgroundColor" value="lightGray">

Example

In the following applet tag, the background of the login form and links list interfaces is set to pale yellow.

<applet name="Launcher" code="com/wrq/rweb/Launcher.class" archive="Launcher.jar" codebase="./ex" width="500" height="440">
<param name="backgroundColor" value="#FFFFCC">
</applet>

certAndCRLSignedBySamePrivateKey

This parameter, If set to true, instructs the certificate verification code to verify that the certificate and the CRLs (Certificate Revocation Lists) are signed by the same CA (Certificate Authority) private key. The default is false.

Certificate Authorities may use one private key to digitally sign certificates and CRLs, but CAs can also use separate private keys to digitally sign certificates and CRLs. This applies to SSL/TLS sessions only, and requires that the CRL be already present.

Value

  • true
  • false (Default)

Example

<param name="certAndCRLSignedBySamePrivateKey" value="true">

certExplicitPolicyIndicator

This parameter, when set to true, instructs the certificate verification code to verify that the first CA certificate in a certificate chain has the Certificate Explicit Policy Indicator extension set. This parameter allows you to require an explicit policy identifier for certificate path processing. This applies to SSL/TLS sessions only.

Value

  • true
  • false (Default)

Example

<param name="certExplicitPolicyIndicator" value="true">

certPolicyOIDs

This parameter specifies the initial certificate policies. It instructs the certificate verification code to verify that a certificate chain meets the policy requirement. Specify the initial policy OIDs (Object Identifiers), separated by commas. The default is empty. This applies to SSL/TLS sessions only.

Value

Any string; may be empty (Default).

Example

<param name="certPolicyOIDs" value="2.16.840.1.101.2.1.48.1,2.16.840.1.101.3.1.48.3">

Code

This required attribute specifies the name of the class file used to start the applet. The value is relative to the URL specified in the codebase attribute, or if no codebase attribute is present, to the URL of the document containing the applet. This value is case sensitive.

Value

com.wrq.rweb.Launcher.class

The code attribute must be used in conjunction with the Launcher.sessions parameter.

Example

<applet mayscript name="IBM3270" 
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300">
</applet>

Codebase

This attribute specifies the URL for the folder that contains the terminal emulation applet JAR files. The URL can be relative to the location of the HTML page or it can specify the entire path.

Value

./ex/ (Default)
<Any valid URL>

Example

Codebase specifies entire path:

<applet mayscript name="Reflection" 
        codebase="http://ReflectionWeb.example.com/connections/" 
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300">
</applet>

Codebase is relative to the location of the HTML page:

<applet mayscript name="Reflection" 
        codebase="java/" 
        code="com.wrq.rweb.Launcher.class"
        width="400" height="300">
</applet>

Configuration

This parameter specifies the URL or name of a configuration file (usually with a .config extension) created by a system administrator. For more information, go to the Overview of Configuring Reflection.

The value of the configuration parameter is treated initially as an absolute URL that points directly to the file. If the file cannot be opened, Reflection appends the value to the URL of the current document base (the location of the web page that is running the applet). If using the document base does not locate the file, then the value is appended to the codebase for the page, named in the Codebase attribute of the applet. (If no codebase is specified, the codebase is the same as the document base.)

Value

<any valid URL>

Example

<param name="configuration" value="salesdept.config">

crlIssuers

This parameter specifies the URLs of the CRLs (Certificate Revocation Lists) that are used by certificate path processing for checking the certificate revocation status of a certificate chain. The default is empty. This applies to SSL/TLS sessions only. LDAP, file, and HTTP URLs are supported.

Value

Any series of URLs separated by semicolons; may be empty (Default).

Example

  • <param name="crlIssuers" value="ldap://myCAServer.example.com/CA/certificaterevocationlist; ldap://rootCA.verisign.com/CRL">
  • <param name="crlIssuers" value="file://localhost/c:/crls/TrustAnchorCRL.crl">
  • <param name="crlIssuers" value="http://server1.example.com/CertEnroll/server1.example.com.crl">

Top of index

3.3.2 D-E-F

declans

This parameter specifies the text of an answerback message that is sent to the host in response to an ENQ character. This text is linked to the Answerback message box in the Advanced VT Terminal Items dialog box. (The name of the parameter derives from the mnemonic for the VT terminal's "Load Answerback Message" control sequence.) The declans parameter applies to VT emulations only.

Value

Any string.

Example

<param name="declans" value="Hello world.">

DestinationName

This parameter indicates the ultimate host to which the Reflection security proxy server connects. This parameter is valid only when user authorization is enabled on the proxy server; otherwise, the destination host and port are predefined by the proxy server for a given server port. The value -1 can be used to indicate that the user may specify a destination host at runtime; in this case, the DestinationName and DestinationPort parameters must both be -1.

This parameter is used in conjunction with the securityEnabled parameter, and is valid for dynamically generated or protected static sessions only. When the HTML is delivered to the user, the DestinationName and DestinationPort parameters are removed from the HTML to hide the name and port of the ultimate destination host if the user views the HTML source from the web browser.

NOTE:The recommended method for configuring most settings is to use the dialog box equivalents where available. In these cases, parameters should be restricted to static pages or scripted sessions. The equivalent setting for the DestinationName parameter is Destination host.

Value

The name of the actual destination host to which the proxy server will connect.

Example

<param name="DestinationName" value="myHost">

DestinationPort

This parameter indicates the ultimate port to which the Reflection security proxy server connects. DestinationPort is valid only when user authorization is enabled on the proxy server; otherwise, the destination host and port are predefined by the proxy server for a given server port. The value -1 can be used to indicate that the user may specify a destination port at runtime; in this case, the DestinationName and DestinationPort parameters must both be -1.

This parameter is used in conjunction with the securityEnabled parameter, and is valid for dynamically generated or protected static sessions only. When the HTML is delivered to the user, both DestinationName and DestinationPort parameters are removed from the HTML to hide the name and port of the ultimate destination host if the user views the HTML source from the web browser.

Value

The name of the actual destination port to which the proxy server will connect.

Example

<param name="DestinationPort" value="23">

deviceName

This parameter is only used with IBM terminal emulation. This parameter specifies the device name (also known as an LU--logical unit) or pool to use when the session connects to the host. If no device or pool is specified for a terminal session, the host dynamically assigns an LU to the session.

NOTE:The recommended method for configuring most settings is to use the dialog box equivalents where available. In these cases, parameters should be restricted to static pages or scripted sessions. Otherwise, use an equivalent setting for the deviceName parameter, such as Specify device name.

Value

<any valid device name>

Example

  • <param name="deviceName" value="LU12orion">
  • <param name="deviceName" value="NWpool">

disableAutoRepeat

This parameter turns off the automatic repeat feature for a specified key or keys.

Value

A whitespace-delimited string of decimal numbers that correspond to any KeyEvent names. KeyEvent names are available in the JDK's KeyEvent source. Note that values must be specified in decimal rather than hexadecimal form.

Example

The following example disables autorepeat on the Enter/Return (VK_ENTER = \n = 10) and F1 (VK_F1 = 0X70 = 112) keys.

<param name="disableAutoRepeat" value="10 112">

displayDeviceName

This parameter specifies whether or not the Reflection session frame displays the device name established with the host. The default is false. This parameter applies to IBM terminal and printer emulators (IBM 3270, IBM 5250, IBM 3287, and IBM 3812) only.

Value

  • true
  • false (Default)

Example

<param name="displayDeviceName" value="true">

emailtechsupport

This parameter redirects the Contact Technical Support command in the Help menu for the terminal session to the specified URL.

Value

  • https://www.microfocus.com/support-and-services/ (Default)
  • <any valid URL>

Example

  • <param name="emailtechsupport" value="http://support.example.com">
  • <param name="emailtechsupport" value="mailto:helpdesk@example.com">

encryptStream

This parameter directs the terminal session to use SSL/TLS datastream encryption.

Value

  • true
  • false (Default)

Example

<param name="encryptStream" value="true">

enterviewhomeid

This parameter redirects the Reflection for the Web Home Page command in the Help menu for the terminal session to the specified URL.

Values

https://www.microfocus.com/products/reflection/web/?utm_medium=301&utm_source=attachmate.com (Default)

<any valid URL>

Example

<param name="enterviewhomeid" value="http://www.example.com/Reflection.html">

errorAlarm

This parameter applies to IBM 5250 emulation and controls whether a keyboard error is accompanied by an audible beep. If this parameter is not present, keyboard errors are reported quietly.

Value

  • true
  • false (Default)

Example

<param name="errorAlarm" value="true">

forceCRLF

This parameter is valid only for VT terminal sessions. If users are having problems with the output from VT controller mode printing not properly aligning on the page, use the forceCRLF parameter to insert a carriage return (CR) and line feed (LF) when a <LF> is received in the host data intended to be printed. Inserting a <CR><LF> ensures each line of printer output starts at the left margin.

Value

  • true
  • false (default)

Example

<param name="forceCRLF" value="true">

foregroundColor

This parameter determines the color of the text on the login and links list interface. To use this parameter, add it to the applet tag inReflectionData/ReflectionClient.html.

Value

You can specify a color in one of three ways:

  • Hexadecimal - <param name="foregroundColor" value="#CCCCCC">

  • RGB (red, green, blue) - <param name="foregroundColor" value="204,204,204">

  • One of 13 named colors: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white, and yellow - <param name="foregroundColor" value="lightGray">

The default foreground color is black.

Example

In the following applet tag, the background of the login form and links list interfaces is set to pale yellow.

<applet name="Launcher" code="com/wrq/rweb/Launcher.class" archive="Launcher.jar" codebase="./ex" width="500" height="440">
<param name="foregroundColor" value="0,51,102">
</applet>

frame

The frame parameter determines whether the terminal window is shown in a separate window. When frame is set to true, the session starts in a new window and the Reflection menu is available. When frame is set to false, the Reflection menu is unavailable unless you set the shortcutMenu parameter to true.

When frame is set to true, use the framewidth and frameheight parameters to determine the size of the separate terminal window. If frame is set to true and you do not include the framewidth and frameheight parameters, Reflection determines the best frame dimensions for each user based on the user's monitor resolution.

Value

  • true
  • false (Default)

Example

<param name="frame" value="false">

frameheight

Together with framewidth, this parameter specifies the dimensions of the separate terminal window when frame is set to true. If frame is set to true and you do not include the framewidth and frameheight parameters, Reflection determines the best frame dimensions for each user based on the user's monitor resolution.

If frame is set to false, frameheight is ignored, and Reflection uses the applet height attribute to determine the height of the applet within the browser window.

Value

<height in pixels>

Example

<param name="frameheight" value="440">

framewidth

Together with frameheight, this parameter specifies the dimensions of the separate terminal window when frame is set to true. If frame is set to true and you do not include the framewidth and frameheight parameters, Reflection determines the best frame dimensions for each user based on the user's monitor resolution.

If frame is set to false, framewidth is ignored, and Reflection uses the applet height attribute to determine the height of the applet within the browser window.

Value

<width in pixels>

Example

<param name="framewidth" value="660">

FTPDestinationName

This parameter indicates the ultimate FTP server to which the Reflection security proxy server connects. This parameter is valid only when user authorization is enabled on the proxy server; otherwise, the destination host and port are predefined by the proxy server for a given server port.

This parameter is used in conjunction with the securityEnabledFTP parameter, and is valid for dynamically generated or protected static sessions only. When the HTML is delivered to the user, the FTPDestinationName and FTPDestinationPort parameters are removed from the HTML to hide the name and port of the destination FTP server if the user views the HTML source from the web browser.

Value

The name of the actual destination FTP server to which the proxy server will connect.

Example

<param name="FTPDestinationName" value="myHost">

FTPDestinationPort

This needs to be complete

Top of index

3.3.3 G-H-I

GenerateUniqueDeviceName

This parameter is valid for IBM 3270 emulator, IBM 3270 printer, IBM 5250 emulator, and IBM 5250 printer sessions. When the parameter is set to true and no device name is specified in the configuration file or the Session Setup dialog, Reflection generates a unique device name when a connection to the host is initiated. The name is based on the machine name or the user's IP address.

Value

  • true
  • false (Default)

Example

<param name="generateUniqueDeviceName" value="true">

Height

The required height attribute controls the initial height of the session applet embedded in the browser window. The height is measured in pixels. When the frame parameter is set to true, use the frameheight parameter to set the height of the separate Reflection terminal window.

Example

<applet mayscript name="IBM3270"
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300">
</applet>

Heartbeat

A periodic “heartbeat” is maintained between the applet that launches the client and the Management and Security Server to prevent the server from timing out due to inactivity. If a heartbeat between the client and server is not maintained, configuration work can be lost when the inactivity timer expires.

To prevent the loss of work when undergoing lengthy configurations, such as keyboard mappings or macros, you can modify the heartbeat services that affect session management and the links list.

NOTE: If you use SiteMinder (or something similar) to control access to terminal sessions, see Using Crumb Mode (below) to set a heartbeat.

Management and Security Server heartbeat

When you are configuring Reflection for the Web sessions in Management and Security Server, a heartbeat is automatically sent to the server every 3 minutes to keep the Administrative Server from timing out. To change this default or to modify other heartbeat behavior, you can add parameters on the Configure Session panel.

  1. Open launchsession.jsp, located here with a default installation:C:\Program Files\Micro Focus\MSS\server\web\webapps\mss\aws\smt\launchsession.jsp

  2. In launchsession.jsp, locate the section that begins with <rweb:applet code="com.wrq.rweb.Launcher">.

  3. Add the parameters you want to set. See the available Heartbeat parameters, described below.

    For example, to change the heartbeat interval from 3 minutes to 5 minutes, add the following parameter:<rweb:param name="HeartbeatInterval" value="5"/>

NOTE:Edits to launchsession.jsp may be overwritten when you upgrade Reflection for the Web or Management and Security Server.

Links list heartbeat

The list of links does not, by default, maintain a heartbeat with the server. Users are automatically logged out of the Management and Security Server after 60 minutes if they are not actively using the links list.

To enable a heartbeat for the links list, you must modify the source of the login page. It is recommended that you work in a custom login page to avoid having your modifications overwritten by product upgrades.

  1. Create a custom login page, as described in Technical Note 2386.

  2. In your custom login page, locate the section that begins with <mss:applet userequest="true"/>.

  3. Add the heartbeat parameters you would like to set.

Heartbeat parameters

You can add these parameters to the Management and Security Server applet and/or the links list applet to modify the default heartbeat behavior. Use the basic syntax:<mss:param name="name" value="value"/>.

  • enableHeartbeat – Enables the heartbeat. The default for Session Manager is true. The default for the links list is false.

  • adminHeartbeatOnly – Enables the heartbeat only for a user logged in as the administrator. Applies only to the links list and only when “enableHeartbeat” is true. The default is false (links list heartbeat will apply to both users and administrators).

  • heartbeatInterval - Specifies the interval between heartbeats, in minutes. The default is 3 minutes, the minimum is 1 minute, and the maximum is 720 minutes (12 hours).

  • heartbeatMax – Specifies the maximum lifetime of the heartbeat, in minutes. The default is 0, which lets the heartbeat run indefinitely. The maximum is 720 minutes (12 hours).

  • heartbeatRetry – Specifies the maximum number of consecutive failed heartbeats before the heartbeat is stopped permanently. The default is 5, the minimum is 1, and the maximum is 100.

  • heartbeatCrumbMode – Indicates whether to use “servlet request mode” or “crumb mode” for heartbeat operations. The default is false, and the heartbeat operates in “servlet request mode”. If set to true, an additional parameter, “heartbeatCrumbFilename”, can be set to specify the name of the “crumb” file if the default filename of “crumb.txt” is not desired. See Using Crumb Mode.

Using Crumb mode

If you use SiteMinder (or something similar) to control access to terminal sessions, you can set the heartbeat to operate in “crumb mode” instead of the default “servlet request mode”. In servlet request mode, the emulator client makes a request to the servlet to maintain activity. In crumb mode, heartbeat requests are sent to fetch a crumb of data from the codebase directory on the Management and Security Server.

The crumb of data is simply a text file called crumb.txt, and the file contents must be only the string ok. You must create the crumb file manually and place it in the applet codebase directory. In a default installation, locate the directory here:C:\Program Files\Micro Focus\MSS\server\web\webapps\mss\ex

Access management products, such as SiteMinder, record the heartbeat crumb request as activity to prevent session timeouts, whereas they may not record activity generated by heartbeats in servlet request mode. Crumb mode does not maintain Management and Security Server activity.

Two parameters control crumb mode: heartbeatCrumbMode and heartbeatCrumbFilename, described above. The following example shows how crumb mode may be enabled in the links list and configured to use an alternate crumb file:

<mss:applet userequest="true">
   <mss:param name="heartbeatCrumbMode"value="true"/>
   <mss:param name="heartbeatCrumbFilename"value="mycrumb.txt"/>
</mss:applet>

helpbase

This parameter specifies the path to the starting folder of the Reflection online help for the terminal session. The value should be formatted as a URL. If this parameter is not specified, Reflection uses the URL specified in the Codebase applet attribute to find the starting folder

If a relative URL is specified, Reflection starts searching for the page from the Ex folder in the terminal emulation component. By default, Reflection looks in the Help folder (considered the starting folder), installed at the same level as the Ex folder.

Value

http://<terminal emulation component installation>/ (Default) <any valid URL>

Example

<param name="helpbase"
       value="http://Reflection.example.com/RWebHelp/">

hostURL

This parameter can be used to specify three values: transport, host, and port. These values are named using the following syntax: transport://host:port.

You can define all or part of the hostURL. If you omit the host name, a dialog box prompts for a host when the session starts; if you omit the port or transport, Reflection automatically includes default values. The default value for the transport is determined by the transport parameter if one is specified. Otherwise, the transport and the port are both selected from Reflection program defaults. If you know which transport or port you need, however, it is recommended that you specify them in this parameter instead of depending on the defaults.

NOTE:The recommended method for configuring most settings is to use the dialog box equivalents where available. In these cases, parameters should be restricted to static pages or scripted sessions. The equivalent setting for the hostURL parameter is Host.

Values

Host

Values

IBM 3270

<host name or IP address> 
<host name or IP address>:<port> 
tn3270://
tn3270://<host name or IP address>
tn3270://:<port>
tn3270://<host name or IP address>:<port>
tn3270e://
tn3270e://<host name or IP address>
tn3270e://:<port>
tn3270e://<host name or IP address>:<port> 
demo://ibm3270

IBM 3270 Printer

The default port number for the tn3270e transport is 23. The port may be different for your organization. To change the default, specify the port number in this parameter.

<host name or IP address> 
<host name or IP address>:<port> 
tn3270e://
tn3270e://<host name or IP address>
tn3270e://:<port>
tn3270e://<host name or IP address>:<port>

IBM 5250

<host name or IP address> 
<host name or IP address>:<port> 
tn5250://
tn5250://<host name or IP address>
tn5250://:<port>
tn5250://<host name or IP address>:<port> 
demo://ibm5250

IBM AS/400 Printer

<host name or IP address> 
<host name or IP address>:<port> 
tn5250://
tn5250://<host name or IP address>
tn5250://:<port>
tn5250://<host name or IP address>:<port>

IBM AS/400 Data Transfer

The transport and port values are not used for IBM AS/400 data transfer; only the host name or IP address is used.

<host name or IP address>

HP

<host name or IP address> 
<host name or IP address>:<port>
nsvt://
nsvt://<host name or IP address> 
nsvt://:<port> 
nsvt://<host name or IP address>:<port> 
telnet://
telnet://<host name or IP address>
telnet://:<port>
telnet://<host name or IP address>:<port> 
demo://HP3000
demo://UNIX

VT

<host name or IP address> 
<host name or IP address>:<port>
telnet://
telnet://<host name or IP address>
telnet://:<port>
telnet://<host name or IP address>:<port> 
demo://digital
demo://UNIX

UTS

<host name or IP address> 
<host name or IP address>:<port>
int1://
int1://<host name or IP address>
int1://<port>
int1://<host name or IP address>:<port> 
airgate://
airgate://<host name or IP address>
airgate://<port>
airgate://<host name or IP address>:<port> 
matip://
matip://<host name or IP address>
matip://<port>
matip://<host name or IP address>:<port> 
pepgate://
pepgate://<host name or IP address>
pepgate://<port>
pepgate://<host name or IP address>:<port> 

T27 and T27 Printer

<host name or IP address> 
<host name or IP address>:<port>
tcpa://
tcpa://<host name or IP address>
tcpa://<port>
tcpa://<host name or IP address>:<port>

ALC

<host name or IP address> 
<host name or IP address>:<port>
lantern://
lantern://<host name or IP address>
lantern://<port>
lantern://<host name or IP address>:<port> 
airgate://
airgate://<host name or IP address>
airgate://<port>
airgate://<host name or IP address>:<port> 
matip://
matip://<host name or IP address>
matip://<port>
matip://<host name or IP address>:<port> 
atstcp://
atstcp://<host name or IP address>
atstcp://<port>
atstcp://<host name or IP address>:<port> 
sabre://
sabre://<host name or IP address>
sabre://<port>
sabre://<host name or IP address>:<port> 
tcpfrad://<hostname>:<port>
tcpfrad://<host name or IP address>:<port> 
udpfrad://
udpfrad://<host name or IP address>
udpfrad://<port>
udpfrad://<host name or IP address>:<port>

Example

The transport, host, and port are all specified: <param name="hostURL" value="tn3270://jupiter:23">

Only the host is specified, and the default transport and port are used:<param name="hostURL" value="jupiter">

The transport and host are specified, and the default port is used: <param name="hostURL" value="tn3270://jupiter">

The host and port are specified, and the default transport is used. <param name="hostURL" value="jupiter:23">

hphelptoc

This parameter redirects the Help Topics command in the Help menu for HP terminal sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/hphelp.html (Default)<any valid URL>

Example

<param name="hphelptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/hphelp.html">

httpsProxy

Use this parameter to specify the port and name or IP address of a secure HTTP proxy to use while running encrypted Reflection sessions. The secure HTTP proxy specified in this parameter overrides any secure HTTP proxies that are set in the browser's properties.

You can use the httpsProxy parameter in combination with the proxyExcept parameter to bypass authentication schemes on HTTP proxies that are not supported in Reflection. The httpsProxy parameter overrides the browser settings and then the proxyExcept parameter overrides the setting for Reflection sessions. The Reflection session--encrypted using the Reflection security proxy server--can then pass directly through the firewall (an opening must be made in the firewall).

When the httpsProxy parameter is used without the proxyExcept parameter, it can be used to direct all incoming Reflection sessions to one specific secure HTTP server.

HINT:In general, this parameter is unnecessary. It should be used only when Reflection for the Web cannot automatically detect the secure HTTP proxy.

Values

Any valid secure HTTP proxy address in the following format:address:port

Example

<param name="httpsProxy" value="myHTTPSProxy:443">

ibm3270helptoc

This parameter redirects the Help Topics command in the Help menu for IBM 3270 terminal sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/ibm3270help.html (Default)<any valid URL>

Example

<param name="ibm3270helptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/ibm3270help.html">

ibm3287helptoc

This parameter redirects the Help Topics command in the Help menu for IBM 3270 Printer sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/ibm3287help.html (Default)<any valid URL>

Example

<param name="ibm3287helptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/ibm3287help.html">

ibm3812helptoc

This parameter redirects the Help Topics command in the Help menu for IBM AS/400 Printer sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/ibm3812help.html (Default)<any valid URL>

Example

<param name="ibm3812helptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/ibm3812help.html">

ibm5250helptoc

This parameter redirects the Help Topics command in the Help menu for IBM 5250 terminal sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/ibm5250help.html (Default)<any valid URL>

Example

<param name="ibm5250helptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/ibm5250help.html">

ibmxfrhelptoc parameter

This parameter redirects the Help Topics command in the Help menu for IBM AS/400 data transfer sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/ibmxfrhelp.html (Default)<any valid URL>

Example

<param name="ibmxfrhelptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/ibmxfrhelp.html">

ignoreASCIIData

This parameter is used in IBM 5250 emulation and IBM AS/400 printer emulation. The parameter directs the emulator to ignore any ASCII data records that may precede the first valid block-mode data (5250 data stream commands) received after connecting. By default, when the parameter is set to false, such ASCII data will result in an error message. When set to true, such ASCII data will not result in an error.

Value

  • true
  • false (Default)

Example

<param name="ignoreASCIIData" value="false">

ignoreHostPrintRequest

This parameter specifies whether host-initiated print requests in a 3270 terminal session are ignored. The default is true. This parameter applies to 3270 sessions only.

Value

  • true (Default)
  • false

Example

<param name="ignoreHostPrintRequest" value="true">

indAutoPositionCursor

This parameter controls whether Reflection enters IND$FILE commands into the last unprotected field on the screen. If true (the default), Reflection sends a HOME and a BACKTAB key to move the cursor to the last unprotected field before issuing the IND$FILE command.

Value

  • true (Default)
  • false

Example

<param name="indAutoPositionCursor" value="true">
<param name="indAutoPositionCursor" value="false">

int1InsertPads parameter

This parameter is used with UTS emulation sessions only. If Insert Pads is set to true, a Pad code is inserted into the INT1 transmit buffer before sending if the buffer is not completely filled. The value of the Pad code is 0x9F.

Value

  • false (Default)
  • true

Example

<param name="int1InsertPads" value="true">
<param name="int1InsertPads" value="false">

Top of index

3.3.4 J-K-L

jceprovider

This parameter specifies an alternative JCE provider for an SSH session. Use this parameter if you have a VT session that runs over a FIPS certified SSH connection. In this case, use the value "JsafeJCE" to invoke the RSA Jsafe crypto module. This value is case sensitive. If the JsafeJCE provider is successfully loaded, information in the Java console will indicate whether the module was loaded and if it is in FIPS-140 mode. If you do not use the correct case, the module will still load, but the client won't be able to connect, and you'll see this exception in the java console: kSecurityFactoryNoSuchProvider?com.wrq.fipsmodule.resources.Resources

Value

A valid JCE provider name. The default, "", uses JCRYPTO.

Example

<param name="jceProvider" value="JsafeJCE">

launcher.keepalive

This parameter determines the behavior of the session applet when the user browses away from the page that launched the applet.

NOTE:The browse-away behavior of sessions accessed from the Reflection links list and that launch in their own window is controlled by the launcher.keepalive parameter for the links list applet itself, so changing the value of this parameter in the Administrative Console session management panel will not have any effect on these sessions. The launcher.keepalive parameter can be set for embedded sessions, which use a new launcher applet for each session.

If the value of launcher.keepalive is framed (the default when you are not using a portal for authentication), sessions that launch in their own window remain open when the user browses away from applet page. Embedded sessions are closed.

If the value is all, both embedded sessions and sessions launched in their own windows, remain active when the user browses away from the applet page or closes the browser window containing the applet (unless the window closed is the only browser window remaining, in which case the session is closed). Users can navigate back to the session and resume work.

A value of portal (the default when you are using a portal for authentication) results in the same behavior as all, with additional optimizations for a portal environment.

To close both embedded sessions and sessions launched in their own window when the user browses away from the applet page, set the launcher.keepalive parameter to none, and also set the parameter legacy_lifecycle to false. The legacy_lifecycle parameter is processed by both Reflection and the Java plug-in itself, and a value of false will allow the plug-in to terminate the applet upon browse-away

CAUTION:When launcher.keepalive is set to all or portal, embedded sessions remain active even after the user browses away from a session page. If the user does not log out of the session, an unauthorized user with access to the authorized user's computer could gain access to the session by clicking a session link or using the browser's Back function.

Value

  • framed (default for non-portal sessions)
  • none
  • all
  • portal (default for portal sessions

Example

<param name="launcher.keepalive" value="none">

launcher.sessions

This parameter launches a session of the type specified. This parameter is case-sensitive.

  • HP
  • IBM3270
  • IBM3287 (for IBM 3270 printer sessions)
  • IBM5250
  • IBM3812 (for IBM 5250 printer sessions)
  • IBM5250Xfer (for AS/400 data transfer sessions)
  • VT
  • UTS
  • T27
  • T27 Printer (for T27 printer sessions)
  • ALC
  • ePrint

Example

<param name="launcher.sessions" value="IBM3270">

launcher.splash

This parameter determines whether the Reflection splash screen is displayed while Reflection is loading. The splash screen includes a progress indicator, so the loading progress is not displayed when the splash screen is suppressed.

NOTE: If your session appears in its own window and users will access it via the Reflection links list, changing the value of launcher.splash in session management will appear to have no effect. Such sessions use the same launcher applet as the links list; because this applet has already loaded, the parameter is not applied when the session opens. You can set Launcher parameters for embedded sessions, which use a new launcher applet. To specify an embedded session, choose Display session embedded in a web browser window under Appearance in the session management panel of the Administrative Console.

Value

  • true (default)
  • false

Example

<param name="launcher.splash" value="true">

loadJavaClassName

This parameter specifies the name of a Java "attachment class" to insert into the Load Java Class dialog box when it first opens. This lets you provide a default Java attachment class, without requiring users to remember the class name.

Java attachment classes are a feature of the Reflection Emulator Class Library (ECL) that allow Java code to attach to the currently running terminal session and perform automated tasks. If you write your own Java attachment class, it must be packaged into a user archive file, and the userArchive parameter must be used to specify the name of the archive file. If you use an attachment class built into Reflection, you do not need to add the userArchive parameter when specifying a startup Java class. Java attachment classes must implement the interface ECLAppletInterface.

Value

<a fully qualified Java class name>

Example

<param name="loadJavaClassName" value="com.mycorp.reflection.MyAutomatedTask">

loadUserPrefs

This parameter determines whether user preferences are loaded when a user starts a Reflection session and a preferences file exists for that session. There is more information about user preferences in the Management and Security Server documentation, Configuring Reflection: User Preferences.

Value

  • true (default)
  • false

Example

<param name="loadUserPrefs" value="true">

Top of index

3.3.5 M-N-O

macroTimeout

This parameter specifies the number of seconds that a macro waits for the next screen during playback. If the timeout elapses without the screen being received, the macro stops and an error message displays. You can also set this value in the Macro Playback dialog box. You may need to increase the timeout if your host is slow to respond.

Value

10 Default, in seconds 1-9999

Example

<param name="macroTimeout" value="20">

mayscript

This attribute allows a Java applet to access JavaScript. If an applet attempts to access JavaScript when the mayscript attribute is not specified, the browser generates an exception (for example, netscape.javascript.JSException: MAYSCRIPT is not enabled for this applet).

Themayscript attribute does not take a value such as true or false.

Example

<applet name="IBM3270"
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300"
        mayscript>
</applet>

meteringContext

This parameter specifies the web application context for the metering server. This is used in the URL that accesses the metering server, and is specified when the metering component is installed. The default, rwebmeter, is the correct value if you used the automated installer and have only one metering server.

The usage metering component monitors and logs connection information and queries. For more information, see Overview of Usage Metering in the Management and Security Server documentation.

Value

  • rwebmeter (Default)
  • <descriptive string>

Example

<param name="meteringContext" value="rwebmeter">

meteringEnabled

This parameter determines whether usage metering is enabled for Reflection sessions. The usage metering component monitors and logs connection information and queries. For more information, go to Overview of Usage Metering.

When this parameter is set to true, you must specify the host on which the metering servlet resides, using the meteringHost parameter.

Value

  • true
  • false (default)

Example

<param name="meteringEnabled" value="false">

meteringFTPenabled

This parameter determines whether usage metering is enabled for FTP connections. The usage metering component monitors and logs connection information and queries. For more information, go to Overview of Usage Metering.

When this parameter is set to true, the FTP connection is monitored. (However the meteringFTPenabled parameter is always ignored when meteringEnabled is set to false.)

Note that a metered FTP session does not use a second license in addition to the terminal session--licensing is based upon the number of computers connecting, not the number of connections made. However, when meteringFTPenabled is set to true, the FTP connection counts as an additional session, which is monitored when the perUserLimit parameter is enabled in the metering servlet.

Value

  • true (default)
  • false

Example

<param name="meteringFTPenabled" value="false">

meteringHost

This parameter identifies the host on which the metering servlet resides. You can use a full host name or its full Internet Protocol (IP) address. The usage metering functionality monitors and logs connection information and queries. For more information, go to Overview of Usage Metering.

Value

  • <host name>
  • <IP address>

Example

<param name="meteringHost" value="myServer.example.com">

meteringHostRequired

This parameter specifies whether host connections can be made when the metering servlet is unresponsive for any reason. Setting this parameter to true prevents all host connections when the metering servlet is unavailable.

When this parameter is set to true, you must specify the host on which the metering servlet resides, using the meteringHost parameter. The usage metering functionality monitors and logs connection information and queries. For more information, go to Overview of Usage Metering.

Value

  • true
  • false (default)

Example

<param name="meteringHostRequired" value="false">

meteringPort

This parameter specifies the port on which the metering servlet resides. The default is 80. The usage metering functionality monitors and logs connection information and queries. For more information, go to Overview of Usage Metering.

Value

  • 80 (Default)
  • <any valid port number>

Example

<param name="meteringPort" value="80">

meteringProtocol

This parameter specifies whether the metering server uses the HTTP or HTTPS protocol for connections to the client. The usage metering component monitors and logs connection information and queries. For more information, go to Overview of Usage Metering.

When the parameter is set to true, the HTTPS protocol is used; when it is set to false, HTTP is used. The HTTPS protocol provides SSL/TLS encryption and is consequently more secure, but requires that the servlet runner be SSL/TLS-enabled. If you used an automated installer and installed the default servlet runner, SSL/TLS is enabled with a self-signed certificate.

Value

  • true (use HTTPS)
  • false (use HTTPS, default)

Example

<param name="meteringProtocol" value="true">

model

This parameter specifies the terminal model for the session. To use this parameter, enter only values that are compatible with the type of applet specified in the applet tag. If you do not use this parameter to specify a model, the default model for the applet is used.

Value

Host type

Value

IBM3270

(E means Enhanced)

  • 2E (default)
  • 3E
  • 4E
  • 5E
  • 2
  • 3
  • 4
  • 5

IBM3270 printer

3287

IBM5250

  • 3179-2 (Default)
  • 3180-2
  • 3196-A1
  • 3477-FC
  • 3477-FG
  • 3486-BA
  • 3487-HA
  • 3487-HC
  • 5251-11
  • 5291-2

IBM AS/400 printer

3812-1

IBM AS/400 data transfer

The model parameter is not used for AS/400 data transfer.

HP

  • 2392A
  • 70092 (Default--includes 70096)
  • 70094 (Includes 70098)

VT

  • VT52
  • VT102
  • VT400-7 (Default)
  • VT400-8

UTS

  • UTS20
  • UTS40
  • UTS60 (Default)

T27

  • UNISYS-TD830
  • UNISYS-TD830-ASCII
  • UNISYS-TD830-INTL
  • UNISYS-TD830-NDL (Default)

T27 printer

The model parameter is not used for T27 printer.

ALC

The model parameter is not used for ALC.

Example

<param name="model" value="2E">

name

This optional attribute specifies the name of the applet. The applet name is used by other programs and applets to reference and communicate with the applet. It is important that you assign each applet a unique name if you are running multiple applets on a page, enabling user preferences, or using the Reflection API.

Also, the value for the name attribute is displayed in the title bar of the session when the applet session is running in a separate window (the frame parameter is set to true) and the title parameter is not specified.

Example

<applet mayscript name="IBM3270" 
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300">
</applet>

onExitJavaClass

This parameter specifies a Java "attachment class" to run when you select the Exit command in the File menu, you click the session's close box, or you invoke the API exit() method. iThe attachment class can then perform any "clean-up" tasks it needs to before the session is exited.

Java attachment classes are a feature of the Reflection Emulator Class Library (ECL) that allow Java code to attach to the currently running terminal session and perform automated tasks. If you write your own Java attachment class, it must be packaged into a user archive file, and the userArchive parameter must be used to specify the name of the archive file. If you use an attachment class built into Reflection, you do not need to add the userArchive parameter when specifying a startup Java class. Java attachment classes must implement the interface ECLAppletInterface.

Value

<a fully qualified Java class name>

Example

  • <param name="onExitJavaClass" value="com.mycorp.reflection.MyCleanUpClass">
  • <param name="onExitJavaClass" value="com.wrq.eNetwork.ECL.modules.PreventSessionClose">

NOTE:The <param name="onExitJavaClass" value="com.wrq.eNetwork.ECL.modules.PreventSessionClose"> parameter/value combination helps to prevent a user from closing down their session prior to disconnecting. This parameter/value combo should be used only with sessions that are in their own frame.

onStartupJavaClass parameter

This parameter specifies a Java "attachment class" to load immediately after the Reflection terminal session is done loading.

Java attachment classes are a feature of the Reflection Emulator Class Library (ECL) that allow Java code to attach to the currently running terminal session and perform automated tasks. If you write your own Java attachment class, it must be packaged into a user archive file, and the userArchive parameter must be used to specify the name of the archive file. If you use an attachment class built into Reflection, you do not need to add the userArchive parameter when specifying a startup Java class. Java attachment classes must implement the interface ECLAppletInterface.

Value

<a fully qualified Java class name>

Example

  • <param name="onStartupJavaClass" value="com.mycorp.reflection.MyAttachmentClass">
  • <param name="onStartupJavaClass" value="com.wrq.eNetwork.ECL.modules.JSEventNotifier">

Top of index

3.3.6 P-Q-R

pasteDelay

If users are having problems pasting multiple lines into host applications, use the pasteDelay parameter to increase the number of milliseconds the emulator waits between each line sent to the host. This parameter is valid for HP and VT terminal sessions only.

Value

350 (Default--in milliseconds)<any whole number, including 0>

Example

<param name="pasteDelay" value="350">

preloadJSAPI

This parameter enables the use of JavaScript with the Java plug-in. Setting this parameter to true causes the Reflection session to preload a minimal set of code needed by the Reflection API for executing JavaScript commands when running with the plug-in.

Value

  • true
  • false (default)

Example

<param name="preloadJSAPI" value="true">

printerColumnsTiedToDisplay

This parameter applies to HP and VT sessions only.

When printerColumnsTiedToDisplay is true (the default value), the number of columns in a printout changes to match the number of columns in the display. The display columns can be read from a configuration file or user preferences file when the session loads, set in the Terminal Setup dialog box, or set by a host application using an escape sequence. If the display column setting changes during a session and you want to retain the original printer column setting, you must open the Print Setup dialog and reset printer columns.

When printerColumnsTiedToDisplay is false, the number of printer columns is always taken from the printer column setting and changing the display columns does not affect the printer columns.

Value

  • true (default)
  • false

Example

<param name="printerColumnsTiedToDisplay" value="false">

printerPassthroughStripFF parameter

This parameter strips trailing form feed characters from T27 Printer data when using pass-through printing mode. When false, the form-feed characters are sent to the printer device.

Value

  • true (default)
  • false

Example

<param name="printerPassthroughStripFF" value="False">

promptForDeviceName

This parameter specifies whether a printer session will prompt the user for a device name when a connection is requested. Because the normal behavior of printer sessions varies, the results of setting this parameter are also slightly different depending on the type of printer session involved.

In an IBM 3270 Printer session, the normal behavior is to prompt the user for a device name (promptForDeviceName is true). If you set promptForDeviceName to false, you must either save the device name in the configuration or user preference file or provide some other method for the host to locate a printer device

In an IBM AS/400 Printer session, normal behavior is not to prompt for a device name (promptForDeviceName is false) but to cycle through all printer devices to find one that is available. If the parameter is set to true, the session prompts the user for a device name.

Value

  • true (default for IBM 3270 printer session)
  • false (default for IBM AS/400 printer session)

Example

<param name="promptForDeviceName" value="true">

proxyExcept

Use this parameter to specify the IP addresses or host names of machines that should not use the specified secure HTTP proxy to connect. (The secure HTTP proxy is specified with the httpsProxy parameter and is valid only for secure Reflection sessions.) If a secure HTTP proxy is not specified, this parameter is ignored.

The httpsProxy parameter can be used in combination with the proxyExcept parameter to bypass authentication schemes on HTTP proxies that are not supported in Reflection. The httpsProxy parameter overrides the browser settings and then the proxyExcept parameter overrides the setting for Reflection sessions. The Reflection session--encrypted using the Reflection security proxy server--can then pass directly through the firewall, once an opening is available.

Value

<any valid host name or IP address>

<param name="proxyExcept" value="machine1, machine2, machine3">

renegotiateEcho

This parameter enables the renegotiation of an echo. Passwords are not displayed on the local screen, but all other typed text is visible. Reflection supports the Telnet Suppress Local Echo (SLE) option when connected to a host in half-duplex mode. This means that Reflection will suppress character echo to the host computer, and with SLE support Reflection can be instructed to suppress echo locally. This parameter applies to HP with Telnet and VT emulations only.

Value

  • true
  • false (default)

Example

<param name="renegotiateEcho" value="true">

retryWithoutHTTPProxy parameter

This parameter configures secure connections that go through an HTTP proxy using an unrecognized authentication method to make a second connection attempt that bypasses the proxy. Reflection understands only Basic authentication; this parameter may be useful in situations where NTLM is being used but the HTTP proxy isn't necessary for the connection.

Value

  • true
  • false (default)

Example

<param name="retryWithoutHTTPProxy" value="true">

Top of index

3.3.7 S-T-U

secureDestHost

This parameter has been replaced by the DestinationName parameter.

secureDestPort

This parameter has been replaced by the DestinationPortparameter.

securityEnabled

This parameter directs the terminal session to make a secure connection to the Reflection security proxy server and port specified by the hostURL parameter (or configuration file setting).

If client authorization is enabled on the proxy server, the destination host and port can be specified using the DestinationNameand DestinationPort parameters. If client authorization is not enabled on the proxy, the ultimate destination host and port are defined by the proxy server.

If you set securityEnabled to true, you must also set encryptStreamto true.

Value

  • true
  • false (default)

Example

<param name="securityEnabled" value="true">

securityEnabledFTP

This parameter directs the FTP session to make a connection through the Reflection security proxy. If client authorization is enabled on the proxy server, the destination host and port can be specified using the FTPDestinationName and FTPDestinationPort parameters. If client authorization is not enabled on the proxy, the ultimate destination host and port are defined by the proxy server.

Value

  • true
  • false (default)

Example

<param name="securityEnabledFTP" value="true">

serverIdentityOverride

This parameter overrides the global setting Enable server identify verification for SSL/TLS connections. This option is located in the Administrative Console under Set Security Options.

If you need to have the server identity check turned on for most sessions, you can override this setting for a particular session. For example, you may wish to turn off server identity verification if an SSL/TLS direct to host connection tunnels through the security proxy and the host's certificate doesn't list the proxy as a subject alternate name.

Value

  • default (Use the global setting)
  • true (Perform a server identity check regardless of the global setting)
  • false (Do not perform a server identity check regardless of the global setting)

Example

<param name="serverIdentityOverride" value="true">

sessionInactivityTimeout

This parameter specifies the time, in seconds, of datacomm inactivity that can elapse before the session is disconnected. Inactivity is triggered by absence of data being sent to or read from the host. If associated with a block mode application, the data may not be sent to the host until the Enter key is pressed.

Value

<any integer>

Example

<param name="sessionInactivityTimeout" value="15">

sftpSendEnvironment

This parameter specifies a comma-delimited list of name-value pairs (environment variables) to send to the SSH server when an SFTP session is connected.

Value

A comma-delimited string of SSH environment variables, with each variable specified as "<name>=<value>". If a name or value itself contains an equal sign or comma, escape the equal sign or comma by preceding it with a backslash. For example, "COMPANY=EXAMPLE\, INC."

Example

<param name="sftpSendEnvironment" value="TERM=3270,ID=8000">

shortcutMenu

This parameter determines whether the shortcut menu functionality is enabled in the terminal window. When shortcutMenu is set to true, the menu is displayed when a user clicks the context mouse button.

Value

  • true (default)
  • false

<param name="shortcutMenu" value="false">

showHostURL

This parameter determines whether the host URL appears in the status line at the bottom of the terminal display. Any value other than true prevents the URL from appearing.

Value

  • true (default)
  • false

Example

<param name="showHostURL" value="false">

showPrintDestination

This parameter controls whether the printer or print to file destination that is configured for a session is displayed in the status bar. Any value other than "true" will prevent the print destination from appearing in the status line.

Value

  • true
  • false (default)

Example

<param name="showPrintDestination" value="true">

showStatusLine

This parameter controls whether the status line is presented. The status line appears at the bottom of the window display and includes information such as the cursor position, whether the connection is encrypted, and the type and status of the connection.

This parameter can be set for static sessions only. For dynamic sessions, use the Display status bar setting on the Manage Settings panel in the Administrative Console when creating or modifying a session.

Value

  • true (default)
  • false

Example

<param name="showStatusLine" value="true">

SOCKSProxy

This parameter identifies a SOCKS proxy host with which terminal emulation connections are to be negotiated. The port value is optional and the default is 1080.

Value

<host> [:<port>]

Example

<param name="SOCKSProxy" value="myHost:1080">

SOCKSProxyUserID

This parameter provides a user ID value to be used with SOCKSProxy. If unspecified (as opposed to empty) then a default ID of the system property user.name is used.

Value

Any string; may be empty.

Example

<param name="SOCKSProxyUserID" value="johndoe556">

splash parameter

This parameter determines whether the Reflection splash screen is displayed while Reflection is loading. The splash screen includes a progress indicator, so if the splash screen is not displayed, the progress indicator is not visible.

Value

  • true (default)
  • false

Example

<param name="splash" value="true">

sshSendEnvironment

This parameter specifies a comma-delimited list of name-value pairs (environment variables) to send to the SSH server when the SSH session is connected.

Value

A comma-delimited string of SSH environment variables, with each variable specified as <name>=<value>. If a name or value itself contains an equal sign or comma, escape the equal sign or comma by preceding it with a backslash. For example, "COMPANY=EXAMPLE\, INC."

<param name="sshSendEnvironment" value="TERM=3270,ID=8000">

sslAES256

This parameter specifies whether the emulator includes or excludes AES 256-bit cipher suites when negotiating a secure connection to a host. During the negotiation, the emulator tries to use the highest level of encryption that is supported on the host, but if the host supports 256-bit encryption and the necessary policy files are not installed on the client, the connection fails. Set this parameter to false to exclude AES 256-bit from the list of cipher suites available during the SSL/TLS negotiation. AES 256-bit cipher suites are included in the SSL/TLS negotiation if this parameter is set to true or if this parameter is not used.

If the host supports 256-bit AES encryption and a 256-bit cipher suite is included on the available list on the client, you must download the Unlimited Strength Jurisdiction Policy Files. If you choose not to install the policy files, you can exclude AES 256-bit from the client list of cipher suites using this parameter.

Value

  • true (default)
  • false

Example

<param name="sslAES256" value="true">

sslAllowInnerNullCipher

This parameter applies to the inner SSL/TLS connection in an end to end encryption through the server proxy connection. End to end encryption involves two SSL/TLS handshakes. If the host's SSL/TLS server requires a null cipher, configure this applet parameter. If set to true, TLS_RSA_WITH_NULL_SHA is added to the supported cipher suite list along with the default cipher suite.

Value

  • true (default)
  • false

Example

<param name="sslAllowInnerNullCipher" value="true">

terminalBorder

This parameter determines whether a border is drawn around the terminal display. When the parameter is set to true, a border is drawn around the terminal display in the browser. When the parameter is set to false, no border is drawn, and the terminal display fills the area specified by the height and width attributes.

Value

  • true (default)
  • false

Example

<param name="terminalBorder" value="true">

terminalIDResponse

This parameter determines Reflection's response to a terminal ID status request from an HP host computer. This setting does not affect how Reflection for the Web operates, but it may change the way a host program works: some applications require a given Terminal ID response. Normally, you should use the default response.

The terminalIDResponse value changes automatically when you change the Terminal type (Setup > Terminal > Emulation).

Value

<HP terminal ID; a string of five or fewer characters>

Example

<param name="terminalIDResponse" value="70092">

title

Use this parameter to determine the value in the window title bar when a Reflection session runs in a separate window. If a title parameter is not specified, Reflection uses the value for the applet name attribute in the window title bar instead. The title parameter is ignored when the frame parameter is set to false.

Value

<any phrase>

Example

<param name="title" value="Reflection for IBM 3270">

tn3270eConnectType

This parameter is valid for IBM 3270 printer sessions only. The tn3270eConnectType parameter specifies whether the session connects directly or whether it uses TN association to locate a printer device. For detailed information about setting up TN association using applet parameters, see tnAssociation.

Value

  • 0 - Associate--the LU name to which users are connecting is the name of a particular printer device

  • 1 (Default) - Connect--connect to a printer associated with a specific terminal LU name

Example

<param name="tn3270eConnectType" value="0">

tnAssociation

This parameter is used with IBM 3270 terminal and printer sessions only. Use this parameter to associate a 3270 terminal session with a specific 3270 printer session (this feature applies to the Telnet Extended transport).

NOTE:The tnAssociation parameter is valid only when the tn3270eConnectType parameter is set to 0.

When associating a 3270 terminal session with a 3270 printer session, use the tnAssociation parameter to assign a unique TN association string in the terminal session. Reflection uses this value to automatically link the two sessions when the same value is used in the printer session for the tnAssociation parameter, the tn3270eConnectType parameter is set to 0, and the promptForDevicename parameter is set to false.

Applet

Parameter

Value

IBM3270

hostURL

tnAssociation

tn3270e://myhost

anyname

IBM 3270 printer

hostURL

tn3270eConnectType

tnAssociation

promptForDevicename

tn3270e://myhost

0

anyname

false

For information about linking 3270 terminal and printer sessions from within a session, open the online help in the emulator session. Then, under How To, go to Using TN Association in the Print section.

Note that both the terminal session and the printer session must be running in the same type of browser (for example, Internet Explorer) for TN association to work. A terminal session running in Internet Explorer and a printer session running in Firefox cannot be associated. (However, the sessions are not required to run in the same browser window.)

Value

<any association name>

Example

<param name="tnAssociation" value="anyname">

useANSIColor

This parameter applies to VT emulations only. When useANSIColor is true, any ANSI color attributes specified by the host overrides colors configured in the Color Setup dialog box. If useANSIColor is false, host color attributes are ignored and colors are selected according to the configuration in the Color Setup dialog box only.

Value

  • true (default)
  • false

Example

<param name="useANSIColor" value="false">

userArchive

This parameter specifies the name of a user archive file containing custom Java code written to use the Reflection Emulator Class Library (ECL). This parameter is required when using the Load Java Class command in the Reflection Macro menu, the loadJavaClass() API method, or the onStartupJavaClass or onExitJavaClass parameters. This parameter is not required, however, when using any of the ECL modules built in to Reflection.

Value

<user archive file name>

Example

<param name="userArchive" value="MyArchive">

Top of index

3.3.8 V-W-X-Y-Z

visible

This parameter applies only to sessions that appear in a separate window and determines whether the display will be visible. This parameter is most useful for custom solutions where it is desirable to hide the display.

Value

  • true (default)
  • false

Example

<param name="visible" value="false">

vthelptoc

This parameter redirects the Help Topics command in the Help menu for VT sessions to the specified URL.

Value

http://<terminal emulation component installation>/help/vthelp.html (Default)

<any valid URL>

Example

<param name="vthelptoc"
        value="http://ReflectionWeb.example.com
                    /customHelp/vthelp.html">

width

The required width attribute controls the initial width of the session applet embedded in the browser window. The width is measured in pixels. When the frame parameter is set to true, use the framewidth parameter to set the width of the separate Reflection terminal window.

Example

<applet mayscript name="IBM3270"
        code="com.wrq.rweb.Launcher.class" 
        width="400" height="300">
</applet>

XFRFTPHostName

This parameter specifies the name of the proxy server that is used for secure FTP connections. This parameter is used in conjunction with the securityEnabledFTP parameter, and is valid for dynamically generated or protected static sessions only.

Value

The name of the security proxy server that is used for secure FTP connections.

Example

<param name="XFRFTPHostName" value="hostname.example.com">

XFRFTPHostPort parameter

This parameter specifies the port number of the proxy server that is used for secure FTP connections. This parameter is used in conjunction with the securityEnabledFTP parameter, and is valid for dynamically generated or protected static sessions only.

Value

The port number used by the security proxy server through which secure FTP connections are made.

Example

<param name="XFRFTPHostPort" value="3000">

Top of index

3.3.9 Numbers

3270_hostKeyboardType

This parameter allows the host keyboard type to be set for an IBM3270 session; thus, which characters can be input into a numeric-only field. The effect of each parameter value is shown in the following table.

Value

Allowed input

normal

numbers and some symbols: comma (,), period (.), plus (+), and minus (-).

typewriter

All characters allowed when value="normal", shifted number key symbols (such as !, @, #, and $); and uppercase letters. (Lowercase letters will appear in uppercase)

dataEntry

All characters.

Value

  • normal (default)
  • typewriter
  • dataEntry

Example

<param name="3270_hostKeyboardType" value="normal">

3270_insertProtocol

This parameter is used with IBM 3270 emulation sessions only and specifies what Reflection does if a user attempts to insert a character.

Value

firstNull (default)

Reflection makes room for the character being inserted by moving all characters to the right of the insertion point one character to the right until a null is encountered. The null is replaced by a character and all subsequent characters are unchanged. If no null is found, the insertion fails.

trailingSpace

Reflection uses the same logic as for firstNull except that if no null is found it looks for a trailing space.

trailingChar

Reflection replaces the last character in the insert arena on an insert if neither a null nor a trailing space is found.

Example

  • <param name="3270_insertProtocol" value="firstNull">
  • <param name="3270_insertProtocol" value="trailingSpace">
  • <param name="3270_insertProtocol" value="trailingChar">

3270_keyboardErrorReset

This parameter is used with IBM 3270 emulation sessions only. Standard terminal behavior requires the user to press Reset when an error message appears in the operator information area. Setting 3270_keyboardErrorReset to false (the default) maintains this behavior.

When 3270_keyboardErrorReset is true, the next key pressed clears the error and restores the previous error line data. Reflection attempts to execute the keystroke as follows:

  • If the cursor is in a valid input field and the key is a data key, the data is entered.

  • If the cursor is in a valid input field and the key is a function key, the key operation is executed.

  • If the cursor is not in a valid input field and the key is a data key, the cursor is moved to the next valid input field and the data is entered there (if the data is valid for that field).

  • If the cursor is not in a valid input field and the key is a function key, the cursor is moved to the next valid input field and the key is ignored.

  • If the current screen contains no valid input fields, the user hears a beep with each keystroke and no keystrokes are executed.

Value

  • true
  • false (default)

Example

<param name="3270_keyboardErrorReset" value="true">

<param name="3270_keyboardErrorReset" value="false">

3270_wordWrap parameter

This parameter is used with IBM 3270 emulation sessions only. The 3270_wordWrap parameter specifies whether text is truncated at the end of the current line (false) or wrapped to the next available line (true) in a multi-line field.

  • true
  • false (default)

Example

<param name="3270_wordWrap" value="true">

<param name="3270_wordWrap" value="false">

Top of index