The DeltaXML compare workflow action is a solution that can compare two Typefi Content XML (.cxml) or XML files, producing an output delta file (.xml) that highlights the differences between the two files. You can use the DeltaXML compare workflow action to run comparisons either with default settings or with a customised DeltaXML Document Comparator Pipeline (DCP) to set specific parameters that influence which XML changes you see. This enables you to tailor the comparison process to your specific needs and preferences.
Running the default DeltaXML comparison
The DeltaXML plug-in uses the DeltaXML compare workflow action by default to compare XML files (A and B) and generates an output delta file (C) that shows all structural and content changes between the files.
Using a DeltaXML Document Comparator Pipeline (DCP)
While the default settings of the DeltaXML compare workflow action enable you to compare all possible changes, there may be situations where you don’t need certain changes to appear in the output delta file.
Adding a DeltaXML DCP as a resource to Typefi's DeltaXML compare action allows you to set parameters that ignore specific differences you don't need to highlight in your output XML file.
Use case for customised pipelines
Let’s say there are two acceptable styles of writing a trademark symbol in your organisation. In one document (file A), a superscript TM, is used, while in another version (file B), a different writer uses the symbol ™. Both variations are acceptable to your organisation, and you don’t need to see A!=B for every instance where a superscript TM or the symbol ™ is used differently between the two files.
By using a customised pipeline, you can exclude this type of change from appearing in the delta output file since you don't need to track the difference.
To build a DeltaXML document comparator pipeline, follow these guidelines from DeltaXML Compare. Need help building a DeltaXML DCP? Contact your Typefi Solutions Consultant to discuss how we can help!
Add customised pipelines
If there are XML changes that you would like to exclude from the delta output, you can add an XZIP file containing a DCP and optional XSLT filters to the Resources field. By adding customisations, your delta output file will show changes based on the parameters set by your organisation, allowing you to customise the comparison process to your specific needs and preferences.
DeltaXML compare user interface
Adding customisations to the Resources field is optional. If you want to run a DeltaXML comparison, simply leave the resources field empty.
|Input 1||The file path to the first input Typefi Content XML (.cxml) or XML file (.xml)
Click the Choose File or Folder icon to select the Typefi Content XML or XML file. Alternatively, enter the file path —for example, Input/my-input.cxml or Input/my-input.xml.
|Input 2||The file path to the input Typefi Content CXML (.cxml) or XML file (.xml) you want to compare with Input 1. Click the Choose File or Folder icon to select the Typefi Content XML or XML file to compare. Alternatively, enter the file path —for example, Input/my-input.cxml or Input/my-input.xml.|
|Resources||To run a default comparison, leave the Resources field empty.
Add optional DCP pipelines (.dcp) and other configuration files that contain XSLT filters as ZIP (.zip) or XZIP files(.xzip). You can set Boolean, string parameters, and XSLT filters.
The output delta file (.xml) compares Input 1 and Input 2. The default name is output-1.xml.
Create a custom output file name by using the variables menu.
Updating DeltaXML workflow actions
Customers who are currently using earlier versions of Delta XML workflow actions, STS redline and Compare XML and wish to upgrade to the DeltaXML plug-in (v8) will need to follow these steps:
First, update the DeltaXML workflow actions to ensure that you have access to the new features of DeltaXML compare (v14). Please refer to the article, Update a workflow action for guidance.
Next, contact your Typefi Solutions Consultant to update your DCP resources. After the update, your DeltaXML workflows may not run as expected until you add the resources.
For more information about the DeltaXML plug-in (v8 or later) and the DeltaXML compare workflow action, contact us. We are happy to help!