Skip to content

Add the PhoneTools Component to a Record Page

The PhoneTools Lightning Component is how your users see screening results and screen a record on demand. It is not added for you when the package is installed, so add it to the Lightning Record Page of each object you screen.

Adding the Component

  1. Go to Setup and open Object Manager.
  2. Select the object you want to add the component to.
  3. Select Lightning Record Pages.
  4. Select an existing page and then Edit, or select New to build a new record page.
  5. Find PhoneTools in the components list on the left of the Lightning App Builder, under the custom managed components, and drag it onto the page.
  6. Select Save, then activate the page if it is not already assigned to your users.

Note: The component needs a record to work with, so add it to a Lightning Record Page. On a page with no record behind it, it reports that there are no screenable phone numbers.

The (Obsolete) Checkboxes

Selecting the component shows four checkboxes labelled (obsolete) in the properties panel on the right. They control nothing. They are the remains of features that have been removed, and are kept only so that existing record pages carry on working.

Leave them as they are. Ticking or unticking them makes no difference to what the component does.

What Your Users See

The component appears as a Phone Numbers card, with one row for each phone field on the record that is configured and has Enable Screening ticked. Each row shows the label of the phone field and the number it holds.

Alongside each number is a status icon. Hovering over the icon opens a summary giving the result for each register you screen against, and the date the record is next due for screening. The wording of each status, and what it means, is described in Phone Screening Statuses.

The card also carries a Screen button, which screens the numbers on the record there and then and refreshes the page with the result. What your users see when they use it is described in Screen a Record.

A number that is clear on every register you screen against is shown as a link, so a user with a softphone can dial it from the component. Every other status leaves the number as plain text.

If the record has no phone number in any configured field, the card reads "This record has no screenable phone numbers." rather than showing an empty table.

Controlling Where the Component Appears

The component only reports on phone fields that are configured and have Enable Screening ticked, so on an object with nothing configured it has nothing to say. See Configure a Field to Screen.

You can also use Add Filter in the Lightning App Builder to set the conditions under which the component is shown, for example hiding it on records where every phone field is empty.

If Your Users Cannot See or Use it

Screening from the component writes back to the record, so a user who screens needs more than read access:

  • read access to the phone fields on the object, such as Account.Phone,
  • read access to the object's Phone Status Field, Next Screen Due Field and Screening Results Field, in order to see the results,
  • edit access to those same three fields, and to the object itself, in order to use the Screen button.

A user who lacks the access needed to write the result back sees an error when they screen. If the object itself is not updateable for them, it reads "The current user does not have update access to the Account object or one of its fields to which access is required." If the object is updateable but one of the three functional fields is not, the same message appears with "query+update" in place of "update".

These are the permissions PhoneTools needs in order to screen a single record on demand, so they apply equally when a Flow queues a screen on save. See Queue a Screen From a Flow.

Note: The packaged PhoneTools Permission Set grants read access to these three fields, but not edit access, so it is not enough on its own for a user to press Screen. How to grant the rest is covered in Permission Set Assignments.