Release Documentation

XML Compare Help

Getting Started

The XML Compare GUI gives you the power of XML Compare's comparison technology with the simplicity of a user interface tailored for your platform. While the tools that the user interface use are designed for integration into your own publishing and data systems, this user-interface makes them usable without any configuration and programming.

Start the GUI up by opening a command prompt (or terminal window) at the directory where the product is installed and typing

at the Windows command prompt

deltaxml-gui.bat

or in a terminal window:

sh deltaxml-gui.sh

Running a Comparison

When a comparison window is first displayed, the configure comparison is loaded. If you close this window, the "Configure" button in the Comparison Window's toolbar will display it again - the inputs/settings that you enter will persist. If you wish to create a new Comparison Window, you can use the "New Comparison Window" or "Clone Comparison Window" in the File menu.

After choosing the pipeline you wish to use, selecting your inputs and changing any settings you wish to change you can click the Run Comparison button to run the comparison. The comparison result will be displayed.

Managing your License

When you download XML Compare from DeltaXML's FlexNetOperations Site, you also need to download a license file. This license file should be saved as deltaxml-xml-compare.lic and placed in the same location as the GUI (either the DeltaXML XML Compare.app file or the deltaxml-gui.jar file, depending on your distribution).

Installing the Command Line Tools and Developer API

The XML Compare developer API and command line tools come with the GUI in the Java distribution. However, on the Mac distribution they need to be installed to a location of your choice which can be done via the XML Compare > Install Command Line Tools and API... menu.

Different Comparison Options

XML Compare uses custom pipelining technology to support multiple input and output options. These are automatically discovered and displayed in the "Pipeline:" pop-up in the Comparison Configuration Window.

The options that are configurable depends on the pipeline that has been chosen. Some of the more common pipeline options are discussed below:

Word By Word

XML Compare by default identifies changes in PCDATA at a block level, e.g. changing the word "brown" to "red" in "<a>The quick brown fox jumps over the lazy dog.</a>" would result in the entire contents of <a> being marked as changed. Turning this setting on allows changes to be identified and marked-up at a word level, e.g. only the change to the word "brown" is identified and marked-up.

Preserve Whitespace

Usually when using comparing your XML documents or data, you are not interested in changes to whitespace. However, if seeing changes in whitespace is important then this option can be turned-on.

Enhanced Match 1

When XML Compare knows that it is comparing documents, it can optimise its matching to generate a better result. If you are comparing XML data or you are seeing odd results, then it is recommended to turn this off.

Further Reading

The GUI uses the PipelinedComparator component and only exposes a small fraction of the power of XML Compare. If you want to integrate the tools into your existing systems or you are creating a pipeline for your specific data, then please see the ReadMe.html which comes as part of the XML Compare distribution. We also have a comprehensive set of documentation available on our website.