Configuring the configuration servlet
By default, Z and I Emulator for Web clients that are created using the Configuration server-based model or the Combined model use port 8999 to access configuration information from the Service Manager. For Z and I Emulator for Web clients that are created using the HTML-based model, all host session configuration information is contained in the HTML files themselves. The only time clients created using the HTML-based model need to access the configuration server is when license usage counting is enabled. You can disable license use management (LUM) by adding a Disable parameter with a value of LUM on the HTML parameters window of Advanced Options in the Deployment Wizard.
If any of your clients are outside the firewall, the firewall administrator needs to open port 8999 both internally and externally. However, you can avoid opening this port by customizing your clients to use the configuration servlet to access configuration information. The configuration servlet tunnels the configuration information from the client to the configuration server over an HTTP or HTTPS connection using the defined configuration server port. Refer to
Installing the configuration servlet
in the
Planning, Installing, and Configuring Z and I Emulator for Web
guide for information about how to install the configuration servlet.
Configuration servlet parameters
The Z and I Emulator for Web configuration servlet recognizes these parameters. Check your Web server or servlet engine's documentation for instructions on how to pass parameters to a servlet.
Parameter | Default value | Description |
---|---|---|
ConfigServer | 127.0.0.1 | Host name or IP address of the Z and I Emulator for Web server. |
ConfigServerPort | 8999 | Port number the Z and I Emulator for Web Service Manager listens to. |
BufferSize | 4096 | Size of the buffer to use on buffered input or output streams. |
PoolSize | 5 | Size of the buffer or socket pool to maintain. To turn off pooling, set PoolSize to 0. |
Trace | false | When set to true, the configuration servlet writes servlet messages to the servlet engine log file, and to the browser when requested, for debugging purposes. |
ShowStats | false | When set to true, allows the configuration servlet to return configuration information and statistics to browser requests. |
Client parameters
The Z and I Emulator for Web clients, such as the Administration client (admin.html), recognize these parameters:
Parameter | Default value | Description |
---|---|---|
ConfigServer | Z and I Emulator for Web Server | Host name of the Z and I Emulator for Web server. The default value is taken from the hostname portion of the client's address. |
ConfigServerPort | 8999 | Port number that the Z and I Emulator for Web Service Manager listens to. |
ConfigServerURL | No default | Address or alias of the Z and I Emulator for Web configuration servlet. |
You can set client parameters in the client's HTML code in the config.properties file that you place in the publish directory (the same directory as the client HTML files on the server) or allow the clients to use default parameter values. When the clients load, they first look for any parameters set in the HTML code. If none are present, they look for any parameters set in a config.properties file. If no parameters are set in config.properties, or if config.properties does not exist, the clients use the default settings. The config.properties file can be an ASCII or a UTF-8 text file and contains name=value pairs. Lines that begin with the "#" are treated as comments.
If you need to edit config.properties for an z/OS server, first transfer the file in binary to an ASCII based system such as Windows or Unix. Edit the file and then transfer it back to the z/OS system in binary. If you need to create a config.properties file, do so on an ASCII system and then transfer the file to the z/OS server in binary. The reason for this is that the client applets expect ASCII text in config.properties, but files created or edited on z/OS are stored in EBCDIC. |
For example, to set the port number the client uses to contact the Service Manager from the default port 8999 to 12345, place ConfigServerPort=12345 in the config.properties file on a line by itself.
When a config.properties file exists in the publish directory, all the clients use the same file. If you want some clients to use their own unique settings, you can configure the Server connection options in the Advanced Options window of the Deployment Wizard when you are creating or editing the client HTML files. |
When you specify the Server connection options for a given client HTML file, the options selected will override any system values that may have been set in config.properties, such as those you specified during the Z and I Emulator for Web installation process.
You cannot use the Deployment Wizard to edit HTML files you create manually. You also cannot use the Deployment Wizard to edit HTML files you created with the Wizard and later edited manually. |
Debugging information
You can access trace, configuration and statistical information from the configuration servlet for debugging purposes. To access trace information you need to set the Trace parameter to true for the configuration servlet. To view the trace load http:// server_name/ servlet_alias/ZIEConfig/trace in your browser. The configuration servlet's trace information will be displayed in the browser and written to the servlet engine's log file.
To access configuration and statistic information you need to set the ShowStats parameter to true for the configuration servlet. To view the information load http:// server_name/ servlet_location/ZIEConfig/info in your browser.
Related topics: