Configuration
External Query Service
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2023.
All rights reserved. All hardware and software names used are brand names and/or trademarks of their respective manufacturers.
These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or any other protected rights. The dissemination, publication, or reproduction hereof is prohibited.
For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.
Introduction
The external QueryService plugin gives you the ability to browse both local and external indexes. It also gives you the ability to use external query expression/search response transformation services. “External" in this sense means a different Docker container.
Thus, you also have the possibility to use multiple indexes, but in this case, you should note that for this you need to configure the SearchResponseTransformationService, which combines the individual results (SearchResponses) of all indexes.
Installation
To install the plugin, open the Mindbreeze Management Center. Select the "Configuration" item from the left menu. Then navigate to the "Plugins" tab. In the "Plugin Management" section, select the corresponding mindbreeze.plugins.external.queryservice-<version>.tar.gz file and upload it using the "Upload" button. This will automatically install the external query service or update it if necessary.
Configuration
To create or configure the service, navigate to the "Indices" tab and click the "Add Service" button in the "Services" section.
Then select the desired service "QueryServicePlugin.ExternalService".
Base Configuration
Bind port | Port on which the service can be reached. |
Bind address | IP address or hostname to which the service is bound. |
Backend threads | Number of threads of the backend web server. |
Query Service Configuration
URLs of the Indices to query | List of indexes (specified as URL) used for the search queries. |
URL of the QueryExprTransformationService | Optional URL of the QueryExprTranformationService, which can also be in a container that is called before the indexes are invoked. |
URL of the SearchResponseTransformationService | Optional URL of the SearchResponseTransformationService, which can also be in a container that is called after the indices are invoked. Note: When using multiple indexes, this service is required. |
Fallback OAuth Configuration
By default, JWT is used as the authentication method. However, if this is not yet supported, the OAuth2 authentication method is used instead.
OAuth token URL | The URL from which OAuth2 access tokens can be requested. Normally: https://<server-FQDN> :8443/auth/realms/master/protocol/openid-connect/token |
OAuth Username | The OAuth User. Normally: admin |
OAuth Password | Password of the OAuth user. |
OAuth Client ID | Client ID of the OAuth user. |
Configuration in the Client Service
In order for the service to be used in the search, it must be entered in the client service under "Federated Query Engines" (Advanced Settings).
