Quick Search

Quick Search finds documents, lists, reports, and pages in Frappe Books. It also opens new forms.

Open Quick Search

• On a computer, click the search icon in the page header. You can also press Ctrl + K, or Cmd + K on macOS.
• On a phone, tap Search in the bottom tabs.

Search

Type in the search box. Uppercase and lowercase letters are the same.

For a list, a form, a report, or a page, type some letters of its name in the same order. For example, sinv finds Sales Invoice.

Quick Search finds a document by its name, its document type, its main fields, and the main fields of its table rows. For example, it finds an invoice by its number, its customer, or an item in it. It finds documents by words:

• Each word that you type must match. The words can be in any order. For example, karen invoice finds the invoices of the customer Karen.
• A word of four or more characters also finds the words that start with it. For example, kare finds Karen. A shorter word must match a full word.
• A hyphen separates words. For example, 1001 finds SINV-1001.

A new or changed document can take some minutes to show in the results.

Quick Search shows only the documents, lists, and reports that you can read. It shows a Create result only for documents that you can create. It does not show the lists of features that are off.

Results

Each result has a gray label at the right that shows its type.

Lists, forms, reports, and pages show before documents. A document ranks higher when your words are in its document type or its name, and when it changed recently. Cancelled documents show last.

Quick Search shows the first 50 results. To show more, select 100, 500, or All at the bottom. On a phone, tap Show all.

When the search box is empty, Quick Search shows the last 10 items that you opened. To search them, start with #, such as #cust.

Filters

To hide a result type, click its button at the bottom of the dialog: Docs, List, Create, Report, Page, or Recent. Click it again to show the type.

To hide document types, click More filters. Skip transactions hides all transactions, such as invoices and payments. Click a document type to hide it, and click it again to show it. A filled button shows that its type is in the results.

On a phone:

1. To hide a result type, tap its button below the search box.
2. Tap Filters.
3. In the Search filters sheet, tap Skip transactions or each document type that you want to hide.
4. Tap Done.

The filters stay set until you reload the page.

Keyboard Shortcuts

On macOS, press Cmd instead of Ctrl. Click Help at the bottom of the dialog to open this page.