Versions Compared

Old Version 8

changes.mady.by.user Julien Massiera

Saved on

compared with

New Version 9

changes.mady.by.user Olivier Tavard

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note: We have a dedicated page for more technical information on the aggregator.

Note

If you use Keycloak with the Search aggregator, go to this page : /wiki/spaces/DATAFARI/pages/1067712513

...

  • Enable/Disable results aggregation: Set to ‘On’ to dispatch search requests to external Datafari instances and aggregate results. Set to ‘Off’ to disable the requests dispatch (SearchProxy behavior). NOTE: This button must only be activated on the main search server, it must be set to OFF on all the external servers.

  • Renew ‘search-aggregator’ client’s password:
    /info

    As specified in the first section of this documentation, the SearchAggregator makes use of a client on the Search API to get access tokens. The client name is ‘search-aggregator’ and is hardcoded in Datafari (cannot be changed), but its secret password has to be generated at least one time. This button generates a new secret password for the search-aggregator client. Obvioulsy, this Renew button is to be used on the External Datafari servers. You will then insert this secret into the second part of this admin UI page (External Datafaris) presented further below.

Info

Use it only if you do not use an Identity Provider like Keycloak

Note

The generated secret password is not saved in clear anywhere for security reasons ! Thus, once you click on the ‘renew’ button it will appear in clear just once so you will need to carefully keep it or you will need to renew it again !

...

  • Datafari name: The name you want to use to identify the external Datafari instance you are configuring (must be unique)

  • Search API URL: The URL of the Search API of the external Datafari instance. You MUST aim for the search API that disable the aggregator otherwise you will face two main problems in case the external Datafari has enabled the aggregator: first, the results of the external Datafari will contain results from other external Datafaris that should not be included, second, if the external Datafari is itself, then the request will end in an infinite loop !
    In Datafari v5.4 upwards, the endpoint of the search API that does not trigger the aggregator in any case is /rest/v2.0/search/noaggregator, so you MUST aim for the following URL: https://EXTERNAL_DATAFARI/Datafari/rest/v2.0/search/noaggregator

  • Token Request URL: The URL to request to get valid Oauth2 access tokens compatibles with the Search API.
    If the external Datafari instance does not use an Identity Provider like Keycloak then the default URL is http://EXTERNAL_DATAFARI_HOST:PORT/Datafari/oauth/token
    If the external Datafari instance uses an Identity Provider like Keycloak then you need to specify the URL of the Identity Provider that delivers access tokens

  • Password of ‘search-aggregator’ user: The secret password of the ‘search-aggregator’ client on the external Datafari instance (generated thanks to the ‘renew’ button but on the external Datafari instance)

  • Enabled: You can enable or disable the external Datafari to tell the SearchAggregator to either dispatch it or not the requests. It can be useful if for any reason the external Datafari instance is down or something.

...