PdfFormTask

Type Configuration (Static)

Field	Type	Description
template_file*	String	Path to the PDF template file used for all executions of this task type.
resultTemplate	String	Template for the success message. Supports {output_file} and {count}.

Execution Configuration (Runtime)

Field	Type	Description
output_file	String	The destination path for the filled PDF. Defaults to filled_form.pdf.
fields	Map<String, String>	Manual overrides for field names to values.
flatten	Boolean	If true, flattens the form fields to make them read-only. Default: true.

Task Lifecycle

1. Initialization: Loads the PDF template specified in TypeConfig and inspects the AcroForm structure.
2. Context Analysis: If an LLM is available, the task sends the conversation history and the list of available PDF fields to the model to extract relevant data.
3. Data Merging: Merges LLM-extracted fields with manual overrides provided in ExecutionConfig.
4. PDF Generation: Uses Apache PDFBox to populate fields, optionally flattens the document, and saves it to the workspace.

Error Handling

If fields specified in the configuration are not found in the PDF template, the task logs a warning but continues processing other fields.

Embedded Execution (UnifiedHarness)

To invoke this task programmatically using the Cognotik engine:

import com.simiacryptus.cognotik.apps.general.UnifiedHarness
import com.simiacryptus.cognotik.plan.tools.file.PdfFormTask
import java.io.File

val harness = UnifiedHarness(serverless = true).apply { start() }

val typeConfig = PdfFormTask.PdfFormTypeConfig(
    template_file = "templates/nda_template.pdf"
)

val executionConfig = PdfFormTask.PdfFormExecutionConfig(
    output_file = "output/signed_contract.pdf",
    fields = mapOf("SignerName" to "John Doe"),
    flatten = true
)

harness.runTask(
    taskType = PdfFormTask.PdfForm,
    typeConfig = typeConfig,
    executionConfig = executionConfig,
    workspace = File("./my-project")
)
            

Test Case Example

Example of how the agent uses this task during a planning phase:

{
  "plan": [
    {
      "task_type": "PdfForm",
      "task_description": "Generate the final report PDF",
      "output_file": "reports/final.pdf",
      "fields": { "Status": "Approved" }
    }
  ]
}
            

Dynamic Prompt Injection

The following instructions are injected into the LLM context to help it understand how to use this tool:

PdfForm - Fill out a PDF form template.
- template_file: [path]
- output_file: Path for the generated PDF.
- fields: Map of field names to values.
- flatten: (Boolean) Make fields read-only.
Available Fields:
  - "Full_Name" (Text)
  - "Date_Row1" (Text)
  ...