Configuration File Schema Guide

This guide provides a short description of each element and attribute defined in the XML schema for the XML Data Compare configuration file. A fuller description of the configuration file, along with the examples and an explanation of the main concepts can be found in the User Guide and associated documentation.

An occurrence indicator is used here for cases other than where a child element may occur once and only once. The occurrent indicators are descibed below:

[*] - Zero or more
[?] - Zero or once
[+] - One or more

Element Index

attribute-splitting 6

child-alignment 17

child-order 9

configuration 1

data-list 14

data-set 15

namespace 13

normalize-whitespace 7

numeric 11

output 4

text-splitting 8

xpath-namespaces 5

Element Detail

Elements are listed in document-tree order, top-level elements first, then alphabetically:

Element: configuration 1

The root element for defining the configuration for the XML Data Compare.

Contained by

/

Contains

Attribute	Type	Description
id	idType	A unique identifier for this configuration file.
version	string	The DeltaXML XML Data Compare configuration file version this conforms to - fixed at '1.0'.
Element	Description
defaults	An element for defining the user defaults for a feature [?]
location	A container element for a feature applied to a set of input document nodes [*]
output	An element for controlling the output format [?]
xpath-namespaces	Container element for binding prefixes used in XPath expressions to namespace-uris [?]

Element: defaults 2

An element for defining the user defaults for a feature [?].

A feature defined inside container will override this.

Contained by

/ configuration

Contains

Element	Description
attribute-splitting	Sets if and how attribute value content should be split into words [?]
normalize-whitespace	Sets whether to normalize whitespace or not [?]
text-splitting	Sets whether text node content should be split into words using standard ICU word separators [?]

Element: location 3

A container element for a feature applied to a set of input document nodes [*].

The XPath attribute is used to select the nodes.

Contained by

/ configuration

Contains

Attribute	Type	Description
name	nameType	A unique name to identify the container.
xpath	xpathLocationType	XPath (3.1 compatible) expression.
Element	Description
attribute-splitting	Sets if and how attribute value content should be split into words [?]
child-order	For defining a container for an unordered comparison [?]
ignore-changes	Defines how to ignore changes in specific items [?]
normalize-whitespace	Sets whether to normalize whitespace or not [?]
numeric	Control numeric tolerance for specified items [?]
text-splitting	Sets whether text node content should be split into words using standard ICU word separators [?]

Element: output 4

An element for controlling the output format [?].

By default, the output format is set to 'deltaV2' with full output.

Contained by

/ configuration

Contains

Attribute

Type

Description

format

[enum]

Permitted values / descriptions:

deltaV2: Raw deltaV2 output. The default.
sbs-folding-diffreport: Side by side folding diff-report

changes-only

booleanType

Whether to produce the differences and also the similarities between the two inputs. The default is false.

Element: xpath-namespaces 5

Container element for binding prefixes used in XPath expressions to namespace-uris [?].

Referenced namespaces normally correspond to those declared in the source XML but may also be those used for functions included in the XPath 3.1 specification. Note that the prefixes 'xsl', 'ignore' and 'deltaxml' are pre-allocated for internal use.

Contained by

/ configuration

Contains

Element	Description
default-namespace	Binds a namespace to be used in XPath when no prefix is specified [?]
namespace	Binds a prefix used in XPath to a namespace found in the source XML [*]

Element: attribute-splitting 6

Sets if and how attribute value content should be split into words [?].

By default content is split using standard ICU word separators. Add a child element to specify how content should be split.

Contained by

/ configuration / defaults

/ configuration / location

Contains

Attribute	Type	Description
enabled	booleanType	Specify whether content should be split into words.
Element	Description
data-list	Split text content into an ordered list of items using a specified tokenization method
data-set	Split text content into a set of unique items using a specified tokenization method
narrative-text	Split text content into words using standard ICU separators

Element: normalize-whitespace 7

Sets whether to normalize whitespace or not [?].

