A-Z and eBook Search Indexes

The A-Z index uses data from the RSI index. Therefore, you must first build the RSI index and then build the A-Z index. You can build both indexes in one action from the AZ Tool menu. For information on building the RSI index, see Rapid Service Indicator .
To access this option, type 7 A-Z Index from the main menu. The following is displayed:
AZ Index
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)
Please select [1-2,q,m]:

eJournal A-Z Index Tools

To access the eJournal A-Z index tools, type 1 eJournal A-Z index tools. This option allows you to rebuild the A-Z eJournal index alone or with the RSI index and schedule the A-Z eJournal index building. The AZ eJournal Tools menu is displayed:
AZ Tools
1 (Re)build the AZ index
2 (Re)build RSI and AZ index
3 Show scheduled AZ (and RSI) index builds
4 Schedule an AZ (and RSI) index build
Please select [1-4,q,m]:
Select option 1 (Re)build the eJournal AZ index. A screen similar to the following is displayed:
Running the index builder may take a long time, possibly hours depending on the amount of active portfolios.
Are you sure you want to continue? [y/n] y
AZ IndexBuilder initializing.
Logging to /exlibris/sfx_ver/sfx4_1/sfxlcl41/logs/az_index_builder.20070410140334.log.
Creating AZ build tables...
Creating build tables ...
Acquiring all locally active portfolios...
Preparation done
Loading active titles...
Filling titles extra info...
- Retrieving displayers (ISSN, LCCN etc)...
- Done retrieving displayers (ISSN, LCCN etc)
- Retrieving MAIN title...
- Done retrieving MAIN title
- Retrieving ABBREV titles...
- Done retrieving ABBREV titles
- Retrieving categories...
- Done retrieving categories
- Retrieving target services...
- Done retrieving target services
- Updating records...
- Done updating records
:
Done filling extra into for titles
Copying data from build tables...
Reloading AZ cache...
Done reloading AZ cache
AZ Index Builder done.
AZ Profile: default
* Active objects processed: 13987
* Failed objects (see log for details): 0
* AZ Titles loaded: 13987
* AZ Letter Groups created:: 13987
* AZ Searchable Titles created:: 32346
Select 2 (Re)build RSI and eJournal AZ index to build both the RSI and eJournal AZ indexes. The following is displayed:

This option will first (re)build RSI index - then (re)build A-Z index. The process may take a long time, possibly hours depending on the amount of active portfolios.

Are you sure you want to continue? [y/n]

Type y to continue.
  • Journals in the SFX KnowledgeBase missing required title information for display or sorting are not included in the A-Z list. They are listed in the log file generated during the A-Z index creation. This log file is located at:

