Vault can generate and populate any XFA PDF form, for example, FDA Form 2301 or Form 2253. To use this feature, Admins can contact Veeva Support for assistance setting up the XML Element object records and loading the relevant forms into your Vault.
Once the structure is set up, Admins configure Generate Form document lifecycle state user actions. When a user triggers a Generate Form action, Vault creates a copy of the template document, constructs the XML from the object records, populates the XFA PDF form using data from the mapped fields, and makes that form the source file for a new document.
Note: This feature is designed to replace the previous Generate 2253 functionality. If you wish to migrate to the newer functionality, contact your Vault representative.
Setting Up Form Types
To set up new forms, contact Veeva Support for guidance. In some cases, including 2253, they can provide CSV files that you upload through Vault Loader to create the necessary object records. Note that the provided CSV files work only if all non-standard fields in your Vault use the
__c suffix, rather than
__vs. When contacting Support, let them know if your Vault has any
- Optional: Set up the document type to use for the form. If you use a document type that already exists, this is not necessary.
- Create a new document and upload the XFA form as the source file. This will serve as a template for generating forms. Make sure that the Document Name is something easily understandable because Vault will use it for the generated forms.
- Create new records in the XML Element object that reflect the structure of the XFA form. We recommend that you work with Veeva Support for this portion of the process.
- Make any necessary changes to the form field mappings. You must use the public keys (
Document.product__v.name__v, etc.), which are easier to find and input than the private keys used in the previous mapping method.
- Set up new user actions for any document lifecycle states where users will need to generate forms. Note that the Create Compliance Package bulk action runs every Generate Form action on the Start state of the Compliance Package’s document lifecycle.
Within the XML Element object, one of the XML Element Types (object type) is Input. Vault stores the mapping information for the form in this element type.
How to Edit Mapping
To edit mapping for a form:
- Navigate to the XML Element object record page. You may need to set up a custom tab or change the object settings to show this in Business Admin > Objects.
- Use the filters to show only object records with Input as the XML Element Type. Set a filter to only show Input records for the Form Type you’re working on. If you plan to add a new XFA forms in the future, we recommend adding a value to the Form Type picklist so that you can easily organize your object records.
- Each Input record corresponds to a single field input on the form. Some fields (like Yes/No fields) have two or more inputs, one for each option. Edit the Formula for the object records, which should include a mapping to the document, binder, or referenced object field that Vault uses to populate the form field.
Using the Hierarchy Viewer
The Hierarchy Viewer displays a hierarchy of related XML Element object records, for example, an FDA Form 2253 object record and its child elements. To open the Hierarchy Viewer, click the View Tree Layout button on an XML Element’s object record detail page.
The Formula field on the Input object record allows you to use Vault’s expression language. See Creating Formulas in Vault.
Field Mapping Syntax
Form fields can be mapped to fields on a document, a binder, a document in a binder, a document reference field, or a referenced object field. For each of these, there is a specific syntax you must use, which follows the standard Vault syntax for formulas. If users will trigger the form generation from a binder and you want to use field values from the binder’s component documents, you’ll use the prefix
DocInBinder. If you want to use field values from the binder itself or the document from which users will trigger the action, use the prefix
Examples for document or binder fields:
- Document Name for a document in a binder:
- Document Name for the binder itself:
Examples for referenced objects:
- Name for referenced product on a binder:
- Internal ID for referenced product on a binder:
- Name for referenced application (referenced through the binder’s product):
In the above examples, you’d use the document field that creates the object reference, then the object field.
Example for referenced documents:
- Name for the referenced document’s field:
In the above example, you’d use the object that has a document reference field, then the field on that referenced document.
Generate Form User Actions
Each Generate Form action can trigger up to five (5) different forms to generate.
Your Vault will not automatically switch over to using this functionality for 2253 generation. You must contact Veeva Support to enable XFA form generation. Once enabled, Vault creates the XML Element records automatically and 2253 generation will function as it did in previous versions.
The primary differences are:
- You can easily update your field mapping by editing the Input records in Admin.
- You can configure the Generate Form user action for any lifecycle state where users need to trigger 2253 generation. If needed, you can make the user action conditional, for example, Country equals United States.
- The Generate Form user action can generate up to five (5) forms at once, like the older generate action created both the Form 2253 and Supplementary Sheet.
- Vault orders documents on the form by Document Number (Material ID), first numerically and then alphabetically.
Form Generation Errors & Warnings
This section can help you troubleshoot common errors that occur with form generation.
|The formula is not valid. This could occur because there is a typo in the function name, the formula uses a nonexistent function, the formula references a nonexistent field, a function uses a field that doesn't have the correct data type. This is only a warning, so Vault will not stop the form, but invalid formulas will evaluate to blank/null.
|Invalid table formula
|A specified variable is not valid or does not exist. For example, a form field maps to a document field that doesn't apply to the source document.
|The Secondary Brands field could not be repopulated because you cannot view all documents in the binder.
|You do not have permission to view one or more documents in the binder. This includes the forms you are generating, so make sure that you have at least permission to view every document in the binder.
|Regeneration failed because you do not have permission to either view or version the form in its current state.
|You are not in a role that has view and version permission for the current lifecycle state of the form. Check the Sharing Settings of the generated form, and ensure that you have permission to version in the current lifecycle state.