---
sourceDocument: Australia ServiceNow AI Platform user interface
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/platform-user-interface

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia ServiceNow AI Platform user interface

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Zing search in Service Portal

# Zing search in Service Portal {#ariaid-title1}

Release version: Australia  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Zing search in Service Portal

Service Portal search integrates the ServiceNow Zing text indexing and search engine, enabling efficient indexing and searching of record data by table within the ServiceNow instance.
This functionality allows users to create search sources that retrieve data from one or multiple ServiceNow tables or external websites, providing flexible and powerful search capabilities within the portal.
Show full answer Show less  

## Search Sources

A search source defines the origin and behavior of searchable data, including:

* Where the data is retrieved from.
* Whether search suggestions populate as users type.
* How results are displayed.

There are two types of search sources:

* **Simple:** Configured to index data from a single ServiceNow table using default instance search engine settings.
* **Advanced:** Uses server-side data fetch scripts to query multiple tables or external data sources, allowing full control over search behavior.

## Text Index Groups

Text index groups control how search results are presented by combining results from multiple sources and weighting fields. They are an AI Platform feature and associate portals with unified search rules. The base system includes a default text index group covering Catalog items and Knowledge tables, delivering combined results. Note that external search sources are not supported in text index groups.

## Search Suggestions and Typeahead

Search suggestions replace typeahead search in Service Portal by default. You can configure this behavior using the `glide.serviceportal.searchasyoutypebehavior` system property. Service Portal search widgets automatically adapt to the enabled feature.

## Search Facets

Search facets enable users to filter and refine search results to obtain more relevant outcomes. Facets can filter results based on:

* Indexed fields in tables (e.g., Active, Author).
* Query conditions (e.g., date ranges).

Facets display in the Faceted Search widget on the `spsearch` page and are enabled by default in new instances. For upgrades, facets must be enabled by activating a record in the Page Route Maps table.

Facet configuration options include:

* **Simple:** Create facets for simple search sources based on field values or query conditions.
* **Advanced:** Use facet generation scripts and ServiceNow facet APIs to define complex, multi-choice facets for advanced search sources.

You can disable facets on selected search sources via system properties if needed.

## Practical Configuration and Use

* **Define search sources:** Set up either basic table-based sources or advanced scripted sources to tailor search data retrieval.
* **Enable or disable facets:** Control user filtering options based on your instance and upgrade status.
* **Populate search suggestions:** Run a script during upgrades to pre-fill suggestions or rely on user searches to build suggestions dynamically.
* **Assign text index groups to portals:** Customize how combined search results appear to users.
* **Set default search sources:** Use the `glide.serviceportal.defaultsearchsources` property to specify which sources are searched by default.
* **Configure contextual search:** Limit search results in typeahead widgets based on context to improve relevance.  
Service Portal search supports the ServiceNow Zing text indexing and search engine. Zing allows you to index and search record data by table and is created entirely with ServiceNow code and implemented within the relational model.

To make data searchable from Service Portal, you create search sources that fetch data from a single table within your ServiceNow instance, from multiple ServiceNow tables, or from an external site.

## Search sources {#zing-search-service-portal__section_iqf_zkd_ycb}

A search source is a record that describes the behavior and source of searchable data. A search source defines:

