The integrated search function is based on the Apache Solr search platform, which is installed in the <ifs_home>/ifsdoc/search folder. The search functionality is based on indexes which are created when the documentation is installed.
During the installation of the documentation there are indexing scripts created. The scripts are then started in a sub process to create indexes for each part of the documentation. This console window will monitor the indexing progress and remain until confirmed.
| Part | Indexing Script |
|---|---|
| Online Documentation | indexsite_ifsdoc_<language>.<extension> (one for each language) |
| Technical Documentation | indexsite_techdoc.<extension> |
| Training Material | indexsite_tm.<extension> |
The indexing scripts reside in <ifs_home>/ifsdoc/search and the log files in <ifs_home>/ifsdoc/search/logs, along with the Solr log solr.log. There is a script indexsite_all.<extension> which calls all the other scripts to recreate all indexes and a script indexsite_recently_installed.<extension> for the latest installed documentation. All scripts can be run again. Before an index is recreated the existing one is deleted.
The indexing is performed by a java program in <ifs_home</repository/ifsdoc/indexsite.jar using the SolrJ API's.
The indexes are stored in <ifs_home>/ifsdoc/search/solr in separate folders e.g. ifsdoc_en and techdoc. If some documentation is installed via a delivery, an existing documentation folder is deleted and the new content is extracted in a new one. Also the index will be recreated for that part. By using the indexing scripts created at the installation, it is possible to locally modify the documentation and re-run the indexing scripts. The modifications will then be included in the indexes.
The Solr search platform includes an administration web page. This is accessed through the URL http://<server>:<port>/solr/ where port is the main http access point e.g. 58080. For further information see the Solr official web site.
The Solr path in the above URL is redirected (proxied) to "localhost", http://localhost:<port>/solr/ and can be accessed when logged on to "localhost". The port number is defined in the part Setup Documentation of the installation and the default is the main port number + 15, e.g. 58095.
The administration web page for Solr version 7.2 is by default protected by an authentication logon dialog. The user and password is though not activated. To activate, manually edit the file <ifs_home>/ifsdoc/search/etc/realm.properties and restart the Solr service. Note! The authentication is of type BASIC and the username and password are stored in cleartext in the file. Through the administration web page it is possible to modify and even destroy the indexes. Hence access should be enabled only when required for debugging purposes. It should be reset and the Solr service restarted when ready.
Example:
#user: password, admin
Remove the comment character "#" , change "user" and "password"
to appropiate values and save the file. Do not change the group identifier "admin".