Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

In order to prefill forms, customers will need to first map fields in their data source system (typically a CRM) to the Quik! field definition. This mapping should only be performed once on initial setup, followed by minor updates as new fields are added. Whether a given form's job is to open a new account or change an address, any time the form requires mapped field information (such as the customer's first and last name), that name should appear on the form in the correct place regardless of how the form is visually designed.

Field mapping configurations

Our intent is to simplify how customers talk to Quik! via field mapping, and reduce the amount of work required as much as possible. When prefilling a form, it is only required that the customer tell Quik! a field name and value. We recommend customers take the "shotgun approach" - send all of a client's data to a form for prefill, and the form will apply what is needed on the given fields and ignore everything else.

Field mapping is best accomplished in a translation table that relates Quik!'s base field name (e.g. "FName", "DOB", "H.Addr1", etc.) from Quik! with your corresponding field (e.g. "FirstName" or "F_Name") as it exists in your data source. Then to output the values to Quik! and prefill the form, query the translation table and prepend the Quik! parent field (e.g. "1own" for owner 1, or "2ben" for beneficiary number 2, etc.) to the field name (e.g. 1own.FName) and loop through the records and populate the Quik! Forms Engine using the AddFieldToForm method and the corresponding properties.

Quik! maintains a web service for helping to manage field mapping. For REST documentation, please consult the Quik! REST API - QFEM swagger page. One particularly helpful endpoint is /forms/fields, which returns a detailed list of fields for a given set of forms.

Quik! Field Definition

While the Quik! Forms Engine is the primary way in which Quik! delivers forms, the Quik! Field Definition is the power behind how we manage them. The purpose of the Field Definition is to make all forms and documents work in the same manner through a defined set of field types with common field names. For an in-depth look at the Quik! Field Definition, naming conventions, and a list of all Quik! fields, please visit the Quik! Field Definition Guide. Consulting this guide has proven immensely helpful for customers when setting up field mapping for their implementation.

This page is also helpful for how to view the names of fields on a Quik! form.


  • No labels