* Where to retrieve search data from.
* Whether search suggestions can populate the search field based on user input.
* How a search entry displays in the search result page.
{#zing-search-service-portal__ul_mgb_mgb_qz}

Search sources have simple and advanced configurations.  

Simple
:   Define a table within your ServiceNow instance as a source of searchable data. To learn more, see [Define a search source](https://www.servicenow.com/docs/fl69Wo2bO72DkB1FBiQJog "Configure a basic search source to query data from an instance table, or configure an advanced data fetch script to query data across multiple tables and data sources, or to pull data from anywhere on the web.").

    When you create a simple search source, Service Portal uses the search engine settings configured on your instance. To learn more, see [Zing text indexing and search engine](https://www.servicenow.com/docs/access?context=c_ZingTextSearch&version=australia&pubname=australia-platform-administration&ft:locale=en-US).

Advanced

:   Define a data fetch script to return data. A data fetch script executes on the server and returns a result array to the search widget. This method is more complex, but offers complete power over how a search executes. You
    are not limited to querying single tables within ServiceNow and can define a script that fetches data from multiple tables, or from anywhere on the web. To learn more, review the [Tutorial: set up an external knowledge base search source](https://www.servicenow.com/docs/G5Nfb~xa~g4GxAQQ7DOc5A "Define an advanced search source to return data from any source on the Internet. To understand the power of search sources, follow this tutorial to set up an external knowledge base search source.").

    Note:  
    Search facets may not behave as expected if integrated into an advanced search source that queries data from a non- ServiceNow site.

## Text index groups {#zing-search-service-portal__section_irs_gll_rhb}

A text index group defines how users see search results. For example, combine search results from several sources, or set the weight of certain fields.
Text index groups are a ServiceNow AI Platform feature. To learn more, see [Configure multiple
tables for indexing and searching](https://www.servicenow.com/docs/access?context=index-multiple-tables&version=australia&pubname=australia-platform-administration&ft:locale=en-US).

Associate a portal with a text index group to create common search rules and to combine search results from all search sources in the group. If you have a custom search source or portal, consider whether you want to use the base system portal_index_group text index group, or create your own text index group. The base system text index group includes the Catalog items and Knowledge tables. When a user searches for an item in Service Portal, they see combined results from these tables. To add an index group to a portal, see [Add a text index group to a portal](https://www.servicenow.com/docs/QdgSdWjlqbXuqTbwVPAwEw "Define how users see search results. For example, combine search results from several sources, or set the weight of certain fields.").  
Note:  
Text index groups do not support external search sources.

## Search suggestions and typeahead search {#zing-search-service-portal__section_tvx_m2r_fyb}

Search suggestions replaces typeahead search in Service Portal. Update the glide.service_portal.search_as_you_type_behavior system property to change this behavior. For more information, see [Enable and disable search suggestions](https://www.servicenow.com/docs/access?context=enable-search-suggestions&version=australia&pubname=australia-platform-administration&ft:locale=en-US). Service Portal search widgets automatically use whichever feature you enable.

## Search facets {#zing-search-service-portal__section_tjj_fyt_5cb}

Enable your end users to filter search results for a more meaningful result set. Facets can return results based on:  
* Fields in a table such as Active or Author.
* Query conditions such as \[Updated\]\[After\]\[Last week\].
{#zing-search-service-portal__ul_ucx_x2j_vbb}  
Note:  
Only set search facets for indexed fields. Fields that are not indexed may take longer to return results and are not optimized for a fast search experience. Learn more: [Configure a table for indexing and searching](https://www.servicenow.com/docs/access?context=configure-single-table-for-indexing&version=australia&pubname=australia-platform-administration&ft:locale=en-US).

Search facets render in the Faceted Search widget on the sp_search page.
In new instances, search facets are enabled by default. If upgrading from a previous release, enable search facets by activating a record in the Page Route Maps \[sp_page_route_map\] table. See [Enable search facets](https://www.servicenow.com/docs/pEI1v1Pq2_l8ikGkU9UTNA "In new instances, search facets are enabled by default. If upgrading from a previous release, enable search facets by activating a record in the Page Route Maps [sp_page_route_map] table.").  

Simple
:   Enable end users to refine search results for a simple search source. You can create facets for a table search source that return results based on field values or query conditions. See [Add facets to a simple search source](https://www.servicenow.com/docs/ai8_eWG1Qe2yA7Xv1vatUg "Enable end users to refine search results for a simple search source. You can create facets for a table search source that return results based on field values or query conditions.").

Advanced

:   Define facets for advanced search sources using the Facet generation script on the search source record. Use facet APIs to create facets and assign ServiceNow facet items or mapped queries to the facet.

    {#zing-search-service-portal__table_lhy_415_5cb__entry__2}

    | API | Use |
    |-|-|
    | [SPScriptedFacetService - Scoped](https://www.servicenow.com/docs/access?context=SPScriptedFacetServiceScopedAPI&version=australia&pubname=australia-api-reference&ft:locale=en-US) | Creates a single or multi choice facet. |
    | [SPScriptedFacet - Scoped](https://www.servicenow.com/docs/access?context=SPScriptedFacetScopedAPI&version=australia&pubname=australia-api-reference&ft:locale=en-US) | Defines facet items, filters, or mapped queries for the facet. |
    [ ]

    {#zing-search-service-portal__table_lhy_415_5cb}
* **[Define a search source](https://www.servicenow.com/docs/fl69Wo2bO72DkB1FBiQJog)**   
  Configure a basic search source to query data from an instance table, or configure an advanced data fetch script to query data across multiple tables and data sources, or to pull data from anywhere on the web.
* **[Enable search facets](https://www.servicenow.com/docs/pEI1v1Pq2_l8ikGkU9UTNA)**   
  In new instances, search facets are enabled by default. If upgrading from a previous release, enable search facets by activating a record in the Page Route Maps \[sp_page_route_map\] table.
* **[Add facets to a simple search source](https://www.servicenow.com/docs/ai8_eWG1Qe2yA7Xv1vatUg)**   
  Enable end users to refine search results for a simple search source. You can create facets for a table search source that return results based on field values or query conditions.
* **[Disable facets for a search source](https://www.servicenow.com/docs/mkrEzJJ3Gpiw8Jjj1QOl0A)**   
  Disable facets for one or more search sources by adding a system property. Once disabled, the search source does not display search facets in the Faceted Search widget on the sp_search page. You can disable facets for simple or advanced search sources.
* **[Populate search suggestions in Service Portal](https://www.servicenow.com/docs/eLalpbnhNEQzggobJ7a8UQ)**   
  If you are upgrading from a previous release, run a script to populate search suggestions with data from a platform search table to provide search suggestions to your users. Alternatively, you can wait until users search for keywords instead of running this script.
* **[Add a text index group to a portal](https://www.servicenow.com/docs/QdgSdWjlqbXuqTbwVPAwEw)**   
  Define how users see search results. For example, combine search results from several sources, or set the weight of certain fields.
* **[Set the default portal search source](https://www.servicenow.com/docs/bI1~nqpVdOz8dwUv3QVGMA)**   
  Use the glide.service_portal.default_search_sources system property to define default search sources.
* **[Configure Search Sources available on a page](https://www.servicenow.com/docs/HyzBDOzs7VKa1E8Z0bfgaw)**   
  Use contextual search to limit search results for an instance of the type-ahead search widget.