Texpress options

Five Texpress options are available to configure Solr's interaction with EMu. The options are set and adjusted by the emuindexing command when the -s option is applied (see Enable Solr indexing for details).

The options are:

Option	Description
indexing	The type of indexing set for a given module. The allowable values are texpress or solr. The default value is texpress.
indexurl	The URL used to contact the indexing engine. The texpress indexing engine is built-in and does not require any value to be set. For solr indexing the URL should be that used to communicate with the Solr instance used for indexing. The normal value for Solr indexing is http://localhost:8983 where the Solr instance is installed locally. The default is an empty value.
indexprefix	A prefix to be applied to the Solr core associated with the module where solr indexing is enabled. The prefix is used to differentiate between different instances of the same module. For example an institution may have production, test and development instances of their EMu installation. Each instance may have a version of the eparties module. The indexing for each instance of the eparties module is stored in the same Solr instance so a name clash would occur if each EMu instance tried to get the core name eparties. To avoid the clash the value of indexprefix followed by a hyphen is applied to the front of the module name (e.g. nmnh-eparties, nmnhtest-eparties, nmnhdev-eparties). The default value for indexprefix is the name of the EMu client instance. When Texpress indexing is enabled, the value of indexprefix is ignored.
solrpath	The location in which Solr files are stored. The default path for an EMu installation is in the solr directory in the EMu instance's home directory. The directory will contain an entry for each module in the installation. The path is not used by Texpress indexing.
solrdata	If Solr indexing is enabled, this option indicates whether a JSON representation of the data should be stored with the indexing information. If the option is set to yes, an extra field, named _data_, is available as a JSON string value. The string contains the data record JSON escaped. The default value is no. The setting is not used when Texpress indexing is enabled.

The -d option may also be used for Solr indexing to enable generation of a JSON string containing the indexed record. In general, there is no need to set the options manually. When the indexing method changes from solr to texpress, the indexprefix and indexurl settings will remain as they are used by both texinit (initialize a module) and emureindex to remove Solr indexing files no longer required. The solrpath option is set in EMu's .profile as a client-wide setting. The other options are set in the module's opts file (data/{module}/opts).

A typical opts file with Solr indexing enabled will contain (amongst other settings):

indexing=solr

indexurl=http://localhost:8983

indexprefix=museum

When Texpress indexing is enabled, either no entries will exist in the opts file or the indexing value will be set to texpress.