This article covers Field Groups and:
- How they can combine related fields into a single, repeatable item.
- how to configure and move a field group within a template.
- how to set up a field group to create items automatically based on a prior field's value.
What is a Field Group?
Multiple fields can be combined to create a single Field Group Item. In the example below, the fields are as follows:
- Array Number
- Photo: Array Location
- Array Tilt
- Array Azimuth
- Array Obstructions? (include photos)
This set of fields can be added as a new item as many times as needed.
How to Configure Field Groups
Field groups are configured within the template editor. See How to Create and Manage Templates to learn more.
- Navigate to the template section where you want to create a field group and click the "..." icon.
- Click "Add new field group".
-
Enter a name for your field group and click "Add Field Group".
You also have the option to copy from an existing field group by checking the "Copy from an existing field group?" box. Once this box is checked, you'll see a list of field groups in your template to copy from.
- Click the + icon below the field group to create a new field. See How to Add and Edit Fields to learn more about creating new fields.
- Click and drag the new field into the field group.
- Add as many fields as needed in the field group.
Using Field Group Items
Once a field group is configured, it appears in projects built from that template as a dynamic item that field users can add, review, and remove.
This is an example of what a field group looks like on the web app. Click "Add New" to create an item.
Who Can View Item Details?
- Portal Admins can view the date, time, and user who created an item by hovering over the item; the metadata will appear.
- Manager users can only see when the item was created.
You can delete an item by clicking "Delete this item" at the bottom of the item. Deleted items cannot be restored.
Move a Field Group
Portal Admins can move a field group to any spot within its section from the template editor.
- Go to a template that has field groups. Scroll to the field group you want to move and click the three dots next to the edit icon.
- Click "Move field group".
- Click "Insert here" under the new location.
- Click Save. The field group will highlight yellow to confirm the move.
Auto-Create Field Group Items
Dynamic items can be created automatically using the "Create Multiple Items," "Create Multiple Service Items," and "Create Single Item" Workflow Fields. Below is the step-by-step process to set up a template this way.
Auto-Create Multiple Items
- Create the field group you want to auto-create items with (see Adding Field Groups with Dynamic Items).
- Create a field outside of the field group, in the same section. For the "Create Multiple Items" workflow, this field must be an integer field.
- Give this field the workflow field type "Create Multiple Items".
- Under "Add Items", select the field group you want to trigger the auto-create function with.
Entering a value into the integer field will now prompt the user to create that many field group items.
Auto-Create Multiple Service Items
Using the same process, Service Line Items can also be created automatically using the "Create Multiple Service Items" Workflow Field. The field type must be Boolean, Selection, or Button Selection.
Selecting the trigger value on the Boolean, Selection, or Button Selection field will now prompt the creation of Service Line Items.
Auto-Create Single Item
A single field group item can also be created using the "Create Single Item" Workflow Field. The field type must be Boolean, Selection, or Button Selection.
Selecting the trigger value on the Boolean, Selection, or Button Selection field will now prompt the creation of a single item.
Best Practices
Field groups and conditional logic don't mix across sections. Conditional logic that spans multiple sections evaluates individual fields, it doesn't extend to fields grouped inside a field group. If a field's visibility needs to depend on a condition set elsewhere in the template, consider using an individual field in its own section instead of placing it inside a field group. See Conditional Logic to learn more.
Use auto-create for a variable number of items. When the number of items needed varies from project to project (for example, the number of arrays on a roof), set up an Auto-Create Field Group Item workflow field instead of asking field users to click "Add New" for each item individually. Entering or selecting a value in the trigger field generates the items automatically, which keeps data entry consistent from project to project.
What's the difference between a field and a field group?
A field is a single question or data-collection element in a template. A field group combines several fields into one repeatable item, for example grouping an Array Number, Array Tilt, and photo field together so they can all be added as a single unit as many times as needed.
Can I move a field group after I've created it?
Yes. Portal Admins can move a field group to any location within its section from the template editor. See Move a Field Group above.
Can I delete a field group item?
Yes. Click "Delete this item" at the bottom of the item. Deleted items cannot be restored, so double-check before deleting.
Who can see who created a field group item and when?
Portal Admins can hover over an item to see the date, time, and user who created it. Manager users can only see when the item was created.
Can field group items be created automatically instead of manually?
Yes. The "Create Multiple Items," "Create Multiple Service Items," and "Create Single Item" Workflow Fields let a field outside the field group trigger the automatic creation of one or more items. See Auto-Create Field Group Items above.
Comments