User-Defined Fields Tutorial
Overview
- User-defined fields capture information the standard fields do not have, on customers, suppliers, their contacts, staff and My Organisation.
- The fields appear on a User Fields tab on the record.
- For every field type and option, see User-Defined Fields.
💡These tutorials explain how to add user-defined fields, give them a dropdown list or SQL lookup, arrange and preview them, fill them in on a record, and delete them.
How to Add a User-Defined Field
- Navigate to User-defined Fields.
- Module = Select the module the field is for, for example, Customers.
- Note: Without a module, the message
Please select a Module.
appears.
- Note: Without a module, the message
- Click New (button) and fill in the new row:
- Name = Enter a system name without spaces. Firebird reserved words, such as DATE, cannot be used.
- Caption = Enter the label users see.
- Editor = Select the field type, for example, Text, Number, Date or ComboBox (Fixed list).
- Layout = Select Below, Column or Right to place the field.
- Caption (position) = Select Hide, Left, Right or Top.
- Width = Enter the width of the field.
- Decimal = Enter the number of decimal places for a number field.
- Click Save (button).
How to Give a Field a Dropdown List
Note
ComboBox (Fixed list) only allows a value from the list. ComboBox (Editable) also lets users enter their own text.
- Select the field with the ComboBox editor.
- Click the three dots (...) on the row, or right-click it, and select Edit Lookup List.
- Enter the entries, one per line.
- Click OK (button).
How to Look Up Values with SQL
Note
The SQL must return an ID (integer) field and a DESCRIPTION (text) field. It can use parameters named after other user-defined fields on the same record, for example, :CUSTOMER.
- Select the field with the Lookup (SQL) editor.
- Click the three dots (...) on the row, or right-click it, and select Edit SQL.
- Enter the SQL and save it.
How to Arrange and Preview the Fields
- To change the order, click the three dots (...) on a field, or right-click it, and select Move Up or Move Down. To add a field above the selected one, select Insert.
- Click Preview (button) to see the fields on a blank page.
- Click Save (button).
How to Fill In User-Defined Fields
- Open the record, for example, a customer.
- Click User Fields (tab).
- Click Edit (button) and fill in the fields.
- Click Save (button).
- Note: Read-only fields are filled in by the database and cannot be changed.
How to Delete User-Defined Fields
- Navigate to User-defined Fields and select the module.
- Select the fields (hold down Ctrl to select several).
- Click Delete (button). At
Delete all the selected Fields?
, click Yes.