| Action Parameter |
eoInsertFormFields |
| Purpose |
This action allows the client application to place only the necessary signature blocks and text fields in a document, based on the required number of signatures. For example, a contract with both buyer and co-buyer signature locations would require signature blocks in both locations only if both parties were included in the transaction. |
| Description |
Inserts signature blocks and supporting text fields, storing the resulting PDF file as a new document version in the document profile; returns an XML response containing the revised document version ID for the PDF file with signature and text blocks added. |
| Type |
Granular |
| Preconditions |
Document profile has been created in the eCore® service, and the client application has the dpSid.
Document profile does not contain another Electronic Original document. |
| Implementation Notes |
Each Document Profile must be mapped to an existing Document Type. A Document Type is a template for creating a unique instance of a document within the eCore service.
Document Types must be configured within Command Center (see Preferences) and should have the "Required in Signing Experience" flag set IF the document will be signed within eOriginal's SmartSign Web application.
Document Type configurations will vary based on your specific use case. Document Types may or may not be mapped to a source PDF. Note that if a source PDF is mapped to your Document Type, the PDF will be created by default within your Document Profile at the time of Document Profile creation. |
| Implementation Notes |
There are two options available for creating form fields within the specified document:
formFieldsTemplateName Parameter:
Static signature templates can be created within Command Center. These signature templates compile all form fields that should be presented on a document. The signature template name established as part of the template creation process can be passed within the formFieldsTemplateName parameter. See Command Center/Preferences/Signature Templates.
formFieldsXML Parameter:
Signature templates can be managed outside of the eCore service. The XML representation of that signature template can be passed through the formFieldXML parameter.
Note: A signature template can be created within Command Center (see Command Center/Preferences/Signature Templates), and can be exported as an XML file - this XML file provides the XML representation of the form fields defined within the signature template created. |