Custom field templates

Purpose: By default, Commusoft provides standard fields across the system, using custom fields these can be expanded upon to store further details specific to your business or customer needs. 

For example, if your engineers drive and need a place to park, this can be stored on the customer record using a custom field allowing office staff to assist with any arrangements before the appointment is due.

 

The term ‘object’ refers to a record, eg. a customer, work address, invoice, or job

The Custom fields feature is currently only available for Customer and Work address objects

 

View Custom field templates

➡️ Profile icon > Settings > Global > Custom field templates > View

Custom field templates1-1.png

  1. Search - Find the template you need using the name or description
  2. Quick filters - Filter the displayed templates by status
  3. Add new custom field template - Create a brand new template ready to configure
  4. Template name - Name provided when template is created
  5. Description - Description provided when template is created
  6. Fields configured - Number of fields configured in the template
  7. Status:
    • Active: Currently live and visible
    • Draft: Saved but not live
  8. In use:
    • Yes: Assigned to an object
    • No: Not assigned to an object
  9. Actions:
    • Configure: Create and edit custom fields using the configurator
    • Clone: Duplicate existing template for similar use or modification
    • Edit: Edit the template name, description and make template active
    • Delete: Permanently delete or archive the selected template

Reorder your templates using the Reorder.png slider.

A template can be deleted if it has not been used, instead, it will be archived and can no longer be assigned to new objects.

This action is irreversible and cannot be recovered.

If a template is archived while still assigned to an object, the fields will stay on the existing records unless you decide to delete that data. The template will show as ‘Archived’ when viewing in the ‘Assign custom fields to objects’ setting.


Setting up templates

Step 1: Add new custom field template

add new template.png

  1. Template name - Type a name for the template
  2. Template description - Type a distinct description for the template
  3. Is active? - Activate/deactivate the template, this will be greyed out
  4. Cancel - Discard new template creation
  5. Save - Save the entered details and create template

Making the description as detailed and concise as possible will ensure you can search for it in the future as the list of templates grows

All templates will be made draft by default and must be configured with at least 1 field before being made active


Step 2: Configure custom field template

➡️ Locate new template in list > Configure

The configurator lets you easily add sections and input types to build your custom field template. Our guide on the configurator explains each input type available and the options available after saving.

You can create up to 5 custom fields across one or more templates. Even if the template is in draft status, the field count will still be considered.

Add a section or input type to open a side panel and set up the details for that field.

Custom field templates 1.2.png

  1. Field name - Enter the name for your new custom field
  2. Field help text - Displayed in green below the field name, enter text to help users when this field is in use
  3. Required - To make the field mandatory, tick this box
  4. Show in screens - Where do you want the new field to be displayed for completion?
    • Add - When adding an object, eg. adding a new customer
    • Edit - When editing an object, eg. editing a customer
    • Add/Edit - When adding and editing an object
    • Don’t show anywhere - Hide the field
  5. Cancel - Discard new field creation
  6. Save - Save entered details and create new field

Test your chosen input types before daily use to ensure satisfaction with the setup and user data input experience.

Some input types and options may not be suited for use with custom fields, the configurator guide can help to determine which fields are more appropriate here.

Multiple templates can be assigned to an object, consider creating separate templates for organised and tailored fields.


Step 3: Activate template

Now the template is configured it can be activated, making it appear in the list to assign it to objects.

Is active.png

➡️ Locate the template in the list > Edit > Tick ‘Is active’ box > Save

Next, you will need to assign the templates to the desired objects. The Assign custom field templates to objects guide explains how to do this.