Click on Images to Expand Them

Very often, one data set can be connected to the master set and repeated several times with the same structure but different content. For example, the client might have a residential address, an alternate mailing address, and an employer address. Rather than adding each address field three times, a reusable field group can be used to populate all fields of an address at once.

Info
Recommendation. To avoid unnecessary effort, define which groups must be reusable field groups during the design phase of the wizard.

Part 1: Creating a new reusable field group from scratch

Rw ui steps macro

Rw step

Open Pages.

Select New reusable field group under Add a field > Reusable Field Groups.

Creating a new reusable field group

A new section (“newReusableGroup(0)” in the example) is added in the group "Reusable Field Groups" (or it is created if not present) and the button (The Reusable Field Groups section now has a new group NewReusableGroup(0) (1), and a button is created in the Reusable field groups section of the Add a Field pane (2).

“newReusableGroup(0)” in the example) is added to the “Reusable field groups” sectionhas been used here as an example.

Default new Reusable Field Groups settings

The reusableFieldGroups and newReusableGroup0 functions are added to the JSON code with the default parameters.

Info
Info. Click JSON to view the code.

Changes in JSON code

Rw step

Click newReusableGroup(0) in the Pages tree.

Select the Edit icon in the Group Name field and enter the group's name. “Beneficiary Address” has been used here as an example.

Select the Check icon to confirm the changes.

The reusable field group is renamed in the Pages tree, Reusable field groups section, and design layout.

Edit icon

Check icon

Renaming the reusableFieldGroup

Rw step

Click Beneficiary Address in the in the Reusable Field Groups group.

The settings for the group are displayed in the Add a Field pane and are divided into two parts: Reusable Field Group Settings and Reusable Field Group Parameters.

Reusable field group settings and parameters

Rw step

Reusable Field Group Settings contains a list of fields with the default values.

Click Reusable Field Group Settings and enter the values in the required fields.

Info
Information. Many fields in Docupace Start will allow you to use or show values from the wizard’s objects. The How to Access Meta Field Values section describes this in-depth.

Reusable field group settings

Rw step

Reusable Field Group Parameters are used to change the behavior on different occasions.

Select Reusable Field Group Parameters.

Select +Add to add a parameter.

Reusable field group parameters

Rw step

A new parameter form is added.

Each parameter has the following values: Name, Title, and Description.

Enter the relevant values into the Name, Title, and Description fields.

Note. An unlimited number of parameters can be added.

Configuring the parameter

If the parameter is defined as an expression, one of the following syntaxes must be applied in the corresponding group field to retrieve the parameter value.

Syntax	Description	Example
model.params.xxx	Use in conditions for the group, and in conditions for Rich Text.
model.parent.params.xxx	Use in conditions on fields inside the reusable group (except richText).
fieldViewModel.parent.model.params.xxx	Use parameter value in a Rich-text field (a field that doesn’t have its own model).	{{fieldViewModel.parent.model.params.xxx}}

Rw step

Add fields to the group layout in the same manner as for an ordinary group.

Rw step

Select Apply when the layout design is complete.	Applying the layout design
Select Save or Save and Close to save the layout design.	Saving the work

Step 2: Create a new reusable field group from an existing group

Rw ui steps macro

Rw step

You can use the appropriate group (“General Information” in the example) or create a new one with required fields.

Select the group.

Select Create Reusable Field Group in the Field Settings pane.

Creating a reusable field group

The new section is added to the group Reusable Field Groups, and a button is created in the Reusable field groups section of the Field Settings pane. “General Information” has been used here as an example.

New reusable field group settings

The reusableFieldGroups function, which has the parameters from the selected group as sub-functions, is added to the JSON code. “General Information” has been used here as an example.

Changes in JSON code

Rw step

Select General Information in the "Reusable Field Groups" group. The General Information settings are displayed in the Field Settings pane and are divided into two parts: "Reusable Field Group Settings" and "Reusable Field Group Parameters.”

Reusable field group settings and parameters

Rw step

Reusable field group settings contain the values inherited from the source group. These previously defined values are the default values for the next created group. Click Reusable Field Group Settings to display these values. These default values can be changed for the created group only and do not affect initial reusable group values. The specific values for the created group (e.g., Read-only condition, meta-field pattern) have to be defined for each created group separately.

Info
Information. Many fields in Docupace Start will allow you to use or show values from the wizard’s objects. This is described in-depth in How to Access Meta Field Values section.

Reusable field group settings

Rw step

Reusable Field Group Parameters are used to change the behavior of the fields on different occasions. The parameters are inherited from the source group. Click Reusable Field Group Parameters to display all parameters.

Each parameter has the following values: Name, Title, and Description.

Reusable field group parameters

Change the values of the default parameters if required.

Enter the relevant values into the Name, Title, and Description fields.

Configuring the parameters

To change the behavior of the fields, specify conditions for each of them.

In the example on the right:

The system validates the addresses. The condition returns the value ‘true’ or ‘false’.
The system verifies the required fields. In this case, the specified expression returns the value ‘true’ or ‘false’.

Specifying conditions

To add a new parameter, click +Add.

Info
Note. An unlimited number of parameters can be added.

To delete an unnecessary parameter, click the cross icon.

Deleting a parameter

Adding a new parameter

In case the parameter is defined as the expression, to get the parameter value, one of the following syntax have to be applied in the corresponding reusable group field:

Syntax	Description	Example
model.params.xxx	In conditions for the group; in conditions for Rich Text
model.parent.params.xxx	In conditions on fields inside the reusable group (except richText)
fieldViewModel.parent.model.params.xxx	Using parameter value in a Rich-text field (a field that doesn't have its own model)	{{fieldViewModel.parent.model.params.xxx}}

Note
Important. Changing the values in the Reusable Field Group Settings are not applied to already added reusable groups.

Rw step

Click Apply when finished layout design.	Applying the layout design
Click Save or Save and Close to save layout design.	Saving the work

Part 3: Using a Reusable Field Group

Rw ui steps macro

Rw step

To reuse this group, open the required page (“Contacts” in the example) and click the required group button from the list of Reusable field groups section (“General Information” in the example). This group is added to the page.

The structure of this group (on page “Contacts” in the example) is inherited from the Reusable Field Group (fields, expressions, validations).

Selecting a Reusable Field Group

Rw step

To change the settings, click Reusable Field Group Settings to display fields, conditions, and values. Add or change the values as required.

Note. Changing settings of the reused group do not affect the Reusable Field Group settings.

Reusable Field Groups Settings

Rw step

To change the parameters, click Reusable Field Group Parameters to display fields and values. Change the values as required.

Reusable Field Groups Parameters

Rw step

Click Apply when finished.

Applying the changes

Rw step

Click Save or Save and Close to save the changes.

Saving the work

Rw step

To check the usage of a particular Reusable field group, see the Page tree. A number of usages are displayed on the layout. (To display the layout, go to Page tree section Reusable Field Groups and click Beneficiary Address in the example).

@

Usage of Reusable Field Group

Note. Unlimited Reusable Field Groups can be used.

Reusable Field Groups

Versions Compared

Old Version 53

New Version 54

Key

Part 1: Creating a new reusable field group from scratch

Step 2: Create a new reusable field group from an existing group

Part 3: Using a Reusable Field Group

Page Comparison

Versions Compared

Old Version 53

New Version 54

Key

Part 1: Creating a new reusable field group from scratch

Step 2: Create a new reusable field group from an existing group

Part 3: Using a Reusable Field Group