Methods

The following methods are made available by the Quik! Forms Engine.

AddFieldToForm

Adds a field to the form.

Use this method to prefill any visible or hidden fields on the form. It is recommended that you attempt to fill every field for which you have data. That way you can send the same data to all of the forms and not care whether or not the form has the corresponding field. Any extraneous data supplied to the form is ignored.

Hidden field can also be added to forms so that you might pass hidden data (e.g. system data you need submitted back but don't want the user to see). Simply add the field with a unique field name and the value to populate and it will be added to the end of the form. Then, when a user submits the form, the hidden data will be submitted too.

Example:

'Add hidden field 
objQFE.AddFieldToForm( _
FieldName:="TransactionID", _
FieldValue:="123456789", _
FieldReadOnly:=QuikFormsEngine.QFD.FieldReadOnly.NoRestrictions, _
FieldVisibility:=QuikFormsEngine.QFD.FieldVisibility.None, _
FieldRequired:=QuikFormsEngine.QFD.FieldRequired.NotRequired, _
FieldFormat:="", _
FieldMaskFlag:=False, _
FieldCalcOverride:=False, _
HiddenField:=True)

Parameters

LoadXML

Add multiple fields to the form via an XML file.

Use this method to prefill any visible or hidden fields on the form. It is recommended that you attempt to fill every field for which you have data. That way you can send the same data to all of the forms and not care whether or not the form has the corresponding field. Any extraneous data supplied to the form is ignored.

Hidden field can also be added to forms so that you might pass hidden data (e.g. system data you need submitted back but don't want the user to see). Simply add the field with a unique field name and the value to populate and it will be added to the end of the form. Then, when a user submits the form, the hidden data will be submitted too.

Example:

'Load data via XML
objQFE.LoadXML("C:\Temp\LoadXMLExample.xml")

Structure

Quik! Fields are defined by a "parent" field – the top-most field that indicates the data set type (e.g. client, account, company, representative, etc.) – and a "base" field – the lowest level field that defines the data element (e.g. first name, date of birth, address line 1, etc.).

The field naming convention is as follows: {ROLE NUMBER}{PARENT FIELD NAME}.{BASE FIELD NAME}

• Role Number represents a counter that indicates the instance of the parent name – a counter is not used with certain names.
• "PARENT NAME" – The Parent Name is a top-level field name that describes the entity that the base field applies to (e.g. Owner, Annuitant, Rep, etc).
• "BASE NAME" – The Base Name is the actual field name that describes the purpose of the data that appears on the form.
• "." – A period or "." separates field names in order to distinguish a hierarchy amongst fields (note: Base Names can be formed from multiple fields separated by periods ".").

A field is defined by the parent and its child field(s). For example, the primary account owner's first name is defined as:

• Quik! Field Name ="1own.FName"
• Quik! Field Name = "1ben.H.Addr123"

Parameters

Attributes
Every field has attributes that controls the field and its value.

Schema

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="ParentField">

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" name="Field">

 <xs:complexType>

 <xs:sequence>

<xs:element name="FieldName" type="xs:string" />
<xs:element name="FieldValue" type="xs:string" />
<xs:element name="FieldReadOnly" type="xs:boolean" />
<xs:element name="FieldVisibility" type="xs:unsignedByte" />
<xs:element name="FieldRequired" type="xs:boolean" />
<xs:element name="FieldFormat" />
<xs:element name="FieldMask" type="xs:boolean" />
<xs:element name="FieldCalcOverride" type="xs:boolean" />
<xs:element name="HiddenField" type="xs:boolean" />

</xs:sequence>

</xs:complexType>

 </xs:element>

</xs:sequence>

 </xs:complexType>

 </xs:element>

</xs:schema>

 Sample XML

 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ParentField>

 <Field>

 <FieldName>1own.FName</FieldName>
<FieldValue>Thomas</FieldValue>
<FieldReadOnly>false</FieldReadOnly>
<FieldVisibility>1</FieldVisibility>
<FieldRequired>false</FieldRequired>
<FieldFormat></FieldFormat>
<FieldMask>false</FieldMask>
<FieldCalcOverride>false</FieldCalcOverride>
<HiddenField>false</HiddenField>

 </Field>
<Field>

<FieldName>1own.LName</FieldName>
<FieldValue>Williams</FieldValue>
<FieldReadOnly>true</FieldReadOnly>
<FieldVisibility>1</FieldVisibility>
<FieldRequired>true</FieldRequired>
<FieldFormat></FieldFormat>
<FieldMask>false</FieldMask>
<FieldCalcOverride>false</FieldCalcOverride>
<HiddenField>false</HiddenField>

 </Field>

 </ParentField>

AddDocToForms
Add an external document to the form package when e-signing.
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's 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.
Example:
'Add hidden field
objQFE.AddFieldToForm( _
FieldName:="TransactionID", _
FieldValue:="123456789", _
FieldReadOnly:=QuikFormsEngine.QFD.FieldReadOnly.NoRestrictions, _
FieldVisibility:=QuikFormsEngine.QFD.FieldVisibility.None, _
FieldRequired:=QuikFormsEngine.QFD.FieldRequired.NotRequired, _
FieldFormat:="", _
FieldMaskFlag:=False, _
FieldCalcOverride:=False, _
HiddenField:=True)
Parameters