HTML Event Initiator

The HTML Event initiator begins when an HTML event is generated. This might occur when a person interacting with a web page fills out a web page form and clicks the submit button. See the Interaction Web Tools Developer's Guide in the PureConnect Documentation Library.

Event Page (HTML Event Initiator)

Registered Name

The name of this initiator which is registered on the CIC server when this handler is published. The event and field information is stored along with the initiator's name on the CIC server and this allows this information to be recalled in another HTML initiator by selecting the proper registered name. Inserting the Registered Name of a previously used HTML Event initiator will set all the settings to be those of the named HTML Event initiator.

Example: HandlerA is written using the HTML Event initiator and the Registered Name is specified as "HandlerA." This stores all the settings specified for HandlerA under that name on the CIC server. Later, you're writing a second handler, HandlerB, that uses all the same settings as HandlerA. Instead of manually assigning them each individually, simply insert "HandlerA" into the Registered Name field of HandlerB, and all the settings will be automatically set to those saved under "HandlerA."

HTML Event

The first command line argument to the CIC servlet.

Field List

The form element names passed in from the servlet.

Variable List

The variables in the handler that contains the values of the form element names.

Add button

Click this button to add a form element and an associated variable.

Edit button

Click this button to edit a form element and its associated element.

Delete button

Click this button to delete a selected form element.

CGI Command Line Arguments

The variable of type List of String that holds any command line arguments passed along with the event.

Web Connection

The variable that contains the name of the web connection. The web connection is established by the CIC servlet. The web connection is used by the Generate HTML step to send a web page back to a user. If there is no Generate HTML step to send a page back to a user, the user is sent a page that says "Error Generating HTML."

Outputs

These outputs are generic optional servlet variables. You will most likely never need to specify values for these parameters. These environment variables are set when the server executes the gateway program.

Gateway Interface

Contains the revision of the CGI specification that this server uses.

Request Method

The method used for the request. It tells you where and how to look for whatever data is passed. Usually it is either Post or Get.

Script Name

This is set to the file name of the servlet. This may be useful if you are generating scripts on the fly.

Query String

This variable contains information being passed to the servlet. If you are trying to debug your HTML query strings, you can store their values here.

Server Software

The name and version of the information server software answering the request (and running the gateway).

Server Name

The server's host name, DNS alias, or IP address as it would appear in self-referencing URLs.

Server Protocol

The name and revision of the information protocol accompanying a request.

Server Port

The port number to which the request was sent.

HTTP User Agent

Contains the name and version of the user’s browser.

HTTP Accept

Provides the MIME format that the browser can accept.

Path Info

The extra path information, as given by the client. In other words, scripts can be accessed by their virtual path name, followed by extra information at the end of this path. The extra information is sent as PATH_INFO. This information should be decoded by the server if it comes from a URL before it is passed to the servlet.

Path Translated

The server provides a translated version of PATH_INFO, which takes the path and does any virtual-to-physical mapping to it.

Remote Host

Contains the text equivalent of the host name of the computer connected to your web site. Specify a value here if you want to log this information.

Remote Address

Contains the IP address in dotted-decimal notation of the computer making the request. Specify a value here if you want to log this information.

Remote User

The name of the person connected to your web site. This information is not present if the user has not specified a name in his or her browser.

Remote Identifier

If the HTTP server supports RFC 931 identification, then this variable is set to the remote user name retrieved from the server. Use of this variable should be limited to logging only.

Authentication Type

Contains the authentication method used to validate the user.

Content Type

The MIME content-type of the attached information.

Content Length

The number of bytes of data in the attached data.

HTTP Cookie

The information contained in the HTTP cookie of the user connected to your web site. The information is stored as a ‘&’-separated set of values. An example would be:

Brian & Depauw Blvd.&Suite 1060&&Indianapolis&IN&46268&ExistingCustomer&Marketing

The subroutine SystemWebParseCookie will break apart this stream of data into the appropriate data containers(variables).

Exit Paths

Start

This step always exits through the start path.