Populate PDFs With Case Data - Keeping it Simple

Pega-as-a-Service
1

By Jeff Watters, Sr Solutions Consultant

Why Smart PDFs Matter in Pega

Smart PDFs bridge the gap between structured case data and the real-world documents your business users depend on. Whether you are producing government forms, financial documents, or customer-facing correspondence, Pega’s EForm File and Map eForm capabilities let you reliably inject case data into PDF fields—without custom code, brittle scripts, or manual effort.

This guide extends the basic reference in the Platform Support Guide and walks through a clean, repeatable approach for uploading a Smart PDF and populating it using Pega case data—keeping configuration simple, testable, and easy to maintain.

Purpose

This walkthrough demonstrates how to Upload a Smart PDF into Pega using the EForm Wizard, Map case properties to PDF form fields using Map eForm, and leverage the Create PDF Automation to generate a populated PDF directly from the case lifecycle.

Pre-Work

  1. Created or modified a PDF Template with fillable form fields
  2. Verify smart field names within the PDF (Adobe Acrobat or similar tooling)
  3. Identified the Pega case properties that will populate those fields

Step 1: Upload the Smart PDF Using an EForm File

Start by uploading the Smart PDF so Pega can recognize and bind to its form fields.

  • Navigation: Dev Studio → Create → Integration Mapping → EForm File
  • This launches the EForm File creation wizard, which registers your PDF as a reusable form template.

image
image200×136 9.3 KB

Step 2: Associate the PDF with Your Case Class

When creating the EForm File:

  • Select the case class where the PDF will be generated
  • Name the EForm clearly (for example, 1099NEC)
  • Set the file type to PDF
  • Select the Class for the PDF – The Class is Applied To your Case you created. In this example we are applying the PDF to the class O34R9W-DFAS1099-Work…

image
image410×150 9.62 KB

Step 3: Upload the Smart PDF

Upload the PDF file containing the fillable fields. Use a consistent naming convention—this name will later be used during mapping and PDF generation.

image

Tip: Ensure your PDF fields are uniquely named and predictable (e.g., Text1, AddressLine1, City). Clean field names make mapping faster and easier.

Step 4: Create a Map eForm Rule

With the PDF uploaded, the next step is linking PDF fields to case data.

  • Navigation: Dev Studio → Create → Integration Mapping → Map eForm
  • This rule acts as the translation layer between your case properties and PDF form fields.

image
image228×126 8.84 KB

Step 5: Configure the Map eForm Context

During Map eForm creation:

  • Apply the rule to the same case class
  • Add it to the appropriate ruleset
  • Give it a clear name aligned to the PDF (for example, 1099NEC)

image
image365×149 8.92 KB

Note: Consistency here pays dividends during testing and troubleshooting.

Step 6: Map PDF Fields to Case Properties

On the Mapping tab:

1. Select the uploaded PDF file and confirm the extension

2. Review the automatically generated transform name

3. Begin mapping fields

image
image166×152 6.15 KB

4. Map the fields to properties from you Case.

  • Enter the PDF file name and extension
  • For each field Pega automatically detects available PDF fields and case properties, making this process fast and intuitive.
  • In Field name column, arrow down to see the available fields for mapping
  • Select the desired field
  • See the Property column opposite the selected field name – place your cursor in the Property field, click the down arrow on the keyboard to display case properties.
  • Select the property.

Best Practice: Start Small… Before fully mapping the form:

  • Map two or three fields only

  • Save the rule

  • Run the case and test PDF generation

  • This incremental approach lets you validate: PDF rendering, Field population, and

    Class context

  • Once confirmed, return and complete the remaining mappings.

Step 7: Review the System-Generated Data Transform

When the Map eForm is saved, Pega automatically creates a data transform that drives field population. This transform:

  • Builds using the .pyEFormParameters rule
  • Maps PDF field names to property references
  • This transform can be modified (but rarely needs editing)

image
image415×162 19.8 KB

Step 8: Generate the PDF from the Case

To generate the populated PDF:

1. Open the case type

2. Add a Create PDF automation step

3. Configure the step

image
image135×128 5.59 KB

Configuration highlights:

  • Generate PDF from: eForm template
  • Select the Map eForm rule created earlier
  • Enter the PDF file name
  • Choose the appropriate Attachment Category
  • Save the step and run the case.

Step 9: Test, Validate, and Refine

Run the case and confirm:

  • The PDF is created successfully
  • Fields are populated correctly
  • Formatting and alignment are correct
  • Adjust mappings as needed and retest until the document output meets expectations.

Key Takeaways

Leveraging this approach highlight how Smart PDFs integrate seamlessly into the Pega case lifecycle, allowing document generation to occur as a natural extension of case processing. By leveraging the EForm File and Map eForm rules, document population remains fully declarative and upgrade‑safe, avoiding custom code and fragile implementations. Incremental testing helps prevent configuration sprawl and simplifies troubleshooting, while minimal configuration ensures maximum reuse across cases, forms, and environments.