Gateway servlet parameters

By default, the gateway servlet has only one parameter defined: the parameter hptGatewayProperties. This parameter specifies a gateway properties file. The gateway properties file sets the remaining parameters for the gateway servlet. By default, the gateway properties file is the file gw.properties in the folder JavaResources\JavaSource. Comments in this file begin with the pound symbol (#).

Alternately, you can set the gateway servlet parameters in the same place as the hptGatewayProperties parameter is specified. However, it is better practice to set the parameters in the gateway properties file. The parameters in the gateway properties file override those you specify in the web application server.

Linkage properties are set in the linkage properties file. This file is specified in the hptLinkageProperties gateway servlet parameter. See Linkage Properties.

Table 1. Gateway Servlet Parameters
Servlet Parameter Parameter Value Notes
hptDateMask yyyy/dd/mm Required if any UI records have non-numeric date fields. For those fields, the datetime values that pass between tier 2 and tier 3 in either direction must correspond internally to a long Gregorian format for date and time. Parameter hptDateMask specifies that format. For web transactions generated as C++ programs, the format must match that specified in environment variable EZERGRGL. For web transactions generated as COBOL programs, the format in hptDateMask must match the datetime format specified during the server installation.
hptEntryApp web_transaction Specifies a web transaction that provides an entry page. The program name must correspond to a name (such as a CICS® definition) in the tier 3 environment. Also, an entry for the program name must be in the file to which parameter hptLinkageProperties refers.

Either hptEntryPage or hptEntryApp is required. If both are specified, hptEntryPage is used.

hptEntryPage /entry_page_jsp Specifies the entry page JSP, relative to the document root.

Either hptEntryPage or hptEntryApp is required. If both are specified, hptEntryPage is used.

In the HTML output of the entry page JSP, the name of the web transaction invoked by the user must be assigned to hptAppId. Also, the SUBMIT button that invokes the web transaction must have the name hptExec, and the SUBMIT button that ends the web application server session must have the name hptLogout.

Vagen1EntryPage.jsp is provided as a working example. There, each web transaction name is included in a VALUE clause of a <SELECT> structure, and the NAME clause of that structure refers to hptAppId.

hptErrorLog gateway_servlet_log_file Optional. Specifies the fully qualified path of a log file. If this parameter is specified, the gateway servlet provides a trace of events and errors, and you can use the log to diagnose problems. Removing hptErrorLog turns off tracing.
hptExpiredPasswordPage /expired_password_page _jsp Optional. Specifies the expired password page JSP, relative to the document root.

In the HTML output of the expired password page JSP, the userid input field must have the name hptUserid, the old-password input field must have the name hptPassword, the new-password input field must have the name hptNewPassword, the new-password input confirmation field must have the name hptConfirmNewPassword, and the SUBMIT button must have the name hptExpiredPasswordPageLogin.

ExpiredPasswordPage.jsp is provided as a working example of the JSP.

The parameter hptExpiredPasswordPage has an effect only if hptLogonCheck is also specified.

hptGatewayProperties gateway_properties_file Optional. Specifies the fully qualified path of a file that contains the other gateway servlet parameters.
hptIDManageHost host_name Optional. Specifies the TCP/IP host name for the machine where the Session ID Manager runs. The default is localhost.
hptLinkageProperties linkage_properties_file Required. Specifies the fully qualified name of the linkage properties file, which establishes a connection between the gateway servlet and each web transaction. See Linkage properties.
hptLogonCheck fully_qualified_class_name Optional. Specifies a logon-check class to handle user authentication.

RACFValidateLogin is provided as a working sample. To use that sample, specify the following:hptLogonCheck=com.ibm.hpt.gateway.RACFValidateLogin

hptLogonPage /logon_page_jsp Optional. Specifies the logon page JSP, relative to the document root. If this parameter is omitted or if hptPublicPassword and hptPublicUserid are present, no logon page is displayed.

In the HTML output of the logon page JSP, the userid input field must have the name hptUserid, the password input field must have the name hptPassword, and the SUBMIT button must have the name hptLogin.

Vagen1LogonPage.jsp is provided as a working example of the JSP.

Following is an example of a gateway properties file:
hptLogonPage=/Vagen1LogonPage.jsp
hptEntryPage=/Vagen1EntryPage.jsp
#hptEntryApp=WEBTXN1
hptErrorLog=c:/traces/Vagen1Gateway.log
hptLinkageProperties=c:/linktabs/csogwLinkage.properties
# use the following property if using Websphere 2.0, 
# which uses JSP 0.91 and Servlet 2.0 support 
#hptServletVersion=2.0

Related tasks
Configuring a project to run Web transactions
Adding Web transaction support to an EGL Web project

Related reference
Linkage properties

Feedback
(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.