Global search allows you to search an entire ArcGIS Knowledge Studio project or the data in the knowledge graph it references. Entities and relationships returned in search results can be previewed, selected, and added to new or existing content items. You can open content items directly from the search result list.
The global search area is shown in the following image and described below. The numbers in the image correspond to the descriptions.
- Search bar—Modify the scope of the search term. By default, the entire project is searched as well as the entities in the knowledge graph.
- Search results pane—The content items or knowledge graph records that contain the search term are listed. You can select records and add them to content items or open content items directly from the results list.
- Record preview pane—The properties of the specified record from the Search results pane are displayed.
Search a project
Search results can include maps, link charts, and data cards that contain the search term, as well as entities and relationships from the knowledge graph.
- Click Search
on the title bar and type a search term in the text box. - Press Enter to start the search.
- Optionally, click Data in the search bar to limit the search to only the data in the knowledge graph.
Filter results
Search results can be filtered by content item and record types.
- Click Results Filter
in the search results pane. - Choose one or more filter options to filter the search results.
The filters you choose are listed at the top of the search results pane.
- Click Close
to the right of a filter option to remove it.
Open content items
Content items that contain the search term can be opened directly from the search results pane by clicking them.
Note:
You can have a maximum of 13 content items open at the same time. The chosen content item will automatically open if you have not reached this limit.
Add records to a content item
Entity and relationship results can be added to new or existing content items. You can also preview the properties of an entity or relationship result.
- Check the check box next to a record to choose it.
- Optionally, click a record to preview its properties.
- Click Add To
at the top of the search results pane. - Choose the appropriate option.
- Link Chart
—Create a link chart in the project. - Link Chart from Template
—Create a link chart in the project using an existing link chart as a template. The content for a new link chart is typically arranged using the force directed layout and default symbols are used to visualize entities and relationships. However, if you have imported a link chart that contains custom symbology, labels, popups etc. you can use it as a template. The new link chart layer will use the same custom layer definition as the existing link chart to visualize entities and relationships.
- Map
—Create a map in the project. - Map from Template
—Create a map in the project using an existing map as a template. New maps use default symbols to visualize entities. However, if you have imported a map that contains custom symbology, labels, popups etc. you can use it as a template. The new knowledge graph layer will use the same custom layer definition as the knowledge graph layer on the existing map to visualize entities.
- Data Card
—Create a data card in the project. This option is available when only one record is chosen. - Click the name of an existing content item where you want the records added.
- Link Chart
New content items appear in the Investigation Contents pane.
Search the knowledge graph
You can limit the search results to only the data in the knowledge graph.
- Click Search on the title bar and type a search term in the text box.
- Click Data on the search bar to limit the search to only the data in the knowledge graph.
- Optionally, click Scope Filter on the search bar to change the scope of the search.
Instead of searching only entities, you can also search only relationships or search both entities and relationships. The options only filter the records returned from the knowledge graph.
Scope Description Entities
Compare the search criteria to properties of all entity types included in the search indexes in the knowledge graph.
Relationships
Compare the search criteria to properties of all relationship types included in the search indexes in the knowledge graph.
Entities and relationships
Compare the search criteria to properties of all entity types and all relationship types included in the search indexes in the knowledge graph. This scope may not be available for all knowledge graphs.
- Press Enter to start the search.
Each knowledge graph has a Lucene index. Entity and relationship property fields can be added to the search index if they have Text or Globally Unique Identifier (GUID) data types. This allows you to search for entities and relationships using the content stored in those properties.
Search entities by keyword
When you search a knowledge graph, the criteria you provide are evaluated using the indexed properties of all entity types by default. The search results show the entity found by the search, its entity type, and the individual properties whose text met the search criteria.
Search syntax
In general, you can use the same search syntax as the advanced search in your portal to search for entities and relationships in a knowledge graph. Consider the following:
- To match words that start or end with a specific word or letters, add an asterisk (*) at the start or end of a search. For example, drive* returns records with properties containing driver, drives, and drive.
- You can refine search results by adding an additional word. Providing two words, such as drive truck will find graph items with text properties containing both words: drive and truck.
- When searching by two words, you can find graph items with text properties containing one or the other word by adding the Boolean operator OR (for example, drive OR truck).
- To find graph items with text properties containing a specific phrase, the appropriate words must be enclosed in quotation marks (for example, "drive a truck").
- You can use the note:truck syntax to find entities and relationships containing the word truck in the note properties. Likewise, you can use the note:"drive a truck" syntax to find graph items containing the phrase drive a truck.
While user-defined properties with the GUID data type are indexed and searchable by default, the system-defined globalid property is not. The value for this property is indexed, but you can only find a graph item by its globalid value by searching the specific field, for example, globalid:9612603C-D3A5-49B6-8631-B8A79234BC49. GUID values are enclosed in braces and displayed in the investigation's details panel, for example, {9612603C-D3A5-49B6-8631-B8A79234BC49}. You can search for a graph item using a GUID enclosed in braces within quotation marks, for example, globalid:"{9612603C-D3A5-49B6-8631-B8A79234BC49}".
Many other advanced searches are possible using the standard Lucene search syntax.
What you can search
What you can search in the knowledge graph depends on how the knowledge graph was created. Each knowledge graph has a Lucene index, to which you can add entity type and relationship type properties.
Knowledge graphs created with ArcGIS Pro
In knowledge graphs created with ArcGIS Pro, by default, all properties for entity and relationship types are indexed if they have Text or GUID data types.
Knowledge graphs created with ArcGIS API for Python
By default, knowledge graphs created with ArcGIS API for Python only contain search indexes for fields with the GUID data type. Search indexes for fields with the Text data type must be created separately after creating the knowledge graph. If search indexes are not created in the knowledge graph, global search in Knowledge Studio will not return results from the knowledge graph.
Knowledge graphs created with ArcGIS REST API
By default, knowledge graphs created with ArcGIS REST API only contain search indexes for fields with the GUID data type. Search indexes for fields with the Text data type must be created separately after creating the knowledge graph. If search indexes are not created in the knowledge graph, global search in Knowledge Studio will not return any results from the knowledge graph.