1. SuiteAnalytics
  2. Search
  3. Saved Searches
  4. Defining a Saved Search
  5. Highlighting Search Results

Highlighting Search Results

Saved searches provide a variety of highlighting options you can use to call attention to selected search result rows. You can highlight individual rows that meet defined conditions. If your search results include grouped values such as counts, sums, and averages, you can highlight aggregated results that meet defined conditions.

Available highlighting options include:

For information about highlighting search results, see:

To apply highlighting to search results:

  1. On the saved search page, click the Highlighting subtab.

  2. On the Highlight If or Highlight If (Summary) subtab, click the Set Options icon next to the Condition field to open a popup window.

    • If you want to include expressions in the condition's filter(s), check the Use Expressions box. For information, see Using Expressions in Search Criteria.

    • If you are creating a condition for summary results, select from the Summary Type dropdown list. This selection must match the summary type defined for the field on the Results subtab.

  3. In the popup, select a field or a formula to be used as filter for the highlighting condition.

    Note:

    If you are creating a condition for summary results, make a selection from the Summary Type dropdown list. This selection must match the summary type defined for the field on the Results subtab.

    • To define a field value from the selected record type as a filter:

      • Select the field from the Filter dropdown list.

      • Click the Set Options button to open a popup where you can enter a value, and search logic (if available), for the filter field.

    • To define a formula as a filter:

      • Select a Formula option from the Filter dropdown list.

      • Click the Set Options button to open a popup where you can enter the formula.

      • For more information about search formulas, see Formulas in Searches.

    • To define a join field value from a related record type as a filter:

      • Select the related record type in the Filter dropdown list.

      • In the first popup that appears, select the join field from a Filter dropdown list.

      • In the next popup, enter a value, and search logic (if available), for the filter field.

      • For a list of related record types with join fields available for each record type search, see Related Records Fields Available for Advanced Searches.

  4. Repeat step 3 for each filter you want to apply as a condition for highlighting results. When you have added all filters, click the Set button in the popup.

  5. If you want to use an image to highlight results that meet the condition, select from the Image dropdown list, or click the Icon next to this dropdown list and select an image from the popup Icon Picker.

  6. If you want to change the text color of each result that meets the condition, click the Select Color icon in the Text Color column.

  7. If you want to change the background color of each result that meets the condition, click the Select Color icon in the Background Color column.

  8. If you want to bold text for each result row that meets the condition, check the Bold box.

  9. If you want to include a Legend in the footer of the Search, enter a Description for this highlight condition. For more information about legends, see Adding a Legend to Highlighted Search Results.

  10. Click Add.

  11. Repeat steps 2-10 for each highlighting condition you want to apply to the results of this search.

  12. Click Save.

Conditions for Highlighting

You select the result rows to be highlighted by defining conditions on the Highlighting subtab of a saved search page. You can define multiple conditions for each saved search; each condition can have its own associated highlighting options. A condition consists of one or more filters that are compared with results values. Results that satisfy filter(s) meet the condition, and are highlighted according to the options you set for that condition.

For example, you could create a condition for a saved customer report that would apply a green background to all customers in San Francisco with a balance greater than $5000. You then could create an additional condition that would highlight customers in San Diego with a balance over $5000 with a blue background.

One row in a search result can meet more than one highlight condition. When multiple conditions are met, highlighting depends on the order of highlight conditions. The first condition has the highest priority. When the first met highlight condition doesn't use all highlight possibilities (Image, Text color, Background color, Bold) then another condition is applied but for available criteria. If there are multiple conditions, the search results will be highlighted using the order of the conditions. For example, if a search result is a row with the following values.

Name

Email

Adam

No@example.com

For this example, the user applies multiple condition in this order:

  1. Name starts with ‘X’, Background Color is ‘Black’, Bold is ‘None’, Text Color is ‘White’, and Image is ‘None’.

  2. Name starts with ‘A’, Background Color is ‘Green’, Bold is ‘None’, Text Color is ‘None’, and Image is ‘None’.

  3. Email starts with ‘N’, Background Color is ‘Red’, Bold is ‘Y’, Text Color is ‘None’, and Image is ‘None’.

Nothing in the first condition applies to the search result. In the second condition, the search result matches the criteria of ‘Name starts with A’ so the entire rows background is green. In the third condition, the email does match the criteria of ‘Email starts with N’ so the background would be red, however, in the second condition the criteria supersedes this criteria. The ‘Bold is Y’ criteria is a match so the entire row has bold text.

Highlighting Using Greater Than or Magnitude Greater

The difference between the ‘Greater Than’ and ‘Magnitude Greater Than’ option is that the ‘Magnitude Greater Than’ option highlights both compared periods whereas the ‘Greater Than’ option does not. For example, if you compare sales for this period to last period and you use the ‘Magnitude Greater Than’ as follows:

Highlight if = Magnitude Greater Than | Threshold = ‘amount’ | Period = All | Background Color = ‘color’.

The result for both periods are highlighted. If, however, you use the ‘Greater Than’ option, in this example it will highlight the results for ‘This Period’.

Summary Highlighting

If you have defined a summary type for a field on the Results subtab of a saved search page, you can set up highlighting of aggregated results for this field on the Highlight If (Summary) subtab of the Highlighting subtab. Available summary types include count, sum, minimum, maximum, and average.

For example, if you filtered a saved transaction search to include sales transactions, and defined a summary type of Sum for the Net Amount field, you could highlight the names of customers with over $100,000 total sales with a red background color.

Adding a Legend to Highlighted Search Results

You can add a legend to highlighted search results for improved readability.

To add a legend to highlighted search results:

  1. On the saved search page, click the Highlighting subtab.

  2. For each defined highlighting condition enter a description in the Description field.

    For example, if you chose to highlight all customers with the 504 area code in yellow, you can enter 504 area code as your description.

  3. When the description is entered, click Done.

  4. Click Save.

Related Topics

General Notices