PDF Enhancement Parameters
The PDF Enhancer uses a JSON-style configuration structure to control PDF processing, image enhancement, and file handling operations. This document describes all available configuration parameters organized by functional categories.
Overview
The PDF Enhancer uses a JSON-style configuration structure to control PDF processing, image enhancement, and file handling operations. This document describes all available configuration parameters organized by functional categories.
General Settings
Core configuration parameters for PDF processing behavior.
Parameter | Type | Default | Description |
---|---|---|---|
viesusIni | String | C:\ProgramData\Imaging Solutions\VIESUS\PDFEnhancer\IsEnhance.json | Location of the VIESUS configuration file |
archive | Boolean | 1 | Enable/disable archiving of processed files |
delete | Boolean | 1 | Enable/disable deletion of source files after processing |
debug | Boolean | 1 | Enable/disable debug mode and logging |
minFileSize | Integer | 20 | Minimum file size (KB) of images for processing |
destFileLog | Boolean | 0 | Enable destination file logging |
useColorRatio | Boolean | 0 | Enable color ratio analysis for artificial image detection |
colorRatioThres | Float | 0.05 | Threshold for color ratio analysis |
checkAdjacentImages | Boolean | 1 | Check for adjacent images to merge for enhancement |
adjacencyThres | Integer | 10 | Threshold for determining image adjacency (pixels) |
overlapThres | Integer | 10 | Threshold for determining image overlap (pixels) |
includeSoftMaskedImages | Boolean | 1 | Enable enhancement of images with soft masks |
streamReading | Boolean | 1 | Enable JPEG stream reading (disable for files with zipped images) |
skipFullPageBackground | Boolean | 1 | Skip background images that fill the entire page |
For boolean types: 0 = OFF | 1 = ON
Notes
- checkAdjacentImages: Should be disabled for very complex PDF files to avoid performance issues
- streamReading: May cause problems with PDFs containing compressed/zipped images
Resizing Configuration
Controls image resizing and enhancement parameters.
Parameter | Type | Default | Description |
---|---|---|---|
enable | Boolean | 1 | Enable/disable image resizing |
mode | Integer | 0 | Resizing mode |
threshold | Float | 1.2 | Resize factor to trigger AI Upscaling |
targetResolution | Integer | 300 | Target resolution in DPI |
maxFactor | Float | 16.0 | Maximum allowed resize factor |
maxTargetSize | Float | 500.0 | Maximum output file size (MB) |
removeArtifacts | Boolean | 0 | Enable artifact removal processing |
arMode | Integer | 2 | Artifact removal mode (see table below) |
Resizing Modes
Refer to the resizing modes described in the Viesus Image Enhancement - Parameter and CLI Reference.
Artifact Removal Modes
Mode | Behavior | Description |
---|---|---|
0 | Off | No artifact removal |
1 | Automatic | AI decides when to apply artifact removal |
2 | Always On | Apply artifact removal to all images |
Folder Configuration
Defines folder paths for PDF processing workflow.
Parameter | Type | Default | Description |
---|---|---|---|
srcFolder | String | C:\ProgramData\Imaging Solutions\VIESUS\PDFEnhancer\Folders\PDFHotFolder | Source folder for input PDF files |
destFolder | String | C:\ProgramData\Imaging Solutions\VIESUS\PDFEnhancer\Folders\PDFDestFolder | Destination folder for processed PDF files |
archiveFolder | String | C:\ProgramData\Imaging Solutions\VIESUS\PDFEnhancer\Folders\ArchiveFolder | Archive folder for original files |
statusFolder | String | C:\ProgramData\Imaging Solutions\VIESUS\PDFEnhancer\Folders\PDFDestFolder | Status folder for processing information |
debugFolder | String | "" | Debug folder for diagnostic files |
Folder Structure Requirements
- All folders must exist and be accessible to the application
- Source folder is monitored for new PDF files
- Archive folder stores original files when archiving is enabled
- Debug folder contains diagnostic information when debug mode is active
Trigger Configuration
Controls file-based processing triggers and notifications.
Parameter | Type | Default | Description |
---|---|---|---|
trigger | String | order.ready | Name of the trigger file to monitor |
removeTrigger | Boolean | 0 | Remove trigger file after processing |
renameTrigger | Boolean | 1 | Rename trigger file during processing |
outTrigger | String | "" | Output trigger file name |
Trigger Workflow
- Application monitors source folder for trigger file
- When trigger file appears, processing begins
- Trigger file handling depends on
removeTrigger
andrenameTrigger
settings - Optional output trigger can signal completion
File Extension Settings
Controls naming conventions for processed files.
Parameter | Type | Default | Description |
---|---|---|---|
destExtension | String | _dest | Suffix appended to output filenames |
archiveExtension | String | _arc | Suffix appended to archived filenames |
tempDestPrefix | String | "" | Prefix for temporary destination files |
Example File Naming
- Input:
document.pdf
- Output:
document_dest.pdf
- Archive:
document_arc.pdf
Special Functions
Render to Image (RTI)
Configuration for converting PDF pages to image format.
Parameter | Type | Default | Description |
---|---|---|---|
renderToImage | Boolean | 0 | Enable PDF to image conversion |
renderToImageDPI | Integer | 301 | DPI resolution for rendered images |
renderToImageStartPage | String | "" | Starting page number for conversion |
Render to PDF (RTPDF)
Configuration for PDF reconstruction from enhanced images.
Parameter | Type | Default | Description |
---|---|---|---|
renderToImageToPDF | Boolean | 0 | Enable image-to-PDF conversion |
renderToImageToPDFSinglePages | Boolean | 1 | Create single-page PDF files |
Troubleshooting
Please refer to Viesus Image Enhancement - Parameter and CLI Reference for exit codes and general troubleshooting information.
Common Issues
- File not found: Verify all paths exist and are accessible
- Permission denied: Ensure exclusive read access to the source file and exclusive write access to the destination and archive folders
- Invalid INI/JSON: Check INI/JSON file syntax and parameter values
- Port conflicts: Use
-p
to specify alternative port if default is in use - Memory errors: Reduce batch size or increase available system memory
- Processing fails: Check folder permissions and paths
- Images not enhanced: Verify
minFileSize
and threshold settings - Memory errors: Reduce
maxFactor
ormaxTargetSize
- Trigger not working: Ensure trigger file format and folder monitoring