Configuring the SFX Menu

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Advanced SFX Menu Template Configuration

This section provides information regarding the advanced SFX menu template configuration.

SFX Menu Example

In the example below, the SFX menu uses the advanced SFX menu template. The services on the SFX menu are grouped into Basic and Advanced.

Advanced SFX Menu Display

Basic services can be defined in the basic_grouping.config_ file in your instance. All other services display in the Advanced services group.

You can choose whether to make the headers for these groups collapsible by editing the ctx_object.config file in your instance.

Each of the individual services listed in the example is comprised of the following parts:

The text describing the type of service, such as Full text available via X.

Changes can be made to this text by editing the services_public_name.config_file in your instance.

The name of the target (displayed in bold).

You can change the name of a target by editing the target’s PUBLIC_NAME field in your instance of the KBManager.

Defining the Basic Group of Services

In the basic_grouping.config_ file, you can define the SFX services to be displayed in the top part of the SFX menu and the order in which they are displayed. The configuration file is used if you want to group services in the Basic or Advanced sections of the SFX menu. (For more information, see Grouping Services on an SFX Menu Screen).

The basic_grouping.config_ file overrides the order of services configured in the services_public_name.config_ file (for more information, see Defining the Order of Groups of Services and Text Describing Each Group) even if grouping is not used; therefore, it is important to define the order of services in the SFX menu in the basic_grouping.config_ file.
The only service that cannot be configured in the basic_grouping.config_ file is the bX getRecommendation service. This service uses very specific display programs, and its display is controlled by the UNIX configuration file config/bx.config. More information about the configuration of the bX recommendation service can be found in the bX–SFX Configuration Guide.

To edit the basic_grouping.config_ file:

Telnet to the SFX server and log on as sfxlcl41.
Enter cn.
Enter vi basic_grouping.config_.
You are prompted to break the symbolic link. Enter y.
In the “basic_grouping” section, enter the target services.

Section "basic_grouping"

getFullTxt

getHolding

EndSection

The services not listed in “basic_grouping” automatically display as part of the Advanced group.

If desired, you may change the default names for the Basic and Advanced groups of services. See Changing the .tmpl Files that Constitute the SFX Menu.

Save your changes.

Grouping Services on an SFX Menu Screen

In the ctx_object.config file, you can specify:

whether SFX services should be grouped on the SFX menu into Basic and Advanced services
the option to allow users to collapse and expand these groups on the SFX menu

To edit the ctx_object.config file:

Connect to the SFX server and log on as the instance user, such as sfxlcl41.
Enter cn.
Enter vi ctx_object.config.
Go to the “html_menu” section.

Section "html_menu"

debugging "1"

log "$ENV{SFXCTRL_HOME}/logs/sfxmenu"

timer "1"

keep_log "1"

debug_ip_range "*.*.*.*"

grouping "Y"

collapsible "Y"

user_must_pick_single_object "1"

template "$ENV{SFXCTRL_HOME}/templates/sfxmenu/sfxmenu.tmpl"

EndSection

Set the grouping and collapsible options.

If grouping is set to Y, the services are grouped into Basic and Advanced services as defined in the basic_groupings.config_ file.

Setting grouping to Y also enables the option to make these groups collapsible on the SFX menu. Set the collapsible option to “Y” to make groups collapsible on the SFX menu.

If grouping is set to N, the target services display on the menu without a header or footer for Basic and Advanced services.

Save the file.

Defining the Order of Groups of Services and Text
Describing Each Group

In the “group_names” section of the services_public_name.config_ file, you can specify or change:

The names for the headings that display for each group of services.
The order in which the groups of services display.

When using the advanced menu, the order of services is configured in the services_public_name.config_ file. However, the services listed in the basic_grouping.config_ configuration file are displayed before any other services - even when grouping into basic and advanced sections is not used. SFX first displays the services listed in basic_grouping.config_ (using the order defined in services_public_name.config_) and afterwards displays the services not listed in basic_grouping.config_ (using the order defined in services_public_name.config_).
The only service that cannot be configured in the services_public_name.config_ file is the bX getRecommendation service. This service uses very specific display programs, and its display is controlled by the UNIX configuration file config/bx.config. More information about the configuration of the bX recommendation service can be found in the bX–SFX Configuration Guide.

To edit the “group_names” section of the services_public_name.config_ file:

Telnet to the SFX server and log on as sfxlcl41.
Enter cn.
Enter vi services_public_name.config_.
You are prompted to break the symbolic link. Enter y.
Go to the “group_names” section.

Section "group_names"

getFullTxt "Full Text"

getSelectedFullTxt "Full text"

getDOI "Full text"

getMessageNoFullTxt "Full text"

getHolding "Holding information"

getDocumentDelivery "ILL"

getBookReview "Reviews"

getAbstract "Abstract"

getTOC "Table of contents"

getAlikeRecord "Reviews"

getAuthor "Author"

getCitedAuthor "Author"

getCitedReference "Reference"

getReference "Reference"

getCitedBook "Citation information"

getCitedGenome "Citation information"

getCitedRecord "Citation information"

getCitedJournal "Citation information"

getAuthorEmail "Author"

getSubject "Subject"

getWebService "Web Service"

getWebSearch "Web Search"

EndSection

Change the name or phrase in quotation marks to change the group name displayed in the SFX menu.
Change the order of the service types to your preference.

The order of the list of service types displayed on the SFX menu is determined by the order of the service types as entered in the “group_names” section.

If the getFullTxt service is the first one entered in the “group_names” section, it is the first service that displays on the SFX menu if a FullTxt service is available for the link source.

If you remove the name or phrase in quotation marks, the group name is removed from the SFX menu. The services are still grouped and ordered, but the name of the grouping does not display.

In addition, do not remove the name of the service, such as getFullTxt

Save the file.

Defining the Text Describing Each Service

In the “services” section of the services_public_name.config_ file, you can specify or change the default text describing each service as it displays on the SFX menu.

To edit the “services” section of the services_public_name.config_ file:

Telnet to the SFX server and log on as sfxlcl41.
Enter cn.
Enter vi services_public_name.config_.
Go to the “services” section.

Section "services"

getFullTxt "Full text available via"

getSelectedFullTxt "Full text available via"

getDOI "Full text available via"

getMessageNoFullTxt "No Full text available"

getHolding "Holdings in"

getDocumentDelivery "Request document via"

getBookReview "Read the review or buy this book at"

getAbstract "Abstract available in"

getTOC "Table of contents from"

getAlikeRecord "This record at"

getAuthor "Other articles by this author? -- using"

getCitedAuthor "Is this author cited? -- using"

getCitedReference "Is this article cited? -- using"

getCitedJournal "This journal in"

getReference "References at"

getCitedBook "This book in"

getCitedGenome "Get sequence information from"

getCitedRecord "This record in"

getAuthorEmail "Find this author's email in"

getSubject "Find this subject in"

getWebService "Find related information in"

getWebSearch "Find related information in"

EndSection

Change the default text to your preferences.
Save the file.

Defining the Order for Targets for the Same Service Type

If several target services of the same type are displayed in the SFX menu, they are by default displayed in alphabetical order by the target name. You can change the order of the display in the “sort” section of the sort_services.config_ file.

To edit the “sort” section of the sort_services.config_ file:

Telnet to the SFX server and log on as sfxlcl41.
Enter cn.
Enter vi sort_services.config_.
Go to the “sort” section.
Change the sort arrangement to match your preferences using the example below as a guide.

Section "sort" Type=LIST

#getHolding services
LOCAL_CATALOGUE_ENDEAVOR_VOYAGER

LIBRARY_OF_CONGRESS

#getFullTxt service

SWETSWISE

SPRINGER_LINK_JOURNALS

EndSection

In this “sort” example:

You have activated the following getHolding target services:
- A link to your local OPAC
- A link to the Library of Congress

You want the local OPAC link to display first and the Library of Congress link to display second.

You have activated full-text access to journals via SwetsWise and Springer. If more than one full-text link displays in the SFX menu, you want the link to the SwetsWise service to display first and the link to the Springer service to display second.

All target services not listed in the “sort” section are sorted alphabetically.

When specifying a target in the “sort” section, use the correct TARGET name found in the KBManager.

Save your changes.

Force Targets to Display at the Bottom of a List of Services

You may want to suppress certain targets so that they always display at the bottom of the list of services in the SFX menu. A target defined in the bottom_list.config_ file displays at the bottom of each list of services in which it is found. These changes can be made in the “bottom” section.

To edit the “bottom” section of the bottom_list.config_ file:

Telnet to the SFX server and log on as sfxlcl41.
Enter cn.
Enter vi bottom_list.config_.
Go to the “bottom” section.

Section "bottom" Type=LIST

LIBRARY_OF_CONGRESS

EndSection

Specify the target to display at the bottom.
Save the file.

Changing the Text Explaining a Particular Service

Use the KBManager to change the default explanation text for one particular service. To do this, enter the text in the PUBLIC_NAME field of the TARGET_SERVICE table. The text you enter in the PUBLIC_NAME field overrides the default explanation text defined in the services_public_name.config_ file.

For example, if you have created a getWebService service that allows the user to send an e-mail with comments or questions to the library, according to the services_public_name.config_ file, the default text for this service is Find related information in. If, instead of the default text, you want the SFX menu to display Send questions or comments to, enter this text in the PUBLIC_NAME field of your new service. The new text overrides the default text specified in the services_public_name.config_ file.

Changing the Text Explaining a Particular Service

HTML Templates of the Advanced Menu Template

The SFX menu is created from the following .tmpl files that are located in
/exlibris/sfx_ver/sfx4_1/<instance>/templates/sfxmenu.

banner.tmpl– This file is used to create the reference box at the top of SFX menu.
sfxmenu.tmpl– This file points to the CSS style sheet and grouping templates.
grouping_yes.tmpl– This file contains the layout instructions for menus when grouping is set to yes and points to the target_list.tmp file.
grouping_no.tmpl– This file contains the layout instructions for menus when grouping is set to no and points to the target_list.tmp file.
target_list.tmpl – This file contains Perl instructions to create service links and references target displayers.

The display characteristics of the SFX menu are defined in the following .css file that is referenced by sfxmenu.tmpl and the HTML style sheet:

/exlibris/sfx_ver/sfx4_1/<instance>/templates/css/publicstyle.css

SFX Menu Display Characteristics

Changing Images in the SFX Menu

The following .gif files provide the default images used in the SFX menu:

tl_sfx.gif
header.gif
arrow_on.gif
arrow_off.gif

These files are located in /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/sfxmenu.

Optionally, you may use your custom images instead of these default images.

To use custom images instead of default images:

Create backups of the default images.
1. Log on to your server as the instance user.
2. Copy the following files from /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/sfxmenu:

cp header.gif header-bak.gif
cp tl_sfx.gif tl_sfx-bak.gif
cp arrow_on.gif arrow_on-bak.gif
cp arrow_off.gif narrow_off-bak.gif

Create new images and save them with the same names as the ones you are replacing.
FTP your new .gif files to /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/sfxmenu.

The location and names of the 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 (see Changing the .tmpl Files that Constitute the SFX Menu).

Changing the .tmpl Files that Constitute the SFX Menu

This section describes how to edit the .tmpl files that constitute the SFX menu. Any changes made to the .tmpl files are preserved when the SFX software is updated.

Each .tmpl file contains parameters that refer to the SFX data elements to be displayed in the SFX menu. For example, in banner.tmpl, you find <TMPL_VAR NAME="ATITLE"> and <TMPL_VAR NAME="ISSN"> to refer to metadata that displays in the top part of the SFX menu.

When SFX generates an SFX menu, <TMPL_VAR NAME="ATITLE"> is replaced by the article title and the journal ISSN. Similarly, JournalTitle/BookTitle, date, volume, issue, and start page information are displayed when available.

It is recommended that you not change these parameters because they are used by the SFX programs to generate a valid SFX menu.

If you do need to make changes, create backup files of the .tmpl files.

To back up files:

Log on to your SFX server as the user of the instance where you want to make changes (such as the sfxlcl41 user) to make changes to the sfxlcl41 instance.
Enter sx.
Enter cd templates/sfxmenu.
Enter cp xxxx.html xxxx-bak.html.

For example:

cp banner.tmpl banner-bak.tmpl

The main .tmpl files that constitute the SFX menu are:

banner.tmpl
sfxmenu.tmpl
grouping_yes.tmpl
grouping_no.tmpl
target_list.tmpl

The sfxmenu.tmpl file allows you to specify or change the following:

The referenced Cascading Style Sheets used when generating the menu html.

<LINK REL="stylesheet" TYPE="text/css" href="/<TMPL_VAR INSTANCE>/css/public/style.css">

The image across the top of the SFX menu. By default, the header.gif file is used.

<IMG SRC="/<TMPL_VAR INSTANCE>/img/sfxmenu/header.gif" WIDTH="455" HEIGHT="48" BORDER="0" ALT="ExLibris Electronic Library">

The SFX icon located at top of menu.

<IMG SRC="/<TMPL_VAR INSTANCE>/img/sfxmenu/tl_sfx.gif" WIDTH="103" HEIGHT="35" BORDER="0" ALT="SFX">

To change the image:

Enter vi sfxmenu.tmpl.

The system prompts you for the following:

[break symbolic link 'sfxmenu.tmpl' ?] [y/N]

Enter y and the file is created as a local file.
Make your changes to the sfxmenu.tmpl file.

The banner.tmpl file allows you to change or specify the text used in the banner to display journal and article information.

Save your changes.

To change the banner.tmpl file:

Enter vi banner.tmpl.

The system prompts you for the following:

[break symbolic link 'banner.html'?] [y/N]

Enter y and the file is created as a local file.
Make your changes to the banner.tmpl file.

The grouping_yes.tmpl file allows you to change or specify the text used to describe the Basic and Advanced service groupings when used in the SFX menu. A different name can be defined for collapsible menus.

<TMPL_IF COLAPSIBLE_ENABLED><a href="javascript:toggleBasic();" class="GroupTitle">Basic</a>

<TMPL_ELSE>

Basic

</TMPL_IF></TD>

<TMPL_IF COLAPSIBLE_ENABLED><a href="javascript:toggleAdvanced();" class="GroupTitle">Advanced</a>

<TMPL_ELSE>

Advanced

</TMPL_IF>

</TD>

Save your changes.

To change the grouping_yes.tmpl file:

Enter vi grouping_yes.tmpl.

The system prompts you for the following:

[break symbolic link 'grouping_yes.html' ?] [y/N]

Enter y and the file is created as a local file.
Make your changes to the grouping_yes.tmpl file.

The target_list.tmpl file allows you to change or specify the button to go to a particular target. By default, the ico_go.gif image is used.

<IMG SRC="/<TMPL_VAR NAME='INSTANCE'>/img/sfxmenu/ico_go.gif" WIDTH="20" HEIGHT="20" BORDER="0" ALT="GO" HSPACE="10">

Save your changes.

To change the target_list.tmpl file:

Enter vi target_list.tmpl.

The system prompts you for the following:

[break symbolic link 'target_list.html'?] [y/N]

Enter y and the file is created as a local file.
Make your changes to the target_list.tmpl file.

Make target names clickable.

It is possible to make the name of each target and/or the text describing each target clickable. To do this, you need to edit the target name section of the target_list.tmpl file.

If you want the target name to be hyperlinked, add the lines as shown in the example below.

Without hyperlinks in the service and target name:

<tr>

</td>

With hyperlinked target name:

<tr>

<TMPL_IF IS_LINKABLE>

<TMPL_ELSE>

</TMPL_IF>

</td>

If you want both the target name and the text describing the target to be hyperlinked, add the lines shown in the example below:

Without hyperlinks in the target name:.

<tr>

<TMPL_VAR NAME='SERVICE_NAME'>

<TMPL_VAR NAME='TARGET_NAME'></span>

</td>

With hyperlinked service and target name:

<tr>

<TMPL_IF IS_LINKABLE>

<A HREF="javascript:openWin(this);window.document.<TMPL_VAR

FORM>.submit();">

<TMPL_VAR NAME='SERVICE_NAME'>

</A>

<TMPL_ELSE>

<TMPL_VAR NAME='SERVICE_NAME'>

</TMPL_IF>

<TMPL_IF IS_LINKABLE>

<A HREF="javascript:openWin(this);window.document.<TMPL_VAR

FORM>.submit();">

<span class="LabelHighlightInner"><TMPL_VAR

NAME='TARGET_NAME'></span>

</A>

<TMPL_ELSE>

<TMPL_VAR NAME='TARGET_NAME'>

</TMPL_IF>

</td>

The style.css file allows you to change or specify the style (fonts, colors, and layout) of the SFX menu.

To change or specify the style of the SFX menu:

Enter cd /exlibris/sfx_ver/sfx4_1/sfxinstance/templates/css/public/.
Enter vi style.css.

The system prompts you for the following:

[break symbolic link 'style..css'?] [y/N]

Enter y and the file is created as a local file.
Make your changes to the style.css file.

Creating Language-Specific Menu Templates

It is possible to use and create language-specific .tmpl files when an SFX menu is generated.

The SFX installation comes with a set of language templates for English that is used as the default and has no file extensions. Additionally, there are language template sets for Dutch and Spanish. More language template sets can be created. It is possible to define which set of templates are the defaults.

When a user chooses available languages from a drop-down list on the SFX menu, the defined language templates are consulted and a new menu is generated based on these. If the program cannot find a template file with a language extension, it uses the default set of SFX menu template files.

For example, the following default template files are consulted when a user chooses Espanol from the SFX menu:

/exlibris/sfx_ver/sfx4_1/instance/templates/sfxmenu

banner.tmpl.es

sfxmenu.tmpl.es

target_list.tmpl.es

error.tmpl.es

grouping_yes.tmpl.es

grouping_no.tmpl.es

/exlibris/sfx_ver/sfx4_1/instance/config/services_public_name.config_.es

To define the default language if it is different from English:

In the /sfx_ver/sfx4_1/<instance>/config/map_languages.config_ configuration file, add a default_language section.
Specify the default language of your choice.

See the example below where the Dutch language templates are used as the default set.

Section "default_language"

default Dutch

EndSection

Section "map_languages"

Dutch "du"

Spanish "sp"

EndSection

Save your changes.

To specify additional language-specific templates:

Create additional language-specific .tmpl files.
1. Telnet to your SFX server and log on as sfxlcl41 (or the instance where you want to use the language-specific SFX menu).
2. Enter sx.
3. Enter cd templates/sfxmenu.
4. Enter cp banner.tmpl banner.tmpl.<language extension>.
5. For example, Enter cp banner.tmpl banner.tmpl.ger for German.
6. Enter vi banner.tmpl.<language extension>.
7. Make the changes you want, and save the changes by typing :wq.
8. Repeat this process for additional menu templates.

When German is selected from the SFX menu, the SFX program uses the .tmpl files with the .ger extension. If it cannot find a .tmpl file with a .ger extension, it uses the default .tmpl files (without extensions).

Specify the language name and its .tmpl extension that is to be used in the map_languages.config file.
1. Telnet to the SFX server and log on as sfxlcl41 (or the instance where you want to use the language-specific SFX menu).
2. Enter cn.
3. Enter vi map_languages.config.
4. Edit the “map_languages” section.
5. Add the language name as it displays in the SFX menu drop-down list.
6. Tab and add the extension of your choice. In the example below, “ger” is used for German.

Section "map_languages"

Espanol "es"

German "ger"

Dutch "du"

EndSection

Save your changes, and quit the file by typing :wq.

Verify that the sfx_language_code_to_sfxmenu section exists in the map_languages.config_ file. Do not remove this section from the file. For more information, see Setting user_profile Cookies.

Add a new language option to the drop-down navigation list of the SFX menu in /exlibris/sfx_ver/sfx4_1/instance/templates/sfxmenu/sfxmenu.tmpl.
1. Telnet to the SFX server and log on as sfxlcl41 (or the instance where you want to use the language-specific SFX menu).
2. Enter sx.
3. Enter cd templates/sfxmenu.
4. Enter vi sfxmenu.tmpl.
5. Add the name that you defined in the map_language.config file to the following section of the sfxmenu.tmpl file.

Language

<OPTION value="English"<TMPL_VAR NAME='English' ESCAPE='HTML'>>English</OPTION>

<OPTION value="Espanol"<TMPL_VAR NAME='Espanol' ESCAPE='HTML'>>Espanol</OPTION>

<OPTION value="German"<TMPL_VAR NAME='German' ESCAPE='HTML'>>German</OPTION>

</SELECT>

In this example, German was added.

Overview of SFX Menu-Related Features, Files, and Tools

Where Found in SFX Admin
Where Found in SFX Admin	Function
Setup & Administration > Configuration: Menu Configuration	Display logic Suppressing a particular target when another specific one is present
KBManager: TARGET Public Name	Controls target display name on menu
KBManager: TARGET_SERVICE Public Name	Controls OVERRIDE default service wording See services_public_name.config_ below

Where Configuration Files for Instance - Shortcut: cn Found
Where Configuration Files for Instance - Shortcut: cn Found	Function
services_public_name.config_	Text describing service and/or order of service - Text for “group name” - Regrouping of service on the menu
ctx_object.config	Specify grouping menu into Basic and Advanced sections Make headers for groups collapsible
basic_grouping.config_	Basic services can be defined All other services fall into extended services
sort_services.config_	Sorting Push to top of list (services of the same type)
bottom_list.config_	Sorting Push to bottom of list (services of the same type)

Where Template Files - Shortcut:tm Found
Where Template Files - Shortcut:tm Found	Function
/css/public/style.css	Central style sheet
/img/sfxmenu	Storage of the images for banner, header, arrows, and so on
/sfxmenu/sfxmenu.tmpl	Central file References all the images Can remove the language drop-down in the upper-right corner
/sfxmenu/grouping_yes.tmpl	Change text describing “Basic” and “Advanced” sections
/sfxmenu/target_list.tmpl	Can make the target names clickable hyperlinks

Target Displayers

A target displayer is a program that determines what a service looks like on the SFX menu.

Each service type has a default target displayer. For example, a full-text service typically has four small input boxes and looks like the following example in the advanced menu.

Full-Text Service in the Advanced Menu

In the simplified menu, the displayer looks like the following:

Full -Text Service in the Simplified Menu

The default target display is used by most existing TARGET_SERVICES.

In the KBManager, you can see which target display is used.

When a TARGET_SERVICE uses the default parser, the DISPLAYER field in the KBManager is left blank.
When a TARGET_SERVICE uses a special display parser, the name of the parser is filled in the DISPLAYER field of that particular TARGET_SERVICE.

For example, the getWebSearch service for the Web Search Engine target does not use volume or start page information, so a special displayer shows a drop-down list of different search engines instead of the input boxes.

Drop-Down List of Search Engines

In the displayer field of the TARGET_SERVICE for WWW_SEARCH_ENGINES, you see WWW::ALL.

This refers to the location of a specific target displayer on the SFX server in
/exlibris/sfx_ver/sfx4_1/instance/lib/Parsers/TargetDisplayer/WWW/ALL.pm.

Another example of a service that uses a special display parser is UNION_ALL_CATALOGUES, with a drop-down list of different union catalogs.

To edit or view the target displayers:

Telnet to the SFX server and log on as sfxlcl41.
Enter tp.
Enter cd ../TargetDisplayer/.

This is where you find the different target displayers.

If you would like to prevent the year/volume/issue/startpage input boxes from displaying completely for a particular target service, you can apply a special NO_FILL_IN displayer.

To prevent the year/volume/issue/startpage input boxes from displaying completely:

Click the E button on the target service level of the target of your choice.
Go to the Displayer field (the next field under parse_param).
Enter FT::NO_FILL_IN in the Displayer field.
Save your changes.

Using a Special Displayer to Show Date Threshold
Information in the SFX Menu

In some SOURCES, very little metadata (no date, volume, issue, or page information) is available but links to full-text services display on the SFX menu.

This is true for:

OPACs
An HTML list of electronic journals on a customer’s library pages
The CitationLinker form
A journal index, such as Ulrichs periodicals database

To provide more information about full-text availability, an extra line with availability information can be added to each full-text service in the SFX menu. (The same availability information is also displayed in the DirectLink sidebar, if the sidebar is in use in the SFX instance.) This special displayer shows the relevant OBJECT_PORTFOLIO date and time difference (timediff) thresholds in the SFX menu. The format of these thresholds is changed to make them more user-friendly.

In the example below, the following date threshold exists in the Academic Search Premier getFullTxt OBJECT_PORTFOLIO for the American Heart Journal:

$obj->parsedDate(">=",1975,140,1)

The special displayer looks like the following:

Special Displayer

To use this special displayer, you need to access the KBManager and go to the List of Sources. Click the

Edit button to edit the source for which you want the availability information to be displayed in the SFX menu, and click the check box for the Show Availability option as in the following:

Show Availability

You can use following OpenURL to create new screen shot of the SFX menu:

http://il-sfx07:3410/sst1_4?url_ver=Z39.88-2004&url_ctx_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Actx&ctx_ver=Z39.88-2004&ctx_enc=info%3Aofi%2Fenc%3AUTF-8&rfr_id=info%3Asid%2Fsfxit.com%3Akbmanager&sfx.ignore_date_threshold=1&rft.object_id=954925246074

$obj->parsedDate(">",1975,140,1) && $obj->parsedDate("<",2015,200,1)

is displayed as:

Available after 1975 volume: 140 issue:1 until (not including) 2015 volume: 200 issue:1

and

$obj->parsedDate(">=",1975,140,1) && $obj->parsedDate("<=",2015,200,1)

is displayed as:

Available from 1975 volume: 140 issue:1 until (and including) 2015 volume: 200 issue:1

Related Objects in XML, OpenURL, and Consortium API

In all cases where SFX does not respond by presenting the SFX menu, the behavior for related objects is described below:

XML OpenURL

Only close relations are included in the XML responses. This happens only if the related object display is turned on for the SFX menu. There is no indication that these services originate from related objects.

Consortia API

When retrieving additional services using consortia API, services from the related objects are displayed based on configuration both in the local and remote instance.

If the related object display is turned on in the local instance only, only related services from the local instance are included in the SFX menu.
If the related object display is turned on in both the local and remote instance, related services from both instances are included in the SFX menu.

SFX Window Behavior

By default, three windows are open during the SFX flow: the source, the SFX menu, and the target windows.

Source window – the database from which you begin your search. If you click the SFX button in the top bar of the record, the SFX menu opens.
SFX menu window – contains a list of available services. When you click one of the services, the target window opens.
Target window – the service requested in the SFX menu. In the following example, the user requests a full-text service, so the target window displays the HighWire full-text version corresponding to the original abstract record.

SFX Windows

If you click the SFX button for a second record in the source window, a new SFX menu is opened in a new window or new browser tab (depending on browser settings).

When another service is clicked in the SFX menu, a new the target window is opened in a new window or new browser tab (depending on browser settings).

Changing the Size of the Target Window

It is possible to change the size of the target window that is created after clicking a link to the target from the SFX menu.

To change the size of the target window:

Log on to the SFX server as the instance user.
Navigate to the template directory:

cd /exlibris/sfx_ver/sfx4_1/<instance>/templates/js/sfxmenu

Access the JavaScript files listed below. In both files, you need to change the current window size (marked in red) to the window size of your choice.

main.js

function openWin(obj)

var options = "toolbar=yes,location=yes,directories=yes,buttons=yes,status=yes";

options += ",menubar=yes,scrollbars=yes,resizable=yes,width=800,height=600";

function openWin_location

var options = "toolbar=yes,location=yes,directories=yes,buttons=yes,status=yes";

options += ",menubar=yes,scrollbars=yes,resizable=yes,width=800,height=600";

gbs.js

function openWindow(obj, form_name)

var options = "toolbar=yes,location=yes,directories=yes,buttons=yes,status=yes";

options += ",menubar=yes,scrollbars=yes,resizable=yes,width=800,height=600";

When changing the size of the target window, remember that your window size may display differently on computers with different screen resolutions.

Save your changes.

Including COinS Representation in the SFX Menu

It is possible to include a COinS representation of the SFX ContextObject in the SFX menu HTML span tag. COinS stands for ContextObject in Span. COinS allows citation metadata to be in embedded into HTML so that the client-side software (such as browser plug-ins and extensions such as LibX and Zotero) can make use of this metadata.

A COinS is an OpenURL ContextObject inside a hidden <span> tag of the HTML page.

The specification of COinS can be found in http://ocoins.info/.

For example:

For the OpenURL http://demo.exlibrisgroup.com:3210/demo?genre=article&title=Proceedings%20of%20the%20second%20ACM%20SIGPLAN%20international%20%20&issn=&date=1997&volume=&issue=&spage=&atitle=A%20practical%20subtyping%20system%20for%20Erlang&aulast=Marlow&auinit=S, the COinS representation looks like the following:

</span>

The strength of COinS is that it can provide an alternative to the conventional way of an OpenURL-enabling of resources, namely, contacting vendors and turning on SFX buttons in their databases.

Freely available resources typically do not have subscribers and have difficulty discovering a user’s institutional affiliation, which is needed to create an OpenURL. By including COinS metadata, these resources can be made OpenURL-compliant. Client-side software uses COinS to add links to this non-subscription-based content.

COinS can also be used for many other purposes. For a list of COinS implementations, refer to http://ocoins.info/. A short description of some COinS tools is also provided in Applications that Use COinS.

Note that the quality and quantity of the metadata in the ContextObject determines whether the COinS information is useful. It is not possible to guarantee that every OpenURL creates a usable COinS representation.

Setup

To enable the inclusion of the COinS in the SFX menu, it is necessary to add a configuration option to the following file:

/exlibris/sfx_ver/sfx4_1/<instance>/config/ctx_object.config

Add the following line in the “html_menu” section:

include_coins "Y"

The "html_menu" section looks like the following:

debugging "0"

log "$ENV{SFXCTRL_HOME}/logs/sfxmenu"

keep_log "0"

debug_ip_range "*.*.*.*"

grouping "Y"

collapsible "Y"

user_must_pick_single_object "1"

template "$ENV{SFXCTRL_HOME}/templates/sfxmenu/sfxmenu.tmpl"

verde_link "0"

include_coins "Y"

EndSection

After the setup, send an OpenURL to the SFX instance and check that the HTML source includes the following tag:

See the following example of an OpenURL to be used for testing:

<base-URL>?id=pmid:15486829

Applications that Use COinS

LibX

LibX is a browser plug-in for Firefox and Internet Explorer that provides direct access to your library’s resources. It includes a toolbar and a right-click context menu, and supports searches against the library catalog (OPAC) as well as against an OpenURL linking server. Information about LibX can be found at http://libx.org.

OpenURL Referrer

This extension enables the browser to display OpenURL links on Web pages with CoinS embedded in the HTML source code. If COinS is turned on for the SFX menu, you see an SFX button in the menu banner.

The extension is available for both IE 6+7 and Firefox. Information can be found at http://openly.oclc.org/openurlref/.

Zotero

Zotero is a library metadata utility extension for Firefox. Its purpose is to help you collect, manage, and cite your research sources. Information about Zotero can be found at http://zotero.org.

Configuring the SFX Menu Interface Language

You can configure the SFX menu to be available for more than one language.

Configuring the SFX Menu Language in the SFX Admin Center

The language configuration depends on the SFX menu template selected.

Simplified Menu Template

To configure the simplified menu template of the SFX menu to be available for more than one language:

In the SFX Admin Center, click Set-up and Administration > Configuration > Menu Configuration > Menu Design. The following is displayed:

Menu Design

Select Show language drop-down.
Select the languages that you want to appear in the language drop-down from the All Languages pane and click the right arrow to move them to the Selected Languages pane. The first language in the Selected Languages pane is the default language.

If you only move one language to the Selected Languages pane, the SFX menu appears only in that language and no drop-down list appears.

Advanced Menu Template

For information concerning configuring the advanced menu template of the SFX menu to be available for more than one language, see Creating Language-Specific Menu Templates.

Setting the SFX Menu Language in an External Application

The following two methods exist to set the SFX menu language from an external application:

via the language user profile cookie set via an external application, the SFX menu, or the SFX A-Z language drop-down list.
via the req.language OpenURL element

For both methods, the language has to be set up according to the configuration described in Configuring the SFX Menu Language in the SFX Admin Center.

If a language is set in an external application that is not configured in the SFX Admin Center, the SFX menu default language is used.

Setting the SFX Menu Language via a User Profile Cookie

For information on setting the SFX menu language via a user profile cookie, see Setting user_profile Cookies.

If the user’s browser has an SFX language cookie, the cookie takes precedence over the OpenURL req.language parameter, except when an OpenURL is sent from a Primo source, in which case the req.language parameter sent by Primo takes precedence over the language cookie.

Setting the SFX Menu Language via the req.language OpenURL Element

You can set the SFX menu language via the following OpenURL element: req.language=<ISO 639-2(B) language code>. SFX supports the 3-letter language codes of the ISO 639-2 (B) standard. SFX defaults to the default language configured if a language that is not supported is set.

The following OpenURL example sets the SFX menu interface language to Spanish:

http://demo.exlibrisgroup.com:3210/demo?ctx_ver=Z39.88-2004&url_ver=Z39.88-2004&ctx_enc=UTF-8&rft.issn=0894-9867&rft.year=2011&rft_id=info%3Apmid%2F21812037&rft.atitle=Predicting%20pediatric%20posttraumatic%20stress%20disorder%20after%20road%20traffic%20accidents%3A%20the%20role%20of%20parental%20psychopathology.&rft.issue_start=4&rft.object_id=954925559531&rft.volume_start=24&rft.volume=24&rft.month=8&rft.genre=article&rft.issue=4&rft.doi=10.1002%2Fjts.20667&rft_val_fmt=info:ofi/fmt:kev:mtx:journal&req.language=spa

SFX Menu for Mobile Devices

You can change the display of the mobile SFX menu by changing the following files in the following locations:

It is recommended to make changes only to images and CSS files. If you make changes to the template files, you will need to manually implement in the localized template files any future updates made to the template files distributed as part of a revision update.

Mobile SFX menu header images:

/exlibris/sfx_ver/sfx4_1/<instance>/templates/img/simplified_template1/mobile/default/

/exlibris/sfx_ver/sfx4_1/<instance>/templates/img/simplified_template1/mobile/custom/

Do not change the images in this directory. Instead, use SFX Admin Center > Configuration > Menu configuration > Menu Design to upload and select the header images.
A different header image is used for the CitationLinker and multi-object window. For this header image, upload the image in the location specified below.

Location of other mobile SFX menu images (including service type icons):

/exlibris/sfx_ver/sfx4_1/<instance>/templates/img/mobile/

CSS files for the mobile SFX menu:
- Global css files that should not be changed:

/exlibris/sfx_ver/sfx4_1/<instance>/templates/css/public/mobile/style.css

/exlibris/sfx_ver/sfx4_1/<instance>/templates/css/public/mobile/style_rtl.css [Hebrew css]

Local CSS files that can be used to override the global CSS classes:

/exlibris/sfx_ver/sfx4_1/<instance>/templates/css/public/mobile/custom.css

/exlibris/sfx_ver/sfx4_1/<instance>/templates/css/public/mobile/custom_rtl.css [Hebrew css]

Mobile SFX menu template files:

/exlibris/sfx_ver/sfx4_1/<instance>/templates/simplified_template1/mobile

Mobile target displayers:

/exlibris/sfx_ver/sfx4_1/<instance>/templates/simplified_template1/services/mobile/

Mobile version of the DirectLink banner and multi-object window templates and images:
- Images for multi-object window and DirectLink banner mobile version (including header image):
  /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/mobile/
- Header image name location and file name. (Note that this image is shared by the mobile versions of the CitationLinker, DirectLink banner, and multi-object window):
  /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/mobile/logo_sfx.png
Recommended image size: 213 pixels wide, 52 pixels high
Templates for the mobile version of the SFX menu – multi-object menu and DirectLink banner:
/exlibris/sfx_ver/sfx4_1/<instance>/templates/multiobject/mobile
Templates and images for the CitationLinker mobile version:
- Images for the CitationLinker mobile version (including header images):
  /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/mobile/
- Citationlinker title image located on the left side of the screen:
  /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/mobile/logo_citation_linker.png
  
  Recommended image size: 238 pixels width, 52 pixels height
- SFX logo image on the right side of the screen:
  /exlibris/sfx_ver/sfx4_1/<instance>/templates/img/mobile/logo_sfx.png
  
  Recommended image size: 213 pixels width, 52 pixels height
Templates for the CitationLinker mobile version:
/exlibris/sfx_ver/sfx4_1/<instance>/templates/citation/mobile

Advanced SFX Menu Template Configuration

SFX Menu Example

Defining the Basic Group of Services

Grouping Services on an SFX Menu Screen

Defining the Order of Groups of Services and Text Describing Each Group

Defining the Text Describing Each Service

Defining the Order for Targets for the Same Service Type

Force Targets to Display at the Bottom of a List of Services

Changing the Text Explaining a Particular Service

HTML Templates of the Advanced Menu Template

Changing Images in the SFX Menu

Changing the .tmpl Files that Constitute the SFX Menu

Creating Language-Specific Menu Templates

Overview of SFX Menu-Related Features, Files, and Tools

Target Displayers

Using a Special Displayer to Show Date Threshold Information in the SFX Menu

Related Objects in XML, OpenURL, and Consortium API

SFX Window Behavior

Changing the Size of the Target Window

Including COinS Representation in the SFX Menu

Setup

Applications that Use COinS

Configuring the SFX Menu Interface Language

Configuring the SFX Menu Language in the SFX Admin Center

Simplified Menu Template

Advanced Menu Template

Setting the SFX Menu Language in an External Application

Setting the SFX Menu Language via a User Profile Cookie

Setting the SFX Menu Language via the req.language OpenURL Element

SFX Menu for Mobile Devices

Defining the Order of Groups of Services and Text
Describing Each Group

Using a Special Displayer to Show Date Threshold
Information in the SFX Menu