Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Property-Set-Stream method

Updated on August 10, 2022

Use this method to save the contents of an HTML or XML stream, after stream processing completes, as the value of a Single Value property. The property value can then be mapped as output for transmission to an external system.

This method sets the results of stream processing on any stream rule, after all directives or JSP tags are processed, as the value of the property specified.

For example, if your application uses a Service Email rule ( Rule-Service-Email rule type) to respond to an incoming email message, the response mapping can return an HTML-formatted email message containing clipboard values and HTML markup.


This method has four parameters:

PropertyName Enter a Single Value target property reference. Identify the property that to receive its value from stream processing. Typically, choose a property that has a Text type.
StreamClass Identify the rule type of the stream, one of the following:
  • Rule-Obj-Corr
  • Rule-Obj-HTML
  • Rule-Obj-XML
  • Rule-Corr-Fragment
  • Rule-HTML-Fragment
StreamName Enter the Stream Name key part of an HTML rule (Rule-Obj-HTML rule type) to be processed to produce the value of the property.
StreamType Optional. If the StreamClass is Rule-Obj-Corr or Rule-Obj-XML, enter the third key part of the rule instance to be processed.


This method forms a key to a rule of the rule type specified in the StreamClass parameter from the value you supply in the third and fourth parameters plus the class of the step page or of the activity. It then uses rule resolution to find the rule.

If the step page does not exist, a new page is created, of the class identified in the Pages & Classes tab.

Next, it performs stream processing to interpret and evaluate the JSP tags or HTML directives (including property references) in this rule. It stores the resulting XML or HTML text as the value of the property identified in the first parameter.

If the Type of the expression doesn't match the Type of the destination, the value is converted following the same scheme as within expressions. See Data type conversions (casting) in expressions and property assignments.

Any property messages previously associated with the property are cleared. The property value is validated against the property rule.


  • You cannot use this method for a property that is also the target property of a Declare Expression rule. You can't save the Activity form if such a conflict is detected.
  • Do not attempt to set the value of a property that has a name starting with pz; changes to such properties are reserved.

Checking the method status

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

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us