Overview
This node integrates with Enfocus PitStop Server to process PDF files. It allows users to run PitStop Server operations on input PDFs, applying preflight profiles, action lists, and variable sets to automate PDF quality control and correction tasks. The node can also clean up temporary output folders created during processing.
Common scenarios include:
- Automating PDF preflight checks and corrections in a document workflow.
- Applying custom action lists to modify or fix PDFs automatically.
- Generating reports about the processing tasks.
- Managing variable sets for dynamic PDF processing configurations.
Practical example:
- A user uploads a batch of PDFs, runs this node to apply a preflight profile and action lists that fix common errors, then outputs corrected PDFs along with XML reports for auditing.
Properties
| Name | Meaning |
|---|---|
| Input PDF Binary Field | The name of the binary field containing the input PDF file to be processed. |
| Output PDF Name | The filename for the output PDF generated by PitStop Server. |
| Preflight Profile | Path to a preflight profile file defining PDF validation and correction rules. |
| Action Lists | JSON array (as string) of paths to action list files specifying automated PDF modifications. |
| Variable Set | Option to use no variable set, create a new variable set, or update an existing variable set. |
| Variable Set Path | Path to a template variable set file (used only when updating a variable set). |
| Variables | Collection of variables to add or update in the variable set, each with a name, type, and value. |
| Options | Collection of additional options: |
| - Generate Task Report | Boolean flag to generate an XML task report describing the processing performed. |
| - Generate XML Report | Boolean flag to generate an XML report summarizing the operation. |
| - Put Output File in Field | Name of the binary output field where the resulting PDF will be stored (default is "outputData"). |
Output
The node outputs the processed PDF file as binary data in a specified binary field (default "outputData"). The JSON output may also contain an array pitStopServerInstances holding instances of the PitStop Server runs for potential further reference or cleanup.
If enabled, XML reports (task report or general XML report) are generated internally but not explicitly output as separate fields; they are part of the processing side effects.
Dependencies
- Requires the Enfocus PitStop Server CLI library (
@enfocussw/pitstop-server-cli) to run PDF processing commands. - Uses temporary directories and files to handle input/output PDFs (
tmp-promise). - Requires access to the input PDF as binary data within n8n.
- No explicit external API keys or credentials are required, but the environment must have PitStop Server installed and accessible.
Troubleshooting
- Unable to get Input PDF file binary buffer: This error occurs if the specified binary field does not exist or contains no data. Ensure the input binary field name matches the actual input data.
- PitStop Server run exit code non-zero: Indicates failure during PDF processing. Check the stderr message for details. Common causes include invalid preflight profiles, corrupted PDFs, or incorrect action list paths.
- pitStopServerInstances undefined, unable to cleanup: Happens if cleanup is attempted without prior successful runs. Make sure to run the "Run" operation before "Cleanup".
- JSON parsing errors on the Action Lists property: The action lists must be a valid JSON array string. Verify the format before running.
- If output binary data is missing, check the "Put Output File in Field" option to ensure the output is stored correctly.