Skip to main content

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

Creating a Parse XML rule

Updated on April 6, 2022

Create a Parse XML rule to map data from an XML text message into clipboard property values. Parse XML rules are used with services and connectors.

A Parse XML rule has three key parts: a class, a name, and a root element.

Although the first key part of this rule is known as the Namespace, it does not conform to any official XML namespace, but serves a similar function, to partition the set of possible parsing rules to avoid accidental name collisions.

  1. In the header of Dev Studio, click CreateIntegration-MappingParse XML.
  2. On the Create page, in the Label field, enter a name to group logically related XML documents.
    This value is arbitrary and is used only to differentiate identical element names that are used in different contexts. (You can include special characters such as @, % & * in this key part.)

    Although conceptually similar to a XML namespace, the Namespace key part is not used for matching namespace-qualified element names as defined by a Document Type Description (DTD) or XML Schema (XSDL) definition.

    If this Parse XML rule was created by the Import XSD/DTD wizard from a XML Schema Definition (XSD) file, the namespace in the XSD is used. If the XSD file does not identify a namespace, the value pyDefault is used. This value has no special significance or function.

  3. In the Root Element Name field, enter the name of the root element of the XML documents to be parsed by this rule.
    This value must be a valid Java identifier.
  4. In the Context section, in the Apply to field, select a class for this rule.
    The class is typically derived from the Data- base class or Work- base class.

    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 Parse XML rule opens on the Mapping tab.
What to do next: Define the Parse XML rules by using a graphical tree control. For more information, see Defining the mapping 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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us