Skip to main content

Custom fields

Custom fields let your organisation capture information the standard client form does not ask for, such as a local ID number or a membership category.

Who can use it: Admin, Proprietor.

Where custom fields appear​

Active custom fields for clients appear:

  • on the client registration and edit form, as an extra step called Additional Info (the step appears only when at least one active client field exists), and
  • on the client's details and review pages.

Fields are grouped under their section heading, in the display order you set.

note

The Custom Fields tab also has tabs for Account, Loan, Address, Next of Kin, Guarantor, Group and Transaction. Only Client fields currently appear on the platform's screens; fields created under the other tabs are not shown on any form.

Opening the custom fields​

  1. Select Tenant Settings under Administration.
  2. Select the Custom Fields tab.
  3. Select the Client tab to see the client fields. The table shows each field's Order, Section, Field Key, Label, Type, Required and Status.

Adding a field​

  1. Select Add Field (or Create your first field if there are none yet).

  2. Fill in the Create Custom Field dialog:

    FieldWhat to enter
    Field KeyA unique internal name in lowercase with underscores, for example custom_id_number. It cannot be changed later.
    Entity TypeChoose Client.
    Section (Optional)A heading to group related fields under.
    LabelThe name staff see on the form.
    Field TypeThe kind of answer: Text, Text Area, Number, Date, Date & Time, Dropdown (Single), Dropdown (Multiple), Checkbox, Radio Buttons, Email, Phone, URL or Currency.
    Description (Optional)Extra guidance about the field.
    Display OrderWhere the field sits among the others; lower numbers come first.
    Required FieldSwitch on to make staff fill it in. The form will not continue without it and shows "label is required".
    ActiveSwitch off to hide the field from the form without deleting it.

  3. Depending on the field type, extra settings appear:

    • For Dropdown (Single), Dropdown (Multiple) and Radio Buttons: under Options, enter a Value and Label for each choice. Use Add Option and Remove to manage the list, and switch on Allow "Other" option if staff may type their own answer.
    • For Number and Currency: optional Minimum Value (Optional) and Maximum Value (Optional).
    • For text fields: Maximum Length.

  4. Select Create Field.

Changing a field​

  1. Select the edit button on the field's row.
  2. Change what you need. The field key cannot be changed.
  3. Select Update Field.

To stop using a field but keep the answers already captured, switch it to inactive rather than deleting it.

Deleting a field​

  1. Select the delete button on the field's row.
  2. In Delete Custom Field?, select Delete.
caution

Deleting a field permanently deletes it and every answer captured in it. This cannot be undone.