XML Structure Tab: Combine Key Column

 Explanation | Examples

Applies to: Marshalling data to XML only

Available: For mapped nodes only. This column is not editable. Values are set using the Combine Node wizard that appears when you click in the Combined Node column. Using the Combine Node wizard, you can set any descendants of the combined node (elements or attributes) as keys to use in combining the element. Elements or attributes must be mapped to a DB column or an expression.

Possible values:

Not currently set. You may use this node as a key in identifying duplicate nodes, but it is not currently set.

This node will be used as a key in identifying duplicate nodes.

Explanation

Summary | Examples

When you set an element as a "Combined Node" using the Combine Node Wizard, the default behavior in the "Combine Key" column is to set the child attributes of the combined node as keys to use in identifying duplicated nodes in the XML output.

You can set custom values in the Combine Key column to change the way an element is compared. This is useful both for performance and for identifying other elements and/or attributes as keys to use.

Examples

Summary | Explanation

 

 

Marshal with Combine Project

Overview of the project used in examples below.

1.

Marshal Without Combine

No settings have been made in the XML Structure tab

2.

Marshal with Combine

XML output combines all PurchaseOrder nodes that have a matching value for the OrderID node.

3.

Marshal with Combine and Group

 XML output groups  all matching elements (LineItem) together

4.

 

Marshal with Combine and Order By

XML output contains records retrieved from the database using an ORDER BY clause

5.

Marshal with Optimized Combine

XML output generated using the Optimized Combine feature in the XML Structure tab.

See Also

XML Structure Tab
Introduction to Combining Nodes in XML Output When Marshalling

Combining Duplicate Elements in XML Output

Customizing Combine Settings for XML Output