1. Home
  2. Administration
  3. Config>Administration
  4. How to Create User Defined Fields

How to Create User Defined Fields

In this guide you will be shown how to create a User Defined Field, which are essentially customised fields that you can store against student, staff or contact records.

See also: How to create User Defined Flags

Access: The minimum permissions required to create User Defined Fields are found in the Administration Module of Config>Setup>Roles & Permissions.

To begin, go to Config>Administration>User Defined Fields.

Pathway

Once the page loads, you will see a list of User Defined Fields that already exist.

Ignore these for now and click on the New button.

UDF Page

This will open a new section on the right.

In here, you can enter the details that comprise the User Defined Field (anything marked with * is mandatory).

New UDF

Below is a list of what each field refers to;

  • Name – enter a Name for the UDF
  • Description – enter a Description for the UDF
  • Data Group – select the Group the UDF will display in from the dropdown list
  • Data Area – this will be one of the tabs within the secreted Data Group
  • Start Date – will be the Date the new UDF will be available from
  • End Date – this will be the Date the UDF will no longer be available from, leave blank if there is no End Date
  • Field Type – this will set the content for the UDF, which can be set to accept only:
    • Date – will only accept a Date
    • Dropdown Multiple – this allows you to define your own dropdown with multiple choices
    • Dropdown Single – this allows you to define your own dropdown with a single selection
    • Number – will accept only Numbers
    • Number/Currency – will accept Numbers or Currency values
    • Text – will accept a short Text entry
    • Text (Multiline) – will accept a longer Text entry
    • True/False – will accept either True or False only
  • Add to Additional Columns List – This allows you to use the Column on the Students/Staff pages as a Filter Column.
  • Read only Roles – All Roles added here will have Read Only access to the UDFs
  • Read & Edit Roles – All Roles added here will have Read & Edit access to the UDFs

Note: Administrator is the default and cannot be cleared, but it is only necessary to add a Role once to the appropriate Permission. In other words Read & Edit does not require Read Only as well.

Once you are happy with the details you have added for the User Defined Field, press Create. It will now be available to use from the Start Date you gave it.

Create

If you ticked Add to Additional Columns List, the UDF will now be visible when adding an Additional Column on the Students List page.

UDF Appears on Students List

It can now also be added via the bottom of the Profile Tab of a Student’s Record.

Adding the UDF to a Student

Note: All UDF fields are reportable through the Reporting module.

Updated on November 10, 2022

Was this article helpful?

Related Articles