Skip to main content

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

Parse XML rules

Updated on April 6, 2022

Use Parse XML rules with services and connectors to map data from an XML text message into clipboard property values. Each Parse XML rule contains an array of parsing instructions that Pega Platform uses to interpret an incoming XML document or message.

The incoming message might arrive using an email protocol or by SOAP over HTTP protocol. The message might be a request for service or a reply from a connector.

Where referenced

Parse XML rules are frequently used with Web services and are often referenced in Connect SOAP and Service SOAP rules. For more information, see Connect SOAP rules and Service SOAP rules.

You an also execute a Parse XML rule in an activity by using the Apply-Parse-XML method. For more information, see Apply-Parse-XML method.


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


If you have a XML Schema (XSD) file for the XML documents to be parsed by a Parse XML rule, you can create classes and properties and Parse XML rules corresponding to the XML definition automatically by using a wizard. For more information, see About the Connector and Metadata wizard.


Parse XML rules are instances of the Rule-Parse-XML class. They belong to the Integration-Mapping category.

  • Creating a Parse XML rule

    Create a Parse XML rule to map data from an XML text message into clipboard property values. Parse XML rules are primarily used with SOAP services and connectors. You can also call a Parse XML rule from an activity.

  • Defining the mapping for a Parse XML rule

    Use the Mapping tab to define Parse XML rules using a graphical tree control. The tree structure allows you to define how the parsed XML data will be mapped to the clipboard values referenced in the individual tree nodes.

  • Defining pages and classes for a Parse XML 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 in a Parse XML rule.

  • Enabling XML validation for a Parse XML rule

    Specify that the system is to validate incoming XML against an XML Schema Definition (XSD) file before the system attempts to parse the XML document.

  • Unit testing a Parse XML rule

    You can test a Parse XML rule directly, separate from the activity or other context in your application in which it ultimately operates.

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