/exlibris/sfx_ver/sfx4_1//logs/

  • Some configuration of the A-Z list is required before the A-Z index can be built. This configuration is done from the SFXAdmin center by clicking the A-Z List option from the Configuration section of the Set-Up and Administration area. (More information can be found in the A-Z List section of the SFXGeneral User's Guide.)
  • The A-Z index building prints an error message and quits if there is no country defined in the default A-Z configuration.
To ensure that the A-Z index is updated daily with changes in the SFX instance, it is recommended to set up a cron job to build the A-Z index. Select option 4 Schedule an AZ (and RSI) index build from the AZ Tools menu. Define the index you want and rebuild. You are then asked questions about what time and days you want the A-Z index build process to run. In the following example, the A-Z list index build is scheduled to be run in a cron job every night at 2:30 AM. (Bold text is typed by the user.)
AZ Tools
1 (Re)build the AZ index
2 (Re)build RSI and AZ index
3 Show scheduled AZ (and RSI)index builds
4 Schedule an AZ (and RSI) index build
Please select [1-3,q,m]: 4
Please define index to rebuild:
1 AZ index
2 RSI + A-Z index
Please select [1-2,q,m]:1
Please enter scheduling parameters
Time must be in the form HH:MM where
HH can be: 00-23 for midnight-11PM or * for every hour
MM can be: 00-59 or * for every minute
Enter the time to run [00:00]: 2:30
Would you like to schedule for a certain weekday? [Y/n] n
Please enter month (1-12 for January-December respectively or '*' for every month) [*]: *
*
Please enter day of the month (1-31 or '*' for every day) [1]: *
*
Successfully added the refresh task to your crontab.
Once you have successfully added a cron job, it can be viewed and deleted. Select option 3 Show scheduled AZ (and RSI) index builds from the AZ Tools menu. The following screen is displayed:
AZ Tools
1 (Re)build the AZ index
2 (Re)build RSI and AZ index
3 Show scheduled AZ (and RSI)index builds
4 Schedule an AZ (and RSI) index build
Please select [1-3,q,m]: 3
AZ indexing schedule is as follows:
[1] AZ index only - 00:00 of every Sunday of every month
[2] RSI + AZ index - 00:00 of every Sunday of every month
Would you like to remove any of these? [y/N] y
Please enter the number of the task to remove or to cancel:
Type the number of the cron job that you want to delete.
If SFX detects at the start of the AZ build, that the RSI_BUILD table still exists, the following error is displayed and the build stops: RSI index build is currently running - RSI/AZ build process cannot be started.

eBook Search Index Tools

To access the eBook Search index tools, type 2 eBook Search index tools. The following is displayed:
eBook Search Tools
1 (Re)build the eBook Search index
2 (Re)build eBook RSI and Search index
3 Show scheduled eBook Search (and RSI) index builds
4 Schedule an eBook Search (and RSI) index build
Please select [1-4,q,m,u]:V
Select 1 (Re)build the eBook Search index to build the eBook Search index or select 2 (Re)build eBook RSI and Search index to build both the eBook Search and RSI indexes. The following is displayed:

Running the eBook search index builder may take a long time, depending on the amount of active portfolios.

Are you sure you want to continue? [y/n]

Type y. The following is displayed:

The eBook search index build can be either 'complete' or 'incremental'.

Incremental build is recommended as it will take less resources and time.

Do you want to use incremental build - if this is available in your instance?

Type (i) for incremental build, or (c) for complete build: [i]

Type i for an incremental build or c for a complete build. The following is displayed:

In case incremental build of the eBook search index cannot be performed, do you want to run complete build instead?

Note that in a live SFX environment, a complete build of the eBook search index is recommended to be run at night or during a server 'slow' time, because it requires a significant amount of system resources. [y/N]

Type y or n to start the build.

Schedule an eBook Search (and RSI) Index Build

This task cannot be scheduled when Centralized Management of Maintenance Tasks is activated. If you attempt to do so, the following is displayed: Maintenance tasks can be scheduled only by the system administrator of this SFX installation. This option is not available for local SFX instances.
Select 4 Schedule an eBook Search (and RSI) index build to schedule a build. It is recommended to set up the following two scheduled builds:
  • An incremental only build once a day (or on another frequent schedule). This build is fast and does not impact SFX performance.
  • A build using the incremental unless complete build is required option once every night (or less frequently, 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.

Configuration

The maximum amount of changes before a complete build is needed is defined in the config/solr_index.config configuration file in the complete_build_params section:

Section "complete_build_params"

# The parameters below determine the maximum amount of changes allowed for incremental build of the monograph A-Z index.

# If the number of changes in the SFX KB exceeds the parameters below, a complete build is required.

max_op_changes "15000"

EndSection

A-Z Index Tools for Multiple Instances

Use this option to run or schedule an RSI and A-Z index build for multiple instances. This is done if the SFX installation contains more than one production instance, and the building of the indexes can be set up to be performed one after the other.
Building an RSI or A-Z index for multiple instances must be done as the sfxglb41 user. Additionally, before using this option, sudo permissions need to be set up for the following script:
/exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances.pl
Otherwise, the following error is displayed:

sudo permission for run_rsi_az_for_all_instances.pl is mandatory, the script cannot run.

Select 3 eJournal A-Z index tools for multiple instances to build the RSI or A-Z index for multiple instances. The following is displayed:

Building RSI and eJournal A-Z index for multiple instances (only by sfxglb41)

1 (Re)build RSI and eJournal A-Z index

Please select [1,q,m,u]:

Select 1 (Re)build RSI and eJournal A-Z index. The following is displayed:

Warning: This option can only be used if sudo permissions have been set up for the file admin/aztools/run_rsi_az_for_all_instances.pl. Otherwise, the index build will fail.

Define instances for which index should be (re)build:

1 all instances

2 all except test instances

3 use configuration file

4 specify instances

Please select [1-4,q,m,u]:

For information concerning recommendations for scheduling tasks, see 15 - eBook Search in Maintenance Task Checklist.

Building the Index for All Instances

Select 1 all instances to build the index for all instances. The following is displayed:

Running the index builder may take a long time, possibly hours depending on the amount of active portfolios.

Are you sure you want to continue? [y/n]

Type y to continue. The following is displayed:

Logging activity for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl at '/exlibris/sfx_ver/sfx4_1/sfxglb41/logs/run_rsi_az_for_all_instances_new.pl-2012-05-24T13:35:11.log'.

Starting /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Running journals Index build for instance: sfxlcl41 - done.

Running journals Index build for instance: new41 - done.

Done for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Building the Index for All Local Instances Except the Test Instances

Select 2 all except test instances to build the index for all local instances except the test instances.

Building the Index for Instances Listed in a Configuration File

Select 3 use configuration file to build the index for instances listed in a configuration file. This option checks the following locations:
  • the global instance file – /exlibris/sfx_ver/sfx4_x/sfxglb41/config/rsi_ebook_setup.config

The instances should be listed in the section. For example:

Section "index_build"

SST01

SST02

SST03

EndSection

Edit the file in the global instance. Do not break the symbolic links to this file in the local instances.

the rsi_az_index section in the config/rsi.config file of the local instances:

Section "rsi_az_index"

scheduled_build "Y"

EndSection

If this section exists and the value is Y, the instance is added to the set of instances for which the build is run. If this section does not exist or its value is N, the instance is not included in the build. The default value for the scheduled_build parameter is N.

Building the Index for Specific Instances

Select 4 specify instances to build the index for specific instances. Select 4 specify instances to build the index for specific instances. The following is displayed:

Please enter instances names (comma separated if multiple):

Enter the list of instances that you want included in the build separated by a comma (,). The following is displayed:

This option will first (re)build RSI index - then (re)build eJournal A-Z index.

Running the RSI + eeJournal A-Z index builder may take a long time, depending on the amount of active portfolios.

Are you sure you want to continue? [y/n]
Type y to continue. The following is displayed:

The RSI + eJournal A-Z index build can be either 'complete' or 'incremental'.

Incremental build is recommended as it will take less resources and time.

Do you want to use incremental build - if this is available in your instance?

Type (i) for incremental build, or (c) for complete build: [i]

Type i for an incremental build, or c for a complete build. If you typed i, the following is displayed:

In case incremental build of the RSI + eJournal A-Z index cannot be performed, do you want to run complete build instead?

Note that in a live SFX environment, a complete build of the RSI + eJournal A-Z index is recommended to be run at night or during a server 'slow' time, because it requires a significant amount of system resources. [y/N]

Type y or n. The following is an example of an output:

-------> sudo /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances.pl --object_type=m --build_type=i --list=sfxlcl41,new41 dLogging activity for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl at '/exlibris/sfx_ver/sfx4_1/sfxglb41/logs/run_rsi_az_for_all_instances_new.pl-2012-05-24T15:01:03.log'.

Starting /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Running eJournal A-Z index build for instance: sfxlcl41 - done

Running eJournal A-Z index build for instance: new41 - done.

Done for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

eBook Search Index Tools for Multiple Instances

Use this option to run or schedule an RSI and eBook Search build for multiple instances. This is done if the SFX installation contains more than one production instance, and the building of the indexes can be set up to be performed one after the other.
Building an RSI or eBook index for multiple instances must be done as the sfxglb41 user. Additionally, before using this option, sudo permissions need to be set up for the following script:
/exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances.pl
Otherwise, the following error is displayed:

sudo permission for run_rsi_az_for_all_instances.pl is mandatory, the script cannot run.

Select 4 eBook Search index tools for multiple instances to build the RSI or eBook index for multiple instances. The following is displayed:

Building RSI and eBook Search index for multiple instances (only by sfxglb41)

1 (Re)build RSI and eBook Search index

Please select [1,q,m,u]:

Select 1 (Re)build RSI and eBook Search index. The following is displayed:

Warning: This option can only be used if sudo permissions have been set up for the file admin/aztools/run_rsi_az_for_all_instances.pl. Otherwise, the index build will fail.

Define instances for which index should be (re)build:

1 all instances

2 all except test instances

3 use configuration file

4 specify instances

Please select [1-4,q,m,u]:

Building the Index for All Instances

Select 1 all instances to build the index for all instances. The following is displayed:

Running the index builder may take a long time, possibly hours depending on the amount of active portfolios.

Are you sure you want to continue? [y/n]

Type y to continue. The following is displayed:

Logging activity for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl at '/exlibris/sfx_ver/sfx4_1/sfxglb41/logs/run_rsi_az_for_all_instances_new.pl-2012-05-24T13:35:11.log'.

Starting /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Running journals Index build for instance: sfxlcl41 - done.

Running journals Index build for instance: new41 - done.

Done for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Building the Index for All Local Instances Except the Test Instances

Select 2 all except test instances to build the index for all local instances except the test instances.

Building the Index for Instances Listed in a Configuration File

Select 3 use configuration file to build the index for instances listed in a configuration file. This option checks the following locations:
  • the global instance file - /exlibris/sfx_ver/sfx4_x/config/sfxglb41/config/rsi_ebook_setup.config

The instances should be listed in the section. For example:

Section "index_build"

SST01

SST02

SST03

EndSection

Edit the file in the global instance. Do not break the symbolic links to this file in the local instances.

the rsi_az_index section in the config/rsi.config file of the local instances:

Section "rsi_az_index"

scheduled_build "Y"

EndSection

If this section exists and the value is Y, the instance is added to the set of instances for which the build is run. If this section does not exist or its value is N, the instance is not included in the build. The default value for the scheduled_build parameter is N.

Building the Index for Specific Instances

Select 4 specify instances to build the index for specific instances. The following is displayed:

Please enter instances names (comma separated if multiple):

Enter the list of instances that you want included in the build separated by a comma (,). The following is displayed:

This option will first (re)build RSI index - then (re)build eBook search index.

Running the RSI + eBook search index builder may take a long time, depending on the amount of active portfolios.

Are you sure you want to continue? [y/n]
Type y to continue. The following is displayed:

The RSI + eBook search index build can be either 'complete' or 'incremental'.

Incremental build is recommended as it will take less resources and time.

Do you want to use incremental build - if this is available in your instance?

Type (i) for incremental build, or (c) for complete build: [i]

Type i for an incremental build, or c for a complete build. If you typed i, the following is displayed:

In case incremental build of the RSI + eBook search index cannot be performed, do you want to run complete build instead?

Note that in a live SFX environment, a complete build of the RSI + eBook search index is recommended to be run at night or during a server 'slow' time, because it requires a significant amount of system resources. [y/N]

Type y or n. The following is an example of an output:

-------> sudo /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances.pl --object_type=m --build_type=i --list=sfxlcl41,new41 dLogging activity for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl at '/exlibris/sfx_ver/sfx4_1/sfxglb41/logs/run_rsi_az_for_all_instances_new.pl-2012-05-24T15:01:03.log'.

Starting /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Running eBooks Index build for instance: sfxlcl41 - done

Running eBooks Index build for instance: new41 - done.

Done for /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances_new.pl

Scheduling an A-Z eJournal List and eBook Search Index Build for Multiple Instances

You can schedule a build for the A-Z eJournal List and eBook Search Indexes for multiple instances to occur on a specific date and time.
This task cannot be scheduled when Centralized Management of Maintenance Tasks is activated. If you attempt to do so, the following is displayed: Maintenance tasks can be scheduled only by the system administrator of this SFX installation. This option is not available for local SFX instances.
This is done by setting up a cron. For more information on cron jobs, including the structure of the scheduling time/date definition, see http://en.wikipedia.org/wiki/Cron.
To schedule a build of the RSI and A-Z index for multiple instances:
  1. Log on as the root user.
  2. Type crontab -e
  3. Specify the scheduled build of the indexes by using the following syntax:

/exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances.cron

For example:

16 12 * * 01 /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/aztools/az_for_all_instances/run_rsi_az_for_all_instances.cron --build_type=c --object_type=m --instances=all_except_test

The following describes the parameters used in the command:
  • Build type
    • --build_type (required) - can be either c for complete build, or i for incremental build

      If you choose an incremental build, the following additional options are available:

    • --no_complete - do not do a complete build if an incremental build is not possible
    • --email= - the e-mail address to which to send an e-mail if an incremental build cannot be performed
  • Object type

    --object_type (required) - can be m for monographs (to build the monograph RSI and eBook Search index) or s for serials (to build the serials RSI and A-Z index)

  • List of instances (list/instances) for which to build the indexes.

    Do one of the following:

    • Provide a list of instances by using: --list= (separate instance names with a comma (,).
    • Indicate the instances by using: --instances=

      The following options are available:

      • all - build the index for all instances.
      • all_except_test - build the index for all local instances except the test instances. These instance are indicated by having tst or test in the file name.
      • file - build the index for instances listed in a configuration file. For more information on building the index for instances listed in a configuration file, see Building the Index for Instances Listed in a Configuration File.