Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Map eForm rules

Updated on April 6, 2022

The SmartForms capability enables your applications to work with PDF files. Your application can extract field data from incoming PDF forms and can generate PDF forms and documents.

The following tabs are available on this form:

Map eForm rules specify the relationship between the form fields in a PDF form and properties in your application. EForm File rules hold uploaded PDF form files that your application uses as templates when generating new PDF documents. When you create a map eform rule, you specify an eForm file rule (Rule-File-eForm ) to which the mapping applies. See About eForm File rules.

Where referenced

Two standard activities accept the name of a map eForm rule as an input parameter:

  • @baseclass.ExtractDataFromEForm
  • @baseclass.GenerateEForm

You can also reference map eform rules with the Connect-File method, to write a PDF form to an output file.


Use the Application Explorer to access map eForm rules in your application. Use the Records Explorer to see all map eForm rules available to you.


For information about configuring your application to use these activities to process incoming PDF forms or to generate a PDF form, see the Pega Community article Working with PDF Forms and Documents.

To simplify the process of creating an eForm and its corresponding map eForm rule, use the Create eForm Rules wizard. To start the wizard, choose Create eForm rules from the Wizards area of the Integration slice. See About the eForm Rules accelerator.


Map eForm rules are instances of the Rule-Map-Eform class. They are part of the Integration-Mapping category.

  • Map eForm rules - Completing the Create, Save As, or Specialization form
  • Map eForm Rules - Completing the Mapping tab

    A map eform rule creates a two-way mapping. When the Pega Platform extracts data from an incoming PDF form, it uses this rule to determine into which properties to write the field values. When a new PDF form is generated, the map is used to determine into which form fields to write property values from the clipboard.

  • Map eForm rules - Completing the Pages & Classes tab

    To map PDF field data to or from properties that do not belong to the Applies To class of the map eForm and eForm file rule, create a page entry for the appropriate class on this tab. Then, return to the Mapping tab and use the page name in the property reference (pagename.propertyname).

  • More about Map eForm rules

    The Pega Platform C includes standard activities that your activities can call use to manipulate PDF files. These activities use Java methods in the EFormUtils API — the Java interface that implements the SmartForms feature — to provide the following.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us