- Print
- DarkLight
- PDF
iO Advanced search
The advanced search function offers a series of features to optimize search in Constellio. The following functions are made available by this module:
- Research Capsules - Available
- Words excluded from the proofreader - Available
- Synonym Management - Available
- Elevation and Exclusion Management - Available
- Research Contexts - Coming Soon
- Learning to rank - Coming soon
- Statistics - Coming soon
- Thesaurus Configuration - Coming Soon
- Boost metadata search - Available
- Boost search by query - Available
- Facets - Available
1. Search Capsule
Capsules are a tool intended to present information complementary to a search. A capsule can be customized. It is displayed when the user's search terms match the capsule criteria.
1.1 Consult the capsules
To consult the capsules:
- Go to " Administration ";
- Then in " Search Configuration ";
- Click on " Search Capsules ".
- The capsules created can be found on this page.
1.2 Add the capsules
- Go to " Pilotage ";
- Then in " Search Configuration ";
- Click on " Research Capsules ";
- Click on " Add capsule ";
- Fill out the form. Click on " Save " to save your capsule.
Metadata for adding capsules | |
---|---|
Field Name | Description |
Code | Internal identifier for your capsule. |
Title | The title displayed to users. |
Keywords | Search terms that will trigger the display of the capsule. |
Capsule language | For which languages the display will be made. |
Sub-collection | (Advanced) Filter for the metadata-based capsule poster under Collection. |
Content (text) | Content displayed for the capsule. |
Content (files) | Images to be used in the capsule poster. Use the right click after uploading to retrieve the image link. |
1.3 Display
Here is an example of displaying a capsule:
2. Words excluded from the spell checker
Constellio's spell checker offers corrections to terms entered by the user based on the content of the index and/or past searches.
2.1 Prerequisites
To allow suggestions to be removed, the user must have a role that provides the "Exclude and raise search result" function.
2.2 Keyword configuration
During a search, you have the option to remove a suggestion.
- Conduct research;
- He has offered you several choices;
- Click on the "X" of the keyword you want to remove;
- Confine deletion;
- Go to "Administration";
- Then in "Search configuration";
- Click on "Words excluded from the spell checker";
- You will find the word you removed during your search.
- To make the word available again in the corrector, click the green arrow on the right.
3. Synonym management
Synonyms are used to provide one (or more) equivalent terms during a search. For example, if we search for "dollar", we can find the documents with the terms "dollars" or "dolar".
3.1 Configuration
To configure the synonym list:
- Go to "Administration";
- Then "Search configuration";
- Click on the "Synonym Management" icon;
- Click on the " Edit " button.
- Synonyms must be entered and separated by commas. Each group of synonyms is separated by a line.
- After your changes, click "Save".
- Synonyms are now effective.
4. Elevation and exclusion management
Elevation allows two functions:
- Place a search result at the top completely for an accurate search.
- Exclude a search result for all searches.
A configuration screen is used to manage documents that are elevated or excluded from the search engine.
4.1 Consult elevations and exclusions
To know which words are high and excluded, follow these instructions:
- Go to "Pilotage";
- Then in "Search Setup";
- Click on "Elevation and Exclusion Management", and you will be able to see the scope of the queries.
4.2 Adding elevation through search
It is possible to elevate a result directly from the link of the result in the search engine.
- Conduct a search in Constellio;
- In the search results, click on this button to "Elevate Result";
- This will be added in so-called high queries.
4.3 Adding an exclusion through search
It is possible to remove a search result by the "Exclude" action.
- Conduct a search in Constellio;
- In the search results, click this button to "Exclude";
- This will be added in the so-called "Excluded" queries.
4.4 Removal of an elevation and/or exclusion
To remove an elevation or exclusion,
- Go to "Pilotage";
- Then in "Search Setup";
- Click on "Elevation and Exclusion Management";
- At the end of the query of your choice, click on the "X".
- To cancel all elevated queries, click the "X" at the end of the "High" query. This will cancel all elevated queries.
- To cancel all excluded queries, click the "X" at the end of the "Excluded" query. This will cancel all excluded queries.
5. Research contexts
Search contexts are used to customize the display of search results. They are used to generate a custom HTML presentation for the display of results.
This integration approach is no longer recommended for new deployments. Integration by Javascript client is much more flexible. However, for heritage purposes, this feature has been integrated into Constellio.
5.1 Prerequisites
An additional database must be installed at Constellio to enable this functionality.
5.2 Configuration
- To confirm the contexts, go to " Pilotage ";
- Then in " Search Configuration ";
- Click on " Search Context ". The list of contexts is displayed;
- To add a context, click the " Add " button.
Properties for contexts | |
---|---|
Field Names | Description |
Context Name | For display. |
Url parameter value | URL used to select context (must be unique). |
External files | Allow you to add external files to the context. |
Collection Name | Whether the context should be displayed for a single collection. |
Header HTML (French) | The content (French) is added directly to the header of the HTML page, at the beginning of the <body>. |
Header HTML (English) | The content is added directly to the header of the HTML page, at the beginning of the <body>. |
Footer HTML (French) | The (French) content is added directly to the end of the HTML page. |
Footer HTML (English) | The content (English) is added directly to the in of the HTML page. |
HTML of the HEAD tag (French) | The content (French) is added directly to the <head> database of the page. |
HTML of the HEAD tag (English) | The content is added directly to the <head> database of the page. |
For context, you can also add parameters, with the "Parameter" button. Parameters are added for each context. They can be inherited for subtexts.
Values of a context | |
---|---|
Value Names | Description |
Parameter name | Identifier with which the value can be referenced. The standard is to use the syntax ###Name###. |
Type |
|
Content | According to the type indicated above. |
6. Statistics
Constellio's statistics module allows you to consult the searches carried out by users. Various reports are available to consult the information.
6.1 Types of reports
Here are the types of reports available to view search statistics.
Types of reports available | |
---|---|
Report Name | Description |
Query log | Full report of all research conducted. |
The most popular queries | Aggregate searches and perform a count sorted by the most popular. |
The most popular queries without result | Aggregates searches without any results and performs a count sorted by the most popular. |
The most popular queries with a mouse click | Aggregates searches for which a result has been clicked and performs a count sorted by the most popular. |
The most popular queries without a click of the mouse | Aggregates searches for which no results have been clicked and does not perform a count sorted by the most popular. |
6.2 Configuring Reports
The following is a description of the fields available for configuring reports.
Click on " Apply " to generate a new report according to the parameters entered.
Field Name | Description |
Excluded queries | Allows you to filter certain queries from generated reports. |
Types of statistics | See the table above. |
Departure/end date | The time period for report generation. |
Filter | (Advanced) Filter according to the content of the search parameters. |
Capsule | Allows you to filter searches according to the capsules displayed. |
Show parameter column | (Advanced) Shows Constellio's internal query, can be used for advanced filtering (with the Filtered field). |
Lines | The number of lines for generating the Excel file. |
6.3 Displayed fields
The following is a description of the fields displayed in the reports.
Field Name | Description |
Date | Date/time (on the server) at the time of search. |
Request | Tests entered by the user. |
Frequency | (For all reports of the most popular types) countdown for the query. |
Sub-collection | (Advanced) Indicates whether the search is filtering based on a sub-collection (metadata fields). |
Tongue | Search language (based on a criterion or user profile). |
Number of results found | Number of total results |
Number of results clicked | The number of links clicked in the results displayed. |
Duration | Time in ms for search processing. |
Page | The page displayed during search. |
Type of search | If it's a search (At least one of the words, Exact phrase, etc.) |
Capsule | Code of the capsules displayed during the search. |
Clicked results | The number of results clicked. |
Parameters | Internal search details. |
7. Learning to rank (expert) (coming soon)
This module allows Constellio to learn how to provide better results based on past research. It is based on a machine learning model that reclassifies the results.
This module works at 3 levels:
- Description of "feature", a feature represents a criterion that will be weighted.
- Training: from the "features" chosen and past research, a model is built.
- Template: A template shows the score of the search.
The process must be done in a loop, in order to refine the model based on the past search result.
7.1 Adding a feature
Click on the "Add" button on the right. Here is the add/edit screen:
The name is used to describe the feature, for example, "pdf".
The type of query.
q: for a feature that depends on the query. The feature determines the score of the document based on its correspondence to the Solr query indicated.
fq: for a feature that does not depend on the query. The feature determines a value of 1 /0 based on the match to the indicated Solr filter.
The value of the query is based on the internal query sent by Constellio to Solr.
7.2 Training
Once the features are defined, we can build a model. Constellio logs queries and associated feature calculations.
We can thus use different techniques to generate a model that will be added to Solr.
Currently, this process has to be done by programming outside of Constellio.
8. Thesaurus Configuration (coming soon)
Constellio allows you to integrate a thesaurus in the SKOS format to add search-level functionality for users. Here are the features:
- Autocomplete in the search field
- Propose related research
- Link domains to research
The thesaurus is stored in the format SKOS.
8.1 Prerequisites
You must have an existing thesaurus in SKOS format. Constellio does not guarantee full support in SKOS format, so it is important to validate compatibility with our product.
8.2 Configuration
- In Pilotage, go to " Search Configuration ";
- Then click on " Thesaurus Management ".
The screen is divided into three tabs:
- SKOS file, indicates the loaded file and allows you to upload a new one.
- Denied Terms: Specifies the terms to be ignored in the uploaded thesaurus.
- Statistics: allows you to retrieve statistics for indexing the thesaurus.
8.2.1 SKOS file
This screen lists the currently loaded thesaurus if one of the following description fields is populated:
- By the way
- Thesaurus
- Description
- Date
- Creator
This information is extracted from the currently loaded (or not) SKOS file. You have the option to download a copy with the Download button. You can empty the loaded thesaurus with the correct "Delete the saved SKOS file". The file field allows you to drag and drop a file or select the file by clicking on "Choose File". Once a new SKOS is uploaded, it is important to click on "Save".
8.2.2 Rejected terms
Enter terms to be ignored from the thesaurus. One term per line. Click on "Save" to apply the changes.
8.2.3 Statistics
Constellio offers a series of statistics for the use of the thesaurus.
- Number of documents with at least one thesaurus concept.
- Number of concepts used at least once.
- Number of documents without concept of the thesaurus.
- The 1000 most used concepts: download the Excel file to consult.
- Unused concepts: download Excel files for viewing.