By default whitespace normalization is enabled when a configuration file is specified.

Contained by

/ configuration / defaults

/ configuration / location

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable whitespace normalization.

Element: text-splitting 8

Sets whether text node content should be split into words using standard ICU word separators [?].

Contained by

/ configuration / defaults

/ configuration / location

Contains

Attribute	Type	Description
enabled	booleanType	Specify whether content should be split into words.

Element: child-order 9

For defining a container for an unordered comparison [?].

Contained by

/ configuration / location

Contains

Attribute	Type	Description
ignore-order	booleanType	Whether to ignore order of child elements of the specified container element.
fail-if-no-key	booleanType	If true, stop comparison and report an error if the key value assigned to any child-element of the specific ordered/orderless container element is an empty string. Defaults to false.
Element	Description
child-alignment	Element that defines an unordered item and its key value [*]

Element: ignore-changes 10

Defines how to ignore changes in specific items [?].

Contained by

/ configuration / location

Contains

Attribute

Type

Description

use

[enum]

Permitted values / descriptions:

BA: Keep the B version if it exists, otherwise keep the A version
AB: Keep the A version if it exists, otherwise keep the B version
A: Keep the A version
B: Keep the B version
DELETE: Don’t copy under any circumstances (but process the subtree if present)

Element: numeric 11

Control numeric tolerance for specified items [?].

Contained by

/ configuration / location

Contains

Attribute

Type

Description

tolerance

double

Absolute tolerance value.

use

[enum]

Permitted values / descriptions:

A: Keep the A version if within tolerance
B: Keep the B version if within tolerance

Element: default-namespace 12

Binds a namespace to be used in XPath when no prefix is specified [?].

Contained by

/ configuration / xpath-namespaces

Contains

Attribute	Type	Description
uri	uriType	Namespace URI for the source XML

Element: namespace 13

Binds a prefix used in XPath to a namespace found in the source XML [*].

Contained by

/ configuration / xpath-namespaces

Contains

Attribute	Type	Description
prefix	prefixType	Prefix used in XPath expressions
uri	uriType	Namespace URI for the source XML

Element: data-list 14

Split text content into an ordered list of items using a specified tokenization method.

Contained by

/ configuration / defaults / attribute-splitting

/ configuration / location / attribute-splitting

Contains

Attribute	Type	Description
separator	string	A separator string used to splitting text content. Use 'regex' attribute to specify more than one separator.
regex	string	A regular expression specifying the match pattern to use for tokenizing text content.
output-token-separator	string	Where content is split into tokens using a 'regex' attribute, token-separators in the input are not preserved, the 'output-token-separator' specifies the string used to separate the tokens in the output. The default is a ',' (comma) character.

Element: data-set 15

Split text content into a set of unique items using a specified tokenization method.

Contained by

/ configuration / defaults / attribute-splitting

/ configuration / location / attribute-splitting

Contains

Attribute	Type	Description
separator	string	A separator string used to splitting text content. Use 'regex' attribute to specify more than one separator.
regex	string	A regular expression specifying the match pattern to use for tokenizing text content.
output-token-separator	string	Where content is split into tokens using a 'regex' attribute, token-separators in the input are not preserved, the 'output-token-separator' specifies the string used to separate the tokens in the output. The default is a ',' (comma) character.

Element: narrative-text 16

Split text content into words using standard ICU separators.

Contained by

/ configuration / defaults / attribute-splitting

/ configuration / location / attribute-splitting

Contains

(Empty element)

Element: child-alignment 17

Element that defines an unordered item and its key value [*].

Contained by

/ configuration / location / child-order

Contains

Attribute	Type	Description
child-xpath	xpathLocationWithinContextType	XPath (3.1 compatible) expression for unordered item.
key-xpath	xpathValueType	XPath (3.1 compatible) expression returning a key value for corresponding unordered item.

(This documentation was auto-generated from the XML Schema for the XML Data Compare configuration file.)