Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Background

Customers often have a need to generate forms for households, such that when generating bundles of forms, certain family members’ information prefills one form, and not the other. Similarly, customers often have a need to  generate multiple copies of the same form in a single bundle, and prefill different people's data onto the same “role” on each copy.

Form group instances make it easier to logically separate forms according to transactions (e.g. open 3 accounts), whereas form instances are really meant to add duplicate forms into a bundle (e.g. adding extra beneficiaries).

In order to add from group instances in the same generated bundle, there is a method called AddFormIDsGroup.

Method Name

Argument

Description

AddFormIDsGroupforms

A string representing a CSV of formIDs. The order in which the group is added is the same in which will be displayed when generated.

Using Form Groups Instances with the Quik! Forms Engine DLL

Example: There is a need to bundle the forms for 3 accounts together but with differing forms. Let's say account A gets form IDs 1,2,2, account B gets Form IDs 1,3 and account C gets Form IDs 2,3. 

...

.

...

languagec#
titleC#

...



Field Names with Form Group Instances

...

Quik! recommends that customers copy and paste the above JSON into the HTMLSettings parameter of the Execute endpoint on Swagger, then open the returned HTML link to see how the first name fields prefill on the forms to aid with understanding how to prefill form group instances. Note: Ensure your account is subscribed to the American Funds form library to test with these forms.


DEPRECATED - Using Form Groups Instances with the Quik! Forms Engine DLL

Example: There is a need to bundle the forms for 3 accounts together but with differing forms. Let's say account A gets form IDs 1,2,2, account B gets Form IDs 1,3 and account C gets Form IDs 2,3. 

The example below will generate 3 group of forms.


Code Block
languagec#
titleC#
QuikFormsEngine qfe = new QuikFormsEngine();

qfe.QuikCustID = "1000123";
qfe.QuikUsername = "myUserName";
qfe.QuikPassword = "myPassword";

qfe.AddFormIDsGroup("1,2,2");
qfe.AddFormIDsGroup("1,3");
qfe.AddFormIDsGroup("2,3");
qfe.Execute();