# Highlighter implementation guide > Install Highlighter, a free Salesforce managed package by To A Finish, and set up a first highlighted field on a Lightning record page. - Publisher: To A Finish LLC - Applies to version: 3.0.x - Last updated: 16 Oct 2026 - Web page: https://www.toafinish.com/support/guides/highlighter/ - Works in: Salesforce Lightning Experience only - Price: free ## 1. Before you begin Highlighter colors, renames or hides fields on a Lightning record page, based on rules you set. This guide takes you from the install to a working highlight. ### What you need - A Salesforce org. Any edition works, with Sales Cloud, Service Cloud or Salesforce Platform. - A user with admin rights in that org. - A sandbox, to set Highlighter up there first. - Lightning Experience. Highlighter acts on fields in Lightning only. > **Test in a sandbox first** > > Highlighter changes how record pages look for every user. Set each action up in a sandbox before you add it to production. ### What Highlighter does not do - It does not work in the Salesforce mobile app. - It does not work on a few standard objects, such as Quote. - It does not change buttons in Lightning. > **Highlighter is free** > > TAF answers quick questions. Help with setup or configuration costs an hourly fee. Report a real bug through a case, and TAF does its best to fix it. See [Get help](https://www.toafinish.com/support/guides/highlighter/#help). ## 2. Install Highlighter Install into a sandbox first. When the whole guide works there, come back and install into production. 1. **For a sandbox, open the Highlighter change log. Click Install in a sandbox.** The **Get It Now** button on the AppExchange installs in production only. A sandbox install starts here. Open the [Highlighter change log](https://www.toafinish.com/support/changes/highlighter/#install-newest). The install box at the top holds the newest version. Click **Install in a sandbox**. Then go on at [step 4](https://www.toafinish.com/support/guides/highlighter/#install-4). For production, go on at [step 2](https://www.toafinish.com/support/guides/highlighter/#install-2). 2. **For production, open the Highlighter listing on the AppExchange. Click Get It Now.** Go to [Highlighter on the AppExchange](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N30000000q4OxEAI). The AppExchange asks you to sign in with a Trailblazer account. That is the free login for Trailhead and the AppExchange. The top of the site now reads AgentExchange. It is the same marketplace. 3. **Pick your production login. Click Install in Production.** A window asks **Where do you want to install this package?**. Under **Connected Salesforce Accounts**, pick the login of your production org. If your org is not in the list, link it to your Trailblazer account first. Then click **Install in Production**. If a terms box shows, tick **I have read and agree to the terms and conditions**. Then click **Confirm and Install**. 4. **Sign in to the org.** Salesforce asks you to sign in to the org. Then it opens the install page for Highlighter, with three choices of who to install for. When Highlighter is already in the org, the page offers **Upgrade** in place of **Install**. 5. **Pick Install for All Users. Then click Install.** Only an admin sets Highlighter up, but every user needs access to its pages. When the install takes a while, Salesforce says it will email you when it finishes. ![The Salesforce install screen for Highlighter, with Install for All Users selected.](https://www.toafinish.com/assets/support/guides/highlighter/install-all-users.webp) 6. **Assign Highlighter (Admin) to each admin who sets up actions.** Highlighter has two permission sets. | Who | Permission set | What it allows | | --- | --- | --- | | Admins who set up Highlighter | Highlighter (Admin) | Opens the setup page and saves actions. | | Every other user | Highlighter (User) | Lets record pages read the actions and show the highlights. | Open Setup. In the Quick Find box, type **Permission Sets**. Click **Permission Sets**. Click **Highlighter (Admin)**. Click **Manage Assignments**, then **Add Assignment**. Tick each admin. Click **Next**. Salesforce asks whether the assignment expires. Leave it with no expiration date. Click **Assign**. 7. **Assign Highlighter (User) to every other user.** Go back to **Permission Sets**. Click **Highlighter (User)**. Assign it the same way, to every user who opens records with highlights. 8. **Open the Highlighter setup page.** Open Setup. In the Quick Find box, type **Installed Packages**. Click **Configure** beside Highlighter. The Highlighter Setup page opens. The first time, it shows a red error. The next chapter fixes it. If the page shows an **Activate Highlighter** button and no red error, a remote site is already in place, for example from an earlier install. Click **Activate Highlighter**. Then go on at chapter 4. ## 3. Add the remote site The first time the setup page opens, it shows a red error that asks for a remote site. A remote site is a web address that Salesforce lets an app call. Here it is the address of your own org. Highlighter uses it to read the list of fields in your org. ![The Highlighter Setup page with a red error. The error names the address to add as a remote site.](https://www.toafinish.com/assets/support/guides/highlighter/remote-site-error.webp) > **TAF cannot reach your org through this setting** > > The remote site only lets your org read its own field list through Highlighter. 1. **Copy the address in the error.** The error sits in quote marks. It starts with `"IO Exception: Unauthorized endpoint` and ends with `Add this endpoint =https://..."`. No space follows the `=`. Copy the address from `https://` to the end. Do not copy the closing quote mark. 2. **Open Remote Site Settings.** Open Setup. In the Quick Find box, type **Remote Site Settings**. Click **Remote Site Settings**. The All Remote Sites list opens. 3. **Click New Remote Site.** ![The All Remote Sites page in Setup, with the New Remote Site button.](https://www.toafinish.com/assets/support/guides/highlighter/remote-sites-new.webp) The Remote Site Edit page opens. 4. **Type a name in Remote Site Name.** Use letters only, for example `Highlighter`. 5. **Paste the address from step 1 into Remote Site URL.** 6. **Make sure Active is ticked. Then click Save.** Salesforce shows the new remote site. 7. **Open the Highlighter setup page again.** Use [step 8 of the install](https://www.toafinish.com/support/guides/highlighter/#install-8). The red error is gone. If the page shows an **Activate Highlighter** button, click it. The page then shows a Welcome box, an empty Action List and a **New** button. The page also shows **Options** and **Sync Layout** buttons. ![The Highlighter Setup page with no actions yet and a New button.](https://www.toafinish.com/assets/support/guides/highlighter/setup-page.webp) ## 4. Create an action An action is one rule. It names an object, a field, and what Highlighter does to that field. Highlighter has three field actions. | Action | What it does | | --- | --- | | Highlight Field | Colors the background of the field. | | Rename Field Label | Changes the field name that users see. | | Hide Field | Removes the field from the page. A blank space stays where it was. | 1. **On the Highlighter setup page, click New.** The New Action window opens, with the lists Object, Action, Component Name, New Value and Only Valid For. ![The empty New Action window, with the Object, Action, Component Name, New Value and Only Valid For lists.](https://www.toafinish.com/assets/support/guides/highlighter/new-action.webp) 2. **In Object, pick the object.** For example, Opportunity. A few standard objects do not work with Highlighter, such as Quote. 3. **In Action, pick Highlight Field, Rename Field Label or Hide Field.** The list also holds four button actions. They do not work in Lightning. **Highlight Button** sits next to **Highlight Field**. If you type the value, typing `Highlight Field` can pick Highlight Button. After the pick, check that the field shows **Highlight Field**. If not, click the list, type `h` once more, then press Enter. 4. **In Component Name, pick the field.** The list shows every field on the object. Each field shows as the label and the API name, for example `Amount (Amount)`. 5. **For Highlight Field, set the background color.** Pick one of two ways. - **Color.** Click the color box. Pick a color in the picker, or type a hex color code such as `#3AB3AC`. Then click **Done**. - **Background Formula.** Pick a formula field that returns a color code. The color then follows the data in each record. TAF recommends this over several actions on one field. ![The Highlighter color picker, with a color area, a hex code box, R, G and B boxes, and Cancel and Done buttons.](https://www.toafinish.com/assets/support/guides/highlighter/color-picker.webp) 6. **Tick Automatically Select Color for the font.** Highlighter then picks white or black text to suit the background, so the field stays easy to read. You can also set a fixed **Font Color** the same way as the background. ![A New Action window for Opportunity. Highlight Field on Amount, with a red color and Automatically Select Color ticked.](https://www.toafinish.com/assets/support/guides/highlighter/action-example.webp) 7. **For Rename Field Label, type the new label in New Value.** 8. **Click Save, if the action applies everywhere.** The window closes, and the new action shows in the Action List. It now runs on every record, for every user. To limit it to some users or some records, do not save yet. Go to [Limit an action](https://www.toafinish.com/support/guides/highlighter/#limit-action). If the action has no filter, an orange bar opens at the top of the same window, with the text **This Action has no Filter**. That is expected. Click **Ignore And Save**. The action saves. In the Action List, the **Component Name** column shows a code such as `opp7`, not the field. The field shows in the **Field API** column. ## 5. Limit an action *Optional. Skip this chapter if your action applies everywhere.* You set these limits in the same New Action window, before you click Save. ### Limit it to some users 1. **In Only Valid For, pick User, Profile or Public Group.** Leave it on **All** to apply the action to everybody. 2. **In the list that appears, pick the user, profile or group.** ### Limit it to some records 1. **Click Add Filter.** A filter row appears, with the lists Field, Operator, Value Type, Value and And/Or, and a **Delete** column with a trash icon. ![A filter row with the Field, Operator, Value Type, Value and And/Or lists.](https://www.toafinish.com/assets/support/guides/highlighter/add-filter.webp) 2. **In Field, pick the field that decides whether the action runs.** It does not have to be the field in Component Name. It can be any field on the object. 3. **In Operator, pick == or !=.** `==` means equals. `!=` means does not equal. 4. **For a Date or Date/Time field, pick a Value Type.** Pick a fixed date, or a date literal such as `TODAY`, `NEXT_WEEK` or `THIS_YEAR`. Skip this step for other field types. 5. **In Value, type or pick the value.** For a picklist, a checkbox or a date literal, pick the value from the list. 6. **To add a second filter, click Add Filter again.** Then go back to the first filter and set its **And/Or** list. - `&&` means this filter and the next one must both be true. - `||` means this filter or the next one must be true. 7. **Click Save.** Highlighter goes back to the list of actions. > **Keep filters few** > > Each filter adds time to the page load. For several conditions, build one formula field that returns True or False. Use that field as the only filter. > > Highlighter does not support nested filters, or `&&` and `||` mixed in one action. ## 6. Turn Highlighter on Your actions do nothing until the Highlighter component sits on the record page. This example uses Opportunity. The steps are the same for any object. 1. **Open a record of the object you set up.** Use a test record in your sandbox. If the object has no records yet, make one. For Opportunity, open the **Opportunities** tab and click **New**. Fill in **Opportunity Name**, **Close Date** and **Stage**. Click **Save**. 2. **Click the gear icon at the top right. Click Edit Page.** The Lightning App Builder opens. Components sit in the left panel, the page sits in the middle, and the settings of the item you click sit in the right panel. ![An Opportunity record with the gear menu open. Edit Page sits near the bottom of the menu.](https://www.toafinish.com/assets/support/guides/highlighter/edit-page-menu.webp) 3. **Add a new tab beside Details.** Click the tab bar on the page, the bar that holds Activity and Details. In the right panel, click **Add Tab**. Click the new tab in that list. In **Tab Label**, pick **Custom**. A second box, **Custom Label**, shows. Type a name in **Custom Label**, for example `Details HL`. Click **Done**. 4. **Drag recordViewWithHighlights into the new tab.** `recordViewWithHighlights` Find it under **Custom - Managed** in the left panel. Do not use the older **HighlightDetail** component. ![The Lightning App Builder. The recordViewWithHighlights component sits in the Details HL tab. Its settings show on the right.](https://www.toafinish.com/assets/support/guides/highlighter/app-builder-component.webp) 5. **Wait for the component to load. Then click Save.** After a few seconds the component grows into a full view of the record. Click **Save** at the top right. If nothing happens after a few seconds, click Save anyway. If the component shows the red text **Please Contact Your Admin to Sync The Layout**, save and activate the page first (step 7). Then open the Highlighter setup page and click **Sync Layout**. In the window, pick the object in **Object Name** and the profile in **Profile**. Click **Sync Page Assignment**. Then reload the record page. 6. **Optional: show maps beside address fields.** Click the component. In the panel on the right, choose whether maps show next to the standard address fields. The panel also holds **Add Outer Margin** and **Allow Owner Changes**. Leave them at their default values. 7. **Activate the page, if Salesforce asks.** Salesforce asks the first time you edit the Lightning page of an object. Click **Activate**. Click **Assign as Org Default**. Choose **Desktop**. Click **Next**. Click **Save**. ![The page activation window, with the Assign as Org Default button.](https://www.toafinish.com/assets/support/guides/highlighter/org-default.webp) 8. **Click Back. Check the new tab.** **Back** sits at the top left of the Lightning App Builder. The record page opens with the new tab. If the new tab does not show, reload the page. Fields with actions show your colors, labels or blanks. ![An Opportunity record with the Details HL tab open. The Amount field is highlighted red.](https://www.toafinish.com/assets/support/guides/highlighter/details-hl-tab.webp) > **Tidy up when it works** > > When the new tab works well, remove the old Details tab. Then rename the new tab to Details. ## 7. Advanced setup Most orgs do not need this chapter. It asks for more Salesforce skill. TAF offers paid help with it through a case. ### Edit with highlights > **Check first** > > The recordViewWithHighlights component already edits fields in place, with the highlights on. Set up a custom Edit page only if you want highlights in the Edit window too. > > The Edit override turns off inline edit on the record page. The Lightning App Builder warns about this with a box, **Inline edit disabled**, when you save the record page. 1. **Open the object in Object Manager.** Open Setup. Click **Object Manager**. Click your object. 2. **Open the standard Edit action.** Click **Buttons, Links, and Actions**. On the **Edit** row, open the menu at the right and click **Edit**. The Override Properties page opens. 3. **Set the Lightning override to the Highlighter Edit component. Then click Save.** Under **Lightning Experience Override**, pick **Lightning component**. Choose: `highlighter:HighlightEdit` Click the component in the list. Do not press Enter, because Enter saves the page at once. ![Override Properties for the Edit action. The Lightning component is highlighter:HighlightEdit.](https://www.toafinish.com/assets/support/guides/highlighter/edit-override.webp) 4. **Wait ten seconds. Then refresh the record page several times.** Lightning takes a while to pick up the change. The new Edit window is a little wider and takes a little longer to load. That is how you know it works. ### Show a field set with highlights The fieldsetWithHighlights component shows a group of fields anywhere on a record page. It edits in place and keeps the highlights. You can add it several times to one page, and each copy works on its own. A field set is a named group of fields that you build in Setup. 1. **Open the object in Object Manager.** Open Setup. Click **Object Manager**. Click your object. 2. **Click Field Sets. Then click New.** To change a field set you already have, click its name instead, and skip the next step. 3. **Name the field set. Then click Save.** Type a **Field Set Label**. Salesforce fills in **Field Set Name**. Type a short note in **Where is this used?**. Click **Save**. The field set editor opens. 4. **Drag fields into the field set.** Drag from the field list at the top into **In the Field Set**. Drag a field back out to remove it. 5. **Click Save.** 6. **Open the Lightning record page.** In Object Manager, click **Lightning Record Pages**. Click the page name. A detail page opens. Click **Edit** to open the Lightning App Builder. If the Lightning Record Pages list is empty, open a record of the object. Click the gear icon, then **Edit Page**. 7. **Drag fieldsetWithHighlights onto the page.** `fieldsetWithHighlights` Drop it inside a region of the page, such as the right column. A region turns green when the component can drop there. The gray area outside the regions does not take the component. If the drag does not drop, click a component in that column, for example Related. Click the **+** above it. Then click **fieldsetWithHighlights**. ![The Lightning App Builder on an Opportunity page. The fieldsetWithHighlights component is dragged onto the right column, which turns green.](https://www.toafinish.com/assets/support/guides/highlighter/field-set-component.webp) 8. **Click the component. Fill in its settings in the right panel.** | Setting | What to enter | | --- | --- | | objectName | Pick the object. Today the list holds only the current object. | | Enter Layout Title | A title for this group of fields. Leave it blank to show the object name. | | Choose Field Set | The field set from steps 2 to 5. | | Enter Icon Name | Leave it blank for the object's own icon. For another icon, type `icon_type:icon_name`, for example `utility:activity`. The four types are utility, doctype, standard and action. See the [Lightning Design System icons](https://www.lightningdesignsystem.com/icons/). | | No. Of Columns | 1 or 2. | 9. **Check the component. Click Save. Then click the back arrow.** The component updates as you fill in each setting. After you save, wait a couple of seconds. The back arrow sits at the top left. > **The same field in two components** > > A change in one component may not show in the other until you refresh the page. ### Options The **Options** button sits under the Action List on the Highlighter setup page, beside **Sync Layout**. Each option applies to every user in the org. TAF cannot turn one on for a single user. ![The Highlighter Options window, with the Lightning Only, Classic Only, Action Suppression and Field Suppression groups.](https://www.toafinish.com/assets/support/guides/highlighter/options.webp) | Option | What it does | | --- | --- | | Hide Logo and Refresh | Removes the logo and the Refresh button from the bottom of the record page. | | Background and Border | Adds a background and a margin when the component sits on the page without a tab. | | Stop Highlight Fields Stop Hide Fields Stop Rename Field Label | Highlighter skips that action type. Turn on the ones you do not use, and pages load faster. | | Disable Checkbox Fields Disable Formula Fields Disable Long Text Fields | Highlighter skips those field types when it checks a page for actions. Pages load faster. | The window also lists Classic options and button options. They do not apply in Lightning. Some features are not in the window at all. Open a case, and TAF sets them up with access to your org or on a call. ### Beta features TAF is building two features that are not on the setup page yet. Open a case to join the trial. TAF sets each one up by hand, in your sandbox first and then in production, and charges for that time. | Feature | What it does | | --- | --- | | Lookup Field Hover Replacement | When a user points at a lookup field, Salesforce shows a few fields of the linked record. This shows many more, which you choose. | | Printable View Replacement | Replaces the standard Printable View. It adds your logo, and lets you pick the fields for an internal page and for a page for clients. | ## 8. Update Highlighter *For later. These steps do not count in the setup progress.* TAF sometimes pushes a new version of Highlighter into every org. Some orgs are on an exclusion list and do not get these pushes. You can also update Highlighter yourself at any time, from **My Installs and Subscriptions** on the AppExchange. > **Update before you report a bug** > > TAF works on bugs in the newest version only. Check your version before you open a case, and update if it is old. 1. **Check the version you have.** Open Setup. In the Quick Find box, type **Installed Packages**. Find Highlighter and read the **Version Number** column. ![The Highlighter row in Installed Packages. The version number sits in the row.](https://www.toafinish.com/assets/support/guides/highlighter/installed-packages.webp) 2. **Check the newest version.** The newest version sits at the top of the [Highlighter change log](https://www.toafinish.com/support/changes/highlighter/#install-newest). If your version matches the newest one, stop here. 3. **Open My Installs and Subscriptions on the AppExchange.** Go to the [AppExchange](https://appexchange.salesforce.com/) and sign in. The top of the site now reads AgentExchange. It is the same marketplace. Click your profile picture at the top right. Click **My Installs and Subscriptions**. ![The AgentExchange profile menu, open on a To A Finish listing, with My Installs and Subscriptions below Select Org and My Favorites.](https://www.toafinish.com/assets/support/guides/highlighter/my-installs.webp) 4. **Pick your sandbox. Update Highlighter there.** The page lists the apps installed in one org. If it shows another org, click **Select Org** in the same menu and pick your sandbox. Find Highlighter in the list and click its update button. Sign in to the sandbox and follow the install screens. The install page shows **Upgrade** in place of Install. If a screen asks who to install for, pick **Install for All Users**. Salesforce installs the newer version over the one you have. Your actions and settings stay in place. 5. **Check your record pages in the sandbox.** Open a few records that carry highlights. Make sure the highlights still show. 6. **Update production.** Go back to **My Installs and Subscriptions**. Pick your production org. Update Highlighter the same way. 7. **Check the version again.** Open Installed Packages again. The Version Number now matches the top of the change log. > **You cannot go back to an older version** > > To go back, you must uninstall Highlighter and set it up again. ## 9. Get help Open a case if a step does not work. Give the link to the step and paste the exact error text. Before you report a bug, update to the newest version. TAF works on bugs in the newest version only. See [Update Highlighter](https://www.toafinish.com/support/guides/highlighter/#update). [Open a case](https://www.toafinish.com/support/#open-a-case)[Give us access](https://www.toafinish.com/support/grant-access/) Highlighter is free. TAF answers quick questions. Help with setup or configuration costs an hourly fee. Report a real bug and TAF does its best to fix it. See what changed in each release in the [Highlighter change log](https://www.toafinish.com/support/changes/highlighter/). Found a mistake in this guide? [Open a case](https://www.toafinish.com/support/#open-a-case) with the link to the step. ### Rate Highlighter If Highlighter helps you, [leave a review on the AppExchange](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N30000000q4OxEAI). If something is wrong, open a case first, so TAF can fix it with you. --- To A Finish LLC. Open a case: https://www.toafinish.com/support/#open-a-case