/
Creating UDFs (User Defined Fields)

Creating UDFs (User Defined Fields)

Owned by Matthew Garrett
Last updated: Sept 01, 2021
3 min read

UDFs or User Defined fields are custom fields that you can create in Framework that may include a range of data types and can be added to custom screens.



Follow the instructions below to create them.:

  1. Open Framework Administration (Program)

  2. Browse to Customisation>User Def Fld

  3. Select the User Defined Group Object either Client, Job or Land that your new UDF(s) will relate to. (In this example, we'll use Job)

     

  4. The next step is to set up your structure under User Defined Field Groups, think of this like a filing cabinet, the location of the fields in this structure does not have any effect on their behaviour or configuration, it is purely organisational and useful to locate your UDFs later. Click into this area of the screen and then click New.


     

  5. If any groups already exist, you'll be asked whether you wish to create a sub group of the selected or at the same level.




  6. Once you have created the required group(s), you can begin creating UDFs. Click into the right hand side of the screen under User Defined Fields then click New.

  7. The first thing to set here is the RMS Data Type. The following selections are available:
      
      - Date 
      - Decimal - A number with up to two decimal places, usually used as a currency field
      - Double - Typically used for percentages
      - Integer (Long) - No decimals
      - Integer (Long) - List Selection ID - List Selection from Entity Roles
      - Integer (Small)/Boolean - Flag Field (Yes, No, Unk, BC (By Client))
      - String - Free text (up to 255 characters)
      - Time



  8. Set the Database Field Name, this can be a maximum of 20 characters (including the prefix that is set by the selected RMS Data Type) A good idea is to truncate the words that you'll use in the Label to make this as meaningful as possible.

  9. Set the Label for the UDF, this will be the words you would want to see on the screen next to the field ie. "Power Connection Arranged"

  10. Set the Transfer With Contract field to Yes or No. If this field is set to Yes, the data in the UDF will become associated with the new contract in the event of a cancellation. If set to No, it will be made inactive in the event of a cancellation.

  11. The Notes field is optional and can include anything for your own reference.

  12. Click Ok, the UDF is now present in the database and can be added to a custom screen.