Skip to main content

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

Property-Set-Corr method

Updated on August 10, 2022

Use this method to save the contents of a correspondence stream (generally HTML text) as the value of a Single Value property. The property value can then be mapped as output for transmission to an external system.

The target property value is the contents of a correspondence rule ( Rule-Obj-Corr rule type), after stream processing. Stream processing evaluates directives and clipboard references.

Don't attempt to set the value of a property that has a name starting with pz; these properties are reserved. Don't use this method for a property that is the target property of a Declare Expression rule.


This method has three parameters:

PropertyName Enter a Single Value target property reference. Identify the property that receives its value from stream processing. Typically, choose a property that has a Text type.
corr streamEnter the second key part — the Correspondence Name — of a correspondence rule.
CorrTypeEnter a correspondence type that is the final key part of a correspondence rule.


This method forms a key to a correspondence rule from the value you supply for the second and third parameters and the class of the step page or of the activity. It uses rule resolution to find the correspondence rule.

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

It then applies stream processing to interpret and evaluate the JSP tags or directives (including property references) in this rule. It stores the resulting text as the value of the property referenced in the PropertyName 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.


  • You can't 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.
  • Don't 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