- Description
- How-to use
- 1 Enable the corresponding Entities and DSOs for global search
- 2 Configure corresponding Entity
- Settings/Attributes
Description
The global search is one searching window for all possible entities. So a developer can configure the searchable entities and for each entity another target window could be opened.
The global search window can be reached on two different ways:
- Via Shortcut:
Ctrl + F
(both for windows and mac) - Via User Profile Dropdown
A window with one Select-Field will pop up. In the Select-Field you’re able to search
How-to use
1 Enable the corresponding Entities and DSOs for global search
This will be done in the file src/backend/.restapplicationsettings
If there is no such file in your repository, you can add it with this template
{
"$schema": "/build-one/swat/backend/Akioma/Swat/.restapplicationsettings.schema.json",
"BaseConfig": "Akioma/Swat/.restapplicationsettings",
"omnisearch": {
"entities": "CustomerEntity|CustomerDSO"
}
}
In this example, we enabled the CustomerEntity for the global search, adjust this to your needed DSO
2 Configure corresponding Entity
- In the Entity itself, configure these values:
DetailsScreen
: The screen, which should be opened after the user chooses one entryDisplayFields
: The fields of the entity, which will be displayed in the result list, comma-seperatedDisplayIcon
: The fontawesome icon, which should be displayed as string, e.gfad fa-user
SearchFields
: The fields in which the global search will be searching
Settings/Attributes
Attribute | Description | Example/Values |
DetailsScreen | The screen, which should be opened after the user chooses one entry | CustomerDetailScreen |
DisplayFields | The fields of the entity, which will be displayed in the result list, comma-seperated | customername |
DisplayIcon | The fontawesome icon, which should be displayed as string | fad fa-user |
SearchFields | The fields in which the global search will be searching | customernumber |
Back to Documentation
Back to Home Page