DeltaXML Sync 3.0

    DeltaXML Sync

    Welcome to DeltaXML Sync. Sync enables you to produce a synchronization result from three input files. The exact details of how the synchronization works depend on which synchronization ruleset you use, controlled via a Feature setting.

    Sync now features a completely new algorithm which enables synchronization of larger files with faster, more accurate synchronization than previous versions. Also included is the new PipelinedSynchronizer API for simpler, easier to understand pipeline building.

    This release contains:

    • The com.deltaxml.sync.pipelined package: an API for easy synchronization pipeline construction using Java or XSLT filters

    • The com.deltaxml.sync.jaxp package: a JAXP-compatible low level API for DeltaXML Sync

    • The synccommand.jar command-line interface (no programming required)

    For support information and further technical details, please refer to the following pages on the DeltaXML website:

    1. Activating your licence

    A licence key is required to activate the DeltaXML Sync code. The activation process is carried out by typing commands into a shell or terminal window.

    You should have received your licence as an email attachment. Save this attachment, e.g. my_name.lic, to the directory that contains sync.jar. To activate this licence, run the command: 

    java -jar sync.jar activate my_name.lic

    Other commands available are:

    deactivate

    Removes all installed Named User or Server licences

    java -jar sync.jar deactivate
    license

    Prints out the current licence information

    java -jar sync.jar license

    Depending on the type of licence being used or evaluated, some constraints apply to the activation procedure:

    • If you are installing a server licence the activation should typically be performed by a user with elevated privileges, for example privileges to create/write files in system areas. Such users include those with Administrator privileges on Windows or MacOSX systems, or root users on Unix.
    • DeltaXML enterprise licences are provided in pre-built DeltaXML releases, specific to each customer; there is no need to activate such releases.
    • If you purchase a DeltaXML licence, we recommend that you deactivate any evaluation licences before activating a full licence. Similarly, if you upgrade from a personal licence to a server licence, we recommend deactivating any existing licence.

    2. What can DeltaXML Sync do?

    DeltaXML Sync takes three XML input files and produces a synchronization result based on a set of synchronization rules, defined in a ruleset. Sync can be configured within a pipeline using Java and XSLT filters, giving it a powerful flexibility to fit in with your requirements. Find out more in the Sync section of the DeltaXML Tour.

    3. PipelinedSynchronizer API

    This new API, first included in the 2.0 release, provides an easy method of constructing synchronization pipelines incorporating either Java or XSLT based filtering, or even a mixture of the two. You can construct the pipelines in Java or in XML using a 'dxp' (DeltaXML pipeline) file. A dxp file can be read directly by the command-line processor. Please consult the samples and javadoc included in the release, particularly the com.deltaxml.sync.pipelined package documentation.

    To determine the version information for the API, invoke: 

    java -jar sync.jar

    4. JAXP API

    The JAXP compatible API provides more functionality than the PipelinedSynchronizer API but requires more programming experience and more code.

    For full API details please read the package description by navigating from docs/api/index.html

    5. Command-line interface

    The release includes a command line processor which can be used to perform synchronization operations on local files through a simple command line interface. The interface is contained in synccommand.jar and is used like this: 

            java -jar synccommand.jar status
        java -jar synccommand.jar sync deltav2 file1.xml file2.xml file3.xml result.xml {param=value}
        java -jar synccommand.jar ...

    Further details are in the file docs/command-processor.html

    6. Samples

    The samples directory contains some sample programs, their data and Ant build scripts. Each sample directory contains a ReadMe file to explain the sample in more detail and to give examples of how to run it if you don't have Apache Ant.

    The samples/dxp directory contains the dxp files used by default by the command line processor as well as a DTD file for validation of your custom dxp files. Use these samples as a starting point for specifying your own pipelines.

    Please read the samples ReadMe for more information.

    7. Feedback

    We are always keen to improve our products, please visit our Support Forums if you have any comments or suggestions while using DeltaXML Sync. We hope you enjoy it!

    The DeltaXML Team.