e-Spirit AG
2023-12-19
1. Introduction
Search functions are just one of many features that customers expect from an online presence. They must be intuitive to use and deliver relevant results.
SmartSearch bundles these requirements and represents a high-performance search solution for them, which can be used on extensive websites. It offers both a high hit quality and an optimal search comfort and thus binds customers to the website.
By means of SmartSearch Connect, the functionalities of SmartSearch and FirstSpirit can be optimally combined. With very little effort it is possible to provide the website created with FirstSpirit with a high-performance search. Changes are directly reflected in the search results.
2. Goal
The goal of SmartSearch Connect is to create a simple and fast link between SmartSearch and FirstSpirit. Care has been taken to create as little installation and configuration effort as possible.
To ensure the simplicity of the module it was deliberately avoided to be compatible with every FirstSpirit project. For example, it is currently not yet possible to use projects in which fragments are used. In most cases the functionality should be more than sufficient.
3. Installation and configuration
To use the functionalities of SmartSearch Connect, the installation and configuration of different components is necessary. The steps required for this are explained in the following subchapters.
4. Installation of the module
The module must be added to the FirstSpirit-Server using the supplied smartsearch-connect-<version number>.fsm file. To install the module, open the ServerManager and select the Server Properties section → Modules.
5. Configuration of the service
The server-wide configuration is done with the SmartSearch ConnectConfigurationService.
5.1. Endpoint
Here you can configure the URL of the SmartSearch server. It is also important to define the port of the URL.
5.2. User/Passwort
The SmartSearch server is protected by user/password. The corresponding access can be stored here. The user defined here must have all rights in SmartSearch which are relevant for the creation of DataGenerators and PreparedSearches. For testing purposes, the standard user admin@localhost.de is sufficient after having been granted all rights as usual.
5.3. Ignore missing ssl certificate (just for tests)
On test systems the SmartSearch server is often not secured by a valid SSL certificate. To test if SmartSearch Connect works anyway, you can set this checkbox to ignore the invalid certificate.
All further configurations are project specific and therefore identical to the configuration in the cloud.
5.4. Testing the service configuration
To test the configuration of the service, the functionality of the "Initialization" can be used:
To do this, first call up the configuration of the project component in any FirstSpirit project as described in the document "SmartSearch Connect".
Using the button Initialize in SmartSearch! located there, a data generator and the PreparedSearch can be created at any time ("Initialization").
The response to this initialization can provide information about potential misconfiguration of the service, in case of an error information about the underlying problem can be taken either from the response dialog of the UI or from the SmartSearch log.
6. Legal notices
SmartSearch Connect is a product of e-Spirit AG, Dortmund, Germany. Only a license agreed upon with e-Spirit AG is valid with respect to the user for using the module. Only a license agreed upon with e-Spirit AG is valid for using the module.
Details regarding any third-party software products in use but not created by e-Spirit AG, as well as the third-party licenses and, if applicable, update information can be found in the file THIRD-PARTY.txt included with the module.
7. Help
The Technical Support of the Crownpeak Technology GmbH provides expert technical support covering any topic related to the FirstSpiritâ„¢ product. You can get and find more help concerning relevant topics in our community.
8. Disclaimer
This document is provided for information purposes only. Crownpeak Technology GmbH may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. Crownpeak Technology GmbH specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.