Skip to main content

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

XML Stream rules

Updated on April 6, 2022

Create an XML stream rule to define an XML template or skeleton message as part of an interface between the Pega Platform and an external system. You can use XML stream rules to assemble and send an XML document in an email message, a SOAP message, a file, or other types of messages.

The XML text in each XML stream rule can contain directives or JSP tags that reference clipboard properties. At run time, the system performs stream processing to evaluate these directives or JSP tags and form the final XML message.

Where referenced

Connect SOAP, Service SOAP, and Service Email rules often use XML Stream rules to compose an XML document from clipboard property values. Most other service and connector rules can use XML Stream rules. In an activity, the Property-Set-XML method evaluates an XML Stream rule using stream processing.

For more information, see the following documentation:

In addition, XML Stream rules define the structure of menus in Dev Studio.


Use the Application Explorer to access XML Stream rules that apply to the work types in your application. Use the Records Explorer to list all XML Stream rules available to you.


If you have an XML Schema (XSD) file that defines the structure of XML documents to be produced by an XML Stream rule, you can create classes, properties, and XML stream rules corresponding to the XML definition automatically, using a wizard. For more information, see About the Connector and Metadata wizard .


XML Stream rules are part of the Integration Mapping category. An XML Stream rule is an instance of the Rule-Obj-XML rule type. The Rule-Obj-XML class is not derived from the Rule-Obj- abstract class. The immediate parent class of the Rule-Obj-XML class is the Rule-Stream class.

  • Creating an XML Stream rule

    Create an XML stream rule to define an XML template or skeleton message as part of an interface between the Pega Platform and an external system. You can use XML Stream rules with Connect SOAP, Service SOAP, and Service Email rules, or call them from an activity.

  • Defining the mapping for an XML Stream rule

    Use the tree structure on the Mapping tab to define how the clipboard values referenced in the individual tree nodes will be converted to XML stream data.

  • Defining pages and classes for an XML Stream rule

    You can use a named page to map XML data. Complete the Pages & Classes tab to define a page name to use with the Context Page value on the Mapping tab of the User Data window. This tab is optional.

  • Configuring the XML output for an XML Stream rule

    The XML tab of an XML Stream rule contains the XML output. Specify how the system generates the stream XML content.

  • Manually editing XML for XML Stream rules

    To avoid errors and compose a complete XML message, you can manually edit the content of your XML document. You can edit the XML provided in an XML Stream rule if it was not auto-generated by a wizard in Pega Platform. The Auto-generated XML check box on the XML tab of the XML Stream rule should be cleared.

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