FCS Aggregator

From WebLichtWiki

(Difference between revisions)
Jump to: navigation, search
(Using FCS Aggregator: Aggregator link set to the clarin contentsearch)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
The Aggregator application is a part of the [http://clarin.eu/content/federated-content-search CLARIN-FCS] common federated content search infrastructure.
+
The Aggregator application is a part of the [http://clarin.eu/content/federated-content-search CLARIN-FCS] common federated content search infrastructure. It serves as a user interface to perform queries to CLARIN-FCS resources and display search results.
 
+
The Aggregator communicates with components called endpoints, which are provided as a service by all centers who participate in the federated content search.
It serves as a user interface to perform queries to CLARIN-FCS resources and display search results.
+
Each endpoint provides access to one or more searchable resources. The user can select a specific resource or resources, based on the resource name or on the language, or search in all of them.
It communicates with components called endpoints, which are provided as a service by all centers who participate in the federated content search.  
+
The content of these resources is searched with the query supplied to the endpoint.
Each endpoint provides access to one or more searchable resources. The user can select a specific resource or resources, based on the resource name or on the language, or search in all of them.  
+
The content of these resources is searched with the query supplied to the endpoint.  
+
 
The endpoint returns results to this query and the aggregator collects the responses from all the endpoints and displays them to the user.
 
The endpoint returns results to this query and the aggregator collects the responses from all the endpoints and displays them to the user.
  
 
== Using FCS Aggregator ==
 
== Using FCS Aggregator ==
  
FCS Aggregator is available [http://weblicht.sfs.uni-tuebingen.de/Aggregator/ here]. No login required.
+
FCS Aggregator is available at [https://www.clarin.eu/contentsearch https://www.clarin.eu/contentsearch]. No login is required.
  
  
=== Sending a query ===
+
=== Basic search ===
To send a query and get search results it is enough to enter a search term and click '''Search''' button or press '''Enter''' key. The default search options will apply: all available in FCS corpora resources, any language, 10 hits per resource per search request.
+
To send a query and get search results it is enough to enter a search term and click the magnifying glass button or press the '''Enter''' key. The default search options will apply: all the available FCS collections in any language will be searched and up to 10 hits per collection will be displayed.
If you have navigated to Aggregator from [http://catalog.clarin.eu/vlo/ VLO] and resources selected in VLO are found among the corpora resources available (e.g. [http://catalog.clarin.eu/vlo/?wicket:bookmarkablePage=:eu.clarin.cmdi.vlo.pages.ShowResultPage&fq=collection:T%C3%BCbingen+Language+Resources&docId=http://hdl.handle.net/11858/00-1778-0000-0001-DDAF-D# TuebaDDC]), then the search will be performed only in those selected resources.  
+
  
===== Specify a search term =====
+
If you have navigated to Aggregator from [http://catalog.clarin.eu/vlo/ the VLO] and the resources selected in VLO are found among the corpora resources available (e.g. [http://catalog.clarin.eu/vlo/?wicket:bookmarkablePage=:eu.clarin.cmdi.vlo.pages.ShowResultPage&fq=collection:T%C3%BCbingen+Language+Resources&docId=http://hdl.handle.net/11858/00-1778-0000-0001-DDAF-D# TuebaDDC]), then the search will be performed only in those selected resources.
In the search field on the top of the Aggregator page enter your search term.  
+
  
===== Restrict the search =====
+
===== Search options =====
This step is optional. It describes how to restrict search by language or by selecting a specific resource or resources. By default, the search will be performed in all the available in FCS infrastructure endpoint resources. Or, if you have navigated to Aggregator from [http://catalog.clarin.eu/vlo/ VLO], only in those resources selected in VLO.
+
The default searching options are easily changed by using the control bar located underneath the Search form.
*Specify language of the resource: <br/>On the '''Search options''' tab, click on the '''Language''' button bar, and select the language.<br/>Clicking on the language bar after that will close the select option, but the selected language will be saved.
+
  
*Specify corpora to search in: <br/>On the '''Search options''' tab, click on the '''Corpora''' button bar. By default all the corpora resources are selected. If you want to restrict your search to a specific resource or resources, deselect all corpora and select only those of interest. <br/> Some corpora have sub-resources. Open on the specific corpora item to see if it has sub-resources. You can also select sub-resources to be searched.
 
  
*Specify number of records per resource per request: <br/>By default, 10 records per resource is returned. You can increase this number to 20 or 30 by clicking on '''Maximum hits''' button bar of the '''Search options''' tab and selecting the number. You can inspect more records after the first 10/20/30 hits are returned by clicking '''next''' arrow at the '''Search Results''' page.
+
[[File:Aggregator-overview.png|center|600px]]
 +
<br clear=all>
  
===== Perform the search =====
+
The following search options are available:
Click '''Search''' button.
+
  
 +
*Specify language of the resource: <br/>Click on the left-most button in the options bar, initially displaying '''Any Language''', and a dialog box with multiple language options will be displayed. To select a language option, click on the desired language and then click on the '''Close''' button. There are currently three language filtering strategies, that can be changed by using the selector at the bottom of the dialog window; these strategies are: 1. only search in the collections known to have resources in the specified language; 2. search in all the available collections, then use a language guesser and display only the results having the selected language; 3. search only the collections having resources in the desired language, and then filter the results by using the language guesser.
 +
<br/> [[File:Aggregator-language-dialog.png|center|600px]]
 +
<br clear=all>
  
 +
*Specify collections to search in: <br/>By default all the corpora resources are selected. If you want to restrict your search to a specific set of resources, click on the middle button in the control bar, initially displaying '''All available collections''' and a dialog window will show up. This dialog provides the option to select and deselect all collections, or particular collections.
 +
<br/> Some collections also have sub-collections, and the ones that do provide a link to expand and explore, select and deselect its sub-collections.
 +
<br/> [[File:Aggregator-collections-dialog.png|center|600px]]
 +
<br clear=all>
  
=== Inspecting the search result ===  
+
<br/>The collections view also offers the option to search the collections attributes and thus filter the list of displayed collections to only those of particular interest.
 +
<br/> [[File:Aggregator-collections-search.png|center|600px]]
 +
<br clear=all>
  
Search results will appear at the '''Search results''' tab. It is opened automatically when the '''Search''' button is clicked. The query is sent to all the selected corpora and the search results from resources are displayed on the first responds - first displayed basis. Therefore, you can start inspecting the search results (the records) before all the corpora have returned a response. Progress bar at the bottom of the page gives an information about the awaiting responses.
+
*Specify number of records per collection per request: <br/>By default, 10 records per collection is returned. You can change this number by using the right-most control of the control bar. More records can be retrieved at any time, in the focused view, when available.
  
===== Displayed records =====
 
The search results are displayed in a concordance view. The searched term in the middle, and left and right contexts. Some records have a permanent identifier (PID) and a reference. Click on the '''i''' icon to inspect PID and/or reference. Each resource returns a number of records specified in '''Maximum hits''' field of '''Search options''' (or 10 as default). Scroll down the page to see all the results.
 
  
===== Next records =====
+
=== Search results ===
As soon as all the resources respond, the '''next''' arrow appears at the bottom of the '''Search results''' page. Clicking it will perform a new query request to the same resources with the same search term, but with the records starting at the end of the currently displayed records. For example, if the number of records is set to 10, after the fist search each resource returns the first 10 records found (if any). Then after clicking '''next''' each resource will return next 10 records found for the given search term.
+
  
 +
Search results will start showing immediately after the search function is invoked. The query is sent to all the selected corpora and the search results from resources are displayed on the first responds - first displayed basis. Therefore, you can start inspecting the search results (the records) before all the corpora have returned a response. Progress bar at the top of the page gives an information about the awaiting responses.
 +
The search results are initially displayed in a textual view.
 +
<br/> [[File:Aggregator-results.png|center|600px]]
 +
<br clear=all>
  
 +
<br/> The textual view can be toggled to a concordance view, with the searched term in the middle, and its left and right contexts.
 +
<br/> [[File:Aggregator-results-kwic.png|center|600px]]
 +
<br clear=all>
  
=== What's next ===
+
<br/> The entire set of search results can be downloaded locally on your computer (click '''Download'''). Several formats are offered for exporting search results.
 +
<br/> [[File:Aggregator-results-download.png|center|600px]]
 +
<br clear=all>
  
You can save search results for further inspection, process them with WebLicht, or start a completely new search.
+
===== Focused View =====
  
===== Save the search results =====
+
For more information on a result set, click on the '''View''' button on the top-right of the result pane. This brings into focus the View dialog with more information on the collection that the results come from, and the option to download only the visible results.
There is an option to export the results into personal workspace (click '''Export to Personal Workspace''') or download locally on your computer (click '''Download'''). Several formats are offered for exporting search results.
+
<br/> [[File:Aggregator-view.png|center|600px]]
 +
<br clear=all>
  
===== Process with WebLicht =====
+
The '''More Results''' button at the bottom of this diablog will perform a new query request to the same collection with the same search term, and will retrieve and display the additional results. This process can be repeated until no more results are available.
To process the search results with WebLicht application, click '''Use WebLicht''' button and select '''with search results as text''' or '''with search results as TCF'''. The option '''with search results as TCF''' only appears if the language has been selected as German in the '''Search options''' tab.
+
  
===== Start a new search =====
+
To process the search results with the WebLicht application, click the '''Use WebLicht''' button and confirm by selecting the '''Send to WebLicht''' button. WebLicht can process result sets in a couple major languages.
You can perform a new search following the steps outlined above, for example changing the query term and/or searchable resources.
+
<br/> [[File:Aggregator-view-weblicht.png|center|600px]]
 +
<br clear=all>

Latest revision as of 11:56, 20 October 2016

Contents

Introduction

The Aggregator application is a part of the CLARIN-FCS common federated content search infrastructure. It serves as a user interface to perform queries to CLARIN-FCS resources and display search results. The Aggregator communicates with components called endpoints, which are provided as a service by all centers who participate in the federated content search. Each endpoint provides access to one or more searchable resources. The user can select a specific resource or resources, based on the resource name or on the language, or search in all of them. The content of these resources is searched with the query supplied to the endpoint. The endpoint returns results to this query and the aggregator collects the responses from all the endpoints and displays them to the user.

Using FCS Aggregator

FCS Aggregator is available at https://www.clarin.eu/contentsearch. No login is required.


Basic search

To send a query and get search results it is enough to enter a search term and click the magnifying glass button or press the Enter key. The default search options will apply: all the available FCS collections in any language will be searched and up to 10 hits per collection will be displayed.

If you have navigated to Aggregator from the VLO and the resources selected in VLO are found among the corpora resources available (e.g. TuebaDDC), then the search will be performed only in those selected resources.

Search options

The default searching options are easily changed by using the control bar located underneath the Search form.


Aggregator-overview.png


The following search options are available:

  • Specify language of the resource:
    Click on the left-most button in the options bar, initially displaying Any Language, and a dialog box with multiple language options will be displayed. To select a language option, click on the desired language and then click on the Close button. There are currently three language filtering strategies, that can be changed by using the selector at the bottom of the dialog window; these strategies are: 1. only search in the collections known to have resources in the specified language; 2. search in all the available collections, then use a language guesser and display only the results having the selected language; 3. search only the collections having resources in the desired language, and then filter the results by using the language guesser.

Aggregator-language-dialog.png


  • Specify collections to search in:
    By default all the corpora resources are selected. If you want to restrict your search to a specific set of resources, click on the middle button in the control bar, initially displaying All available collections and a dialog window will show up. This dialog provides the option to select and deselect all collections, or particular collections.


Some collections also have sub-collections, and the ones that do provide a link to expand and explore, select and deselect its sub-collections.


Aggregator-collections-dialog.png



The collections view also offers the option to search the collections attributes and thus filter the list of displayed collections to only those of particular interest.


Aggregator-collections-search.png


  • Specify number of records per collection per request:
    By default, 10 records per collection is returned. You can change this number by using the right-most control of the control bar. More records can be retrieved at any time, in the focused view, when available.


Search results

Search results will start showing immediately after the search function is invoked. The query is sent to all the selected corpora and the search results from resources are displayed on the first responds - first displayed basis. Therefore, you can start inspecting the search results (the records) before all the corpora have returned a response. Progress bar at the top of the page gives an information about the awaiting responses. The search results are initially displayed in a textual view.


Aggregator-results.png



The textual view can be toggled to a concordance view, with the searched term in the middle, and its left and right contexts.


Aggregator-results-kwic.png



The entire set of search results can be downloaded locally on your computer (click Download). Several formats are offered for exporting search results.


Aggregator-results-download.png


Focused View

For more information on a result set, click on the View button on the top-right of the result pane. This brings into focus the View dialog with more information on the collection that the results come from, and the option to download only the visible results.


Aggregator-view.png


The More Results button at the bottom of this diablog will perform a new query request to the same collection with the same search term, and will retrieve and display the additional results. This process can be repeated until no more results are available.

To process the search results with the WebLicht application, click the Use WebLicht button and confirm by selecting the Send to WebLicht button. WebLicht can process result sets in a couple major languages.


Aggregator-view-weblicht.png