Skip to main content

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

Creating an XML Stream rule

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.

An XML Stream rule has three key parts:

  1. In the header of Dev Studio, click CreateIntegration-MappingXML Stream.
  2. On the Create page, in the Label field, enter a name for this XML Stream rule.
    Choose a name that starts with a letter and contains only letters, numbers, and a hyphen.
  3. In the XML Type field, enter the literal MapFrom if this XML stream rule is to be referenced in the Response tab of a Service rule, such as Service MQ or Service SOAP.
    This key part is arbitrary and is referenced primarily when XML text (in one Rule-Obj-XML rule) uses the <pega:include > JSP tag, which instructs the system to incorporate a second XML stream (where the third key parts must match).

    You can use special characters, such as #, &, *, ( ), in this key part. However, as a best practice, begin the name with a letter and follow the rules for a Java identifier.

  4. In the Context section, in the Apply to field, select the class of the page that is the basis for stream processing to generate an XML document from this rule.

    The list of available class names depends on the ruleset that you select. Each class can restrict applying rules to an explicit set of rulesets as specified on the Advanced tab of the class form.

  5. Click Create and open.
    Result: The XML Stream rule opens on the Mapping tab.

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