Migrating to DeltaNova

DeltaNova offers a unified solution for compare, merge and check. Migrating to DeltaNova is straightforward and most existing integrations should work with minimal changes.

Old licenses for legacy products will not work with DeltaNova. Legacy products are supported for two years, beginning with the first release of DeltaNova.

Minimum Requirements

Refer to our prerequisites page to ensure you are meeting the minimum requirements of DeltaNova.

Licensing Changes

DeltaNova comes with Single Site, Multi-Site or Global licenses. See Licensing Models for more details. All the legacy licenses will not work with DeltaNova. Contact us to find out more about license migration.

Distribution Changes

deltanova-year.x.y.z.jar provides the Java functionality of all the legacy products.
- All other legacy product jars such as deltaxml-x.y.z.jar, deltaxml-docbook-x.y.z.jar and deltaxml-dita-x.y.z.jar are deprecated, and their features are included in the DeltaNova jar.
deltanova-year.x.y.z.jar replaces all the legacy Java command lines.
- All command line invocations must now begin with java -jar deltanova-YEAR.x.y.z.jar.
deltanova-rest-year.x.y.z.jar provides the REST functionality of all the legacy products.
- All other legacy product REST server jars have been deprecated and the deltanova-rest-year.x.y.z.jar contains a single unified REST server that covers all their features.
deltanova-rest-client-year.x.y.z.jar replaces all the legacy Java command line clients.
- All other legacy product rest client jars have been removed and their functionality is contained within the new deltanova-rest-client-year.x.y.z.jar.

Capabilities

A capability represents a particular feature within DeltaNova. There are two types of capability: base and advanced. All users of DeltaNova have all base capabilities available for use, and may have some, none or all of the advanced capabilities available. To support this, some of the default settings for certain comparators have changed. Find more information about the changes in the specific product sections below.

