Setting up FinancialForce Highlight Card Panels
The FF Highlights component enables you to add multiple highlight cards in a single component that users can add to an object's FinancialForce Lightning record page.
You can clone and rename existing component configurations in Highlights Configuration Builder. You can also delete your own configurations. You must have the FF Configuration Builders permission set assigned to you to use the Highlights Configuration Builder.
To set up a cards panel configuration:
- From App Launcher, select Highlights Configuration Builder.
In the Highlights Configuration Builder, existing card panel configurations are displayed on the left and the Highlights configuration pane on the right.
- To create a configuration, click New. The New Configuration window opens.
- Enter a unique label for the panel. This is displayed in the My Configurations list and you can select this configuration when adding the component to the record page.
When you click outside this field, the API Name field is populated.
- [Optional] Edit the API name. This must be a unique name.
- Click Save. The panel's configuration pane opens.
- Select an object that the cards display metrics for.
- Click Add Card in the empty card. The Add Highlight Card window opens.
- Set up the card. See the related topics for information on how to set up each card component.Using Dynamic Thresholds
To use dynamic thresholds:
- From the Threshold Calculation Type options, select Percentage.
- From Threshold Reference Field, select the relevant field.
- From the Greater Than Threshold Percentage field or the Less Than Threshold Percentage field, enter a percentage value as a whole number.
- From the Greater Than Threshold Color field or the Less Than Threshold Color field, select a highlight color.
The following calculation is used:
Card Value > (Threshold Reference Field * Greater Than Threshold Percentage) = Greater Than Threshold Color
If the field selected from Card Value or Threshold Reference Field does not have a value, the card remains white, even if you set threshold colors.
- To add more cards, either:
- Clicking Add Card in the empty card.
- Click between the cards.
- [Optional] To reorder cards, drag a card to a new location in the panel.
- [Optional] To edit a card, hover over the card and click , or double-click the card.
- [Optional] To delete a card, hover over the card and click .
- Click Save when you have completed the configuration of your panel.
Keyboard Controls
You can use the following keyboard controls in the Highlights Configuration Builder. When you are within a New or Edit window, the controls are limited to that window until you use Esc or commit a button action by pressing Enter when the button is selected.
Shortcut |
Usage |
---|---|
Tab | Moves to the New button, down the existing panel configurations, and then through the buttons, fields, and the editor in any selected configuration. |
Shift-tab | Moves in the reverse order to Tab. |
Enter |
Opens the selected panel configuration. Opens a new card. Commits actions on buttons and fields in the card panel and edit windows. |
Space |
Enables you to add a card within the editor. Enables a selected card to be reordered. Commits actions on selected buttons and fields in the card panel and edit windows. |
Up arrow |
Selects the card or Add Card button on the row above the current card or Add Card button. When reordering cards, moves the card to the row above. The replaced card moves to the right. Replaced cards that are at the end of a row move to the start of the row below. |
Down arrow |
Selects the card or Add Card button on the row below the current card or Add Card button. When reordering cards, moves the card to the row below. The replaced card moves to the left. Replaced cards that are at the start of a row move to the end of the row above. |
Left arrow |
Selects the card or Add Card button to the left of the current card. If at the start of a row, selects the card at the end of the row above. When reordering cards, moves the card to the left. The replaced card moves to the right. Replaced cards that are at the end of a row move to the start of the row below. |
Right arrow |
Selects the card or Add Card button to the left of the current card. If at the end of a row, selects the Add Card button at the start of the row below. When reordering cards, moves the card to the right. The replaced card moves to the left. Replaced cards that are at the start of a row move to the end of the row above. |
Esc |
Escapes out of an edit window without saving changes. Cancels the card reordering action. |