Skip to content

User Manual

Sinbad Adjuik edited this page Apr 6, 2026 · 1 revision

User Manual

Main Window

The main window is organized around the current workflow model:

  • workflow selector
  • selected-folder summary
  • action buttons
  • run status

Choose the workflow before selecting the folder so the scan matches the correct batch type.

Photo Workflow

Expected input:

  • image files
  • XML metadata files
  • manifest.ini

Behavior:

  • source files remain unchanged
  • photo assets are converted to TIFF in an output-side scratch workspace
  • ZIPs contain TIFF + XML + manifest.ini

Patent Workflow

Expected input:

  • one or more patent XML files in a batch directory
  • one shared manifest.ini in the same batch directory
  • matching patent PDFs locally or in fallback search roots

Behavior:

  • package name comes from XML IID
  • XML filename stem must match the IID
  • normalized XML document ID must match the IID
  • manifest must contain the required package fields
  • ZIPs contain PDF + XML + manifest.ini

Run Modes

Dry Run

  • creates only the CSV report
  • creates no ZIP files
  • useful for first-pass validation

Staging

  • writes ZIPs to staging_output/
  • intended for review

Production

  • writes ZIPs to output/
  • intended for final ingest

Output Locations

For the selected folder:

  • staging_output/
  • output/

Temporary photo conversion work may appear under:

  • .work/

inside the active output directory during the run. It is cleaned up after successful processing.

Reports And Logs

The application writes:

  • CSV batch report
  • batch_tool.log
  • batch_process_summary.log

Use the CSV report to see:

  • successes
  • warnings
  • missing files
  • invalid manifest conditions
  • patent PDF lookup failures

Last updated: April 6, 2026

Clone this wiki locally