Plan: Not Available: Intermediate, Pro Available: Elite
Users: Available: All users
Practice Management Source: Not Available: APS, Iris, MYOB AE & AO, CCH, MYOB Practice Management (formerly GreatSoft) Available: FYI or Xero Practice Manager
This article defines the terms used within the Forms feature of FYI, including general Form fields, Form Builder components, and automation and workflow concepts.
For detailed instructions on how to use Forms, refer to the following sections:
Form Settings Definitions
Form Settings allows an FYI Admin to enable or disable the Forms feature, set the Default Email Template and select the practice's Primary Brand Colour. Refer to Managing Practice Settings for Forms.
| Form Definition | Details |
| Default Email Template | The Default Email Template selected in Forms Settings, once forms has been enabled. The template is automatically selected when sending Forms via email. |
| Primary Brand Colour |
The main configurable colour used to style key elements of a form. Practice's can update their brand colour, with changes syncing through to all forms and form templates. Note, the default colour is Dark Blue. Refer to Managing Forms Branding (Beta). |
General Form Definitions
Practices can leverage these fields and functions to capture, share and manage client and internal information using Forms.
| Form Definition | Details |
| Client Form | A document created to collect client or internal information. Client forms must be created and filed against a client, using a Form Template. Once created, the form displays in the Documents list. |
| General Form | A form that has been shared from a Form Template external link. This allows practices to easily collect information without linking the form to a specific client. Responses from General Forms are not filed to clients. |
| Default Email Template | The Default Email Template selected in Forms Settings. The template is automatically selected when sending Forms via email. |
| Direct Link | A Direct Link is a shareable link generated from a Form Template External Link. Direct links can be opened and completed without being tied to a specific client record. For example, embedding a direct link to a Satisfaction Survey on a practice's website. |
| Form Settings |
The workspace where an FYI Admin can Enable or Disable the Forms feature, including setting the Default Email Template and selecting the practice's Primary Brand Colour. Refer to Managing Practice settings for Forms and Managing Forms Branding. |
| Form Template |
Templates are used to create Client and General Forms, controlling the fields and layout displayed on each Form. Templates can be customised or copied, and must be set to Active before they can be selected when creating Client Forms. Tip: Sample Form Templates are deployed when Forms are enabled. |
| Form Type |
Template setting that defines the layout of a Form:
|
| Form Actions |
Actions available when completing a Form:
|
| Forms Attachment Link |
The Form Merge Field required when sharing Forms via Email, including New Collaborate. When the When sending a form using New Collaborate, the form link will be uploaded to the Client Folder. When a client selects the form link in the email or from their Client Folder, the Form will open. |
| Open External | Opens the Form in a new browser tab for completion. Recommended for larger forms, and for internal use only. |
| Forms - Submitted View |
The Forms - Submitted Document view is automatically created when Forms is enabled. The view is filtered to Forms with a Submitted Workflow status. Note: If Forms is disabled in the future, this view remains available. |
Form Template Builder Definitions
The Form Template Builder is used to define the layout and fields of Forms.
| Form Builder Term | Details |
| Form Template Builder | Opens in a new browser tab when creating or editing a template and is used to build the form. |
| Rules Builder (Beta) |
The Rules Builder allows users to define conditional logic within a form template. Located within the Form Template Builder, rules can be created to enable dynamic behaviour on a form, such as show or hide, or updating fields. Refer to Creating and Managing Rules for Forms (Beta). |
| Component Window |
The edit window that appears when you drag a field into the Form Template Builder, or click Edit on an existing field. The Component Window consists of three tabs:
|
| Editing Tools |
Tools used to edit the fields displayed on the form:
|
| Field Label |
The label of the field as it appears on the form once created. The Field Label represents what the client will see when they complete a form. This is not mandatory, however it is recommended so the user completing the form can clearly understand what information is being requested Field Labels are displayed to the client on the form, while Field Names are used internally by FYI for automation and merge fields. |
| Field Name |
Field Names are located in Form Builder, when creating and editing a field on the form template. They are the name of the field, for internal use, once the form is submitted. Field Names are used to default client data for FYI fields, and used as merge field names referenced in automations. Note: Updating a Field Name will not change how it displays on the client form, but may affect automations that rely on that field. |
| Layout | Fields used to change the appearance of the form. These fields do not collect any information. Layout fields available include Panel, Heading, Label, Divider, Notes/Help editor and Summary Table. |
| Common Fields | Fields used to capture standard information not related to an FYI field. Different types of common fields are available include Text Box, Number, Yes/No, Radio buttons, Dropdown List, Date, Time, and Checkbox. |
| Advanced Fields | Additional fields that extend the basic usage of a form. Advanced fields include the Upload field, allowing clients to upload related documents when completing a form. |
| FYI Fields | Fields that prepopulate client information in a form based on the data stored in FYI. It is recommended that FYI fields are marked as Read-only and users do not change preconfigured values for FYI Custom Fields in dropdowns. |
| Preview Tab | Displays within the Form Builder, how the Form will display when created. Users can move back to the Form Builder tab to continue editing the template. |
| Show/Hide Field Names | Toggle (top-right) of the Form Template Builder to display internal field names for fields on the template. Useful for distinguishing FYI Fields from Common Fields. |
Form Workflow Statuses
In addition to default document Workflow statuses, Forms use dedicated statuses for process tracking. These statuses are also available to other document types stored in FYI. For detailed information, refer to Managing Form Workflow Statuses.
For all default document Workflow Statuses, refer to Workflow Overview.
The following table provides details of how the Form Workflow states are used for forms:
| Status | Details |
| Pending Submission | Automatically set when a Form is sent to a client. |
| Submitted | Automatically set when the Submit button is used. This includes for external or internal forms. |
| Reviewed |
Manual status that allows Form to be marked as reviewed. Note: no Workflow Approval user settings are required. |
| Finished |
Manual status to mark the form process complete. Users must be an FYI Admin to select or update the Finished workflow status. Important: When the Workflow Status of a Form is updated to Finished, the original form will be permanently deleted and automatically converted to PDF. Refer to Finishing a Form. |
Form Automations
This section explains the automation functions available for Forms, including how merge fields, process steps, and filters interact to create and manage automated form workflows.
| Form Action | Details |
| Create Form | A process step that when added, automatically generates a new form from the selected template. |
| Form Filter | An Automation Filter that defines the form template and document view that the process will action. By selecting the form template, this will define which merge fields become available in the Trigger Form Data section. |
| Trigger Form Data | When inserting merge fields in an automation step, the Trigger Form Data section displays the list of all available Merge Fields from the selected Form Template. |