Skip to main content
ExLibris

Knowledge Assistant

BETA
 
  • Subscribe by RSS
  • Back
    SFX

     

    Ex Libris Knowledge Center
    1. Search site
      Go back to previous article
      1. Sign in
        • Sign in
        • Forgot password
    1. Home
    2. SFX
    3. Product Documentation
    4. Version 4.0
    5. SFX System Administration Guide
    6. eBook Search Set-Up Instructions

    eBook Search Set-Up Instructions

    1. Last updated
    2. Save as PDF
    3. Share
      1. Share
      2. Tweet
      3. Share
    1. Prerequisites
    2. Solr Sizing Requirements
      1. Disk Space
      2. Memory Usage
    3. Setting up the eBook Search
    4. eBook Search Set-Up Scripts for SFX Installations with Multiple SFX Instances
      1. Script to Change config/rsi.config
      2. Script to Copy all A-Z eJournal Profiles for Each Local Instance
      3. Monograph RSI and eBook Search Index Build for Multiple SFX Instances
    This page describes how to set up the eBook Search feature.

    Prerequisites

    The 4.3.0 Service Pack (including both the software and extra packages) needs to be applied on the SFX server.
    If you want to implement the instructions below without first logging out after applying the 4.3.0 SP, do the following: as the sfxglb41 user, go to the home directory of the sfxglb41 instance and type source .cshrc

    Solr Sizing Requirements

    Before setting-up the eBook Search, it is important to ensure the SFX server can handle the additional disk space and memory usage to support this new tool.
    The following tables provide some statistics and requirements that need to be met before you can set up the eBook Search.

    Disk Space

    For about 350,000 active book objects (in an SFX instance without institutes defined) about 500MB additional disk space is requiredin addition to the current SFX disk space requirements. For each institute defined in the instance, another 60-70MB disk space is required.
    It is strongly recommended to take into account future growth of the eBook collection when considering disk space requirements.
    For example:.
    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

    The Solr index requires the following additional memory in addition to the current SFX memory requirements, depending on the number of active book objects for each instance using the eBook Search:
    Heap and Cache Size
    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

    Perform the following procedure as the sfxglb41 user. Part of the procedure uses the Server Admin Utility. (For complete details on the options in the Server Admin Utility, see Server Admin Utility ).
    Cloud customers should not perform any steps that involve using the sfxglb41 user. These are handled by the hosting team.

    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.

    This step is required only for non-Verde customers. Verde customers already have triggers in place before 4.3.0 for SFX-Verde publishing. These triggers are automatically adapted to work with the tracking table when applying the 4.3.0 SP.
    Perform the following steps as a local instance user of each instance where A-Z eBooks will be used:
    Steps 1 and 4 can be done for multiple instances in the SFX installation. For more information, see eBook Search Set-Up Scripts for SFX Installations with Multiple SFX Instances .

    (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.

    It is possible to define additional eBook profiles - either manually or by copying the profiles defined for the A-Z eJournals list by using a wizard in the eBook configuration section. For more information, refer to the Copying eJournals Configuration section of the SFX General User’s Guide.
    Perform the following steps using the Server Admin Utility:

    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.

    It is recommended to set up the following two scheduled tasks:

    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

    You can config/rsi.config for multiple instances in one go by using a script. For more information, see Script to Change config/rsi.config .

    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:

    Perform the following only if the instance name in apache is not identical to the instance name in the SFX installation. For example, perform this step if the instance name on the server is sfxlcl41 - but the SFX base_url is <server>:<port>/sfxlcl3. In this case, sfxlcl3 is the instance aliased name.

    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]

    Make sure to replace <instance_aliased_name> (in two places) with the instance aliased name.

    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

    This section describes the eBook search set-up scripts for SFX installations with multiple SFX instances.

    Script to Change config/rsi.config

    It is possible to use a script to change the config/rsi.config file for each local instance (or list of local instances) so that a separate RSI index is created for eBooks and eJournals.
    Run the script as the root or sfxglb41 user (in which case you are prompted for each instance UNIX password). It takes as input one of the following parameters:

    --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)

    Location and name of the script:
    /exlibris/sfx_ver/sfx4_x/config/sfxglb41/admin/rsi_tools/update_all_rsi_books.pl
    Location and name of the configuration file:
    /exlibris/sfx_ver/sfx4_x/config/sfxglb41/config/rsi_ebook_setup.config_
    In the following section:

    Section "configuration"

    <instance_name1>

    <instance_name2>

    EndSection

    Instructions when using the --all_instances option:

    Log on to the server as the sfxglb41 user.

    Type da.

    Type ./rsi_tools/update_all_rsi_books.pl --all_instances.

    The following is displayed:

    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

    This section describes the script to copy all A-Z eJournal profiles for each local instance (or a list of local instances) and create corresponding eBook Search profiles.
    The script copies the profiles from A-Z ejournals to ebook Search for multiple instances. Run it as the sxglb41 user and use as input one of the following parameters and the location and name of the configuration file, and the instance names:

    --all_instances

    --all_except_test_instances

    --file  

    The script can be used instead of having to use the copy profile wizard from the SFX Admin Center > eBook Search configuration interface for each instance.
    The Script uses all A-Z eJournal profiles defined in a local instance to create corresponding eBook Search profiles (but only if they do not yet exist as an eBook Search).
    For settings that do not exist in the A-Z eJournal list configuration, the following default settings are used:

    Enable book thumbnails: off          

    Enable link between A-Z eJournal and eBook search: off

    Location and name of the script:
    /exlibris/sfx_ver/sfx4_x/config/sfxglb41/admin/aztools/copy_AZ_profiles.pl
    Location and name of the configuration file:
    /exlibris/sfx_ver/sfx4_x/config/sfxglb41/config/AZ_ebook_profiles.config_

    Section "Instances"

    <instance_name1>

    <instance_name2>

    EndSection

     
    Instructions when using the --all_instances option:

    Log on to the server as the sfxglb41 user.

    Type da.

    Type ./aztools/copy_AZ_profiles.pl --all_instances

    The following is displayed:

    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

    It is possible to run and schedule the RSI and eBook Search index for multiple instances. Use Server Admin Utility > 7 A-Z index > 4 AZ Index. The following is displayed:

    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)

    Select 4 eBook Search index tools for multiple instances to create the RSI and eBook Search index for multiple instances.
    For more information about this option, see eBook Search Index Tools for Multiple Instances .
    View article in the Exlibris Knowledge Center
    1. Back to top
      • Maintenance Task Checklist
      • Configuring SSL - Deprecated
    • Was this article helpful?

    Recommended articles

    1. Article type
      Topic
      Content Type
      Documentation
      Language
      English
      Product
      SFX
    2. Tags
      This page has no tags.
    1. © Copyright 2025 Ex Libris Knowledge Center
    2. Powered by CXone Expert ®
    • Term of Use
    • Privacy Policy
    • Contact Us
    2025 Ex Libris. All rights reserved