Universal Search reference

Field reference

Every field and action on Universal Search Setup and Search Index Configuration, with its default, allowed values and the tooltip shown in Business Central.

updated: applies-to: 1.0.0.1

This page applies to version 1.0.0.1; the current product version is 1.0.0.0.

This reference lists every field and action on the two Universal Search administration pages, with its default, its allowed values and the tooltip text Business Central shows for it. Use it alongside the guide pages, which explain when to change each setting: Start indexing, Choose what to index and Set result limits.

Universal Search Setup

Open it from Tell Me. There is one setup record per company.

Universal Search Setup card with the General and License groups
Universal Search Setup.

General group

Field Default and values Tooltip
Indexing Enabled Off after installation. Start Indexing turns it on. Specifies whether background indexing of configured tables is active.
Max Results 25. Allowed range 5 to 100. Specifies the page size for search results - the number of matches shown before the user has to select "Show more results". Also scales the per-table group cap in the mixed (All) view as more pages are loaded.
Max Records per Table 0, meaning no limit. Minimum 0. Specifies the maximum number of records indexed per table. This limits the database storage used by the index. Enter 0 for no limit.
Group Cap in All View 5. Enter 0 for no cap. Specifies the maximum number of results shown per table in the mixed (All) search view, so one large table cannot bury results from smaller tables. Enter 0 for no cap.

License group

All four fields are read-only. They are filled in by the activation wizard.

Field Values Tooltip
Activation Status Grace period, Activated or Declined Specifies whether the free license has been activated.
License Expiry Date Set on activation Specifies when the free license expires.
Registered Company Name Set on activation Specifies the company name registered with the license.
Registered Email Set on activation Specifies the contact email registered with the license.

Actions

Action Tooltip
Start Indexing Creates the background job that keeps the search index up to date.
Index Configuration Choose which tables and fields are searchable.
Universal Search Open the Universal Search page.
Activate Free License Activate your free 50-year license.

Search Index Configuration

One row per searchable table and field. Open it from Universal Search Setup or from Tell Me.

Search Index Configuration list with all ten columns visible
Search Index Configuration.

Columns

Column Default and values Tooltip
Table No. Required. Any table. Specifies the ID of the table that is searchable.
Table Caption Filled in from Table No. Read-only. Specifies the name of the table that is searchable.
Field No. Required. Text and Code fields of the table only. Specifies the ID of the field that is searchable.
Field Caption Filled in from Field No. Read-only. Specifies the name of the field that is searchable.
Weight 5 for new rows. Allowed range 1 to 10. Specifies how strongly matches in this field influence the ranking of search results.
Enable Phonetic On for new rows. Specifies whether sound-alike (phonetic) matching is used for this field.
Record Filter Blank, meaning every record. Checked against the table when entered. Specifies a table view/filter, e.g. WHERE(Blocked=CONST(No)) - only records matching it are indexed for this field. Leave blank to index all records.
Status Pending rebuild, Indexing, Active or Error. Read-only. Specifies the indexing status of this table.
Indexed Records Read-only. Set by each rebuild of the table. Specifies the number of records currently indexed for this table.
Last Error Read-only. Specifies the last error encountered while indexing this table.

Actions

Action Tooltip
Rebuild Selected Table Marks the table of the selected rows for a full rebuild. The rebuild runs in the background.
Process Now Runs the index builder immediately instead of waiting for the background job.

NOTE

A new Weight applies from the next search without a rebuild, because weight is read when results are scored. Changes to Enable Phonetic need Rebuild Selected Table to reach records that are already indexed. A new Record Filter marks the row for a rebuild by itself.

What's next

Return to the guide: Choose what to index, or see API and events for developers.

// next step

Ready to try Universal Search?