About Forms

Updated on 18 Jul 2023
4 Minutes to read
Contributors

Article summary

Did you find this summary helpful?

Thank you for your feedback

Forms offer a significant benefit in terms of storing typed data. By limiting the type and format of data being entered, fields ensure consistency in data entry. For instance, a miscellaneous field that stores a date could be entered in multiple ways such as:

January 1, 2021
Jan 1
1/1/21
01/01/2021

Form fields can restrict the entry of dates to a consistent format every time, and using typed data makes it much easier to report accurately.

Form Categories

Debt Forms are used for storing data on the account page or from the account sidebar.

Client Forms are used for storing data on the Client Profile page.

Transaction Forms are used for storing data related to transactions.

Form Types

Multi instance Form

Standalone Form

Include Form

Form Page

The Form page consists of fields for data entry. Fields with an * are required.

View the table below for field definitions.

Image Displays Form Section

Field	Definition
Identifier	The table name
Form Config Type	Choose Debt, Client, or Transaction
Allow Multiple Instances	True or False (True can only be used for a Standalone form)
Label	Most agencies use the same name as the identifier field
Description	Enter a Description for your Form
Icon	Choose an icon
Location	Include or Standalone
Layout Columns	Default is 2, you can choose how many columns. you want in your Form
View Role	Anyone who can view the form Ex -Agent
Insert Role	Anyone who can insert data into form when manually adding an account
Update Role	Anyone who can edit data in the form
Delete Role	Anyone who can delete a row in a multi-instance form Not applicable for other types of forms

Form Field Section

The form field section consists of additional fields for data entry. Fields with an * are required.

View the table below for field definitions.

Image Displays Form Field Section

Field	Definition
Form	Auto-populated
Identifier	This will be the field name in the database
Misc1 & Misc2	Extra values can be stored in these fields, such as client identifiers and used for reports or code These fields will not be directly visible on the account level
Label	Enter a label for your form field This field can only contain letters, numbers, spaces and underscores. To use symbols and > than 64 characters, use the UI Label section
UI Label Section (rarely used)	If this is set it will be used in lieu of the field label in the UI (on the account page)
UI Label Style (rarely used)	CSS entered in the field will override the system style of the field's label or the form's UI label
UI on Change (rarely used)	Form field validation can be set using custom JavaScript in this field
Tool Tip	Enter in a help description users can view when looking at or filling in the field
Field Type	Example types: String-short text field Text Area-long text field Boolean-true or false field
Others	For optimal system performance, do not set the following attributes unless they meet an identified need
Primary Key	Used for Multi-instance forms as the unique value in each instance
Required	This will prevent accounts from being saved if not populated
Hidden	Field not shown on account, but data can still be inserted/viewed via other means
Searchable	Allows users to use this field to find accounts via the account search page
Display on Summary	This makes the field available to display in a summary section for a multi-instance standalone form Include and standalone forms will already be available to show in the account summary section
Colspan	Allows you to adjust the size of the column (like a merge field in Excel)

Custom Validation Section

Custom Form Validation (JavaScript) can be used to verify data exists or meets expectations. It can also be used to display an error if valid data doesn't exist when saving a completed form.

Warning

Only work on Form updates outside of active production. Adding/Modifying a form can harm your system's stability when users are actively working in ACE or when jobs, loaders and reports are running.

Review the following articles on how to create Forms.

Form Include Type

Standalone Form

Multi Instance Form

Was this article helpful?

What's Next

Custom Form Validation (JavaScript)

Table of contents