Skip to main content


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

Mapping XML attributes and elements in a Parse XML rule

Updated on April 6, 2022

Parse XML rules allow you to map both element and attribute nodes to clipboard pages. If your node type is Attribute, map the attributes in your XML to properties in Pega Platform.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the Integration-Mapping category, and then click Parse XML.
  3. Click the row of a Parse XML rule to open it.
  4. On the Mapping tab, double-click a tree node to display the User Data window for the node.
  5. In the User Data window, in the Node Name field, enter a name that describes the node.
  6. In the Node Type field, select Attribute or Element.
  7. On the Mapping tab, complete the fields based on your node type.
    Node typeActions
    Attribute
    1. In the Context Page field, specify a page listed on the Pages & Classes tab to be used as the target for parsed XML data values.
      You can also specify an embedded Page, Page List, or Page Group property of the node’s context class. Use a Page List or Page Group property for mapping when the Repeating flag is set on the Node tab of the User Data panel. If a Page Group property is used, the name of the parsed attribute or element is used as the group subscript value. This is useful when _any_ is specified as the Node Name value.
    2. In the Override Class field, if Context Page is set to a Page, Page List, or Page Group property, specify the concrete class that will be used when mapping the XML to the embedded page.
      Note: The Context Class field is read-only. This field lists the class of the page or property on the Context Page field. If a context page is not specified on the selected node, the value defaults to the context class of the selected node parent. The context class of the root node is the class that the parse rule applies to.
    3. In the Property field, specify a Single Value, Value List, or Value Group property to map the character data of the XML node.
      If a Value Group property is used, the name of the parsed attribute or element is used as the group subscript value. This is useful when _any_ is specified as the Node Name value. This field only applies to Standard and Literal XML mapping modes.
    4. To specify if you want to use the property in step c as the group subscript value, select Group Subscript.
    Element
    1. Choose the method used to map XML elements to properties:
      • Standard – Parse and extract data from the inbound XML based on the values listed in the selected node and any of its child nodes.
      • Literal XML – Insert the literal content of the Source Property into the XML stream instead of auto-generating XML content for the selected element.
      • Apply Rule – Invoke a component Parse XML rule to parse the content of the selected element node. Note: You must define the component parse rule on the Context class of the node from which it is referenced.
    2. In the Context Page field, specify a page listed on the Pages & Classes tab to be used as the target for parsed XML data values.
      You can also specify an embedded Page, Page List, or Page Group property of the node’s context class. Use a Page List or Page Group property for mapping when the Repeating flag is set on the Node tab of the User Data panel. If a Page Group property is used, the name of the parsed attribute or element is used as the group subscript value. This is useful when _any_ is specified as the Node Name value.
    3. In the Override Class field, if Context Page is set to a Page, Page List, or Page Group property, specify the concrete class that will be used when mapping XML to the embedded page.
      Note: The Context Class field is read-only. This field lists the class of the page or property on the Context Page field. If a context page is not specified on the selected node, the value defaults to the context class of the selected node parent. The context class of the root node is the class that the parse rule applies to.
    4. In the Property field, specify a Single Value, Value List, or Value Group property to map the character data of the XML node.
      If a Value Group property is used, the name of the parsed attribute or element is used as the group subscript value. This is useful when _any_ is specified as the Node Name value. This field only applies to the Standard and Literal XML mapping modes.
    5. To specify if you want to use the property in step d as the group subscript value, select Group Subscript.
    6. In the Namespace field, specify the Namespace key part of the parse rule that will be called to parse the element content. This might be different from the Node Name value.
      This field only applies to the Apply Rule mapping mode.
    7. In the Element Name field, specify the Element Name key part of the parse rule that will be called to parse the element content. This might be different from the Node Name value.
      This field only applies to the Apply Rule mapping mode.
  8. Click OK to close the User Data window, or click the Node tab to continue configuring the node.
  • Previous topic Defining the mapping for a Parse XML rule
  • Next topic Configuring XML tree node properties for a Parse XML rule

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us