Skip to main content

Set up extra field

How to add and manage extra fields for additional data, including restricting visibility using License or Data Conditions

Teresa Bui avatar
Written by Teresa Bui
Updated over a week ago

Setup

You will need the following permission in your security group: Can change site configuration settings.

Click here to learn about permissions and security groups.


Extra fields allow capturing additional data on assets, properties, tasks, clients, and more—for example, Fire Rating or Hinge Type. Some pages support filtering by extra fields, with filter options based on the field type.

If you see this arrow, click to expand for more information!

We will add additional information and images under these arrows.

How to add an extra field

1. Navigate to Control Panel > Extra Fields, then click Add extra field.

2. Complete the following information:

  • Label: Display name of the field.

  • Key: Automatically generated from the label (this is the name of the field that Uptick uses to add to reports).

  • Help Text: Text that appears as a sub-heading to provide context to the field.

  • Object Type: Where the field applies (e.g. Asset, Property).

  • Widget: The type of input the field will accept: Text, Multiline Text, Integer, Choice (dropdown options must be added), Date or Decimal (up to 2 decimal spaces).

  • Order: Defines the display order of extra fields; 1 appears at the top of the list.

  • Required: Is this field required when submitting?

3. Click Create.

Example Setup

Fire Engineering Report extra field on a property with the Choice widget.

  • Label: Fire Engineering Report

  • Object type: Property

  • Widget: Choice (with dropdown options: Yes, No)

FRL extra field on an asset with the Text widget.

  • Label: FRL

  • Object Type: Asset

  • Widget: Text


How to manage the extra field and dropdown options

1. Navigate to Control Panel > Extra Fields, then click the relevant object tab (e.g. Asset, Property) to view all extra fields for that object.

2. Click Edit to change Order, Model (Object Type), Label, Name (Key), Help text, Type (Widget), or click Delete to remove the extra field.

If the field is Choice, enter the Label (leave the auto-generated Value unchanged) and click Add Option in the Type column. Add all dropdown values or click Delete to remove an option.

3. Click Save on the extra field.


How to set the visibility of the extra field

Field visibility can be controlled using License Conditions (visible only to users with specific licenses) or Data Conditions (visible only for selected clients, properties, or asset types) when editing the field.

License Conditions

Tick the box for Field, Customer, or Contractor to show the field only to users with that license.

Data Conditions

Click Add conditions, enter the Key and Values, then click Create.

  • Key: Defines what related data Uptick checks to decide if the field should be shown (client, property_client, property, type, variant). The key must reference a related object, for example use

    • client for the property extra field to be only visible for certain clients.

    • property__client for the extra field on objects linked to a property (like assets) to be visible only to specific clients, or use property - visible for specific properties.

    • type for the asset extra field to be only visible for assets of the specific asset type, or variant - visible for assets of the specific asset type variant.

  • Values: Provide the IDs of the object defined in the Key, separated by commas with no spaces, for example 4,5,8,12.

Example Setup

Fire Engineering Report extra field on a property visible only to clients with IDs 47 and 48.

  • Key: client

  • Values: 47,48

FRL extra field on an asset is only applicable to asset types with IDs 3,24,56.

  • Key: type

  • Values: 3,24,56


Example Use Cases for Properties and Assets

Property Custom Fields

You can create custom fields that apply to properties to track unique information.

Example: Add a "Body Corp Address" field for specific clients.

  1. Create an extra field with Object Type set to Property and Widget as Multiline Text.

  2. Click Add conditions.

  3. Set the Key to client (lowercase).

  4. In the Values field, enter the ID numbers of the clients, separated by commas with no spaces (e.g., 105,760).

  5. Click Create and Save.

Note: There have been inconsistencies reported with filtering by client. If the field doesn't appear, double-check that the key is lowercase and that there are no spaces between comma-separated IDs.

Asset Custom Fields with Property-Based Conditions

You can make an asset's custom field appear based on the property it belongs to.

Example: Show a "Permit Number" field for assets located at a specific property.

  1. Create an extra field with Object Type set to Asset.

  2. Click Add conditions.

  3. Set the Key to property.

  4. In the Values field, enter the ID of the specific property.

Example: Show a "Unique ID" field for assets belonging to a specific client.

  1. Create an extra field with Object Type set to Asset.

  2. Click Add conditions.

  3. Set the Key to property__client.

  4. In the Values field, enter the ID of the client.

Important: It is not currently possible to apply a condition to an asset custom field to restrict it to a specific client or property directly. The workaround is to use the property__client or property key as described above.

Did this answer your question?