Custom Fields

Article author
Aleks Petrovic
  • Updated

Our Custom Fields module allows you to create more fields on your assets, properties, tasks, clients and more. This allows our customers to customise their Uptick system to help add more information to reports or just add specific fields that Uptick doesn't offer, yet is a strong part of your companies processes. 

A good example would be to add a new field to your assets for Fire Rating or Hinge Types.

LearningBanner_Settings-Config_docs.png

Setup

Once the extension is enabled by us and permissions applied, go to Control Panel > Custom Fields.

From here, you can create new fields or modify the configuration of existing custom fields you've added. 

Adding a custom field

  1. Click Add Custom Field
  2. Fill out the fields:Screen_Shot_2020-12-03_at_12.28.10_pm.png
    Label The name of the field
    Key The name of the field with all capital letters and spaces removed (this is the name of the field that Uptick uses to add to reports)
    Object Type

    This is the area of Uptick you would like the field to sit, for example, if I want to add a new field to my properties in Uptick, I want select Property here. Available object types are:

    • Property (can be viewed/edited on mobile app)
    • Assets (can be viewed/edited on mobile app)
    • Tasks (can be viewed/edited on mobile app)
    • Client
    • Asset types
    • Remarks
    • Defect Quote
    • Service Quote
    • Purchase Order
    • Invoices
    • User (on a users profile)
    Widget

    Widgets define the type of field the custom field will be and will determine the type of data the field takes. Available widget types are:

    • Text
    • Number (integers only)
    • Choice (drop down options that can be selected)
    • Date
    • Decimal (allowing for decimal values up to 2 decimal spaces such as currency)

    Order

    The order in which you display your custom fields if there are many, 1 being the top of the list.

    Required

    Ticking this will make the custom field a required field

  3. Once all the details have been filled out, click Save
  4. If you've picked a Choice field, you need to now add the drop down options for your Choice field. This is a requirement for this field otherwise you won't have anything to select from when your office or field staff use this field! Once your field is saved, click Edit on the field again and you'll see an Options section. All you need to do here is type in the Label field your first dropdown option and click Add Option once done, repeat for multiple options. It's important to note that you should not touch the Value field of these choices.

     

Adding help text

Edit any created Custom Field and add help text to the field.

Make the field apply to specific user categories

Edit any created Custom Field and under the Visible to heading, select/deselect which user types will be able to see this custom field.Untitled_6.png

Make the field only show up for certain asset types, variants, clients etc..

You may require a large number of fields that are only applicable for certain asset types, variants, properties or client. For example, the FRL field should only show if the Asset is of type "Door" or a unique id needs to be filled out on a property for a certain client.

Edit the field you are wanting to add this to, and click Add Condition. You are given two areas you need to fill out, a key and a value

The following common conditions have been outlined below, contact support to enquire about other possible conditions:

 

Only applicable to certain asset type:

key = type

value = id/s of asset types in your system you want this field to be applicable too

 

Only applicable to a certain variant:

key = variant

value = id/s of variants in your system you want this field to be applicable too

 

Only applicable to a certain client:

key = property__client

value = id/s of clients in your system you want this field to be applicable too


This is important - ensure the condition ID's are all in 1 line, not seperate entries. 

eg. Screen_Shot_2021-03-11_at_3.07.59_pm.png

 

Screen_Shot_2020-11-30_at_3.09.36_pm.png

The variant id can be found in the URL when you view any variant on the asset type.

Managing custom fields against assets/asset types

You can get an overview of custom fields set against assets and asset types by going to:
Control Panel > Asset types > View the asset type > Custom attributes. 

This overview provides a summary of configuration elements such as:

  • Field name
  • Widget
  • Permissions
  • Restricted to variants
  • Restricted to clients

The Customise button in the upper right corner of the summary is a direct shortcut the Custom fields section of the control panel, where you can edit or create new custom fields.

mceclip1.png

An Example to get you started

You're on the Custom fields configuration page and you're adding a few new fields - one new field on your properties to help determine whether this property has a Fire Engineering Report and another new field on your assets for Fire Resistance Level of that asset.

Field 1: 

Label: Fire Engineering Report

Key: fireengineeringreport

Object type: property

Widget: Choice (which I later add 'yes' and 'no' to the drop down options)

Required: Yes

 

Field 2: 

Label: FRL

Key: frl

Object type: asset

Widget: text 

Required: No

Screen_Shot_2020-06-12_at_3.11.33_pm.png

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.