Field Properties

The field properties tool allows users to modify the properties for any field that is part of the module. To modify the fields for a child record users need to open a form for that type of child record and use the field properties button there.

field properties

Types of Properties

Caption

This section contains 4 pieces of data.

  • Table and field name
  • Current Caption - What the current caption is.
  • User Defined Caption - An editable caption defined by the user.
  • Lucity Caption - The lucity hard coded caption for the field

Shared Field

Appears if this is a shared field. Shared fields are fields in different modules that share the same picklist. This provides a list of the other fields related to this one.

Editing

This section displays the current edit requirements of the field in the form.

  • Allow Input - Indicates if users are able to edit the field. All three of the following fields must be checked for this one to be checked.
    • Lucity Allows Input - Indicates if this field allows input at all. Some fields do not allow input at all because they automatically populated by the program.
    • Globally Allows Input - Indicates if the agency allows edits to this field within the Lucity system. This setting affects Lucity Web, Desktop, and Mobile.
    • This Form Allows Input - Indicates if edits for this field are allowed on the current form. This can only be changed by editing the field properties on this form in the Lucity Administration tool.
  • Required - Indicates if the field must be filled out before saving the record. All three of the following fields must be checked for this one to be checked.
    • Required By Lucity - Indicates if this field is required by the system.
    • Required Globally - Indicates if the agency requires the field throughout the Lucity system. This setting affects Lucity Web, Desktop, and Mobile.
    • Required on this Form - Indicates if the field is required on the current form. This can only be changed by editing the field properties on this form in the Lucity Administration tool.
  • Edits Restricted to Users w/Permissions - If this box is checked the field is Restricted. Only users with the Edit Restricted fields permission for the module will be able to edit it.
  • Default Value - Allows users to set a default value. When a record is created the field will automatically be filled out with this value.

Mask

This controls how many characters users can enter into a field. This gives admins the ability to adjust the mask for the field. What appears here depends on the type of field this is.

  • If it is a text field it will say something like 25x and users will only be able to enter 25 letters or numbers in that field.
  • If it is a number field it will say something like nnn and users will only be able to enter a number up to three digits long.
    • To allow for negative numbers as well as positive numbers place a - before the first n.
    • If the field also supports decimals add the decimal point and place n's after it to show how many decimal places should be displayed. -nnn.nn

      Warning: Use extreme caution when modifying a Mask. If you make a Mask smaller, all existing numeric field data may be lost.

AutoCalc

The AutoCalc function allows an admin to include a custom calculation in a field. This calculation will be preformed be default upon saving a record.

Enter an equation in the grid provided and use the Check Formula button to check for accuracy.  A prompt will appear to inform whether or not the calculation is valid.

Example: Users can enter something like this in the calculation field: (this example is for Sewer Pipe Inventory)

 [NT_DIA] / [NT_LENGTH]

The system will search through the user-defined formula and replace the field names with values from the current record.  For example, if the current record had NT_DIA = 8 and NT_LENGTH = 250, the system will return and calculate this expression:  8/250.

Notes:

  • Make sure that all field names are enclosed in brackets.
  • Make sure that you are not including table names.
  • Make sure that you are not using fields from tables other than the currently displayed module.
  • Make sure that you are not on a record that may cause a division by 0.  If so, you should move to a different record and enter the formula again.
  • Any calculated fields will be disabled or "grayed out" in the form.
  • The calculation function is not available in any of the child dialogs.

User Range

This allows an administrator to include a minimum and maximum range for the values in a field.  User will receive an error message if the value entered in the limited field is outside of the range specified.  

  • For example if the Min Range is 1 and the Max Range is 5, only values (including decimals) 1 through 5 will be allowed in that field.  If someone enter a value outside of that range (e.g. 7), the following error message will appear:

Definition

This section displays the Lucity field definition. This can be overwritten by a user.

  • Definition Lock - Locks the current definition.
  • Apply Lucity Definition - Removed the user modified definition and reapplies the original Lucity Definition.

How to Change a Property

  1. Select a field on the left.
  2. Find the property to change and make the change.
  3. Click the Save button to save changes of click the X button to cancel changes.

    Note: Changes must be saved or canceled before switching to a different field's properties.

See Also

Forms

Form Fields

Street Signs - Special Field

Street Intersections - Special Field

Work Orders - Special Functions

Work Requests - Submittal Forms