Show-HTML method
Use the Show-HTML method to cause the activity to process an HTML rule and send the resulting HTML to a user for display by a browser. Known as stream processing. this may involve the interpretation of JSP tags (or the older directives), which can access the clipboard to obtain property values, or can insert other HTML rules, and so on.
Parameters
This method has three parameters:
| Parameter | Description |
| HTMLStream | Identify the Stream Name key part of an HTML rule ( Rule-Obj-HTML rule type) to be processed. The system uses the class of the step page as the Applies To key part of the HTML rule. |
| HTMLFrame |
Optional. Leave blank in most situations. If you use the
transid
option in a URL JSP tag, the system uses the frame name
to verify the transaction ID parameter
pzTransactionID. If you
enter a value for
HTMLFrame, use both the
transid
and the
frame
options in the URL JSP
tag. (As a best practice, use the name of the primary page as the frame name.)
Technically, this frame name is only an assertion to the server engine as to which HTML frame will receive the output, to enable a later redisplay if required. The run-time destination frame is controlled through JavaScript routines in the portal and may differ from this value. When designing and implementing multiThread interactions for a browser-based user session, it is a best practice to have each Thread that uses the Show-HTML method send its HTML to a specific named HTML frame on the browser window, to avoid confusion. |
| ReadOnly |
Select this check box to cause the system to present any HTML
INPUT
elements on any form as display-only, so that the user
receiving the HTML display cannot enter or update data.
Clear this check box to allow user input, the normal situation. |
Results
The system uses rule resolution to access the HTML rule referenced in the first parameter. It uses stream processing to evaluate and process all the JSP tags (or directives) it contains. It sends the resulting processed HTML code using HTTP or HTTPS protocol to the user who ran the activity.
The system stores the processed HTML as the value of the pxThread.pxHTMLStream property on the Thread page.
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.
Previous topic Show-Applet-Data method Next topic Show-Page method