To create a Fixup and use it in the Workflow, a KFPX file is needed in which the Fixup or the check is described. To do this, use the callas pdfToolbox program. This allows you to put together the desired Fixup according to your ideas and then export the profile as a kfpx file.

For this description, we have already created a Fixup using callas pdfToolbox and then exported it. The aim of this Fixup is to rotate the page 90° clockwise.

The sample files are available for download in 3. Sample files.

After the KFPX file has been created, the XML file must be added. Among other things, the automationKey [4] – which has to be unique throughout the entire Workflow is defined in the XML file. Fixups can only be used if both the KFPX file and the corresponding XML file are uploaded to the Workflow.

The basic structure of an XML file is always the same. It is only extended by the description of the individual variables or elements in the XML.

Figure 1: Left: The XML file for the Fixup Page Rotated 90 Clockwise; Right: The Fixup's dialog in the Workflow

The following basic structure must be present in the XML file for the Fixup, without a controllable variable, to work in the Workflow:

• Version and encoding [1] – this line is present in every XML file and is typically the first line in an XML file. Among other things, it defines the character encoding – UTF-8 – of the file.
• Author, version, and modified [2] – for traceability, this describes who created this file (Author), which version of the file it is (Version), and when the file was created (modified).
• Variable Analyze Mode [3] – defines the style in which the Fixup dialog is to be set up. If you enter XML_BASED_V2, the dialog is set up in the style of the new user interface (available from 01/2023). This means that the dialogs will look the same as the ones you are already familiar with from the other Fixups.

• automationKey [4] – this line defines the automationKey, which is needed, among other things, to call up the Fixup via the Rest API. Please note that this automationKey must be unique and cannot occur a second time in the Workflow!
• Name of Fixup [5] – this is used to determine the name of the Fixup. The name entered here is ultimately displayed in the Workflow in the list of Fixups.  In principle, the Fixup can be translated into all languages offered in the Workflow. The English translation is mandatory. The Fixup will not work without the English description, even if all other languages have been translated. If a language is not translated, the English translation is used instead.
• Description of Fixup [6] – Enter a description of the Fixup here. This is the short informational text that you will find for each Fixup.
• FixupResultMode/checkResultMode [7] – These two lines must currently be included in the XML. They are required for internal Workflow processes and are therefore essential.
  • <FixupResultMode>DEFAULT_CHECKIN</FixupResultMode> – determines that the check-in profile used for uploading is re-applied after the Fixup has been executed.
  • <checkResultMode>APPEND_RESULT_ALL</checkResultMode> – determines that all messages and additional files resulting from the Fixup are loaded for the respective Article/Print Item.
• Fixup [8] – the individual Fixups are entered in this area. The minimum entry for a Fixup can be seen in the example XML file. For more extensive Fixups, values or variables can also be added.
  The following attributes must be assigned for a Fixup:
  • Key – define the unique key for this Fixup here.
    • This key must be unique in the Fixup and therefore must not be the same as the automationKey!
    • Please note that this key must also be unique in a Fixup Chain! Therefore, consider using your own consistent naming convention for naming Fixups!
  • execute – attribute indicates whether the Fixup is executed or not. Therefore, only the values true or false can be specified. true stands for execute and false for not execute.
  • sortIndex – attribute is used to specify the positioning of the Fixup within the dialog. This value comes into play when several Fixups from the pdfToolbox are used for a Fixup in the Workflow.
  • hidden – this attribute indicates whether the Fixup is visible in the Workflow or not. Therefore, only the values true or false can be specified. true stands for hide and false for display. This allows you to determine whether a Fixup, which is applied, should not be displayed.