Aleph SFX interoperability A view from the

Aleph – SFX interoperability. A view from the Aleph side Yoel Kortick, Aleph 500 2 nd line support Team leader

Copyright Statement All of the information and material inclusive of text, images, logos, product names is either the property of, or used with permission by Ex Libris Ltd. The information may not be distributed, modified, displayed, reproduced – in whole or in part – without the prior written permission of Ex Libris Ltd. TRADEMARKS Ex Libris, the Ex Libris logo, Aleph, SFXIT, Meta. Lib, Digi. Tool, Verde, Primo, Voyager, Meta. Search, Meta. Index and other Ex Libris products and services referenced herein are trademarks of Ex Libris, and may be registered in certain jurisdictions. All other product names, company names, marks and logos referenced may be trademarks of their respective owners. DISCLAIMER The information contained in this document is compiled from various sources and provided on an "AS IS" basis for general information purposes only without any representations, conditions or warranties whether express or implied, including any implied warranties of satisfactory quality, completeness, accuracy or fitness for a particular purpose. Ex Libris, its subsidiaries and related corporations ("Ex Libris Group") disclaim any and all liability for all use of this information, including losses, damages, claims or expenses any person may incur as a result of the use of this information, even if advised of the possibility of such loss or damage. © Ex Libris Ltd. , 2008 2

Table of Contents • Introduction • Finding Valid SFX Sample Targets • Conditionally removing the SFX icon in Aleph • The URL Pop Up Window in Aleph showing the Open URL for SFX • Displaying the XML sent from Aleph to SFX • Icons and pop up text from Aleph 3

Introduction • This presentation will not focus on SFX configuration and usage, but rather will show the Aleph side of Aleph-SFX interoperability. • In addition to the information presented here see also the guide chapter “Aleph 20. 01 Syslib Guide - Web OPAC”. 4

Finding Valid Sample SFX Targets • Often when diagnosing an SFX problem it is necessary to find a specific “working” example. • By “working example” we mean a bibliographic record which should have a link to SFX for a specific SFX service such as “full text”. • Showing how to find such a sample will also serve as a useful introduction to the general SFX setup. 5

Finding Valid Sample SFX Targets • The sfx_base_url defines the IP address of the SFX server used by Aleph. • The sfx_admin_base_url defines the IP address of the SFX server for which the SFX administrator may access and update the targets. • Here they are in aleph_start yoelk@il-aleph 07(a 20_1) USM 01> cd $alephe_root yoelk@il-aleph 07(a 20_1) USM 01> egrep ' sfx_base_url|sfx_admin_base_url ' aleph_start setenv sfx_base_url http: //il-cleo 01: 3210/keren setenv sfx_admin_base_url http: //il-cleo 01: 3210/sfxadmin/keren 6

Finding Valid Sample SFX Targets • Here we can enter the sfx_admin_base_url setenv sfx_admin_base_url http: //il-cleo 01: 3210/sfxadmin/keren 7

Finding Valid Sample SFX Targets • After entering the username and password the SFX Admin Center may be accessed. 8

Finding Valid Sample SFX Targets • Under the KB manager section we will click “Targets”. 9

Finding Valid Sample SFX Targets • First choose a target which is listed as Active (yellow Y in “Active” column) • Click the P icon for that target to view the “Object Portfolio”. We will click the P for ADISONLINE We see that it is an active target 10

Finding Valid Sample SFX Targets • When in the portfolio find a journal which you want to use as an example for the specific target. • Here “Journal of mathematical physics” (ISSN 1527 -2427) has service “get. Full. Txt” 11

Finding Valid Sample SFX Targets • Make sure the desired journal(s) are catalogued in Aleph with correct ISSN and title. 12

Finding Valid Sample SFX Targets • Search for record in Aleph and see SFX link • This is the short view 13

Finding Valid Sample SFX Targets • Search for record in Aleph and see SFX link • This is the full view 14

