eBook Search Set-Up Instructions
Prerequisites
Solr Sizing Requirements
Disk Space
Number of Active Book Objects | Number of Institutes | Size (MB) |
---|---|---|
350.000 | No institutes (only default) | 500 |
350.000 | 2 (default + 1 institute) | 550 |
350.000 | 3 (default + 2 institutes) | 600 |
900.000 | No institutes (only default) | 1200 |
900.000 | 4 (default + 3 institutes) | 2100 |
Memory Usage
Number of Active Book Objects | Number of Indexes (Solr Cores) | Number of institutes | Heap Size Required (MB) | Total Memory (MB) |
---|---|---|---|---|
300,000 - 400,000 | 1 | No institutes (only default) | 500 | 750 |
350,000 | 1 | 6 (default +5 institutes) | 500 | 750 |
350,000 | 1 | 11 (default +10 institutes) | 500 | 750 |
900,000 | 1 | No institutes (only default) | 500 | 750 |
300,000 - 400,000 | 3 | No institutes (only default) | 700 | 1050 |
300,000 - 400,000 | 10 | No institutes (only default) | 1200 | 1800 |
300,000 - 400,000 | 20 | No institutes (only default) | 2000 | 3000 |
Configure the heap size in the max_memory_size parameter in the solr_startup_params section in the /config/solr_index.config_ file as described in Setting up the eBook Search .
Heap size depends on the number of instances using Solr and on the number of active book records.
Total memory is calculated as: required heap size + 50% of the required heap. This should be either free memory or cached memory.
It is recommended to have additional 1GB of free/cached memory regardless to the new component for other processes run on the machine.
Take into account future growth of the eBook collection when considering memory usage requirements of your SFX installation, as well as additional instances that may use the eBook Search in the future.
Setting up the eBook Search
In the global instance, in the solr_startup_params section of the /exlibris/sfx_ver/sfx4_1/sfxglb41/config/solr_index.config_ configuration file, perform the following configuration changes:
Section "solr_startup_params" active "N" max_memory_size 500 port 8079 check_memory "Y" timeout "300" EndSection |
Set the active parameter to Y.
For the max_memory_size parameter – Specify a value (in MB) using the Heap Size Required column of the Memory Usage table (detailed in the Solr Sizing requirements section). Make sure that the Heap Size corresponds to the number of active book objects in the SFX installation (taking into account activation in all instances using the eBook Search). The default defined in the configuration file is 500.
The default for the timeout parameter is 300 (5 minutes), but you can increase the value if Solr is known to need more time than that to start up.
Start Solr.
From the main menu, select 1 Start services.
Select 12 Start Solr.
Create a Solr core for all local instances.
Select 14 Solr index.
Select 3 Create Solr cores for all instances.
(optional) Change the Solr password to something other than the default. (The default password is sfx2012.)
Select 3 Change passwords.
Select 4 Change Solr password (only by sfxglb41)
Create the TRACKING_TABLE and triggers.
Select 13 TRACKING table set-up and maintenance.
Select 2 Create table and triggers.
(optional) Review and make changes as desired to the default eBook Search profile provided with the 4.3.0 SP. To do this, from the Set-up and Administration section of the SFX Admin Center, click Configuration and then click eBook Search.
Build RSI eBooks and A-Z eBooks indexes:
Select 7 AZ Index.
Select 2 eBook Search index tools.
Select 2 (Re)build eBook RSI and Search index.
Set up RSI and A-Z eBooks scheduled tasks.
Select 7 AZ Index.
Select 2 eBook Search index tools.
Select 4 Schedule an eBook Search (and RSI) index build.
an incremental only build once a day (or on another frequent schedule)
a build using the incremental unless complete build is required option once every night (or on another less frequent schedule - for example, a few times a week or even weekly). Do not schedule this build to run during the day because a complete build is performed if the incremental build cannot be run. Running a complete build may impact SFX performance.
Alternatively, it is possible to only set up only the second scheduled task if there are few changes expected in activation information for books and if it is acceptable to not have the activation changes reflected immediately in the eBook search and RSI monographs.
It is possible to build or schedule a build of the RSI and eBook Search indexes for multiple instances. For more information, see Monograph RSI and eBook Search Index Build for Multiple SFX Instances .
Change config/rsi.config for each local instance to use a separate RSI index for eBooks and eJournals. Set the parameter to Y to ensure eBook data is stored in a dedicated RSI index.
Section "monograph_parameters" Separate_RSI_for_Books "Y" EndSection |
For customers with Consortia model 2 - consortia API only, see Appendix B eBook Search Set-Up for Consortium Model 2 in the Using SFX in a Consortium Environment document to complete the consortia-specific set-up.
Edit the local_httpd.config file:
Log on as the instance user and type cn
Type vi local_httpd.config
If the following lines already exist in the local_httpd.config file:
RewriteEngine on RewriteRule ^/<instance_aliased_name>-([^/]+)/azlist$ /<instance_aliased_name>/azlist/$1 [PT,E=__INST_URL_PART:-$1] RewriteRule ^/<instance_aliased_name>-([^/]+)/(.*)$ /<instance_aliased_name>/$2 [PT,E=__INST_URL_PART:-$1] |
add the following on the line after RewriteEngine on:
# For the azlist script redirect RewriteRule ^/<instance_aliased_name>(-[^/]+)?/azbook(.*) /<instance_aliased_name>/az$2?param_perform_value=ebook [QSA,PT,E=__INST_URL_PART:$1] |
Type :wq to save the file.
Restart the local instance apache:
apachectl stop apachectl start |
eBook Search Set-Up Scripts for SFX Installations with Multiple SFX Instances
Script to Change config/rsi.config
--all_instances (all local instances on the server)
--all_except_test_instances (all local instances on the server, except for those with either test or tst in their name)
--file (the list of instances is taken from a configuration file)
Section "configuration" <instance_name1> <instance_name2> EndSection |
Log on to the server as the sfxglb41 user.
Type da.
Type ./rsi_tools/update_all_rsi_books.pl --all_instances.
Begin applying changes to RSI configuration file process. Switching to instance: sfxlcl41. Password: Instance: sfxlcl41 - Configuration file changed (config/rsi.config). Switching to instance: new41. Password: Instance: new41 - Configuration file changed (config/rsi.config).Configuration file(s) changed. Check /exlibris/sfx_ver/sfx4_1/sfxglb41/logs/rsi_ebook_setup.20120525174037.log for details. |
Script to Copy all A-Z eJournal Profiles for Each Local Instance
--all_instances
--all_except_test_instances
--file
Enable book thumbnails: off
Enable link between A-Z eJournal and eBook search: off
Section "Instances" <instance_name1> <instance_name2> EndSection |
Log on to the server as the sfxglb41 user.
Type da.
Type ./aztools/copy_AZ_profiles.pl --all_instances
Starting to work on instance sfxlcl41... Copying profile arts... finished. Done for instance sfxlcl41. Starting to work on instance new41... Done for instance new41. Done for ./aztools/copy_AZ_profiles.pl |
Monograph RSI and eBook Search Index Build for Multiple SFX Instances
1 eJournal A-Z index tools 2 eBook Search index tools 3 eJournal A-Z index tools for multiple instances (only by sfxglb41) 4 eBook Search index tools for multiple instances (only by sfxglb41) |