The diagram search feature is designed to simplify the user experience in finding relevant content. This guide will explain how to use the diagram search functionality in both the main app and the diagram application.
Prerequisites
Search is available in all types of spaces
Search logic
The key aspects of the search logic are:
Search Index: The search functionality uses a search index instead of a text index, offering higher accuracy and relevance of search results.
Search Scope: The search runs through both the name and description of the diagrams. It does not take into account any other diagram information.
Draft and Published Versions: The search results are filtered based on the version (draft or published) to avoid content duplication and ensure clarity.
Diagram Search in the Main App
In the main application, navigate to 'diagrams' menu item. Locate the search field at the top of the map list.
The placeholder text will read 'Find diagram'.
When you hover over the search field, a hint text will appear saying 'Search through all hierarchical maps to find the specific diagrams'.
Entering Search Terms:
Type in the name or description of the diagram you are looking for.
The search will run through the names and descriptions of all diagrams.
Search Results:
The search results will display diagrams matching your search criteria.
Only draft diagrams will be shown to avoid content duplication and confusion.
Diagram Search in the diagram app
In the diagram application, locate the search bar in the top left part of the screen. The search bar will function similarly to the main app but with additional version-based filtering.
To understand how diagram search works with versioning, read this article on diagram versioning.
Search Results by Version:
Draft Version:
When searching in the draft version of the map, only draft diagrams will be shown.
Published Version:
When searching in the published version of the map, only published diagrams will be shown.
Other Versions:
When searching in any other version, only draft diagrams will be shown.