Custom export

Note: Dossier-Organizer does not provide any intents by default.

With intents, you can manipulate the behaviour of Dossier Organizer depending on the workflow you are using it in.

Export Intent

This intent can override the default export behaviour. The default export process combines all output documents into a single downloadable PDF file. With an export intent you can change this behaviour to trigger another job when the user decides to trigger the export process. To transport your intention you can add a URL parameter to the Dossier-Organizer URL with an existing collection:

https://dossier-organizer.levigo.de/view/<collection-id>?export-intent=<custom-job-template>

The custom-job-template placeholder for the export-intent parameter can define a Jadice Flow job template containing one or multiple steps of workers. To define your template and make it available in your deployment.

Caution: Current implementation supports the export resulting in a single PDF file. Be careful when using intent resulting in multiple files, as the Dossier-Organizer will not be able to provide links to the individual files.

Configuration

You need to add two configuration files to your deployment:

1. workers.yaml contains a definition of available workers and their configuration. As an example the default configuration looks like this and defines a single worker named fusionCollectionExport:

jadice-flow.workers:
  workerDefinitions:
    - workerName: "fusionCollectionExport"
      description: "Creates a single PDF export for a fusion collection"
      processorClass: "com.jadice.flow.controller.server.processor.RemoteItemProcessor"
      workerURL: "http://jf-worker-topdf"
      infoTags:
        - "ITEM_BASED"
        - "IMAGE_PROCESSING"
        - "REMOTE"
      workerParameters:
        - name: "pdfaConformanceLevel"
          type: "com.jadice.flow.worker.topdf.settings.Conformance"
          subTypes: null
          value: "PDF/A 2b"
          description: "PDF-A conformance level"
        - name: "isCollection"
          type: "java.lang.String"
          subTypes: null
          value: "\"true\""
          description: "PDF export settings"
        - name: "pdfStructureReaderSettings"
          type: "com.jadice.flow.worker.topdf.settings.PDFStructureReaderSettingsDTO"
          subTypes: null
          value: "{\"readStrategy\":null}"
          description: "PDF reader settings. LENIENT-Mode enables to read some documents with structural defects"
        - name: "outputMode"
          type: "com.jadice.flow.worker.topdf.settings.OutputMode"
          subTypes: null
          value: "\"JOINED\""
          description: "PDF export output mode. Generate one stream per page or join all incoming documents together."
        - name: "validationSettings"
          type: "com.jadice.flow.worker.topdf.settings.ValidationSettingsDTO"
          subTypes: null
          value: "{\"performValidation\":false,\"validationMode\":\"PAGE_COUNT_AND_HASH\",\"validationModeFailureAction\":\"FAIL\"}"
          description: "Validation settings"

2. jobtemplates.yaml contains a definition of available job templates which contain the process steps and refer to the workers defined above. As an example the default configuration looks like this and defines a job named fusionCollectionExport:

jadice-flow.jobs:
  jobTemplates:
    - jobName: "fusionCollectionExport"
      description: "This worker exports document(s) and publishes them to the configured export target(s)."
      properties: {}
      enabled: true
      stepTemplates:
        - stepName: "fusionCollectionExport"
          workerDefinitionName: "fusionCollectionExport"
          inputMimeTypes: []
          inputFilterJson: null
          expectsNewPartResult: true
          markSrcAsMetaOnResult: true
          parameters:
            - name: "pdfaConformanceLevel"
              type: "com.jadice.flow.worker.topdf.settings.Conformance"
              subTypes: null
              value: "\"PDFA2b\""
              description: "PDF-A conformance level"
      jobFlow:
        - from: null
          "on": "*"
          to: "fusionCollectionExport"

For more information about workers and job templates please refer to the Jadice Flow documentation here.

To add these files to your deployment see.