Back Forward Show-Stream method

 Methods and instructions by function

Use the Show-Stream method to apply stream processing to an HTML rule, correspondence rule, or XML Stream rule, and send the results to a browser-based requestor session.

Parameters

This method has five parameters:

Parameter

Description
StreamClass

Optional. Identify the class of a rule type derived from the Rule-Stream class. such as:

  • Rule-Obj-Corr
  • Rule-Obj-HTML
  • Rule-Obj-XML

If blank, the default value is Rule-Obj-HTML.

Do not use this method with list view or summary view rules.
StreamName

Enter the second key part of the rule to be processed. To locate the rule using rule resolution, the system uses the class of the of the step page as the Applies To class of the rule.
StreamType

Optional. If you selected Rule-Obj-Corr or Rule-Obj-XML as the StreamClass value, enter here the third key part of the rule (the Correspondence Type or XML Type).
FrameName

Optional. Leave blank in most situations. If you use the T (or TRANSID) option in a URL directive, the system uses the frame name to verify the transaction ID. If you enter a value for HTMLFrame, use both the T and the F options in the URL directive. (As a best practice, use the name of the primary page as the frame name.)

TipWhen designing and implementing multiThread interactions for a browser-based user session, it is a best practice to have each Thread that uses the Show-Stream method send its HTML to a specific, named HTML frame on the browser window, to avoid confusion.

See the Pega Developer Network article PDNPRKB-10979 How to use the URL directive to configure transactional HTML forms for more information on synchronizing user input with database transactions when the URL directive is used with the T option.
Read-only

Select this 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.

Results

The system uses the class of the step page (or of the primary page) of the activity with rule resolution to find and access the rule referenced.

It uses stream processing to evaluate and process all the JSP tags that the rule instance contains. It sends the resulting processed HTML by HTTP or HTTPS protocol to the user who ran the activity.

The system stores the processed HTML as the value of the pxHTMLStream property on the pxThread page.

Checking the method status

This method updates the pxMethodStatus property. See How to test method results using a transition.

Notes

The Show-Page, Show-Stream, Show-Property and Show-HTML methods each send an HTTP message corresponding to an entire document to the user's Internet Explorer browser. They can't be used in combination to assemble a document. Use Show-Page and Show-Property only for debugging.

To review the HTTP messages produced by the Show-Stream method, install an HTTP debugger such as Fiddler, an open-source Windows-based proxy that logs all HTTP traffic between your computer and the Internet. See MSIEwww.fiddlertool.com.

Definitions directive, stream processing

zzzMethods and instructions by function