/
User Defined Fields Administration

User Defined Fields Administration

Owned by Julie Doyle-Whitelock (Deactivated)
Last updated: Jan 31, 2019

The User Defined Fields Administration screen is used to create any user defined field groups and user defined fields.

User Defined Fields (UDF) are a feature of Framework designed to allow you to create custom fields to capture specific information. UDFs can be added against the client, job or land and are found in the UDF tab of the respective Overview screens.

To help manage UDFs, these fields can allocated to a user defined field group. UDF groups can be re-ordered by dragging and dropping the group to a different location.

Procedures

Adding A User Defined Field Group

When adding UDFs against the client, the job, or the land, users can further categorise UDFs within these groups. This allows users to easily locate UDFs by referring to a particular group rather than searching through one long list.

  1. From the Object drop-down list, select the user defined group object. The User Defined Field Groups tree will update.
  2. Select the User Defined Field Groups tree. A shadow will appear around the list to indicate it is selected.
  3. Click New. The Add New Group confirmation prompt will appear.
  4. Click Yes to add a new sub group of the current group. The User Defined Field Group dialog will be displayed.
    OR
    Click No to add a new group at the same level as the current group. The User Defined Field Group dialog will be displayed.
  5. Enter the details.
  6. Click OK. The dialog will close and a new UDF group will be created.

Adding A User Defined Field

  1. From the Object drop-down list, select the user defined group object. The User Defined Field Groups tree will update.
  2. From the User Defined Fields Group tree, select the required group.
  3. Select the User Defined Fields list. A shadow will appear around the list to indicate it is selected.
  4. Click New. The User Defined Field dialog will be displayed.
  5. Enter the details.
  6. Click OK. The dialog will close and a new UDF will be created.


Once created, a User Defined Field cannot be deleted or the data type edited. This is to ensure data integrity. UDFs can be used throughout Framework and may have reports or customised screens dependent on them.

User Defined Field dialog

This dialog is used to capture information about the UDF.


General Group

Field

Description

RMS Data Type

RMS data type. Options include: 

  • Date: Used for recording dates (field prefixed with d_). 
  • Decimal: Used for recording dollar amounts (field prefixed with c_).
  • Double: Used for recording numbers (fractions, i.e. 1.20) (field prefixed with b_).
  • Integer (long): Used for recording whole numbers (field prefixed with l_).
  • Integer (long) - List Selection ID: Used for recording list selection IDs (field prefixed with l_[name]_id).
  • Integer (small)/Boolean: Used for recording Boolean (Yes/No) (field prefixed with f_).
  • String: Used for recording alphanumeric values (field prefixed with s_).
  • Time: Used for recording time (i.e., appointment time) (field prefixed with t_).

List Selection

Note: This option is only available when the RMS Data Type is set to Integer (long) - List Selection ID.

Framework list to which the UDF will be added. Click the List Selection popup button to select.

Database Field Name

Name of the field as it will appear in the database. It can be an abbreviated name of the Label field.

This field name cannot be longer than 18 and there can be no spaces between characters.

Group

User defined field group within which the field is contained. This is automatically populated based on the Group that was highlighted in the User Defined Field Groups tree. If the group is incorrect, click the popup dialog button to select the correct group.

Label

Name of the field as it will appear in Framework.

Note: This field should be not be longer than 50 characters.

RMS Field Ctx PKID

Automatically generated PKID from within Framework. This field is locked and cannot be edited.

RMS Field Group Order

RMS field group order.

Visible?

Visibility status of theUDF in Framework.

Transfer with Contract

Select Yes to link the field to the Contract.

Select No to link the field to the Job.

Notes

Free text area for notes regarding the user defined field.

Related content