Finding Valid Sample SFX Targets • 15 In this case after clicking the SFX link we see the various options and have an example.

Conditionally removing the SFX icon • It is also possible to conditionally remove the SFX icon from both the short view and the full view. • This is done by configuring the table $data_tab/tab_sfx_denied • The table header is very clear 16

Conditionally removing the SFX icon • Here is an actual request from an Aleph user (name removed for privacy reasons): From: North American Aleph Users Group [mailto: ALEPH-NA@LISTSERV. ND. EDU] On Behalf Of … Sent: Thursday, April 23, 2009 11: 11 PM To: ALEPH-NA@LISTSERV. ND. EDU Desire to conditionally Subject: SFX-ALEPH integration remove SFX button Hello everyone, We are implementing SFX along with ALEPH version 18. We are encountering difficulties in ensuring that the SFX Find-it button will not display in ALEPH in the case of monographs for which we do not have (or have not purchased) electronic full-text links. So far, the only information we've been given from Ex. L was that we need to have "a field in the MARC record indicating whether or not the title is in SFX. If so then a logical expression can be written to determine if the button will display" However, I need more specific data, such as: 1. Which ALEPH table do I assign this MARC tag? 2. Does ALEPH care which MARC tag we use? 3. How do I write the logical expression and where do I write this expression? If anyone is willing to share the answers to these questions, we'd be very grateful. Thank you very much, 17

Conditionally removing the SFX icon • Here the record with ISSN does give us the SFX link 18

Conditionally removing the SFX icon • Now we add this line to $data_tab/tab_sfx_denied !1 2 3 4 5 6 7 8 !!-!!!!!-!-!-!!!!!-!-! BK 856## u Y OR 020## a Y SE 856## u Y • The red line above means that if the record is format SE and has an 856 field with sub field u then do not display the SFX link 19

Conditionally removing the SFX icon • And here we add an 856 field to the record 20

Conditionally removing the SFX icon • And now the SFX button is gone It used to be here 21

Displaying the XML • Often when problem solving with Aleph SFX interoperability the SFX team will wish to see the XML which Aleph sends to SFX. • This may be done by putting certain debug messages in www_server. conf and also having a valid line in $data_tab/tab_sfx. 22

Displaying the XML • These are the lines necessary in www_server. conf: yoelk@il-aleph 07(a 20_1)>cd $alephe_root yoelk@il-aleph 07(a 20_1)>grep sfx_service www_server. conf setenv get_buf_sfx_services Y setenv check_sfx_service Y 23

Displaying the XML • Here is an example of a line in $data_tab/tab_sfx: yoelk@il-aleph 07(a 20_1) USM 01> dt yoelk@il-aleph 07(a 20_1) USM 01> grep ^U-USM 01 tab_sfx U-USM 01 www_f_sfx 24 12 N get. Web. Service

Displaying the XML • Now when we view the record in “full view” we will cause the SFX button to be viewed in accordance with the parameters in tab_sfx … Cause record to be viewed in full view 25

Displaying the XML • And in the $LOGDIR log file we will see the actual xml being sent to SFX • First we see this: WWW-F : FULL-SET get_buf_sfx_services debug mode is on Load: /exlibris/aleph/a 20_1/usm 01/tab_sfx (line 00001 of tab_sfx) : BASE-NAME=U-USM 01 BUTTON-NAME=www_f_sfx SERVICE-NAME=get. Web. Service check_sfx_service debug mode is on 26 BUTTON-NUMBER=12 N get. We DIRECT-LINK=N

Displaying the XML • Then we see this: Handling docx (check_sfx_service) : [USM 01. 000050246 (BIB)] FMT LSE LDR L 00000 cas^^2201201^^^4500 001 L 000050246 005 L 20090415214539. 0 008 L 741112 c 19609999 nyumr^p^^^^^^^0^^^a 0 eng^c 010 L$$aa 61003320 0220 L$$a 1527 -2427 030 L$$a. JMAPAQ 032 L$$a 281060$$b. USPS 035 L$$a(OCo. LC)ocm 01800258 037 L$$b. Subscription Fulfillment Division, 335 East 45 th St. , New York, NY 10017 042 L$$alc$$ansdp 05000 L$$a. QC 20$$b. J 65 2100 L$$a. J. math. phys. 222 0 L$$a. Journal of mathematical physics 24500 L$$a. Journal of mathematical physics. 27

