Align order of workfiles on the visual

XMLWordPrintable

    • Medium
    • None
    • Hide
      7.42.0: Visual: Align the order of workfiles on the visual
      7.42.1: Fix for loading of visual files in the UI
      Show
      7.42.0: Visual: Align the order of workfiles on the visual 7.42.1: Fix for loading of visual files in the UI
    • None

      Problem
      When a task with a visual includes several workfiles, often the order of workfiles (which is by workfile-filename) does not suite the order of text in the visual

      Solution
      Utilizing the possibilities to reorder the workfiles in the API, we align the order. We use the segment-mapping that is gathered during the visual in a seperate worker, that runs as the last worker in the visual. This worker is queued, if there are more than one workfiles and more than one page in the mapping. That means, we can achieve this, if the visual was created from a multipage PDF, a multifile HTML/URL or Image/OCR import.
      The worker will gather heuristically the needed order of workfiles and reorder the workfiles if needed.
      There should be a configuration that enables this step with a default of 1/activated

      Problems/Limitations

      When the uploaded workfiles are nested in folders, they maybe cannot be ordered to be aligned. To solve this, the general strategy is, to unwrap nested files that need to be aligned. This of course changes the structure of the export. We need a second config, that allows unwrapping of nested files.

      It can happen, that nested files cannot be unwrapped because of naming-collisions or because unwrapping is not allowed. In this case the alignment is skipped and an error is written to the task-log. In case nested files had to be unwrapped, a warning is written to the task-log

      The alignment shall try to follow the sequence of segments as they appear, although that will not be possible with workfiles, that contain content from several padges in the visual. In that case the first appearance in the pages flow will steer the position of the workfile in the aligned order.

      IMPLEMENTATION DETAILS

      The feature is generally active, the config to deactivate is: runtimeOptions.plugins.VisualReview.alignWorkfilesOrder

      To allow uwrapping of nested workfiles (by default not allowed): runtimeOptions.plugins.VisualReview.alignWorkfilesAllowUnwrap

       

      FRONTEND TESTING

      There is testdata for the issue available in nextcloud/Developer/test-data/visual/testdata-align-workfiles 

      However, it would be better, if for testing the feature own testdata is created (e.g. by creating PDFs with writer & some textfiles) since the testdata in the nextcloud was used for development and is used for the API-test.

      Also, the visual exchange need to be tested, as it also alignes the workfiles ...

       

            Assignee:
            Axel Becher
            Reporter:
            Axel Becher
            None
            None
            Aleksandar Mitrev, Thomas Lauria
            Stephan Bergmann
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved:
              None
              None