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


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

AttributeTypeDescription
ididTypeA unique identifier for this configuration file.
versionstringThe DeltaXML XML Data Compare configuration file version this conforms to - fixed at '1.0'.
ElementDescription
defaultsAn element for defining the user defaults for a feature [?]
locationA container element for a feature applied to a set of input document nodes [*]
outputAn element for controlling the output format [?]
xpath-namespacesContainer 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

Contains

ElementDescription
attribute-splittingSets if and how attribute value content should be split into words [?]
normalize-whitespaceSets whether to normalize whitespace or not [?]
text-splittingSets 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

Contains

AttributeTypeDescription
namenameTypeA unique name to identify the container.
xpathxpathLocationTypeXPath (3.1 compatible) expression.
ElementDescription
attribute-splittingSets if and how attribute value content should be split into words [?]
child-orderFor defining a container for an unordered comparison [?]
ignore-changesDefines how to ignore changes in specific items [?]
normalize-whitespaceSets whether to normalize whitespace or not [?]
numericControl numeric tolerance for specified items [?]
text-splittingSets 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

Contains

AttributeTypeDescription
format[enum]

Permitted values / descriptions:


deltaV2
Raw deltaV2 output. The default.
sbs-folding-diffreport
Side by side folding diff-report
changes-onlybooleanTypeWhether 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

Contains

ElementDescription
default-namespaceBinds a namespace to be used in XPath when no prefix is specified [?]
namespaceBinds 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

Contains

AttributeTypeDescription
enabledbooleanTypeSpecify whether content should be split into words.
ElementDescription
data-listSplit text content into an ordered list of items using a specified tokenization method
data-setSplit text content into a set of unique items using a specified tokenization method
narrative-textSplit 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

Contains

AttributeTypeDescription
enabledbooleanTypeSet 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

Contains

AttributeTypeDescription
enabledbooleanTypeSpecify whether content should be split into words.

Element: child-order 9

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

Contained by

Contains

AttributeTypeDescription
ignore-orderbooleanTypeWhether to ignore order of child elements of the specified container element.
fail-if-no-keybooleanTypeIf 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.
ElementDescription
child-alignmentElement that defines an unordered item and its key value [*]

Element: ignore-changes 10

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

Contained by

Contains

AttributeTypeDescription
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

Contains

AttributeTypeDescription
tolerancedoubleAbsolute 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

Contains

AttributeTypeDescription
uriuriTypeNamespace URI for the source XML

Element: namespace 13

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

Contained by

Contains

AttributeTypeDescription
prefixprefixTypePrefix used in XPath expressions
uriuriTypeNamespace 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

Contains

AttributeTypeDescription
separatorstringA separator string used to splitting text content. Use 'regex' attribute to specify more than one separator.
regexstringA regular expression specifying the match pattern to use for tokenizing text content.
output-token-separatorstringWhere 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

Contains

AttributeTypeDescription
separatorstringA separator string used to splitting text content. Use 'regex' attribute to specify more than one separator.
regexstringA regular expression specifying the match pattern to use for tokenizing text content.
output-token-separatorstringWhere 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

Contains

(Empty element)

Element: child-alignment 17

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

Contained by

Contains

AttributeTypeDescription
child-xpathxpathLocationWithinContextTypeXPath (3.1 compatible) expression for unordered item.
key-xpathxpathValueTypeXPath (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.)

#content .code