Creating or Editing a Search Application Configuration
The user interface of the ADF Search Application allows you to configure various semantic search and recommender applications. You can for instance customize the application layout, specify how the search results will be presented, or which filters will be available to the user to narrow down the search results.
The settings of the applications are stored as configurations. To add a new configuration, follow the instructions below. If you want to edit a configuration that already exists, you can skip to the Editing an Existing Configuration section.
Important
Before you start, make sure that a search space in the connected GraphSearch instance has been correctly configured. For more information, refer to the PoolParty documentation.
Note
GraphSearch remains supported. You can adjust corresponding settings in the Legacy Recommendation Settings section on the Details View Settings tab.
On the configuration interface, click Create new config.
The Edit configuration section appears at the bottom of the page.
Enter the name of your configuration.
Select the search space in GraphSearch that you want to use in this configuration.
Take note of the lock icon next to the search space. Configurations in the ADF Search Application are public or private , reflecting the settings of the selected GraphSearch search space. Private configurations are only accessible to logged-in users. Public configurations are available to all users unless authentication has been enforced in the
ADF.propertiesfile. For more information, refer to Manage Configurations on the Main User Interface of the Search Application.Configure the desired application settings, which include Results, Filter, Layout, and Details View settings.
Note
Some options may not be available depending on your previous choices.
On the configuration interface, select the pencil icon next to the configuration you want to edit.
The Edit configuration section appears underneath.
Edit the name of the configuration as desired.
Select the search space in GraphSearch that you want to use for this configuration. For more information, refer to the PoolParty documentation.
Configure the desired application settings, which include Results, Filter, Layout, and Details View settings.
To delete a configuration, click on the bin icon next to it.
Caution
This action permanently deletes the configuration.
The Result Settings control how search results will be displayed. You can customize various aspects such as the number of search results you want to see per page, whether to display associated tags, or give users the option to view similar documents.
Result Settings in the ADF configuration space
Results per page (1) – Enter the maximum number of search results you want to display per page.
Show results count (2) – Activate this option to display a a count of search results above the results list.
Length of the excerpt (3) – Define the maximum number of characters you want to display in the excerpt for each search result.
Show tags (4) – Enable this option to display the concepts which the search results have been tagged with.
Show results as images (5) – Activate this option to show search results as images on the Search View.
Number of tags (6) – Type in the maximum number of tags you want to display. If the number of tags exceeds this number, the user can click the Show All link to display all tags. Leave empty to display all tags by default.
Title action (7) – Select the action to be triggered when the user clicks the title of the document on the Search View. The possible options are:
Open Details View – Opens a new dialog with the following details:
a link to the original resource (a)
an excerpt from the document (b)
a timestamp when the document was created (c)
a list of concepts the document has been tagged with (d)
a list of recommended documents shown as text or images (if enabled in the Legacy Recommendation Settings on the Details View Settings tab) (e)
a list of similar documents shown as text or images (if enabled in the Recommendation section on the Details View Settings tab) (f)
Link to the original resource – Opens a new browser tab with the document.
Date format (8) – Choose the format to display the timestamp when the document was created. The possible options are:
Short (
YYYY-MM-DD) – year-month-dayMedium (
YYYY-MM-DDThh:mm:ss) – year-month-day hour-minute-secondLong (
YYYY-MM-DDThh:mm:ssZ) – year-month-day hour-minute-second timezone
Show similar documents (9) – Select this option to display the Similar documents button in the Search View.
Number of similar documents (10) – Specify the maximum number of similar documents you want to display when the user clicks the Similar Documents button.
The following example illustrates how the user interface changes to reflect the modified configuration settings:
The ADF User Interface with Default Settings
The ADF User Interface after applying changes in the Result Settings
The following changes have been applied:
Results per page has been increased to 20 results.
Length of the excerpt has been increased to 200 characters.
The Date format has been changed to Long.
Show similar documents has been disabled.
The Filter Settings control the display of search facets coming from the taxonomies connected in GraphSearch.
Filter settings in the ADF configuration space
Name (1) – Define the name of the facet that will appear on the Search View. The fields are pre-filled with concept schemes from the connected taxonomies.
Caution
The facet name must be unique.
Tip
Even if you change the name of the facet, the concept scheme name will be shown on the border framing the respective text field (a).
Show (2) – Choose this option to display the facet on the Search View.
Facet mode (3) – Select how the facets will be displayed. The possible options are:
Flat list – Displays concepts without any hierarchical order.
Top concepts – Only displays top concepts.
Tree view – Displays concepts from the taxonomy in their hierarchical order.
Hierarchical depth of tree (4) – Only available for tree view. Enter the maximum number of child concepts to be displayed.
Sort by (5) – Select how concepts of the facet will be ordered. Concepts can be sorted by Result count, Alphabetically, or Numerically.
Sort order (6) – Specify whether concepts of the facet should be ordered in ascending or descending order.
Number of terms (7) – Type in the maximum number of concepts to display for the facet.
Searchable (8) – Activate this option to display a search field inside the facet.
Hide empty facets – Scroll down to the bottom of the page and enable this option to hide facets without any documents. If not hidden they will be shown grayed out.
Tip
To reorder the facets, drag them by the square icon.
The following example illustrates how the user interface changes to reflect the modified configuration settings:
The ADF User Interface with Default Settings
The ADF User interface after applying changes in the Filter Settings
The following changes have been applied:
All concept schemes have been set to Show.
The Facet mode of Regulatory framework has been changed to Tree view, and the Facet mode of ESG was set to Top concepts.
Hierarchical depth of tree was set to 2 for the concept scheme Regulatory framework.
Regulatory framework is now sorted alphabetically, which was set in the Sort by setting.
The Sorting order of Regulatory framework was changed to be sorted in ascending order.
The Number of concepts have been reduced to 3 concepts for Regulary frameworks and ESG.
The facets for Regulatory frameworks and ESG have been set to be Searchable.
The Layout Settings allow you to customize the logo and the color scheme of the application.
Layout settings in the ADF configuration space
Main highlight color (1) – Select the color for table headers, document titles, selected concepts and URLs in all views.
Action button color (2) – Select the color for the following action buttons: Search, Generate URL, Similar Documents.
Critical action button color (3) – Select the color for the critical action buttons Delete and Reset.
Top navigation (4) – Select the color for the application header.
Facets color (5) – Select the color for the facets box on the left side of the Search View as well as in the Details View.
Documents in Search View (6) – Select the color for the documents box on the Search View.
URL to your logo (7) – Paste in a URL to display a custom logo in the top left corner of the application or leave this box empty to use the default PoolParty logo.
The following example illustrates how the user interface changes to reflect the modified configuration settings:
The ADF User Interface with Default Settings
The ADF User Interface after applying changes in the Layout Settings
The following changes have been applied:
The Main highlight color has been changed to purple.
The Action button color has been set to turquoise.
The Critical action button color is now orange.
The Header has been changed to pink.
The Details View Settings determine how facets, similar and recommended documents are displayed on the Details View of a search result. If enabled (Result settings > Title action), the Details View opens when the user clicks the title of a document returned by search.
Use the navigation on the left to navigate through each section in the Details View Settings (Extraction, Inference Tagging, and Recommendation.)
Extraction section in the Details View settings
Name (1) – If the search result has been tagged with concepts from this concept scheme, type in the name under which the tags should be listed on its Details View.
Show (2) – Select this option to display tags from this concept scheme on the Details View of a search result.
Show concept highlighting (3) – Scroll down to the bottom of the page and enable this option to highlight concepts found in the document excerpt. After the user selects a highlighted concept, a new dialog opens and they can see the concept's definition, alternative labels and broader concepts. This feature is only available to logged in users.
Example configuration of the main user interface
Inference Tagging configurations in the Details View settings
Import (1) - Configurations can be imported from the PoolParty Workbench. For more information, refer to the PoolParty documentation.
Once a valid configuration has been imported, inferred tags (2) will be displayed on the right side of the Details View of a document.
Example configuration of the main user interface
Recommendation configurations in the Details View settings
Import (1) - Configurations can be imported from the PoolParty Workbench. For more information, refer to the PoolParty documentation.
Show similar documents (2) – Activate this option to display a list of similar documents in the Details View of a search result. Depending on the settings, the similar documents can be displayed as text or images.
Number of similar documents (3) – Type in the maximum number of similar documents you want to display on the Details View of a search result.
Show similar documents as images (4) – Enable this option to show similar documents as images instead of text on the Details View.
When enabled, similar documents will be displayed in the Details View of a search result.
Legacy Recommendation Settings
Show document recommendations (5) – Activate this option to show a list of recommended documents on the Details View of a search result. Depending on the settings, the recommended documents can be displayed as text or images.
Number of recommendations (6) – Type in the maximum number of recommended documents you want to display on the Details View of a search result.
Show recommended documents as images (7) – Enable this option to show recommended documents as images on the Details View.
When enabled, recommended documents will be displayed in the Details View of a search result.
Confirm with Save.
Note
All settings can be adjusted if desired for any existing configuration.
The application settings are saved as a configuration. This configuration is by default available for selection on the main user interface. For more information on how to change that, refer to Manage Configurations on the Main User Interface of the Search Application.