Search
To perform searching within the module it is possible to use Quick search functionality which is available on both: Classic UI and New UI.
Quick Search on the New UI
Quick Search on the Classic UI
Quick Search was implemented based on Lucene library that means that syntax considerations of this library are applicable for Quick Search in the Encodify system.
Note! You can search all characters with the exception of special characters, which Data Grid interprets as spaces. These are + - = && || > < ! ( ) { } [ ] ^ " ~ * ? : \ /. You can search for special characters in a field-level search as long as you escape them using \ before the special character.
Below, you can find the list of characters and expressions that could be used in Quick Search to indicate the results that should be returned:
Search Term | Explanation | Example |
? | to replace a single character | search term: appl? results: "apply", "apple" |
* | to replace zero or more characters | search term: appl* results: "apples", "applied", "apply" |
Regular expressions (RegEx) | searches matching a pattern between forward slashes "/" | search term: /[mb]oat/ results: moat, boat |
~ | to search for a term similar in spelling | search term: roam~ results: foam, roams |
OR, || | to search for documents that contain either of two or more terms | search term: apple OR pear results: pear, apple |
AND, && | to search for documents that contain two or more terms | search term: apple AND pear results: apple pear |
NOT | to search for documents that contain one term but specifically not another | search term: apple NOT pear results: apple |
+ | requires that the term after the "+" symbol exist somewhere in a field of a single document | search term: +jakarta lucene results: jakarta lucene, jakarta |
() | to control the boolean logic for a query | search term: (jakarta OR apache) AND website results: jakarta website, apache website |
\ | to escape special characters | search term: \(1\+1\)\:2 results: (1+1):2 |
FilesContent: | to search within only file fields in the module | search term: FilesContent: ubuntu.png results: items with file "ubuntu.png" |
FieldObjectId: | to search by item id | search term: FieldObjectId: 3333 results: item with id = 3333 |
"" | to search by exact phrase | search term: “apple pear” results: apple pear |
Name: | to search within only name fields in the Users list | search term: Name:"David Blane" results: user with name "David Blane" |
Email: | to search within only email fields in the Users list | search term: Email:db@test.dk results: user with email "db@test.dk" |
Address: | to search within only address fields in the Users list | search term: Address:"Test street" results: user with address "Test street" |
City: | to search within only city fields in the Users list | search term: City:"Test" results: user with city "Test" |
Country: | to search within only country fields in the Users list | search term: Country:"Test" results: user with country "Test" |
Department: | to search within only department fields in the Users list | search term: Department:"QA" results: user with department "QA" |
Function: | to search within only title fields in the Users list | search term: Title:"QA" results: user with title "QA" |
Region: | to search within only region fields in the Users list | search term: Region:"New" results: user with region "New" |
SubRegion: | to search within only sub-region fields in the Users list | search term: SubRegion:"New 1.1" results: user with subRegion: "New 1.1" |
SystemAccess: | to search within access right fields in the Users list | search term: SystemAccess:"Admin" results: users with access right "Admin" |
Fax: | to search within only fax fields in the Users list | search term: Fax:"444" results: user with fax "444" |
Login: | to search within only login fields in the Users list | search term: Login:"davidBlane" results: user with login "davidBlane" |
Phone | to search within only phone fields in the Users list | search term: Phone:"555-55-55" results: user with phone "555-55-55" |
UserGroups: | to search within only user group fields in the Users list | search term: UserGroups:"QA" results: user with group "QA" |
For additional information, please, read the full documentation.
By default Quick Search can return max 10000 found items. If the returned number of items is more than 10000 user will be asked to enter more specific search query to make the result more precise. This limit is configurable and can be adjusted in webapp.yaml file. Also it is possible to disable leading wildcards in order to prevent high server load by inaccurate queries.
The list of supported files for text extraction(file indexing) can be adjusted in webapp.yaml in allowedFileFormats property.
Note: list of files in the code snippet below equals to the supported file formats that were hardcoded before and it contains maximum of files we support at the moment.If this property is not added to webapp.yaml then previous hardcoded in code list of files will be used instead.
Important: It is not recommended to add file formats that weren't used before for text extraction without informing development team since newly added format should be verified if it's supported and allowed in the code beforehand.
encode:
webapp:
quickSearch:
max-result-count: 100 (default 10000)
allow-leading-wildcard: false (default true)
allowedFileFormats:'pdf,doc,docx,docm,xls,xlsx,xlsm,ppt,pptx,pptm,potx,potm,ppsx,ppsm,xml' Note! It might be necessary to run reindex job to make quick search functionality works.
Indexing
Precondition for using quick search in the system is indexing of items, files and comments that needs to be performed to be able to search by the mentioned categories.
Indexing of items is a default process that takes place every time item is created/updated in the system. No prior configuration is needed.
Search in comments and files is disabled by default and requires enabling to start indexing process and be able to search.
Search in Comments
Search in comments can be enabled by selecting the "Enable search in comments" check box in Site Configuration > Settings.
Search in Files
Configuration of the file indexing and search includes 2 steps:
Enable in Site Configuration > Settings by selecting "Enable search in Files"
Configure on media holder level by selecting "Enable Indexing" check box
Note!
Enabling indexing on media holder level will start indexing of the whole module
"Enable Indexing" configuration setting is available only for the main media holders
"Enable Indexing" configuration setting is not available for multiple file fields (Starting from version 11, indexing is available for Multiple File fields as well).
Indexing of files will not be done in case "Enable search in Files" is disabled in Site settings, even if enabled on media holder level
If "Enable search in Files" is enabled in Site settings, "Enable Indexing" will be selected by default for all new created media holders
If "Enable search in Files" is disabled in Site settings, "Enable Indexing" will have to be manually enabled for new media holders
Logic for adding index messages to RabbitMQ:
If module has at least one media holder with enabled indexing, 1 message will be added to queue for each 10 items
If module does not have any media holders with enabled indexing, 1 message will be added to queue for each 100 items
Micro Search (Advanced Search)
Micro search can be enabled only for the module link fields in Site Configuration -> 'Field definitions'
By enabling the 'Enable Micro Search' the micro search will be enabled for the field in the module views / inline module views.
Click on the 'Advanced Search' button and an 'Advanced Search' pop-up will be displayed.
Gallery or list view can be selected as the selected view at the top right corner of the 'Advance Search' pop-up.
Items can be filtered and the selected item will be assigned to the particular item.