MTS Highlight Field — User Guide

Version 1.1.0 · SuiteCRM 8.x

1. What it does

MTS Highlight Field lets you color-code fields on your records so important information stands out at a glance. You can:

• Color a field with a fixed background/text color.
• Color a dropdown field differently for each option value.
• Conditionally color a field based on the values of other fields (for example, highlight a field grey when a checkbox is ticked).

Highlighting is shown in List and Detail views.

2. Requirements

• SuiteCRM 8.x
• Administrator access to configure highlighting
• A valid license key (a trial key works during evaluation)

3. Installation

1. In SuiteCRM, go to Admin → Module Loader.
2. Upload the MTS Highlight Field package .zip.
3. Click Install and follow the prompts.
4. When finished, hard-refresh your browser (Cmd/Ctrl + Shift + R).

4. Licensing

1. Go to Admin → MTS Highlight Field (or the plugin's License screen).
2. Enter your license key and validate it.
3. While the plugin is not licensed, the configuration screen shows a license notice and no highlighting is applied.

5. Opening the configuration screen

1. Go to Admin.
2. Open MTS Highlight Field.
3. Choose the module you want to configure (e.g. Contacts, Accounts, Leads).

You'll see a card for each field in that module.

6. Configuring a field

1. Enable a field by clicking its toggle. A configuration panel opens.
2. Choose a configuration type:
   • Static color — always apply one background/text color (non-dropdown fields).
   • Value-based (per option) — for dropdown (enum) fields; pick a color per option value.
   • Conditional — apply color only when conditions on other fields are met.
3. A field can hold several configurations — click + Add configuration to add more (for example, one static base color plus two conditional rules).
4. Click Save. A spinner appears while changes are applied.

7. Building a conditional rule

Inside a Conditional configuration:

1. Pick the Background, Text, and (optional) Related colors.
2. Optionally tick Color the label to also color the field's label.
3. Set Apply when to AND (all conditions must match) or OR (any condition matches).
4. Add one or more conditions. Each condition is: [ field ] [ operator ] [ value ]
   • field — any field on the record (including fields not shown as columns).
   • operator — see the table below.
   • value — the value to compare against (hidden for operators that don't need one).
5. Set a Priority (higher wins when multiple rules match) and the Active toggle.

Example — grey background when a checkbox is on:

Now, whenever Do Not Call is ticked, the Office Phone field shows a grey background in list and detail views.

8. Condition operators

9. Multiple rules & priority

• A field can have several conditional configurations.
• When more than one rule matches at the same time, the rule with the highest Priority is applied.
• If no conditional rule matches, the field falls back to its static or value-based color (if configured), otherwise no color is applied.

10. Where highlighting appears

• List view — the field cell is colored.
• Detail view — the field value (and optionally the label) is colored.
• Edit / Create views are intentionally not colored, so data entry widgets are never altered.

11. Troubleshooting

• Colors don't appear after saving/installing → hard-refresh the browser (Cmd/Ctrl + Shift + R) to reload cached metadata; if needed, log out and back in.
• A condition on a hidden field doesn't work in list view → most scalar fields are available; if a field is explicitly excluded from list queries it can't be read there — add it as a column or use it only on detail.
• Dropdown values not coloring → make sure you selected Value-based for that dropdown field and set a color on the specific option.
• License notice shown → validate your license key on the License screen.

MTS Highlight Field · Mien Trung Soft. Thank you for trying our plugin!