Quik! has three main types of field naming conventions:
1. Quik! Field Definition
At the heart of Quik! is a core architecture that all Quik! products and services share in common: the Quik! Field Definition. Having a standard definition ensures consistency in field names across all forms, allowing for data to be automatically populated in any location that shares the same field name.
Our Quik! Field naming convention is as follows:
##<PARENT FIELD NAME>.<BASE FIELD NAME>
- "##" - The ## 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 ".").
Parent and Base fields relate to each other by sharing the same Data Set Type. Data Set Types, as described below, are intended to group common fields together for a singular purpose (e.g. client data vs. account data vs. rep data, etc.).
You can form the correct field name by pairing the Parent name with the same Data Set Type as the Base name (e.g. Client). The Quik! Field Name is used from both the Parent and Base to form the Quik! Field Name, and the System Name is used from both the Parent and Base to form the System Name.
Sample Field Names
Quik! Form Field Name Samples:
- 1own.FName– the primary account holder's first name
- 1acc.Reg– the primary account registration or title
- 1own.H.FullAddr– the primary account holder's full address
- *Note: The "H" here is just another Base Field level. In this case, it signifies "Home"
Electronic Signature Fields
A signature field is any field on a form that is set up as a signature field type in the form model. The following naming convention ensures that every signature field is absolutely unique across all documents and pages. For customers or partners who are looking to find a signature field on a form, look for field names that end with ".sign"
Our Signature naming convention is as follows:
##<PARENT FIELD NAME>.<Form ID>.<Field Instance>.Sign
- This is the signature field for Owner 1 on Form ID 12345
- This is the second signature for Owner 1 on that form
For more information on how the Quik! Field Definition works, check out our Quik! Field Definition Reference Guide.
2. User-Defined Field
Sometimes you will come across User-Defined Fields. These fields aren't part of our Quik! Field Definition, they are fields that we maintain per customer requests.
Our User-Defined field naming convention comes in two formats:
- User.D<Dealer ID>.<User-Defined Name>
- User.F<Form ID>.<User-Defined Name>
- "User" - These fields will always start with the word "User".
- "<D>" – The "D" stands for "Dealer"
- "<F>" – The "F" stands for "Form"
- "<Dealer ID>" – We use the Dealer ID for maintaining the same fieldname across several forms for a customer's request
- "<Form ID>" – We use the Form ID for creating a unique fieldname (which won't conflict with any other forms) per a customer's request
3. Generic Field
When a form asks for information that we don't have a definition for, and it isn't a commonly asked question, we use Generic Fields. Generic Fields aren't intended to be mapped to since they might change across future form updates. Instead, we ask that our customers only use generic fieldnames for typing in text or selecting a checkbox while filling out the form.
Our Generic field naming convention comes in two formats:
1. Text Fields:
2. Checkbox Fields: