A-Z eJournal List and eBook Search

  • For information on the deep link that enables you to link to the SFX A-Z List and eBook Search with two additional parameters, refer to the EL Commons Web site http://www.exlibrisgroup.org.
  • For general information regarding the A-Z List and eBook Search, refer to the SFX General User’s Guide.

Advanced Customization: HTML Template Files and Header Files

The A-Z eJournal List and the eBook Search interfaces share the same template files.
It is possible to change the display of the A-Z List and eBook Search by making changes to the following template files in the /templates/azlist_ver3 directory:
  • templates/azlist_ver3/head.tmpl
  • templates/azlist_ver3/browse_detail.tmpl
  • templates/azlist_ver3/table_view.tmpl
  • templates/azlist_ver3/detail_view.tmpl
  • templates/azlist_ver3/set_detail.tmpl
  • templates/azlist_ver3/openurl.tmpl
  • templates/azlist_ver3/openurl_filtered.tmpl
  • templates/azlist_ver3/title_head.tmpl
  • templates/azlist_ver3/navigation_bar.css.tmpl
  • templates/azlist_ver3/info_button.tmpl
  • templates/azlist_ver3/navigation_go_button.tmpl
It is possible to change the display of the A-Z List by making changes to the following template files in the /templates/azlist_ver3 directory.

templates/azlist_ver3/category.tmpl

templates/azlist_ver3/locate_browse.tmpl

templates/azlist_ver3/locate_set.tmpl

templates/azlist_ver3/title_browse.tmpl

templates/azlist_ver3/title_set.tmpl

It is possible to change the display of the mobile A-Z List and eBook Search by making changes to the following template files in the /templates/azlist_ver3 directory:
  • az_mobile.tmpl
  • mobile_info_button.tmpl
When customizing your A-Z List templates, it is recommended that you not remove placeholders for the textual elements in the SFX A-Z List that are controlled by the SFX Admin Center Translations & Display section. Removing the placeholders results in the textual element not being displayed.
For example:

<TMPL_VAR NAME='MESSAGE("AZ Main","Result->DisplayingRelatedJournal")' ESCAPE=HTML />

Where to Customize and What to Customize

  • The Search form features and settings, as well as the data elements included among the search results, are all configured in:
  • For the A-Z eJournal list – SFX Admin Center > Setup & Administration > Configuration > A-Z List
  • For the eBook Search – SFX Admin Center > Setup & Administration > Configuration > eBook Search
  • All interface text is defined in the SFX Admin Center > Setup & Administration > Configuration > Translations & Display > AZ Main tab.
  • Images displayed in the SFX A-Z List are, by default, saved in the templates/img/azlist_ver3 directory.
The top banner image is called a-z_banner.gif in the .tmpl files, but can be found in the img/azlist_ver3 directory as header.gif.
  • The headers in the A-Z title tab are defined in the /config/headers directory. For each header set, a configuration file exists that defines each header and the characters that are filed under that header.
  • Other elements are controlled by the template (.tmpl) files. The files identified in the diagrams below are in the templates/azlist_ver3 directory.
  • The banner image in the A-Z and eBook search mobile interface is listed in the templates/azlist_ver3/az_mobile.tmpl file. Replace the image img/azlist_ver3/logo_sfx.png. The recommended image size is 213 pixels (width) and 52 pixels (height).
The location and names of images should not be changed. Rather, the original images should be replaced with your local images. This eliminates the need to make changes to any corresponding .tmpl files.

Title Search ("Starts with"): Detail View

detail_view_title_search.gif
Title Search: Detail View

Title Browse ("Starts with"): Detail View

title_browse_detail_view.gif
Title Browse: Detail View

Title Search ("Starts with"): Table View

title_search_table_view.gif
Title Search: Table View

Title Browse ("Starts with"): Table View

title_browse_table_view.gif
Title Browse: Table View

Category: Detail View

catagory_detail_view.gif
Category: Detail View

Category: Table View

catagory_table_view.gif
Category: Table View

Simplified Chinese and Traditional Chinese Titles

Chinese objects in the SFX KnowledgeBase are assigned the language value chi. They will have, if required, both a Simplified and Traditional Chinese title. For example:

Title - MAIN - Simplified

chinese_character1.gif

Title - MAIN - Traditional

chinese_character2.gif

Title - ROMANIZATION - Pinyin

a ba ke ji

Object ID

1000000000256408

Object type

JOURNAL

Language

Chinese

Peer reviewed

NO

In the SFX menu and A-Z List, only the appropriate Chinese title is displayed, depending on the country settings in the default A-Z profile.
If Mainland China is selected as the country in the default A-Z profile, Simplified Chinese titles are displayed.
If Taiwan is selected as the country, the Traditional Chinese titles are displayed.
If the SFX KB contains only a Simplified or Traditional Chinese title, this title is displayed for both Mainland China and Taiwan country settings.
In KBManager, both Chinese titles (if they exist) will be displayed in the results display of the Search Object search form.
original_title.gif
Chinese Object
A search of Chinese titles can be performed on both the Simplified and Traditional titles. When searching the complete Simplified or Traditional title, no truncation should be used.

Mainland China

The following items are relevant for mainland China:
  • A-Z Searching – When the country chosen in the default A-Z profile is China and the A-Z List contains both Latin and Chinese journal titles, it is recommended to display both Latin and Pinyin headers in the A-Z List.

When both headers display, an additional Pinyin check box displays. Every time a Pinyin search term is typed, the Pinyin check box should be selected to indicate that Pinyin is used. This is required to distinguish between Latin and Chinese titles. The result set corresponds to the check box choice and contains either Pinyin or Latin titles.

The default state of the Pinyin check box (selected or cleared) can be defined in the A-Z Configuration section of the SFX Admin Center.

A search of Chinese titles can be performed on both the Simplified and Traditional titles.

  • Display of Search Results – When a Chinese search term is entered—in either Simplified or Traditional Chinese—the results are displayed in Simplified Chinese if the Simplified Chinese title exists in the SFX KnowledgeBase.
  • Sorting – When the country chosen is China, the Chinese titles in the A-Z List are sorted according to Pinyin.

Taiwan

The following items are relevant for Taiwan:
  • Display of Search Results – When Taiwan is the country chosen and a Chinese search term is entered in either Simplified or Traditional Chinese, the results are displayed in Traditional Chinese if the Traditional Chinese title exists in the SFX KnowledgeBase.
  • Sorting – Chinese titles in the A-Z List are sorted by stroke sequence.

Korea

The following items are relevant for Korea:
  • Searching – When the country chosen is Korea and the A-Z List contains Chinese titles, the Limit search to Chinese titles check box needs to be selected when searching Chinese titles. This is needed to distinguish between Chinese journals and Korean journals with Chinese characters in the title.
  • Sorting – When the country chosen is Korea and a search term is entered in either Hangul or Hanja, the results of the Korean titles are sorted by Hangul.

Japan

  • Display of Search Results – When the country chosen is Japan and the A-Z List contains Japanese as well as Latin titles, it is recommended that both Latin and the two Hiragana headers in the SFX A-Z List be displayed.
  • Searching – It is possible to use Hiragana, Katakana, Kanji, and Latin scripts in a search.

The title search term is used without transliteration being performed.

  • Sorting – The sorting of search results, as well as the grouping into headers for Japanese titles, is performed using normalized Katakana/Hiragana titles.

The main title in the SFX KnowledgeBase is used for sorting and can contain either Hiragana or Katakana characters. The Katakana characters are converted to Hiragana during the A-Z index build.

Limitations in the Current CJK A-Z List Implementation

The following limitations exist in the current CJK A-Z List implementation:
  • Journals in the SFX KnowledgeBase that are missing required title information for display or sorting are not included in the A-Z List.
  • For CJK journal objects, the A-Z List does not currently support searching based on non-CJK titles.

Removing the CitationLinker Tab from the A-Z List

By default, the CitationLinker tab is displayed in the A-Z List.
To hide the CitationLinker tab from the A-Z List users:
  1. In the SFX Admin Center > Setup & Administration > Configuration > A-Z List > DISPLAY Section, select the Hide CitationLinker Tab check box.
hide_citation_linker_tab.gif
Hide CitationLinker Tab

When this option is selected, the A-Z List displays as follows:

a_z_list.gif
A-Z List
  1. Change the wording of the text displayed to the user when a search returns no results. By default, the text provides a link to the CitationLinker tab with the message:

Sorry, your request returned no records. You can use CitationLinker to start a new search here.

  1. Go to the SFX Admin Center > Setup & Administration > Configuration > Translations & Display>AZ Main tab.
  2. For each language used in the A-Z List, edit the following elements:
  • Remove the link from the Result->NoResult->Message element.
  • Delete the contents of the Result->NoResult->LinkToCitationLinkerLabel.
link_to_citation_linker_label.gif
CitationLinker Label
  1. Remove the link from the message text and change it to the following:

Sorry, your request returned no records.

A-Z List Browser Toolbar

The SFX A-Z List browser toolbar is available as an add-on component for Microsoft Internet Explorer that allows end users to quickly search the SFX A-Z List from anywhere on the Web.
a_z_toolbar.gif
SFX A-Z List Toolbar
The toolbar is supported by Microsoft Internet Explorer versions 5.5, 6, 7, and 8, but not later versions.
After installing the A-Z List browser toolbar, the following options are available:
  • A search box to perform an A-Z List title search using one of the following search types:
    • Starts with
    • Contains
    • Exact
  • The Pinyin/Chinese check box (presented only if needed)
  • A link to the library home page and/or the A-Z List of the library by clicking the SFX logo
All links displaying in this drop-down list can be configured in SFX Admin Center > Setup & Administration > Configuration > A-Z List.

Implementing the A-Z List Browser Toolbar

You enable the toolbar in a configuration file and then configure it in the SFX Admin Center.
To enable the toolbar:
  1. Connect to the SFX server and log on as the instance user.
  2. Enter cn.
  3. Enter vi ctx_object.config.
  4. At the end of the file, add the following lines:

Section "azlist"

enable_toolbar "Y"

EndSection

  1. Enter wq to save the file and exit.
To configure the toolbar in the SFX Admin Center:
  1. Go to the SFX Admin Center > Setup & Administration > Configuration > A-Z List section of the instance.
  2. Define the links in the toolbar. This can be done in the default profile or any other A-Z List profile.
  3. Configure the following parameters for the SFX Journal Search Toolbar:
  • Local Library Name – Enter the link name.
  • Local Library Homepage – Enter the link URL.
default_configuration_parameters.gif
Default Configuration Parameters
  1. Save your changes.
The toolbar configuration is saved in an XML form on the SFX server. This configuration is checked for updates whenever the browser toolbar is used. For performance reasons, this configuration is held in the client-side cache and checked once a day. This means that any configuration changes made in the SFX Admin Center only take effect a day later in the end user’s browser. The toolbar content XML can be viewed at: <SFX_AZ_URL>?param_perform_value=toolbar&action=configure

Installing the A-Z List Browser Toolbar

When you want to release the toolbar to end users, specify the following link to the toolbar installer:

<SFX_AZ_URL>?param_perform_value=toolbar&action=install

This can be added to the library Web page on which you want to provide instructions to your users on how to install the A-Z List browser toolbar.
For example:
http://demo.exlibrisgroup.com:3210/demo/az?param_perform_value=toolbar&action=install
The following is an example of an HTML page with this link:

<html>

<head>

<title>Test A-Z toolbar</title></head>

<body>

To install the A-Z toolbar, please click <a href="https://il-sfx01:3210/lr_3/az?param_perform_value=toolbar&amp;action=install">here</a>

</body>

</html>

To install the toolbar:
  1. Click the link to display the following dialog box:
run_file.gif
Run File
  1. Click Run to run the file or Save to save the file and double-click it later at the saved location. The following dialog box displays:
downloading_file.gif
Downloading File
  1. When the following dialog box displays, click Run.
unknown_publisher.gif
Unknown Publisher
  1. Click Install to start the installation process.
unknown_publisher.gif
Install
installation_complete.gif
Installation Complete
  1. Restart the browser when the following message displays:
install_completegif.gif
Install Complete
The A-Z toolbar displays as follows:
a_z_toolbar00001.gif
A-Z Toolbar

Removing the A-Z List Browser Toolbar

You can uninstall the A-Z List Browser toolbar.
To uninstall the toolbar:
  1. Click the SFX logo.
  2. Select Uninstall.
  3. Restart the browser to complete the toolbar uninstall process.

Automatically Updating the A-Z List Toolbar

The A-Z List browser toolbar contains an automatic update mechanism to make sure that when updates to the A-Z List toolbar are released by Ex Libris, toolbar users are alerted that updates are available and are able to install them.
Each toolbar installation contains the toolbar version number. It is compared with a file on the SFX server that contains the current toolbar version number. The file is saved in the following location on the SFX server:
./lib/AZLIST_VER3/Toolbar/version.txt
If updates are needed, this file is updated by the revision update process. Once the revision is applied on the SFX server, each locally installed toolbar detects the change and alerts the user.
The end user can also initiate a check for updates by using the following option directly from the browser toolbar.
update.gif
Update Option

Solr Index Configuration

In the global instance, the following configuration file determines the setup of the Solr index: /exlibris/sfx_ver/sfx4_1/sfxglb41/config/solr_index.config_
In this configuration file, all information is set automatically when creating the Solr core, including the URL, port, and encrypted password. Before starting to use the Solr service, set the active parameter to Y in the solr_startup_params section (the default is N):

Section "solr_startup_params"

active "N"

(...)

Section

Set the check_memory parameter to Y to have a memory check performed before starting the Solr service to make sure there is enough memory for the service (default is Y). Set the parameter to N to skip the memory check.

Section "solr_startup_params"

(...)

check_memory "Y"

Section

For information concerning the server requirements for Solr, refer to Appendix D eBook Search Set-Up Instructions of the SFX System Administration Guide.
Additionally, it is possible to set the bulk_size parameter in the complete_build_params section to define the maximum amount of changes before a complete build is needed:

# Specify how many objects will be processed in each bulk

# Bigger bulks may be faster but will consume more memory

Section build_params

bulk_size 1000

EndSection

If you use the eBook search, it is recommended that you configure a cron job to run a script that restarts Solr automatically if it is down. It is recommended to have the script run at least once an hour. Running the script and restarting Solr have no impact on SFX performance.
To set up the cron job:
  1. Log on as sfxglb41.
  2. Type crontab -e.
  3. Add the following line after the existing tasks:
<scheduling time/date/frequency> tcsh -c 'source ~sfxglb41/.cshrc; /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/init_scripts/solr_daemon.pl'
  1. Save and exit the file.
For example, the following line runs the script once an hour at the beginning of the hour:
0 * * * * tcsh -c 'source ~sfxglb41/.cshrc; /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/init_scripts/solr_daemon.pl'
For more information on cron jobs, including the structure of the scheduling time/date definition, see http://en.wikipedia.org/wiki/Cron.
Update Option

Solr Index Configuration

In the global instance, the following configuration file determines the setup of the Solr index: /exlibris/sfx_ver/sfx4_1/sfxglb41/config/solr_index.config_
In this configuration file, all information is set automatically when creating the Solr core, including the URL, port, and encrypted password. Before starting to use the Solr service, set the active parameter to Y in the solr_startup_params section (the default is N):

Section "solr_startup_params"

active "N"

(...)

Section

Set the check_memory parameter to Y to have a memory check performed before starting the Solr service to make sure there is enough memory for the service (default is Y). Set the parameter to N to skip the memory check.

Section "solr_startup_params"

(...)

check_memory "Y"

Section

For information concerning the server requirements for Solr, refer to Appendix D eBook Search Set-Up Instructions of the SFX System Administration Guide.
Additionally, it is possible to set the bulk_size parameter in the complete_build_params section to define the maximum amount of changes before a complete build is needed:

# Specify how many objects will be processed in each bulk

# Bigger bulks may be faster but will consume more memory

Section build_params

bulk_size 1000

EndSection

If you use the eBook search, it is recommended that you configure a cron job to run a script that restarts Solr automatically if it is down. It is recommended to have the script run at least once an hour. Running the script and restarting Solr have no impact on SFX performance.
To set up the cron job:
  1. Log on as sfxglb41.
  2. Type crontab -e.
  3. Add the following line after the existing tasks:
<scheduling time/date/frequency> tcsh -c 'source ~sfxglb41/.cshrc; /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/init_scripts/solr_daemon.pl'
  1. Save and exit the file.
For example, the following line runs the script once an hour at the beginning of the hour:
0 * * * * tcsh -c 'source ~sfxglb41/.cshrc; /exlibris/sfx_ver/sfx4_1/sfxglb41/admin/init_scripts/solr_daemon.pl'
For more information on cron jobs, including the structure of the scheduling time/date definition, see http://en.wikipedia.org/wiki/Cron.