AddDocToForms Method

Add an External Document to the Form Package

When a customer prints or signs a document, they may want to include external PDF documents (attachments) to the forms (e.g. drivers license photocopy, scanned documents, etc.). To perform this function, the customer will call the AddDocToForms method that creates a list of documents to include and then the Upload method to add the documents to the Quik! servers for inclusion. Each time this method is called another document is added to the list of documents to include in the final package.

This method operates independently of all the other features within the Quik! Forms Engine, meaning that when the Execute command is run, the data loaded via this method is ignored. It is only when the Upload method is run that the data for each file is actually uploaded to Quik!. This enables the software to be run separately for uploading documents vs. generating forms.

NOTES:

The Quik! Forms Engine Execute method must be run before uploading documents in order to obtain a FormViewRequestUNID value to associate the external document to
Attachments must not exceed 20 MB

Security

Each document uploaded to the Quik! server is systematically encrypted during transmission and storage with a unique key per document using standard 128+bit encryption algorithms. Documents are never in the possession or available to any employee or other customer – the documents can only be unencrypted during the process of including them into the final form package for print or signing purposes. Additionally, all documents are deleted from the server in 10 days or less, per the form package's expiration date set by the customer.

Parameters

The parameters needed for each document include:

Parameter	Description	Required
FormViewRequestUNID	The FormViewRequestUNID representing the form package that the document is to be attached to when signing. This value is obtained from the Quik! Forms Engine after running the Execute command.	Yes
DocFileName	The file name of the document (e.g. "DriversLicense.pdf")	Yes
DocPath	The full path of the document on the customer's machine (e.g. "C:\documents\DriversLicense.pdf")	Yes
SortOrder	The order in which to display the document relative to the forms and other documents. NOTE: Value must be a positive integer value between 0 and 999.	Yes
BeforeForm	A boolean flag indicating if the document is inserted before or after the form. If TRUE, insert the document before the form according to the SortOrder. Default is FALSE which appends the document to the Form according to the SortOrder	Yes

Examples

Below is .NET sample code used in Visual Basic:

Sample Code

objQFE.AddDocToForms(objQFE.FormViewRequestUNID, "driverslicense.pdf", "c:\temp\", 2, False)

objQFE.Upload()