{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":39404,"path":"platform-administration/search-administration/configure-single-table-for-indexing.md","title":"Configure a table for indexing and searching","bundle":null,"doc_type":null,"release":"australia","body":"\n# Configure a table for indexing and searching\n\nEnable Zing text indexing for a table to allow users to search its records for string values. Configure the table's text indexing attributes, stop words, and synonym dictionaries to control search behavior.\n\n## Before you begin\n\nRole required: ts\\_admin or admin\n\n## About this task\n\nEnabling text indexing for a table allows users to search for string values in records on that table. You can configure attributes, stop words, and synonym dictionaries to control indexing and search behavior for an indexed table.\n\nBy default, the system creates text indexes for the tables with a Text index record \\(**All** &gt; **System Definition** &gt; **Text Indexes**\\). For example:\n\n-   Knowledge-related tables\n-   Core-data-related tables\n-   Connect-related tables\n-   Task table\n-   User table\n\nEnabling text indexing for a table also enables it for all child tables. If you want to disable text indexing for a child table, see [Remove the text index for a child table](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/remove-index-child-table.md).\n\n**Note:** Whenever you create an index table, the system also creates Access Control Roles \\(ACLs\\) for new tables.\n\nText indexing can be a resource-intensive task that may take a while to complete. You may notice performance degradation or incomplete search results during index generation. To estimate text indexing duration, you can [view historical text indexing statistics](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/r_ViewTextIndexingStatsAndStatus.md).\n\n**Note:**\n\nNew tables created by update set transfers have text indexing disabled, even if it's enabled for the tables included in the update set.\n\nTo enable users to search tables created by update set transfers, you must manually enable text indexing for those tables.\n\n## Procedure\n\n1.  Navigate to **All** &gt; **System Definition** &gt; **Text Index Configurations** and select **New**.\n\n2.  In **Applies to**, select **Table**.\n\n3.  In **Table**, select the table that you want to configure text indexing for.\n\n4.  If you intend to use the table in multi-table searches or if you want to use the BM25 scoring algorithm on the table, upgrade its indexing format to V4.\n\n    1.  If the value in **Format** isn't grayed out, select **v4**, then select **Submit** and skip to step [5](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/configure-single-table-for-indexing.md).\n\n    2.  If the value in **Format** is grayed out, select **Submit**.\n\n        The grayed-out value means that the table has already been indexed and needs its indexing upgraded to V4.\n\n    3.  Navigate to **All** &gt; **System Definition** &gt; **Text Index Configurations** and select the table you submitted.\n\n    4.  Under **Related Links**, select **Show index name record**.\n\n    5.  Under **Related Links**, select **Upgrade to V4** and select **Submit**.\n\n        The specified table's indexing is upgraded from V3 to V4. Now, this table can be part of multiple-table indexing and BM25 is used to score the table's relevance score. Optionally, select **Show Configuration** under **Related Links**to show the table indexing format on the **Text Index Configuration** page.\n\n5.  Configure indexing and search attributes on the selected table.\n\n    1.  Navigate to **All** &gt; **System Definition** &gt; **Text Index Configurations** and select the table you configured.\n\n    2.  In the Text Index Table Attribute Maps related list, select **New**.\n\n        Attributes pertain to the way Zing indexes documents and ranks documents returned in search results.\n\n    3.  On the Text Index Table Attribute Maps form, fill in the fields.\n\n        |Field|Description|\n        |-----|-----------|\n        |Table|Table to define attributes for.|\n        |Attribute name|Search engine attribute. For a list of the attributes and valid values, see [Zing index and search attributes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/index-attributes.md).|\n        |Value|Value for attribute.|\n\n    4.  Repeat this procedure to define additional attributes for the table.\n\n    5.  In the Related Links section, select **Generate Text Index**.\n\n6.  Configure column-level attributes.\n\n    1.  Navigate to **All** &gt; **System Definition** &gt; **Text Index Configurations** and select a table.\n\n    2.  In the Text Index Column Attribute Maps related list, select **New**.\n\n    3.  On the Text Index Column Attribute Map form, fill in the fields.\n\n        |Field|Description|\n        |-----|-----------|\n        |Table|Table that contains the column you want to define attributes for. Only tables in the index group and their child tables display.|\n        |Attribute name|Attribute. For a list of the attributes and valid values, see [Zing index and search attributes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/index-attributes.md).|\n        |Column|The name of the column in the selected table you want to apply the search attribute to.|\n        |Value|Value for attribute.|\n\n    4.  Select **Submit**.\n\n    5.  Repeat this procedure to define additional search engine parameters for table columns in the index group.\n\n    6.  In the Related Links section, select **Generate Text Index**.\n\n7.  Add stop words.\n\n    Stop words are words that you don't want to index, such as `the`, `a`, or `an`. There is a global list of common stop words, so you only have to add stop words specific to your situation. To see the global list of stop words, navigate in your browser to `https://<instance name>.service-now.com/ts_stop_list.do`.\n\n    1.  On the **Index Stop Words** tab, select **New**.\n\n    2.  In **Index**, select the index to add the stop word to.\n\n    3.  In **Word**, enter a single word you don't want to index and select **Submit**.\n\n8.  Add a synonym dictionary.\n\n    Specifying a synonym dictionary searches on the search term as well as synonyms of the search term, such as car, and its synonym, auto. Zing provides a default synonym dictionary.\n\n    1.  On the **Index synonym Dictionaries** tab, select **New**.\n\n    2.  In **Index**, select the index to add the stop words to.\n\n    3.  In **Synonym dictionary**, select the synonym dictionary to use on the specified table.\n\n        To add a dictionary, select **New** and follow the procedure in [Create synonym dictionaries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/create-synonym-dictionaries.md).\n\n\n## Result\n\nThe list search for text option appears on the list views for the table and its child tables.\n\n## What to do next\n\nYou can search records on the indexed table using list search in form view. To learn more about using list search, see [List search finds records from the current table](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/c_TextSearchesInRecordLists.md).\n\nYou can also query the indexed table for string matches using the `GlideRecord.addQuery(name, value)` or `GlideRecord.addEncodedQuery(name, value)` methods with the `123TEXTQUERY321` reserved name. For more information about querying for string matches, see [Querying tables in script](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/scripts/c_UsingGlideRecordToQueryTables.md).\n\n**Parent Topic:**[Zing indexes words](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/zing-indexes-words.md)\n\n**Related topics**  \n\n\n[Zing indexes punctuation as part of some words]()\n\n[Zing indexes some HTML elements]()\n\n[Configure a text index group to search across multiple tables]()\n\n[Zing index and search dictionary attributes]()\n\n[Regenerate a text index for a table]()\n\n[Remove an index]()\n\n[Remove an index for a specific field]()\n\n[Remove the text index for a child table]()\n\n[Change the query mode of an indexed table]()\n\n[Enable indexing of text in multi-row variable sets]()\n\n[Text indexing statistics and status]()\n\n[Configure tables to use the Japanese tokenizer]()\n\n## Fields excluded from text indexing\n\nText indexing excludes fields that meet certain name, type, attribute, or encryption conditions. User searches don't match or return values from excluded fields.\n\nText indexing excludes a field if it meets any of the conditions in the following table.\n\n<table id=\"table_lqx_lgc_bpb\"><thead><tr><th>\n\nCategory\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nField name\n\n</td><td>\n\nText indexing includes the **sys\\_class\\_name** and **sys\\_tags** fields but excludes all other fields whose names begin with **sys\\_**.\n\n</td></tr><tr><td>\n\nField type\n\n</td><td>\n\nText indexing excludes fields of these types:-   Date\n-   Date/Time\n-   Duration\n-   True/False\n-   Workflow\n\n For more information on these types, see [Field types reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/r_FieldTypes.md).\n\n</td></tr><tr><td>\n\nField attributes\n\n</td><td>\n\nText indexing excludes fields that have the **no\\_text\\_index** attribute set to **true**.For more information on this attribute, see [Remove an index for a specific field](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/t_RemoveAnIndexForASpecificField.md).\n\n</td></tr><tr><td>\n\nField encryption\n\n</td><td>\n\nText indexing excludes fields configured for Edge Encryption. For more information on configuring fields with Edge Encryption, see [Encrypt fields using encryption configurations](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_ConfigureCloudEdge.md).\n\n</td></tr></tbody>\n</table>"}}