Gateway query parameters for web transactions

You can pass commands to a gateway servlet through a query string.

Gateway query parameters are not the same as gateway servlet parameters, which configure the servlet itself. For information about gateway servlet parameters, see Gateway servlet parameters.

The query parameters are included in the URL of a web transaction. You can create the parameters in one of two ways:
  • Code the parameters directly into the query string, as in the following example:
    http://localhost:9080/Web/VAGenGatewayServlet?hptAppId=myWebTrans&hptExec=Y&hptRecord=myRec
  • Set fields in the @programLinkData complex property of the VGUIRecord. With this option, you do not have to specify the server, HTTP port, or path to the gateway servlet. For more information, see @programLinkData.
You can pass any number of custom parameters by using either method. The servlet recognizes the following parameter names:
hptAppId
The name of the web transaction to run. Set this value in the programName field of the @ProgramLinkData complex property.
hptExec
A mandatory parameter that causes the servlet to run the page. EGL automatically sets this parameter to Y when you use the @ProgramLinkData complex property.
hptRecord
The name of the UI record to be passed as the inputUIRecord for the web transaction. Set this value in the uiRecordName field of the @ProgramLinkData complex property.
hptProgramPackage
The name of the package that contains the web transaction. This parameter overrides the javaProperty property in the csogw.properties file.
hptUIRecordPackage
The name of the package that contains the UI record. If this parameter is not set, but the hptProgramPackage parameter is set, hptProgramPackage is used. If neither is set, the javaProperty property from the csogw.properties file is used.
hptLogin
When it is set to any value, this parameter tells the gateway servlet to display the login page identified by the hptLogonPage servlet parameter. After logging in, the user sees the web transaction that is identified by the hptAppId parameter, if that parameter is also in the URL. If the hptAppId parameter is not in the URL, the gateway servlet displays the page from the hptEntryPage or hptEntryApp servlet parameters.
If the hptPublicUserId and hptPublicPassword servlet parameters are correctly set, the user is logged in automatically and taken directly to the application specified by hptAppId/hptEntryPage/hptEntryApp.
hptLogout
When it is set to any value, this parameter causes the gateway servlet to log out the current user, and then has the same effect as the hptLogin parameter.

Example

The following example shows the URL for a web transaction:
http://localhost:9080/Web/VAGenGatewayServlet?hptAppId=myWebTrans&
			hptExec=Y&hptRecord=myRec&hptProgramPackage=myWebTransactions
The following record definition shows the VGUIRecord properties that generate that URL:
record uir type vguirecord
	10 lnk char(2) { 
		uitype = programLink, 
		@ProgramLinkData { 
			programName = "myWebTrans",
			uiRecordName = "myRec",
			linkParms = [
				@linkParameter { name = "hptProgramPackage", value = "myWebTransactions" }
			]
		}
	};
end