Displaying the XML • And then we see the actual xml: <ctx: referent> <ctx: metadata-by-val> <ctx: format>info: ofi/fmt: xml: xsd: journal </ctx: format> <ctx: metadata> <rft: journal xmlns: rft="info: ofi/fmt: xml: xsd: journal " xsi: schema. Location="info: ofi/fmt: xml: xsd: journal http: //www. openurl. info/registry/docs/info: ofi/fmt: xml: xsd: journal "> <rft: jtitle>Journal of mathematical physics. </ rft: jtitle> <rft: issn>1527 -2427</rft: issn> <rft: genre>journal</rft: genre> <rft: aulast>American Institute of Physics. </ rft: aulast> <sfx. response_type>service_exist</sfx. response_type> </rft: journal> </ctx: metadata-by-val> </ctx: referent> 28

Displaying the XML • The actual xml from the previous slide may be needed by the SFX team to see why Aleph – SFX interoperability is not behaving as desired. 29

The URL pop up window • When clicking the SFX button from Aleph to SFX it is often necessary when debugging to view the actual URL sent by Aleph. • An easy way to do this is to configure a URL pop up window to display the URL. 30

The URL pop up window • Here is an example of the URL pop up window 1. Click here 2. See URL pop up Window 31

The URL pop up window • The URL pop up window gives the exact URL created by Aleph for SFX • This can be very useful when debugging • When something does not work as desired the “SFX staff” will often wish to know what the URL is which Aleph sends. 32

The URL pop up window • After clicking OK in the URL pop up window the SFX window will open The URL which was in the URL pop up Window is also here (but more difficult to see) 33

The URL pop up window • Background for learning to determine if the URL pop up window will appear • If this is defined in aleph_start: setenv sfx_openurl_version • ver-0. 1 Then this page is used for creating the open URL www_f_eng/sfx-record-ver-0. 1 • If this is defined in aleph_start: setenv sfx_openurl_version • ver-1. 0 Then this page is used for creating the open URL www_f_eng/sfx-record-ver-1. 0 34

The URL pop up window • The files sfx-record-ver-0. 1 and sfx- record-ver-1. 0 contain the following line: var debug =1 ; • If the “ 1” is changed to “ 0” then the URL pop up window will not appear. 35

The URL pop up window • Here we have changed the value to 0: yoelk@il-aleph 07(a 20_1) USM 01> diff sfxrecord-ver-0. 1 sfx-record-ver-0. 1. out. of. box 9 c 9 < var debug =0 ; --> var debug =1 ; yoelk@il-aleph 07(a 20_1) USM 01> 36

The URL pop up window • Now the SFX window opens directly without the intermediary pop up window 37

Icons and pop up text • In addition to the information here see also section 4. 14 “Adding an SFX Link Button” in the guide “Aleph 20. 01 Syslib Guide - Web OPAC”. • We will discuss now how to configure icons and pop up text for SFX links in the Aleph web OPAC • The icons and pop up texts for the SFX link from the Aleph web OPAC full view come from the following parameters in $alephe_root/www_server. conf: • www_f_sfx_dim 38

Icons and pop up text • Here are the default definitions in www_server. conf yoelk@il-aleph 07(a 20_1): . . . a 20_1/alephe>grep www_f_sfx www_server. conf setenv www_f_sfx "<img src=&icon_path/f-sfx. gif border=0 alt='Use SFX services'>" setenv www_f_sfx_dim are available'>" "<img src=&icon_path/f-sfx-dim. gif border=0 alt='No SFX services • www_f_sfx This is used by Aleph when there is a link to SFX • www_f_sfx_dim It is possible to configure the system so thyat this icon will be used by Aleph only when specifically specified in $data_tab/tab_sfx (mentioned later) and only for the full view. 39