When configuring a feature governed by an advanced capability onto a comparator (e.g. Move Detection & Tracking via com.deltaxml.core.config.moves.MoveDetectionConfig), it is important to explicitly enable the advanced capability with the appropriate method (MoveDetectionConfig#setEnabled for the previous example).

General Java API Changes

com.deltaxml.api.DeltaXMLError has been moved to com.deltaxml.core.exceptions.DeltaXMLError and now extends java.lang.RuntimeException as opposed to java.lang.Error.
Many common exceptions are now reused from the com.deltaxml.core.exceptions package rather than duplicated in capability specific- packages For example, com.deltaxml.dita.DeltaXMLDitaError has been replaced by com.deltaxml.core.exceptions.DeltaXMLError, and com.deltaxml.docbook.InvalidInputException has been moved to com.deltaxml.core.exceptions.InvalidInputException.

See the JavaDoc for more details on exceptions.

Methods and classes previously marked as deprecated have been removed.

General REST Changes

For a comprehensive guide to the available REST endpoints, use the DeltaNova Postman Collection.

Endpoint Changes:

/api/X/v1/jobs → /api/jobs
/api/X/v1/downloads → /api/downloads
/api/X/v1/status → /api/status

General CLI Changes

The DeltaNova CLI is structured to reflect the three main operations in DeltaNova: compare, merge and check. Running the CLI with no arguments will give a brief rundown of the available pipelines for each operation. More details for a particular pipeline can be seen by using the describe command with the name of a particular pipeline.

Migrating to DeltaNova from Deprecated Products

XML Compare

Default value changes:

For DocumentComparator and PipelinedComparator, in ResultReadabilityOptions ModifiedWhitespaceBehaviour has changed from AUTOMATIC to NORMALIZE.
In DocumentComparator: All advanced capabilities such as Diagram Processing, Image Processing, Table Processing are disabled by default. Should an UnavailableCapabilityException appear please contact us through the support portal.

DCP changes:

useDefault is no longer a valid value for standardConfig/resultReadabilityOptions/modifiedWhitespaceMode.

Java API

The package com.deltaxml.cores9api no longer exists and has become part of com.deltaxml.core. This also goes for the various ‘sub packages’ - com.deltaxml.cores9api.* becomes com.deltaxml.core.*.
com.deltaxml.cores9api.PipelinedComparatorS9 has been renamed to com.deltaxml.core.PipelinedComparator.
The methods setComparatorProperty, getComparatorProperty, setComparatorFeature and getComparatorFeature have been removed from com.deltaxml.core.PipelinedComparator.
com.deltaxml.cores9api.config.ColumnKeyingMode has been removed, please use either com.deltaxml.core.config.CalsColumnKeyingMode or com.deltaxml.core.config.HtmlColumnKeyingMode.
com.deltaxml.core.DCPConfiguration#getDocumentComparator() has been renamed to getComparator().
Other Java API changes that apply to all legacy products are listed here.

REST

Endpoint changes:

/api/xml-compare/v1/pipelines/X → /api/compare/pipelines/X

Other REST changes that apply to all legacy products are listed here.

DocBook Compare

Default value changes:

For DocBookCompare, in TextComparisonConfig WhitespaceProcessingMode has changed from AUTOMATIC to NORMALIZE.
In DocBookCompare: All advanced capabilities such as Diagram Processing, Image Processing, Table Processing are disabled by default. Should an UnavailableCapabilityException appear please contact us through the support portal.
In ImageConfiguration, showImageChangesAtMediaObjectLevel now defaults to true.

Java API

DocBook comparison is now configured using a hierarchical object based approach as opposed to the flat list of parameters used by DocBook Compare (see the translation table for full details).

Translation Table

Original Parameter Name	New Path (classes in `com.deltaxml.docbook.config`)
`validate-inputs`	`AdvancedParameters → Validation → set / is validateInputs`
`enable-xinclude`	`AdvancedParameters → AdvancedBehaviour → set / is enableXInclude`
`word-by-word`	Removed - `word-by-word` is always on.
`detect-moves`	`MovesConfig → set / is detectMoves`
`remove-move-source`	`MovesConfig → set / is removeMoveSource`
`ignore-inline-formatting`	`FormattingElementsConfig → set / is ignoreInlineFormatting`
`cals-table-processing`	`TableConfig → set / is calsTableProcessing`
`html-table-processing`	`TableConfig → set / is htmlTableProcessing`
`grouping`	`OutputParameters → set / is grouping`
`output-format`	`OutputParameters → set / get outputFormat`
`indent`	`OutputParameters → set / is indentOutput`
`whitespace-processing-mode`	`TextComparisonConfig → set / get whitespaceProcessingMode`
`warning-report-mode`	`AdvancedParameters → Validation → set / get warningReportMode`
`keying-mode`	`AdvancedParameters → Alignment → set / get keyingMode`
`show-non-phrase-changes`	`OutputParameters → PhraseChanges → set / is showNonPhraseChanges`
`additional-phrase-containers`	`OutputParameters → PhraseChanges → set / get additionalPhraseContainers`
`inline-formatting-elements`	`FormattingElementsConfig → set / get inlineFormattingElements`
`add-inline-formatting-elements`	`FormattingElementsConfig → set / get addInlineFormattingElements`
`remove-inline-formatting-elements`	`FormattingElementsConfig → set / get removeInlineFormattingElements`
`invalid-table-behaviour`	`TableConfig → set / get invalidTableBehaviour`
`tracked-changes-author`	`OutputParameters → TrackedChanges → set / get trackedChangesAuthor`
`tracked-changes-date`	`OutputParameters → TrackedChanges → set / get trackedChangesDate`
`oxygen-tcs-version`	`OutputParameters → TrackedChanges → set / get oxygenTcsVersion`
`oxygen-tcs-deleted-space-mode`	`OutputParameters → TrackedChanges → set / get oxygenTcsDeletedSpaceMode`
`xmetal-tcs-table-change-mode`	`OutputParameters → TrackedChanges → set / get xmetalTcsTableChangeMode`
`framemaker-tcs-table-change-mode`	`OutputParameters → TrackedChanges → set / get framemakerTcsTableChangeMode`
`preservation-mode`	`OutputParameters → set / get preservationMode`
`unmarked-change-mode`	`AdvancedParameters → SelectingUnrepresentableChange → set / get unmarkedChangeMode`
`modified-attribute-mode`	`AdvancedParameters → SelectingUnrepresentableChange → set / get modifiedAttributeMode`
`xml-version-declaration`	`AdvancedParameters → AdvancedBehaviour → set / get xmlVersionDeclaration`
`output-encoding-declaration`	`AdvancedParameters → AdvancedBehaviour → set / get outputEncodingDeclaration`
`standalone-declaration`	Removed
`image-compare`	`ImageConfiguration → set / is imageComparedEnabled`
`show-image-changes-at-mediaobject-level`	`ImageConfiguration → set / is showImageChangesAtMediaObjectLevel`
`output-image-ref-form`	`ImageConfiguration → set / get outputImageRefForm`
`output-image-ref-favour-source-doc`	`ImageConfiguration → set / get outputImageRefFavourSourceDoc`
`show-image-changes-at-mediaobject-parent-level`	`ImageConfiguration → set / is showImageChangesAtMediaObjectParentLevel`
`media-object-parents-list`	`ImageConfiguration → set / get mediaObjectParentsList`
`mathml-processing`	`MathMLConfig → set / is mathmlProcessing`
`mathml-granularity`	`MathMLConfig → set / get mathmlGranularity.`
`svg-processing`	`SVGConfig → set / is compareSVG`
`svg-granularity`	`SVGConfig → set / get svgGranularity`
`svg-fallback`	`SVGConfig → set / is svgFallback`
`svg-fallback-change-percentage`	`SVGConfig → set / get svgFallbackChangePercentage`
`input-a-svg-markup-style`	`SVGConfig → set / get inputASVGMarkupStyle`
`input-b-svg-markup-style`	`SVGConfig → set / get inputBSVGMarkupStyle`
`z-index-svg-markup-style`	`SVGConfig → set / get zIndexSVGMarkupStyle`
`svg-z-index`	`SVGConfig → set / is svgZIndex`
`svg-numeric-tolerance`	`SVGConfig → set / is svgNumericTolerance`
`svg-numeric-tolerance-value`	`SVGConfig → set / get svgNumericToleranceValue`
`mark-cals-table-cell-span-extent-changes`	`TableConfig → set / is markCalsTableCellSpanExtentChanges`
`mark-html-table-cell-span-extent-changes`	`TableConfig → set / is markHtmlTableCellSpanExtentChanges`
`character-by-character`	`TextComparisonConfig → set / is characterByCharacter`

Other Java API changes that apply to all legacy products are listed here.

REST

Endpoint Changes

/api/docbook-compare/v1/compare → /api/compare/docbook

The default configuration file name has changed from default-configuration.xml to default-docbook-configuration.xml. This location can still be configured with the same system property com.deltaxml.docbook.rest.defaultConfiguration.

Configuration File Changes

Old element / behaviour	New element / behaviour	Change type
Parameter values given as attributes	Parameter values given as plain PCDATA	Attributes are no longer used within the configuration file
`textComparison`	`textComparisonConfig`	Renamed
`wordByWord`	—	Removed
`tableComparison`	`tableConfig`	Renamed
`formattingElements`	`formattingElementsConfig`	Renamed
`svgComparison`	`svgConfig`	Renamed
`SvgComparisonGranularity`	`zIndexSVGMarkupStyle`	Renamed
`SVGFallback`	`svgFallback`	Renamed
`SVGFallbackChangePercentage`	`svgFallbackChangePercentage`	Renamed
`InputASVGMarkupStyle`	`inputASVGMarkupStyle`	Renamed
`InputBSVGMarkupStyle`	`inputBSVGMarkupStyle`	Renamed
`SVGZIndex`	`svgZIndex`	Renamed
`ZIndexSVGMarkupStyle`	`zIndexSVGMarkupStyle`	Renamed
`SVGNumericTolerance`	`svgNumericTolerance`	Renamed
`SVGNumericToleranceValue`	`svgNumericToleranceValue`	Renamed
`moves`	`movesConfig`	Renamed
`mathml`	`mathmlConfig`	Renamed
`imageComparison`	`imageConfiguration`	Renamed
`imageCompare`	`imageCompareEnabled`	Renamed
`common` (within `outputParameters`)	—	Removed; its parameters have been moved up to become children of `outputParameters` itself
`alignment`	`alignment`	Moved from `comparisonParameters` to `advancedParameters`
`standaloneDeclaration`	—	Removed

It is recommended that you load the provided XSD into your editor to help you migrate any existing configuration files.

Other REST changes that apply to all legacy products are listed here.

CLI

When doing a DocBook comparison from the command line, it is now required to use a configuration file if you wish to modify any parameters. An XSD and sample configuration is provided as part of the distribution to help you write a config file. Refer to the https://deltaxml.atlassian.net/wiki/spaces/DeltaNova/pages/5147164673/Migrating+to+DeltaNova#Translation-Table above for specific parameters equivalents.

Bash

java -jar deltaxml-docbook-x.y.z.jar compare inputA.xml inputB.xml result.xml \
    (parameter=value)*

becomes

Bash

java -jar deltanova-YEAR.x.y.z.jar compare docbook inputA.xml inputB.xml result.xml \
    (config.xml)?

DITA Compare

Default value changes:

For DitaTopicCompare, DitaMapfileCompare and DitaMapTopicsetCompare, in TextComparisonConfig WhitespaceProcessingMode has changed from AUTOMATIC to NORMALIZE.
In DitaTopicCompare and DitaMapTopicsetCompare: SVG processing, CALS table processing and image processing are now disabled by default.

Java API

DITA comparison is now configured using a hierarchical object-based approach as opposed to the flat list of parameters used by DITA Compare (see the translation table for full details).

The com.deltaxml.dita.DitaCompare class no longer exists in favour of three separate classes for each comparison type:

com.deltaxml.dita.DitaTopicCompare
com.deltaxml.dita.DitaMapfileCompare
com.deltaxml.dita.DitaMapTopicsetCompare

Translation Table

Original Parameter Name	New Path (classes in `com.deltaxml.dita.config`)
`validate-inputs`	`AdvancedParameters → Validation → set / is validateInputs`
`use-ids-as-keys`	`DitaConfig → set / is useIdsAsKeys`
`force-specialization`	`AdvancedParameters → AdvancedBehaviour → set / is forceSpecialization`
`grouping`	`OutputParameters → set / is grouping`
`output-format`	`OutputParameters → set / get outputFormat`
`indent-output`	`OutputParameters → set / is indentOutput`
`whitespace-processing-mode`	`TextComparisonConfig → set / get whitespaceProcessingMode`
`remove-rev-attribute-regex`	`DitaConfig → set / get removeRevAttributeRegex`
`add-status-atts`	`OutputParameters → DitaMarkup → set / is addStatusAtts`
`add-revision-atts`	`OutputParameters → DitaMarkup → set / is addRevisionAtts`
`add-outputclass-atts`	`OutputParameters → DitaMarkup → set / is addOutputClassAtts`
`old-revision`	`OutputParameters → DitaMarkup → set / get oldRevision`
`new-revision`	`OutputParameters → DitaMarkup → set / get newRevision`
`old-outputclass`	`OutputParameters → DitaMarkup → set / get oldOutputClass`
`new-outputclass`	`OutputParameters → DitaMarkup → set / get newOutputClass`
`old-version-atts`	`OutputParameters → DitaMarkup → set / get oldVersionAtts`
`new-version-atts`	`OutputParameters → DitaMarkup → set / get newVersionAtts`
`phrase-element-name`	`OutputParameters → DitaMarkup → set / get phraseElementName`
`phrase-container-exclusions`	`OutputParameters → DitaMarkup → set / get phraseContainerExclusions`
`show-non-phrase-changes`	`OutputParameters → DitaMarkup → set / get showNonPhraseChanges`
`include-deleted`	`OutputParameters → DitaMarkup → set / is includeDeleted`
`tracked-changes-author`	`OutputParameters → TrackedChanges → set / get trackedChangesAuthor`
`tracked-changes-date`	`OutputParameters → TrackedChanges → set / get trackedChangesDate`
`oxygen-tcs-version`	`OutputParameters → TrackedChanges → set / get oxygenTcsVersion`
`oxygen-tcs-deleted-space-mode`	`OutputParameters → TrackedChanges → set / get oxygenTcsDeletedSpaceMode`
`xmetal-tcs-table-change-mode`	`OutputParameters → TrackedChanges → set / get xmetalTcsTableChangeMode`
`framemaker-tcs-table-change-mode`	`OutputParameters → TrackedChanges → set / get framemakerTcsTableChangeMode`
`preservation-mode`	`OutputParameters → set / get preservationMode`
`unmarked-change-mode`	`AdvancedParameters → SelectingUnrepresentableChange → set / get unmarkedChangeMode`
`modified-attribute-mode`	`AdvancedParameters → SelectingUnrepresentableChange → set / get modifiedAttributeMode`
`xml-version-declaration`	`AdvancedParameters → AdvancedBehaviour → set / get xmlVersionDeclaration`
`output-encoding-declaration`	`AdvancedParameters → AdvancedBehaviour → set / get outputEncodingDeclaration`
Topic & Map Topicset Specific Parameters
`word-by-word`	Removed - `word-by-word` is always on.
`cals-table-processing`	Removed - Use `TableConfig → set / is enableTableProcessing`
`html-table-processing`	Removed - Use `TableConfig → set / is enableTableProcessing`
`warning-report-mode`	`AdvancedParameters → Validation → set / get warningReportMode`
`steps-conflict-resolution`	`DitaConfig → set / get stepsConflictResolution`
`topic-public-id`	`AdvancedParameters → AdvancedBehaviour → set / get topicPublicId`
`topic-system-id`	`AdvancedParameters → AdvancedBehaviour → set / get topicSystemId`
`map-context-href`	`TopicConfig → set / get mapContextHref`
`invalid-table-behaviour`	`TableConfig → set / get invalidTableBehaviour`
`deleted-id-suffix`	`TopicConfig → set / get deletedIdSuffix`
`added-id-suffix`	`TopicConfig → set / get addedIdSuffix`
`ignore-inline-formatting`	`FormattingElementsConfig → set / is ignoreInlineFormatting`
`inline-formatting-elements`	`FormattingElementsConfig → set / get inlineFormattingElements`
`add-inline-formatting-elements`	`FormattingElementsConfig → set / get addInlineFormattingElements`
`remove-inline-formatting-elements`	`FormattingElementsConfig → set / get removeInlineFormattingElements`
`detect-moves`	`MovesConfig → set / is detectMoves`
`remove-move-source`	`MovesConfig → set / is removeMoveSource`
`move-source-revision`	`MovesConfig → set / get moveSourceRevision`
`move-target-revision`	`MovesConfig → set / get moveTargetRevision`
`mathml-processing`	`MathMLConfig → set / is mathmlProcessing`
`mathml-granularity`	`MathMLConfig → set / is mathmlGranularity`
`image-compare`	`ImageConfiguration → set / is imageCompareEnabled`
`output-image-ref-form`	`ImageConfiguration → set / get outputImageRefForm`
`strict-task-model`	`DitaConfig → set / is strictTaskModel`
`svg-processing`	`SVGConfig → set / is compareSVG`
`svg-granularity`	`SVGConfig → set / get svgGranularity`
`svg-fallback`	`SVGConfig → set / is svgFallback`
`svg-fallback-change-percentage`	`SVGConfig → set / get svgFallbackChangePercentage`
`input-a-svg-markup-style`	`SVGConfig → set / get inputASVGMarkupStyle`
`input-b-svg-markup-style`	`SVGConfig → set / get inputBSVGMarkupStyle`
`invalid-referenced-svg-behaviour`	`SVGConfig → set / get invalidReferencedSVGBehaviour`
`z-index-svg-markup-style`	`SVGConfig → set / get zIndexSVGMarkupStyle`
`svg-z-index`	`SVGConfig → set / is svgZIndex`
`svg-numeric-tolerance`	`SVGConfig → set / is svgNumericTolerance`
`svg-numeric-tolerance-value`	`SVGConfig → set / get svgNumericToleranceValue`
`character-by-character`	`TextComparisonConfig → set / is characterByCharacter`
Map Topicset Specific Parameters
`map-scan-topics-for-references`	`MapParameters → set / is mapScanTopicsForReferences`
`map-result-origin`	`MapParameters → set / get mapResultOrigin`
`map-result-structure`	`MapParameters → set / get mapResultStructure`
`map-pair-remaining-map-name`	`MapParameters → set / get mapPairRemainingMapName`
`map-clean-temp`	`MapParameters → set / get mapCleanTemp`
`map-backup-suffix`	`MapParameters → set / get mapBackupSuffix`
`map-copy-scope`	`MapParameters → set / get mapCopyScope`
`map-uncompared-topic-markup`	`MapParameters → set / get mapUncomparedTopicMarkup`
`map-topic-exception-propagation-mode`	`MapParameters → set / get mapTopicExceptionPropagationMode`
Mapfile Specific Parameters
`map-public-id`	`MapfileParameters → set / get mapPublicId`
`map-system-id`	`MapfileParameters → set / get mapSystemId`

Other Java API changes that apply to all legacy products are listed here.

REST

Endpoint Changes

/api/dita-compare/v1/compare/X → /api/compare/dita/X

Configuration File Changes

Old element / behaviour	New element / behaviour	Change type
Attributes used for parameter values	Plain PCDATA parameter values (except `versionAtt`)	Structural change
`textComparison`	`textComparisonConfig`	Renamed
`wordByWord`	—	Removed
`tableComparison`	`tableConfig`	Renamed
`calsTableProcessing`, `htmlTableProcessing`	`enableTableProcessing`	Removed — replaced
`ditaConfiguration`	`ditaConfig`	Renamed
`formattingElements`	`formattingElementsConfig`	Renamed
`svgComparison`	`svgConfig`	Renamed
`svgComparisonGranularity`	`svgGranularity`	Renamed
`getSVGZIndex`	`svgZIndex`	Renamed
`isNumericToleranceEnabled`	`svgNumericTolerance`	Renamed
`elementMoves`	`movesConfig`	Renamed
`mathml`	`mathmlConfig`	Renamed
`imageComparison`	`imageConfiguration`	Renamed
`enabled` attribute on `imageComparison`	`imageEnabled` child of `imageConfiguration`	Restructured
`common` section within `outputParameters`	Parameters moved up as direct children of `outputParameters`	Removed — restructured
`trackedChangedAuthor`	`trackedChangesAuthor`	Renamed
`newOutputclass`	`newOutputClass`	Renamed
`alignment` under `comparisonParameters`	`alignment` under `advancedParameters`	Moved

It is recommended that you load the provided XSD into your editor to help you migrate any existing configuration files.

Other REST changes that apply to all legacy products are listed here.

CLI

When doing a DITA comparison from the command line, it is now required to use a configuration file if you wish to modify any parameters. An XSD and sample configuration is provided as part of the distribution to help you write a configuration file. Refer to the https://deltaxml.atlassian.net/wiki/spaces/DeltaNova/pages/5147164673/Migrating+to+DeltaNova#Translation-Table.1 above for specific parameters equivalents.

Bash

java -jar deltaxml-dita-x.y.z.jar compare {topic|mapfile|mts} inputA inputB result \
    (parameter=value)*

becomes

Bash

java -jar deltanova-YEAR.x.y.z.jar compare {topic|mapfile|mts} inputA.xml inputB.xml result.xml \
    (config.xml)?

XML Merge

Default Value Changes

In ConcurrentMerge, SequentialMerge and ThreeWayMerge, CALS and HTML table processing is now disabled by default.

Java API

com.deltaxml.mergecommon.MergeCommon and com.deltaxml.mergecommon.MergeBase no longer have generic parameters for the exceptions that they throw. The exceptions are now common across DeltaNova.

Other Java API changes that apply to all legacy products are listed here.

REST

The way Merge is configured via REST has changed to be more similar to other capabilities in DeltaNova. Rather than setting parameters directly in the structured request (XML or JSON) or via dedicated body parts for each parameter in the multipart request, Merge is now configured using a configuration file. An XSD and sample configuration is provided as part of the distribution. Refer to the DeltaNova Postman Collection for passing the configuration file to the REST API.

Endpoint Changes

/api/xmlmerge/v1/types/X → /api/merge/xml/types/X
/api/xmlmerge/v1/types has been removed.

Other REST changes that apply to all legacy products are listed here.

CLI

Bash

java -jar deltaxml-merge-x.y.z.jar merge {concurrent|sequential|concurrent3} \
    <ancestorName/version1Name> <ancestorFile/version1File> \
    (<versionName> <versionFile>)+ \
    <resultFile> <params>

Replace the jar in the command above with deltanova-YEAR.x.y.z.jar.

Parameter names have been changed from PascalCase to kebab-case e.g. ResultFormat → result-format. Parameter values remain the same.

DITA Merge

Default Value Changes

In ConcurrentMerge, SequentialMerge and ThreeWayMerge, CALS and HTML table processing is now disabled by default.

Java API

com.deltaxml.mergecommon.MergeCommon and com.deltaxml.mergecommon.MergeBase no longer have generic parameters for the exceptions that they throw. The exceptions are now common across DeltaNova.

Other Java API changes that apply to all legacy products are listed here.

REST

The way Merge is configured via REST has changed to be more similar to other capabilities in DeltaNova. Rather than setting parameters directly in the structured request (XML or JSON) or via dedicated body parts for each parameter in the multipart request, Merge is now configured using a configuration file. An XSD and sample configuration is provided as part of the distribution. Refer to the DeltaNova Postman collection for passing the configuration file to the REST API.

Endpoint Changes

/api/ditamerge/v1/types/X → /api/merge/dita/types/X
/api/ditamerge/v1/types has been removed.

Other REST changes that apply to all legacy products are listed here.

CLI

Bash

java -jar deltaxml-dita-merge-x.y.z.jar merge {concurrent|sequential|concurrent3} \
    <ancestorName/version1Name> <ancestorFile/version1File> \
    (<versionName> <versionFile>)+ \
    <resultFile> <params>

becomes

Bash

java -jar deltanova-YEAR.x.y.z.jar merge dita-{concurrent|sequential|concurrent3} \
    <ancestorName/version1Name> <ancestorFile/version1File> \
    (<versionName> <versionFile>)+ \
    <resultFile> <params>

Notice the additional dita- prefix for the merge type to distinguish from the generic XML merge types.

Parameter names have been changed from PascalCase to kebab-case e.g. ResultFormat → result-format. Parameter values remain the same.

HTML Compare

HTML Compare was previously only accessible via a REST API, there is now the ability to use it via a Java API and via the CLI. Run java -jar deltanova-year.x.y.z.jar describe html to learn how to use the CLI for comparing HTML.

Default Value Changes

Image comparison, SVG Comparison and table comparison are now disabled by default.

The Java system property controlling the location of the default configuration file has been renamed from default-configuration to com.deltaxml.htmlcompare.rest.defaultConfiguration and a default value has been given as default-html-configuration.xml.

Configuration File Changes

Attributes are no longer used within the configuration file.
Parameter values are now given as plain PCDATA.

It is recommended that you load the provided XSD into your editor to help you migrate any existing configuration files.

Endpoint Changes

/api/html-compare/v1/compare → /api/compare/html.

Other REST changes that apply to all legacy products are listed here.

ConversionQA

ConversionQA is now known as DeltaNova Check or simply Check.

The version of DITA OT included with DeltaNova has been updated to the latest at the time of writing - 4.4. We have patched DITA OT to better integrate it into DeltaNova:

Removed an <xsl:message> instruction in the /xsl/normalize.xsl stylesheet of the org.dita.normalize plugin to reduce console noise.
Removed META-INF/services/org.apache.xerces.xni.parser.XMLParserConfiguration from lib/dost.jar to prevent conflicts with the XML parser shipped with DeltaNova.

Java API

The rename is reflected in the Java package name: com.deltaxml.conversionqa -> com.deltaxml.deltacheck.

Classes within the com.deltaxml.deltacheck package have generally lost their Conversion prefix e.g. com.deltaxml.conversionqa.ConversionChecker → com.deltaxml.deltacheck.Checker.

Methods on com.deltaxml.deltacheck.Checker have been renamed:

checkConversion → check
addConversionCheckerProgressListener → addCheckerProgressListener
removeConversionCheckerProgressListener → removeCheckerProgressListener

Other Java API changes that apply to all legacy products are listed here.

REST

The REST server is no longer runnable via the CLI interface - it should be started by using the unified DeltaNova REST server jar.

Endpoint Changes

/api/conversionqa/v1/check → /api/check.

Other REST changes that apply to all legacy products are listed here.

CLI

Bash

java -jar deltaxml-conversion-qa-x.y.z.jar check \
    docx --file mydoc.docx \
    ditamap --file mydoc.zip --mapfile mydoc/mydoc.ditamap [parameter=value]*

becomes

java -jar deltanova-YEAR.x.y.z.jar check \
    docx mydoc.docx \
    ditamap mydoc.zip mydoc/mydoc.ditamap [parameter=value]*

Notice the removal of the --file / -f option after an input type (docx, xml or ditamap) and the removal of --mapfile / -m. The arguments to the ditamap input type are now positional and required to be in the order: zip, path to master map.