Apache PDFBox Fill
CertifiedFill the form fields of a PDF
Apache PDFBox Fill
Fill the form fields of a PDF
Sets AcroForm fields by their fully qualified name and stores the filled PDF in internal storage. Check boxes accept true/false or the name of their on state. Unknown field names fail the task unless ignoreUnknownFields is true. With flatten, the fields are merged into the page content so the values can no longer be edited.
type: io.kestra.plugin.pdfbox.form.FillExamples
Fill and flatten an onboarding form
id: pdf_fill_form
namespace: company.team
inputs:
- id: form
type: FILE
tasks:
- id: fill
type: io.kestra.plugin.pdfbox.form.Fill
from: "{{ inputs.form }}"
fields:
full_name: "Jane Doe"
start_date: "2026-11-02"
remote: "true"
flatten: true
Properties
fields *object
Field values, keyed by fully qualified field name
from *string
The PDF form, as an internal storage URI
Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150flatten booleanstring
falseFlatten the form after filling so the values become static page content
Default false.
ignoreUnknownFields booleanstring
falseSkip field names that do not exist in the form instead of failing
Default false.
password string
Owner password of an encrypted PDF
The filled form keeps the encryption of the input; changing it needs the owner password, so the user password alone is refused.
Outputs
filledFields integer
Number of fields that were set
uri string
uriInternal storage URI of the filled PDF