Icons and pop up text • The short view and link from the items always uses www_f_sfx • Regarding this the guide “Aleph 20. 01 Syslib Guide - Web OPAC states: “Note that although the SFX button can be displayed on the list of items (placeholder $1500 on item-global-body) and on the Brief list (www_tab_short), this SFX button cannot be made sensitive. “ • This means it always uses www_f_sfx (as the following slides will explain) 40

Icons and pop up text • In the “out of the box” setup the two variables www_f_sfx and www_f_sfx_dim point to identical icons. • This is evident by comparing the following two icons: http: //il-aleph 07: 8991/exlibris/aleph/a 20_1/alephe/www_f_eng/icon/f-sfx. gif http: //il-aleph 07: 8991/exlibris/aleph/a 20_1/alephe/www_f_eng/icon/f-sfx-dim. gif Note: the above URLs are shortcuts to see icons. The URL and path can be exchanged with the actual URL and path in a real library. 41

Icons and pop up text • The icons are not only controlled by the www_f_sfx and www_f_sfx_dim variables, but also by $data_tab configuration files and actual html of the web OPAC: • These are the files: 1. $data_tab/www_tab_short. eng 2. $data_tab/tab_sfx 3. www_f_eng/short-a-head 4. www_f_eng/short-a-body 5. www_f_eng/full-set-head-[extension] 42

Icons and pop up text – short view • The short view is controlled by the files: 1. this line in $data_tab/www_tab_short. lng ! 2 3 4 5 6 7 8 9 10 11 12 !-!-!!!!!!!!!!-!!!!!!-!!-!!-!!!!-!-!-!!!!!-!!-!!!!!9 L SFX 00 00 0100 L 2. This line in www_f_eng/short_a_head <th class=text 3>$1100</th> 3. This line in www_f_eng/short_a_body <td class=td 1 $3000 nowrap valign=top>$1100 43 </td> ## SFX 13

Icons and pop up text – full view • The full view is controlled by this section of $www_f_eng/full-set-head-[extension] <td class="bar" align="center" valign="bottom" nowrap> $1100 $1200 </td> 44

Icons and pop up text – full view • Regarding $data_tab/tab_sfx we may have this in the table ! 1 2 3 4 5 !!!!!!!!!!!!!!!!!!!!-!!-!-!!!!!!!!! USM 01 • www_f_sfx 12 N get. Full. Txt Here we are stating that we are using button identifier www_f_sfx (defined in aleph_start) for html value 12 (in our example defined as $1200 in www_f_eng/full-set-head-[extension]) for the get. Full. Txt function. 45

Icons and pop up text • Here we see the connection between the 12 in tab_sfx and the 12 in full-set-head-[extension] ! 1 2 3 4 5 !!!!!!!!!!!!!!!!!!!!-!!-!-!!!!!!!!! USM 01 www_f_sfx 12 N get. Full. Txt <td class="bar" align="center" valign="bottom" nowrap> $1100 $1200 </td> 46

Icons and pop up text – full view • A more in depth discussion of tab_sfx is beyond the scope of this presentation. • The column 5 SFX service name will be understood by those familiar with SFX (SFX administrators). 47

Icons and pop up text – full view • Let’s suppose we have an icon which is a smiley face. It is in our icon directory and it is called smiley. jpg 48

Icons and pop up text – full view • We may define smiley. jpg as our www_f_sfx icon yoelk@il-aleph 07(a 20_1) USM 01> grep "www_f_sfx " www_server. conf setenv www_f_sfx "<img src=&icon_path/smiley. jpg border=0 alt='Use SFX services'>" 49

Icons and pop up text – full view • And then this will appear in the web OPAC full view 50

Thank You! Yoel. Kortick@exlibrisgroup. com