Resource Management Guide. Version 4.x

Transcription

1 Resource Management Guide Version 4.x

2 CONFIDENTIAL INFORMATION DISCLAIMER The information herein is the property of Ex Libris Ltd. or its affiliates and any misuse or abuse will result in economic loss. DO NOT COPY UNLESS YOU HAVE BEEN GIVEN SPECIFIC WRITTEN AUTHORIZATION FROM EX LIBRIS LTD. This document is provided for limited and restricted purposes in accordance with a binding contract with Ex Libris Ltd. or an affiliate. The information herein includes trade secrets and is confidential. The information in this document will be subject to periodic change and updating. Please confirm that you have the most current documentation. There are no warranties of any kind, express or implied, provided in this documentation, other than those expressly agreed upon in the applicable Ex Libris contract. This information is provided AS IS. Unless otherwise agreed, Ex Libris shall not be liable for any damages for use of this document, including, without limitation, consequential, punitive, indirect or direct damages. Any references in this document to third party material (including third party Web sites) are provided for convenience only and do not in any manner serve as an endorsement of that thirdparty material or those Web sites. The third party materials are not part of the materials for this Ex Libris product and Ex Libris has no liability for such materials. TRADEMARKS ʺEx Libris,ʺ the Ex Libris bridge, Primo, Aleph, Alephino, Voyager, SFX, MetaLib, Verde, DigiTool, Preservation, Rosetta, URM, ENCompass, Endeavor ezconnect, WebVoyáge, Citation Server, LinkFinder and LinkFinder Plus, and other marks are trademarks or registered trademarks of Ex Libris Ltd. or its affiliates. The absence of a name or logo in this list does not constitute a waiver of any and all intellectual property rights that Ex Libris Ltd. or its affiliates have established in any of its products, features, or service names or logos. Trademarks of various third party products, which may include the following, are referenced in this documentation. Ex Libris does not claim any rights in these trademarks. Use of these marks does not imply endorsement by Ex Libris of these third party products, or endorsement by these third parties of Ex Libris products. Oracle is a registered trademark of Oracle Corporation. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company Ltd. Microsoft, the Microsoft logo, MS, MS DOS, Microsoft PowerPoint, Visual Basic, Visual C++, Win32, Microsoft Windows, the Windows logo, Microsoft Notepad, Microsoft Windows Explorer, Microsoft Internet Explorer, and Windows NT are registered trademarks and ActiveX is a trademark of the Microsoft Corporation in the United States and/or other countries. Unicode and the Unicode logo are registered trademarks of Unicode, Inc. Google is a registered trademark of Google Inc. iphone is a registered trademark of Apple Inc. Copyright Ex Libris Limited, All rights reserved. Document released: Web address:

3 Table of Contents Part I Updates to This Guide... 9 About This Guide Content and Scope Target Audience Terms and Definitions Related Documents Resources Chapter 1 KnowledgeBases in MetaLib About the KnowledgeBase Central KnowledgeBase Local KnowledgeBase Chapter 2 MetaLib Management Interface What Are Resources? How Are Resources Configured? Find a Resource Browse List of Resources Add a New Resource The Resource List IRD Actions...20 Configuration Record Actions...21 Chapter 3 IRD Replication Introduction Replicating an IRD Chapter 4 Global Updates About Global Updates Applying Global Updates The Global Update Screen Chapter 5 The Information Resources Database Record (IRD) IRD Cataloging Form

4 MetaLib Resource Management Guide Table of Contents IRD Record Fields Subscription Tab Using the Alternative Link Fields...37 Defining the IP Ranges for Alternate Link Fields...38 Updating the IP Filter List Using a Field from the Converted Record Using the MetaLib SID Field Link to Syntaxes for Aleph Versions Presentation: Primary Tab...41 Presentation: Secondary Tab Presentation: Library Tab...48 Local Tab...50 Categories Tab...51 Assigning Categories to a Resource Running the ALL Subcategories Process...53 Information Resource Description Indexes Chapter 6 MetaLib Resource Configuration Introduction Definition of Concepts Used in MetaLib Configurations Access Methods Creating a New Configuration Types of Configurations Z39.50 Configurations Z39 Gate...58 WEBCONFIG_SIMPLE Configurations...59 Ampersands (&) in HTTP Requests URL Encoding...60 Creating a WEBCONFIG_SIMPLE Configuration...61 Search & Link Resources ALEPH_X Configurations EXTERNAL and EXTERNAL_JUMP Configurations...64 The FIND Function...65 The PRESENT Function Having the FIND Program Perform the First PRESENT...69 The PRESENT_SINGLE (optional) Function...71 How PRESENT and PRESENT_SINGLE Functions Are Merged 72 Troubleshooting External Programs URL in IRD Description

5 MetaLib Resource Management Guide Table of Contents General Configuration Tab Term Transformations Tab Search Transformations...82 Search Type...83 Transformations...83 Target Code...84 Z39.50 Attributes (Requires Z39_Gate Restart)...85 Lateral Term Transformations...86 In Field Tag and Subfield...87 Out Field Tag...87 Transformations...87 Conversion Tab Conversion Program...90 Additional Available Programs...91 vir_fix_doc_table...91 tab_conv_unimarc...91 Conversion Parameters...91 Programs and Parameters...94 Count from Start (formerly vir_fix_doc_first)...94 Count from End (formerly vir_fix_doc_last)...94 Parser (vir_fix_doc_parser)...95 Remove Asterisk (vir_fix_doc_aster)...96 Subfield Order (vir_fix_doc_sforder)...96 ISSN or ISBN (vir_fix_doc_020or022)...97 RegExp (vir_fix_doc_reg_exp)...97 IS Zetoc (vir_fix_doc_is_zetoc)...97 Translate Using Table (vir_fix_doc_table_translate)...97 Actions...99 Conditions SUTRS Conversion Table Incoming SUTRS Field Tag MARC Tag/Subfield Split Character OpenURL Tab If Field/If Field Contains OpenURL Element Tag Program/Parameter Parser (vir_950_parser)

6 MetaLib Resource Management Guide Table of Contents Reg Exp (vir_950_reg_exp) Counting Parser (vir_950_parser_n) Count from Start (vir_950_first) Count from End (vir_950_last) Author First Last (vir_950_au_firlst) Author Last,First (vir_950_au_lstfir) Perl (vir_950_perl) Sort Tab Chapter 7 CKB Update Overview Introduction Working with Consortia Setting Up CKB Update Root Server Table to Modify /etc/services MetaLib Server Tables to Modify tab_ckb_pull Institutional Settings ckb_update_date Confirm Local MetaLib Server IP Address with Ex Libris CKB Server Testing the sftp Connection CKB Update Steps Run a Backup of the DAT01 (KnowledgeBase Data) Initiating a CKB Update Manually Defining a Cron Job to Run the CKB Update Output from the CKB Update CKB Release Notes Chapter 8 Activating Resources Using the Activating Resources Page Exporting Resources Importing Resources Chapter 9 Exporting and Importing KnowledgeBase Records Introduction Exporting Records Exporting an Institution s Records Exporting Specific IRDs Using the Global Update Feature Running the Export from Command Line

7 MetaLib Resource Management Guide Table of Contents Part II Converting Resource IDs to System IDs What is Exported? Importing Records Running the Import from the MetaLib Admin Module (/M) Running the Import from the Command Line Command Line Parameters: What Happens During the Import? IRDs Configurations Categories Import Report Reports and Statistics Chapter 10 Accessing MetaLib Reports and Statistics Introduction The MetaLib Reports and Statistics Page Date Format Entering Values in a Date Field Date Validation Action Icons Input Form Actions Output Form Actions Chapter 11 Reports Introduction KnowledgeBase Report Sample KnowledgeBase Reports MetaLib Search Queries Sample Search Queries Reports Chapter 12 Statistics Introduction KnowledgeBase Resources Sample Reports MetaLib Search Statistics Sample Reports Search Status

8 MetaLib Resource Management Guide Table of Contents Part III QuickSets Search Statistics Sample Reports Resource Categories/Resource Locator Usage Sample Reports Number of Daily Sessions Sample Reports User Records Statistics Sample Reports Links to Native Interface Sample Reports Appendixes Appendix A Yaz Client Introduction Yaz Client Commands Running the Yaz Client Appendix B MetaLib Standard Search Syntax Introduction to the MetaLib Search Syntax Supported Searches Keyword Searching Phrase Searching Truncation Punctuation Stop Words Boolean Searching Lateral/HyperLink Searching Appendix C Term Transformation Programs Transformation Descriptions Appendix D Setting the Date Format Appendix E The KnowledgeBase Report Customizing the Output

9 Updates to This Guide The following changes were made to this guide: Updated the description for the global update types. For more information on the Switch to a Different Configuration Code type, see Applying Global Updates on page 26. 9

10 MetaLib Resource Management Guide Updates to This Guide 10

11 About This Guide This section includes: Content and Scope on page 11 Target Audience on page 12 Terms and Definitions on page 12 Related Documents on page 12 Content and Scope This guide contains the following parts: Part I: Resources This part describes the MetaLib KnowledgeBase, as well as the structure of the resource records and the different types of search configurations. It also details the process for cataloging and localizing Information Resource Description (IRD) records and the process of configuring search routines and programs. The goal of this part is to provide the reader with the following: Confirmation of MetaLib s categories of resources and types of search configurations. Detailed understanding of the Information Resource Description (IRD) records and their configurations. Part II, ʺReports and Statistics,ʺ This part describes how to access and use the various reports and statistics. Part III, ʺAppendixes,ʺ This part contains additional information that may be helpful in understanding the topics that are described in this guide. 11

12 MetaLib Resource Management Guide About This Guide Target Audience This guide is intended to assist those staff members responsible for working with the information resources, including: Cataloging, copying, and localizing IRDs containing descriptive information and subscription data Configuring resources, including developing locally created external programs, to allow end users to search from within MetaLib s interface In addition, this document is helpful for MetaLib staff users and system librarians to access and use the MetaLib reports and statistics. Terms and Definitions This document uses the following terms and definitions: VIR01 is the temporary library in which MetaLib temporarily stores session data. VIR00 stores data relating to MetaLib users, including user records, profiles, history, and e shelf information. The X Server is a licensed component of Ex Libris productsʹ multitier architectural structure. It enables connectivity to the MetaLib system, as well as to the Aleph and DigiTool systems, via a standard XML interface. Statistical data can be accumulated for X Services as well as the standard user interface functionality. Related Documents The MetaLib System Configuration and Administration Guide The MetaLib User Interface Guide 12

13 Part I Resources Part I contains the following: Section 1: KnowledgeBases in MetaLib on page 15 Section 2: MetaLib Management Interface on page 17 Section 3: IRD Replication on page 23 Section 4: Global Updates on page 25 Section 5: The Information Resources Database Record (IRD) on page 29 Section 6: MetaLib Resource Configuration on page 55 Section 7: CKB Update Overview on page 115 Section 8: Activating Resources on page 125 Section 9: Exporting and Importing KnowledgeBase Records on page 133

14 MetaLib Resource Management Guide Part I: Resources 14

15 1 KnowledgeBases in MetaLib This section includes: About the KnowledgeBase on page 15 Central KnowledgeBase on page 15 Local KnowledgeBase on page 16 About the KnowledgeBase MetaLib has a KnowledgeBase that holds technical and descriptive data for the resources accessed via MetaLib. Each resource in the KnowledgeBase has one or more of these types of records: An Information Resource Description record (IRD) with subscription and description data. The IRD is the only mandatory record and, alone, is the basis for a Link Resource that can be located and linked to via the MetaLib portal A configuration record containing rules for searching resources, for retrieving records from resources, and for parsing records to construct the OpenURL (the latter two not being applicable to Search&Link configurations) External programs and configuration tables Complete descriptions of the various record types are provided in MetaLib Resources on page 11. Central KnowledgeBase Ex Libris maintains a Central KnowledgeBase (CKB). Every MetaLib installation includes a copy of the CKB that serves as the basis for creating a Local KnowledgeBase. 15

16 Chapter 1: KnowledgeBases in MetaLib Sites that subscribe to the KnowledgeBase Service may download CKB updates with new and updated resources. The institution is the basic administrative unit in MetaLib and both resources and end users are always linked to a specific institution. CKB IRD records and configurations belong to the METALIB institution. As such, these resources cannot and should not be modified locally. Local KnowledgeBase A typical MetaLib installation includes the Central KnowledgeBase as well as at least one local copy of the CKB. This local copy ( owned by the local institution and containing the local institution s descriptive, subscription/connection data and local configuration data) is the starting basis for the Local KnowledgeBase. Resources from within the Local KnowledgeBase are the ones displayed to users for searching. Within the Local KnowledgeBase, CKB IRD records are inactive; a separate copy of each IRD is created for institution(s) in the installation. Each institution needs to localize its own IRD records by adding data that is specific to a subscription, such as a library s user name/password. A first step is localizing the local copy of the IRD and then activating the resource. Testing the resource (prior to releasing to end users) may include the addition/maintenance of fields in the IRD. Ex Libris Central KnowledgeBase Service maintains configuration records of resources in the CKB. These configurations contain the rules for searching resources, for retrieving records, and for parsing records to construct the OpenURL. Configuration records, external programs, and configuration tables that are created locally are maintained locally. 16

17 2 MetaLib Management Interface This section includes: What Are Resources? on page 17 How Are Resources Configured? on page 18 Find a Resource on page 18 Browse List of Resources on page 19 Add a New Resource on page 19 The Resource List on page 20 What Are Resources? MetaLib resources are primarily databases, searchable Web sites, and library OPACs. Resources in MetaLib can also be e Journals, image collections, and other electronic information sources. The resources fall into the following categories: MetaLib Link Only Resources These resources can only be linked to directly and searched using the information provider s interface, the native interface. They cannot be searched via MetaLib s interface. MetaLib Search & View Resources These resources can be searched and their results viewed via MetaLib s interface. The resources can also be linked to directly. MetaLib Search & Link Resources These resources can be searched via MetaLib s interface, but the results of the search are displayed in the native interface. 17

18 Chapter 2: MetaLib Management Interface How Are Resources Configured? Resources are cataloged and configured in the Web based management interface (also referred to as the /M interface). The first step is to catalog the IRD record. Once the IRD record has been cataloged, you can create the configuration record or link the IRD record to an existing configuration record. The following options are available from the main menu of the MetaLib Management interface: Find a Resource Browse List of Resources Add a New Resource The next sections detail these three functional options available in the Management interface, or /M. Find a Resource Use this function to locate resources for update purposes or to search for a resource to copy. Note that queries can be truncated with the use of a question mark or an asterisk (for example, chem?). The following IRD fields can be used to filter the FIND query: Resource Status Institution Secondary Affiliation The following IRD/configuration fields can be searched: Resource Name searches full, short and alternative names Resource ID Configuration Code Resource Type Publisher Creator Any words searches all resource names, resource type, keywords, languages, description, date added to CKB, date of last update. Free/By Subscription Country NEW Resources Date 18

19 Chapter 2: MetaLib Management Interface NEW Resources User Group Filter Library System MetaIndex Resource System Number search by internal system number Entry Date search by the date of entry Last Update search by date of last update Configuration searches for access method, record type, format conversion program, incoming and outgoing character conversion, direct link type, and holdings method. NOTE: For more information on the searchable KnowledgeBase indexes, refer to the Find Databases section of the MetaLib User Interface Guide, as well as the Information Resource Description Indexes on page 53. The resources located in the Find a Resource function are displayed in a Resource List (explained in more detail in The Resource List on page 20). Browse List of Resources This function enables a browse list of resources by full name. The results of this search display in the same list format as that produced by a Find a Resource function. You can filter the browse list of resources by institution and by resource status. By default, the list will display only active resources that belong to the institution or group to which the administrator belongs (as defined in the./dat01/tab/tab_groups table). Add a New Resource This option will display a blank IRD cataloging form for adding a new resource. 19

20 Chapter 2: MetaLib Management Interface The Resource List Resources located by the Find and Browse functions are displayed in a Resource List. Figure 1: The Resource List The list displays the following functions and basic information about the resource: IRD Action action buttons to edit, copy, or delete a resource as well as a link to the resource s configuration notes, search hints, and release notes Resource Name the full name of the resource Resource ID the ID number of the resource Status Active/Inactive/Testing. The status can be updated by clicking the appropriate radio button Configuration Code the code of the MetaLib resource configuration that is attached to the IRD Access Method the type of configuration Config Action action buttons to add/create, delete, edit, or link to a resource configuration IRD Actions From this list, you can access both the IRD record and the configuration record by using the action buttons. The IRD action buttons are on the left hand side and the configuration record action buttons are on the right hand side. The following actions are available:? Access the Notes. Resource Configuration Notes, Search Hints for the User, and Release Notes (CKB) come from the CKB IRD and may not be edited. A local version of the Search Hints may be copied and edited locally. S Edit (update) the IRD s Subscription information P Edit (update) the IRD s Presentation information 20

21 Chapter 2: MetaLib Management Interface T Use this IRD as a template. Click the <T> action to create a copy of the IRD (excluding the subscription information and the source ID). IMPORTANT: Do not use the <T> action to create a new IRD for the same resource in a different institution; use the Replicate feature instead. D Delete the IRD. V View the IRD. NOTE: Users who are not authorized to update the record, will see only the <V> and <?> actions. Configuration Record Actions If there is a configuration record and the /M user is authorized to update it, the following action buttons will be visible and active: E Edit (update) the configuration record D Delete the configuration record Users authorized to edit the IRD, but not authorized to update the configuration record, will see only the following: V View the configuration record D Delete the link to the configuration record If there is no configuration record linked to the IRD record, an option to add a configuration will display: A Add a new configuration or link the IRD to an existing configuration NOTE: See MetaLib Resource Configuration on page 55 for instructions on working with configurations. 21

22 Chapter 2: MetaLib Management Interface 22

23 3 IRD Replication This section includes: Introduction on page 23 Replicating an IRD on page 23 Introduction The Replicate function is used mainly by consortia. It will copy IRDs to different institutions on the same MetaLib server. In a consortium with central administration, this tool may be used to create IRDs centrally and then copy them to each of the member libraries. NOTE: This type of copy retains the Source ID and should only be used to copy IRDs when the copied IRD and the new IRD are the same resource. To use an IRD as a template (such as using a similar IRD for a different resource), use the <T> action. Replicating an IRD To replicate an IRD: 1 Select the IRDs to be copied. Search for IRDs using Find Resources. NOTE: Each of the resources in the result list has a selection box in the left hand column. To refine the list of IRDs to be edited, clear or select resources in the list, as appropriate. At the top of the column is a Deselect All and/or Select All option, as relevant. 23

24 Chapter 3: IRD Replication 2 Click the Replicate button. The Replicate IRDs screen shows the institutions to which the administrator has the authority to add resources. Optionally, enter the status and authentication data, which will be applied to the newly created IRDs. If an e mail address is entered, an e mail will be sent when the replication process is complete. 24

25 4 Global Updates This section includes: About Global Updates on page 25 Applying Global Updates on page 26 The Global Update Screen on page 27 About Global Updates The Global Update feature is used to make a change to more than one IRD at the same time. For example, a global update may be used in the following situations: If you want to change all of the Free resources in a MetaLib system to Active status. If you want to populate the Authentication field for all resources from a specific provider. If an information vendor s Z39.50 server is temporarily unavailable, you can deactivate the link between IRDs and configurations for all resources from that provider, effectively making them Link Only resources temporarily. NOTE: Consortia with central administration may use Global Updates to change all IRDs for a specific resource or group of resources across institutions. 25

26 Chapter 4: Global Updates Applying Global Updates Thi section describes the Global Update procedure. To apply global updates: 1 Use the Find Resources function to select the resources that need to be changed. Note that the resources in the result list each have a selection box in the left hand column. To refine the list of IRDs to be edited, clear or select resources in the list, as needed. You can use the Deselect All and Select All options at the top of the column to clear all items or select all items, respectively. NOTE: The default for the Find Resources function is to search for IRDs that the validated /M user has the authority to edit. If the default search is changed to find IRDs that the current /M user does not have authorization to edit, those IRDs are blocked by the Global Updates function. 2 Select the type of global update. Each global update is performed on a specific IRD field. The list of fields that may be edited using the global updates is found in the Select Type of Update drop down list. The following global update options are available: Change Status Change Authentication Change Hostname:Port Change Link to Native Interface URL Change Link to Records Change Link to Configurations Changes the status of the link between the IRDs and configurations. If this is set to N, the resources will appear in the User Interface as Link Only. Change Entry Date Change Last Update Create/Add to Export file This global update is used to gather resources to be exported to an XML file. See Exporting and Importing KnowledgeBase Records on page 133 for more information. Switch to CKB Configuration Enter the CKB ID. The CKB ID will be added to the IRDs, connecting them to the CKB Resource Configuration Notes and Search Hints for the User (CKB). This global update will also connect the IRDs to the CKB configuration and will delete the local configuration if it is not connected to another IRD. 26

27 Chapter 4: Global Updates Switch to a Different Configuration Code Enter the configuration code. This global update connects the IRDs to the selected local configuration and deletes the old configuration if it is not connected to another IRD. NOTE: This global update is used only to connect IRDs to local configurations that begin with L_. If you attempt to connect IRDs to non local configurations, the system will display an error message. 3 Choose Collapse or Expand. Expand will list each IRD on its own line in the Global Update screen. Collapse will de duplicate IRDs if the field being changed is identical. 4 Select Go to perform the update. The Global Update Screen The Global Update screen presents the existing data from the IRDs that were selected on the previous screen and the relevant choices for changing this data. NOTE: Only the selected resources are shown in the Global Update screen. To go back to the previous screen to select/clear resources, choose Resource List. Enter the data and select Submit on the relevant line. The system will respond with a message Changing and then Finished Change. NOTE: Some global updates contain a Change All option, which may be used as an alternative to entering data on each line. 27

28 Chapter 4: Global Updates 28

29 5 The Information Resources Database Record (IRD) This section includes: IRD Cataloging Form on page 29 IRD Record Fields on page 30 Information Resource Description Indexes on page 53 IRD Cataloging Form The IRD record cataloging form is arranged in tabs. The following buttons appear at the bottom of each tab: Next Tab Move to the next tab. Clicking a tab will open or move the user to the relevant tab. NOTE: Moving to another tab from the Basic Information tab is not permitted unless the mandatory fields have been filled in. Moving from tab to tab will submit and save the data in the form. Save Save the form after editing and remain on the same tab. Save & Exit Save the form and exit back to the Resource List. Resource List Go to the Resource List resulting from the last Find Resource query. Changes are not saved. Main Menu Return to the main menu. Delete Delete the IRD. 29

30 Chapter 5: The Information Resources Database Record (IRD) The following system assigned information appears above the buttons: Resource ID System assigned unique identifier for the IRD consisting of the local prefix plus a number Source ID Links the IRD to the corresponding CKB IRD Original ID The Resource ID from the system where the record was originally created Sysno System Number Internal system assigned identifier NOTE: An IRD record is created when a user selects the Add a New IRD option and the action cannot be cancelled. If an IRD record is added or copied but should not be retained, the Management user must delete it manually. IRD Record Fields The Information Resource Description (IRD) record fields appear on the following tabs: Subscription, Presentation (Primary, Secondary, and Library), Local, and Categories. Mandatory fields are marked with an asterisk in the interface. To avoid duplication, certain fields in the IRD are automatically copied to the resource configuration files. These fields are noted in the following sections. NOTE: Do not enter double quotes ( ) in the cataloging form. Use single quotes ( ) only. Subscription Tab The Subscription tab (see Figure 2) contains fields necessary to locate and link to the resource. 30

31 Chapter 5: The Information Resources Database Record (IRD) Figure 2: Subscription Tab Full Name (Mandatory) This is the title or full name of the resource. Maximum length: 100 characters Display Name (Mandatory) This is the brief title or name of the resource. This is the name that is displayed in the user interface. Maximum length: 100 characters NOTE: Only the first 40 characters entered in this field will be displayed in MetaLib s user interface results table view. 31

32 Chapter 5: The Information Resources Database Record (IRD) Institution, Secondary Affiliation, and IP Filter Fields These three fields are used for authorizing access to resources. In brief, the system will filter access to resources based on the affiliation of the user and the affiliation of the resource. Users and resources must be affiliated with an institution and optionally a secondary affiliation, typically a user group, if applicable. The IP filter provides an additional level of authorization, if needed. Institution (Mandatory) Every IRD record must belong to a specific institution. This determines which users (both in the KB Admin interface and in the user interface) have access to the IRD. Maximum length: 30 characters Secondary Affiliation IRD records may have one or more secondary affiliations or user groups. Enter multiple user groups separated by a comma with no spaces between entries. Secondary affiliations must be in uppercase. Display a list of secondary affiliations by clicking the link next to the field. Enter GUEST for resources that should be made available to all users, including members of the general public. Maximum length: 30 characters for each affiliation, 2,000 characters total For example: STAFF, GRAD IP Filter In addition to institution and secondary affiliation, resources may be filtered by IP range when access to a resource is determined by the IP. The institution s agreement with the vendor may stipulate that a resource must be accessed only from within the IP range of the institution. This means that if users log in from outside the IP range, they will not be able to access the resource, even though they are affiliated with the correct institution. NOTE: These IP ranges must be defined as affiliated guests within the relevant institution via the IP Addresses page on the Management Interface (/M). For more information, see the MetaLib System Configuration and Administration Guide. The filter is a textual representation, in uppercase, of an IP range defined in the table./vir00/tab/tab_authorize_ip. The list of IP filters can be displayed by clicking the link next to the field. A resource may be 32

33 Chapter 5: The Information Resources Database Record (IRD) affiliated with several IP filters. Separate multiple filters with a comma, without spaces. The maximum length of this field is 100 characters. Each filter has a maximum length of 10 characters, including commas. For more information, on setting up the list of IP filters, see Updating the IP Filter List on page 38. Configuration Code The configuration code is the code of the linked configuration record. This field appears in the IRD but cannot be updated from within the IRD. Clicking the configuration code takes you to the configuration record. The link between the IRD record and the configuration code is created from the resource list by clicking the A (or Add) button in the Config Action column. NOTE: Configuration codes must be in capital letters, maximum 20 characters. All codes that are created locally (not linked to a CKB configuration) must start with L_. See Global Updates on page 25 for switching local configurations to CKB configurations. Free/By Subscription This field indicates whether the resource provides a free search interface or requires a subscription. Link to Native Interface URL Enter the URL of the resource to link to the native interface. Maximum length: 500 characters NOTE: To test the URL, click the arrow icon after saving the IRD to open a new browser window using the Link to Native Interface URL. Proxy Server Flag and Search Proxy Server Flag The Proxy Server flag determines whether or not to use a proxy server when the user links to the native interface of the resource. The Search Proxy Server flag determines whether or not to use a proxy server when the user performs a search in the resource, including when the user links to the native interface of the resource. Both flags are used when the proxy selective filter in the Proxy tab in the Institutional Settings module is set to IRD_SELECTIVE. See the MetaLib System Configuration and Administrator Guide for more information about configuring MetaLib to interact with a proxy server. 33

34 Chapter 5: The Information Resources Database Record (IRD) Hostname: Port This is the address and port number of the server that MetaLib contacts for searching. If the resource uses the HTTP method POST, enter POST; preceding the HTTP Request. For example: POST; Z39.50 Resources The Hostname:Port for z39.50 resources is the server address and port for the z39.50 server. For example: Z3950trial.silverplatter.com:210 Aleph X Server Resources For Aleph version 14.2 and above, the Apache port is used for the port number. For example: se2.ub-fu-berlin.de:81 EXTERNAL, EXTERNAL_JUMP, WEBCONFIG Resources For resources that use HTTP for searching, the hostname:port contains the server address and application to open. It may also include additional HTTP request parameters. For CKB resources, check the Resource Configuration Notes, under the <?> button, to determine the correct hostname:port. Example from Beilstein Abstracts via Scirus: Maximum length: 500 characters Database Code The code used to connect to the database for searching. For example: AERS*, USM01 Maximum length: 200 characters Authentication The user name and password (if required by the resource). For Z39.50 open authentication (standard authentication), the format is user name/password. For Z39 idpass authentication, if a target requires idpass authentication, define the authentication string as follows: "g:[<groupid>] u:[<userid>] p:[<password>]" 34

35 Chapter 5: The Information Resources Database Record (IRD) where <groupid> is the group ID required by the target, <userid> is the user ID required by the target, and <password> is the password required by the target. NOTE: If a target does not require a group ID, user ID, or password, these fields should be left empty. Example 1: The target requires <groupid> = aaa, <userid> = bbb and <password> = ccc. This means that the format of the authentication string should be: ʺg:aaa u:bbb p:cccʺ Example 2: The target does not require <groupid>, but requires <userid> = bbb and <password> = ccc. The format of the authentication string should be: ʺg: u:bbb p:cccʺ Example 3: target requires <userid> = bbb only. The format of the authentication string should be: ʺg: u:bbb p:ʺ Maximum length: 500 characters Link to Records in Native Interface This URL enables the user to jump from a record retrieved in MetaLib to the record in the target database (rather than a link to the home page, this link goes to the record itself). To create this link, the resource must support linkto syntax for linking to individual records and there must be data in the record that can be used to create the link. In many cases, the data used in the link is a unique accession number. This number may come from a specific field in the converted record or from the MetaLib SID field. Maximum length: 500 characters Number of Sessions This field is for use only in resources that are configured to use the Session Handler. Check the <?> Resource Configuration Notes to determine whether a resource is set up to use this field. If so, enter the number of sessions defined as the limit for this resource within this institution. Data should be a number from 0 99, not higher than the server s max_search_processes limit (set in./metalib_conf/ metalib_start) Maximum length: 2 characters NOTE: At this time, no CKB resources are using the Session Handler mechanism. 35

36 Chapter 5: The Information Resources Database Record (IRD) Region This field indicates the Ex Libris office or distributor that contributed and manages this configuration. The region field represents the contributing country s international telephone code. For example: A configuration contributed and maintained by Ex Libris France will receive the region code 33. The only exceptions to this rule are the 001 and blank region fields, which indicate a resource written and maintained by Ex Libris Headquarters. Maximum length: 10 characters Cataloger s Note This field can be used to record any information about the cataloger and the time the record was cataloged. This note is not displayed in the User Interface. Maximum length: 200 characters Entry Date, Last Update, and Version Fields These fields are used in the process of CKB updates and are not editable locally. Verde Indicator Verde is Ex Libris Electronic Resources Management (ERM) product. Selecting this field indicates that there is a matching record in Verde. Note that the MetaLib Resource ID may be stored in the Verde KB in the Resource ID field. Verde Access Type This field corresponds with the Access Type (Z39, XML, SRU, etc ) in Verde. Alternative Link to Native Interface URL This field is used by sites using Athens authentication. The URL in this field replaces the value specified in the Link to Native Interface URL field for users that are outside the campus IP range. Alternative Link to Records in Native Interface This field is used by sites using Athens authentication. The URL in this field replaces the value specified in the Link to Records in Native Interface field for users that are outside the campus IP range. 36

37 Chapter 5: The Information Resources Database Record (IRD) Using the Alternative Link Fields MetaLib offers the ability to differentiate between users who are on or off campus with regard to linking to the native interface of a resource. The following fields are used for off campus users in all of the search modules (QuickSearch, MetaSearch, and Find Database). The Alternative Link to Records in Native Interface field defines the link that appears for the database name in the Table/Brief/Full views of the search result. The Alternative Link to Native Interface URL field defines the link that appears for the database name in all the database lists and Info pages. It is also the link that appears for the database name in the Table/Brief/Full views of the search result if the Alternative Link to Records in Native Interface field is left blank. When a database is displayed in any of the lists, MetaLib first checks whether the Alternative Link to Native Interface URL field is defined. If it is, MetaLib determines the location of the end user based on the pre defined institutional IP ranges that are defined in the./vir00/tab/tab_authorize_ip file, and then displays the appropriate link for the following locations: Off campus displays the link specified in the Alternative Link to Native Interface URL field. On campus displays the link specified in the Link to Native Interface URL field. For information on defining the IP ranges, see Defining the IP Ranges for Alternate Link Fields on page 38. When a search result is displayed, MetaLib first checks whether the Alternative Link to Records in Native Interface field is defined. If it is, MetaLib uses the tab_authorize_ip file to determine the end users location, and then displays the appropriate link for the following locations: Off campus displays the link specified in the Alternative Link to Records in Native Interface field displays. On campus displays the link specified in the Link to Records in Native Interface field. NOTE: If Athens is used for off campus authentication, a parameter is included in the URL for Athens. 37

38 Chapter 5: The Information Resources Database Record (IRD) Defining the IP Ranges for Alternate Link Fields The tab_authorize_ip file (see Figure 3) defines the IP ranges that MetaLib uses for alternative links to determine whether an end user is on or off campus. This file is located under the following directory: /exlibris/metalib/m4_3/vir00/tab!1 2 3!!!!!!!!!!-!!!!!!!!!!!!-!!!!!!!!!!!! URL CAMPUSA CAMPUSB CAMPUSC Figure 3: Sample tab_authorize_ip File To update the tab_authorize_ip file: 1 Enter the following commands to edit the tab_authorize_ip file: dlib vir00 dt vi tab_authorize_ip 2 Use Table 1 to define each IP range. Table 1. tab_authorize_ip Column Descriptions Column Description 1 Enter the name of the campus to which the IP range is assigned. The maximum length is 9 characters. To specify an off campus range, enter URL in this column. 2 Enter the first IP address in the range ( through ). The maximum length is 12 characters. 3 Enter the last IP address in the range. The maximum length is 12 characters. 3 Exit and save changes to the file. 4 Enter the following command to restart the Web Servers: start_w Updating the IP Filter List The ip-list-<institution> file (see Figure 3) defines the list of campuses that display when the IP Filter link is clicked on the Subscription tab of an IRD 38

39 Chapter 5: The Information Resources Database Record (IRD) record. A file for each language <lng> and associated institution <institution_code> is located under the following directory: /exlibris/metalib/m4_3/dat01/www_m_<lng> <html> <head> <title>ip Filter List </title> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> <include>meta-tags </head> <body class=text3> CAMPUSA <br> CAMPUSB <br> CAMPUSC <br> </body> </html> Figure 4: Sample tab_authorize_ip File For more information on the IP Filter field, seeip Filter on page 32. To update the ip-list-<institution_code> files: 1 Enter the following commands to edit the ip-list-<institution_code> file, where <lng> is the language and ins<nn> is the institution: cd /exlibris/metalib/m4_3/dat01/www_m_<lng> vi ip-list-<institution_code> (such as ip-list-metalib) 2 Within the <body class=text3></body> element, you can add, update, or delete entries in the IP Filter list. For example, if you would like to add CAMPUSD to your list, add the entry shown in bold, as follows: <html> <head> <title>ip Filter List </title> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> <include>meta-tags </head> <body class=text3> CAMPUSA <br> CAMPUSB <br> CAMPUSC <br> CAMPUSD <br> </body> </html> 39

40 Chapter 5: The Information Resources Database Record (IRD) IMPORTANT: Each campus listed in this file, must be defined in the tab_authorize_ip file (see Defining the IP Ranges for Alternate Link Fields on page 38). 3 Exit and save the changes to the file. 4 Repeat all steps for the remaining institutions and languages. 5 Enter the following command to restart the Web servers: start_w Using a Field from the Converted Record The field tag and subfield should be entered as $<tag>_<subfield>. If the field does not contain subfields, enter just the dollar sign ($) and tag. In the following example, the record includes the accession number in subfield a of tag 035: <username> &password=<passwd>&databases=s(nu)&search=$035_a Alternatively, if the record itself includes a link to the record in the native interface or to the full text, the field code in which the link is stored may be entered in the Link to Records in Native Interface field. For example, if the 856 field, subfield u contains a direct link to the full record or to the full text, enter $856_u in place of a URL. If individual records are missing the 856_u field, the link will use the URL in the Link to Native Interface. Using the MetaLib SID Field Records retrieved from a search in the User Interface are stored in a temporary database. When records are loaded into the temporary database, the system creates an SID field for every record. The SID may contain the accession number or system number of the record in its original database. The creation of the SID field is controlled by the Direct Link Tag/SYSNO and Direct Link field tag parameters in the configuration record as described in General Configuration Tab on page 75. NOTE: Indicate the SID number by entering the placeholder $0100 in the URL. The following example is the direct link to syntax for a sample Aleph 500 database: hub01?direct-doc/hub01-$ sysno-nocont 40

41 Chapter 5: The Information Resources Database Record (IRD) Link-to Syntaxes for Aleph Versions Note that this link to syntax works only if the Aleph protocol is used as the access method. Aleph 14.2: For example: Aleph 15+: F?func=direct&doc_number=$0100&l_base=<library-code> For example: l_base=usm01 If the default library in the ALEPH profile is not the same as the library entered in l_base, use the following link to syntax: $0100&l_base=<library code>&local_base=<library code> For example: l_base=usm01&local_base=usm01 Presentation: Primary Tab The Primary Presentation tab (see Figure 5) contains information that is initially provided by the CKB. It determines how the resource appears in the User Interface, including whether it appears at all and whether it appears as a Link to or Searchable resource. 41

42 Chapter 5: The Information Resources Database Record (IRD) Figure 5: The Primary Presentation Tab Type You can assign up to three types per resource from the Type drop down lists in this tab. These resource types appear in the list of resources as well as in the Info windows (<i>) on the MetaLib user interface (/V). Status The status enables the institution to control which resources are displayed to the users, as follows. The same options/functionality are available in the Resource List: Active resources are displayed to end users Testing indicates that the resource is in development. Such resources may be displayed in the user interface to staff but not to end users. A user can gain access to the Testing resources by setting the Status of Resources a User Can Search field in the user record to Active and Testing resources. Inactive resources are not displayed either to staff or to end users in the MetaLib user interface (/V). 42

43 Chapter 5: The Information Resources Database Record (IRD) Link to Configuration Active? (Y/N) This flag determines whether the link between the IRD record and the configuration code is active. The default is Y. Changing this flag to N deactivates the link and makes the resource available in the user interface but only as a MetaLib link only resource. Suppress SFX Button? (Y/N) This flag determines whether or not the SFX button will appear in MetaLib s user interface in records from this resource. The default is N. Changing the flag to Y will make the SFX buttons disappear from the user interface in records from this resource. This choice may be made for resources that do not return good metadata for constructing an OpenURL. Resource Icons You can display icons next to resource names on the search screen to highlight a special characteristic of the resource. The name of the icon to display should be entered in this field. Multiple icons are entered with commas for example: fulltext,cdrom. The graphic image (gif) should be placed in the icon_lng directory of each user interface instance. For example:./ins01/icon_eng/v-icon-fulltext.gif Note that the name of the icon must be v-icon-<name>.gif. In the Resource Icons field, enter only the <name> part of the file name. For example, for the icon name in the example above, enter: Resource Icons fulltext Description A description of the resource in general terms. This description is displayed in the User Interface when the INFO button ( ) is clicked. Maximum length: 1900 characters Filter for Subset You can define a search term that will be added to each query sent by MetaLib to a Z39 target. This can be used to create a virtual resource. For example, an IRD may be created for a journal within a database. In this case, the IRD is linked to the same configuration as the database, but includes a filter that limits the users searches to a specific ISSN. An example in the CKB is the IRD for InfoWorld ABI INFORM (SP) (CKB02076). The filter can be created using any of the MetaLib codes: WRD (All fields) WAU (Authors) WTI (Titles) WSU (Subjects) 43

44 Chapter 5: The Information Resources Database Record (IRD) WYR (Year) ISSN (ISSN) ISBN (ISBN) For example, if the user subscribes to Ecology Abstracts in a larger Abstracts database, and wants to limit the search to the Ecology Abstracts section of the database, enter: WRD= ecology abstracts NOTE: This will work only if the target database indexes ecology abstracts in the All Words index. Boolean operators may be used, as in WSU=(history AND medieval) This would limit all searches using this IRD to records containing the words medieval and history. Expiry Date for NEW Resource You can define a resource as new until a certain date. When a user logs into the system and there are such new resources, a special section of the Identify Database selection will appear in MetaSearch. Once the expiry date defined in this field has passed, the resource will no longer appear as a new resource. Enter the date in the YYYYMMDD format. Filter for NEW Resource You can push different new resources to different user groups by defining which user groups see the resource as new. Setting this value does not limit access to the resource, but it does determine who sees it in the New list. The HTML include file used for this function is:./dat01/www_m_lng/irduser-group-include. Link to Holdings in Native Interface This parameter defines the URL that enables the user to link directly from the record retrieved by MetaLib to the items (holdings) of the record in the target database. This URL is used when the Holding method in the configuration record is JUMP. To be able to create this URL, the correct linkto syntax for the target database must be available. MetaLib enters the ID of the record in the target database in the $0100 placeholder. The ID of the source record is stored in the MetaLib SID field. The Direct Link TAG/ SYSNO and Direct Link Field Tag parameters (explained in EXTERNAL and EXTERNAL_JUMP Configurations on page 64) control the creation of the SID field. Maximum length: 500 characters 44

45 Chapter 5: The Information Resources Database Record (IRD) Rank This field contains a number from 1 5. It is used as part of the MetaRank algorithm to give weight to all results from this resource. A score of 5 means the highest rank factor. If two records have an equivalent rank, but one comes from a resource with a 1 rank factor and the other comes from a resource with a 2 rank factor, the record from the resource bearing the 2 rank factor will be listed above the record from the resource bearing the 1 rank factor. CJK Display Name Language This field indicates whether the display name of the resource is one of the CJK languages: Chinese, Japanese, or Korean. This is required due to some special functionality for CJK languages, especially sorting of the resource by display name. The following values are valid for this field: Chinese Korean Japanese Not CJK The default for this field is based on the character set entered in the Display Name field in the Subscription tab. If Chinese characters (which are used in all three CJK languages) are entered, the language is determined from the CJK Language Parameter (CJK_LANG), which is defined in metalib_start, as follows: C, T Chinese K Korean J Japanese N Not CJK CJK Transliterated Display Name This field allows you to enter a transliterated name for the CJK display name, which is used for grouping and sorting. This field is required if the CJK Language is Chinese and the CJK_LANG parameter in metalib_start is C or Japanese. If the CJK Display Name Language is Chinese and the CJK_LANG parameter in metalib_start is T (that is, in Taiwan) or the CJK Display Name Language is Korean, no transliteration is required. The name will be normalized for grouping and sorting purposes automatically by the system on the basis of key stroke for Chinese in Taiwan and Hangul for Korean). If the display name field includes CJK characters, the system creates a transliterated title automatically as follows. This transliteration can be modified by the operator. 45

46 Chapter 5: The Information Resources Database Record (IRD) Chinese Pinyin based on a transliteration table. If the CJK Language parameter in metalib_start is C (that is, in China), the Pinyin will be preceded by the Chinese ideogram. Japanese since automatic translation is not possible, the system enters the text ***Missing transliteration. The Yomigana should be manually entered. Presentation: Secondary Tab The data in this tab (see Figure 6) may be displayed in the INFO screen (after clicking the INFO button ) in the User Interface. Note that only the Publisher and Creator fields are populated in the CKB. These fields are not updated by the CKB updates. Figure 6: The Secondary Presentation Tab Alternative Name Enter alternative titles or additional names by which the resource is known. 46

47 Chapter 5: The Information Resources Database Record (IRD) This field is searchable in the User Interface using the Find Database title search. Maximum length: 200 characters. Coverage Use this field to describe the extent or scope of the resource. Coverage typically includes geographic scope (Egypt) or temporal period (19 th Century). Maximum length: 500 characters. Time span Use this field to describe the time period of the contents indexed/covered in the resource, e.g., Maximum length: 100 characters Languages The main languages of the content of the resource. Link to Database Guide Use this field to enter a URL (which begins with for an online guide to the resource. Maximum length: 200 characters Full Text Note This field allows the user to see notes about full text available from the resource. Maximum length: 100 characters. Publisher The organization or person that is responsible for making the resource available in its present form. The Publisher field usually indicates the database vendor. Maximum length: 200 characters Alternative Publisher Names Additional publisher names. Maximum length: 200 characters Publisher Description A general description of the publisher Maximum length: 1000 characters Publisher URL URL of the home page of the publisher. Maximum length: 200 characters Creator The creator is the entity responsible for creating the intellectual content of 47

48 Chapter 5: The Information Resources Database Record (IRD) the resource. For example, for EBSCO s version of MEDLINE, the creator is the National Library of Medicine and the publisher is EBSCO. Maximum length: 200 characters Copyright Any copyright limitations. Maximum length: 100 characters Keywords Use keywords to describe the resource s content. Ex Libris recommends choosing a controlled vocabulary for entries in this field. Separate keywords with a space. Maximum length: 100 characters per line Presentation: Library Tab This tab (see Figure 7) is used for a resource that is a library OPAC. The fields are displayed in the MetaLib user interface (/V) in the Info window (after clicking the INFO button ). The fields populated in the CKB are Library System and Library Country. Figure 7: The Library Presentation Tab 48

49 Chapter 5: The Information Resources Database Record (IRD) Library System The integrated library system (and vendor) For example, ALEPH (Ex Libris) Maximum length: 200 characters Library Address Street address Maximum length: 200 characters Library City Maximum length: 30 characters Library State/Province Maximum length: 30 characters Library Postal Code Maximum length: 30 characters Library Country Maximum length: 30 characters Library Telephone (3 fields) Maximum length: 30 characters Library Fax (2 fields) Maximum length: 30 characters Library E mail Maximum length: 100 characters Transportation Maximum length: 1000 characters Access for Disabled Maximum length: 250 characters Access Policy Enter any limitations or prerequisites for use. Maximum length: 200 characters Charging (Loaning) Policy Enter any payment mechanism necessary for using the library collection. Maximum length: 200 characters Opening Hours URL Enter link to a page listing the hours during which the library is open. Start the URL with Maximum length: 200 characters Contact Maximum length: 200 characters 49

50 Chapter 5: The Information Resources Database Record (IRD) Note The notes appear in the INFO screen (after clicking the INFO button ). Maximum length: 200 characters Local Tab This tab (see Figure 8) contains the fields that can be defined locally. For example, Local Field 1 may be used to hold information about how to give feedback to the librarian responsible for that resource and Local Field 2 may be used to hold information about restrictions on the resource s use. Figure 8: The Local Tab These fields can also be used in order to store textual data in languages other than English regarding the resource, if the customer wishes to have a multilingual IRD. The field name (presented in the User Interface) of the local fields is determined in the instance level. The five local fields are available in the Local tab in the IRD on the Management Interface. In addition, you can display these fields to end users under the info button in the user interface. In the appropriate ins<nn> library (ins01, ins02, and so forth), in the tab directory, edit the tab_info.<lng> file to contain one line for each of the local fields that should be displayed in the INFO button: Local Field 1 is LCL1# a Local Field 2 is LCL2# a Local Field 3 is LCL3# a Local Field 4 is LCL4# a Local Field 5 is LCL5# a 50

51 Chapter 5: The Information Resources Database Record (IRD) Therefore, if Local Field 1 is used to hold information about how to provide feedback about the resource, the tab_info.<lng> file might contain this line: Feedback LCL1# a where Feedback is the field name that is presented in the User Interface and LCL1# a represents Local Field #1, subfield a. Categories Tab The Categories tab (see Figure 9) includes information regarding the categories and subcategories with which the IRD is associated. This tab contains the following sections: Figure 9: The Categories Tab Update Resources Categories allows you to associate a resource with categories and subcategories. This section includes a drop down list, which contains all of the categories that exist in the IRD s institution. Once a main category is selected from this drop down list, a list of its subcategories appears with a check box next to each subcategory. You can associate subcategories by selecting the corresponding check boxes. If you would like more information on a subcategory, click the subcategory link to display the subcategory in the Category Administration module. View Resource Categories allows you to view the full list of categories and subcategories that are associated with this resource. From this section, administrators can either display or hide the associated subcategories by clicking the Show All or Hide All links, respectively. 51

52 Chapter 5: The Information Resources Database Record (IRD) NOTES: Resources can also be assigned to subcategories within categories by using the Category Administration page. Users can also view the categories/subcategories to which a resource is assigned by clicking the INFO button ( ) in the User Interface (/V). Assigning Categories to a Resource To assign a category/subcategory to a resource: 1 Click the Categories tab from the IRD record page (see Figure 9) to display the fields in the Categories tab. 2 Select a category from the Category drop down list to display the valid subcategories (see Figure 10). Figure 10: The Update Resource Categories Section 3 Select only the subcategories that you would like to assign to the resource. 4 Click Save to assign the subcategories to the resource. The assigned categories/subcategories display in the View Resource Categories section of the page (see Figure 11). Figure 11: The View Resource Categories Section 52

53 Chapter 5: The Information Resources Database Record (IRD) Running the ALL Subcategories Process The Apply Changes to UI button starts the ALL Subcategories process, which automatically creates a new index for all subcategories under each category. You should start the All Subcategories process after you perform the following activities: Add and/or remove resources. Add and/or remove categories and subcategories. For more information on the ALL Subcategories process, see the MetaLib QuickSet and Category Administration Guide. Information Resource Description Indexes The IRD indexes are created automatically when records are saved. Specifically the following indexes are created: Table 2. IRD Indexes Index Index Code Fields from IRD Record Sent to Index Resource Name WCL Resource Names (full, display, alternative) Publisher Names Languages WLN Languages Resource Type WTY Resource Type Filter by Status WST Status Keywords WKY Keywords Configuration Code TGT Configuration Code Resource ID IDN Resource ID Library System WLS Library System Publisher WPB Publisher Filter by Institution WIN Institution Filter by User Group AF2 Secondary Affiliation Country WCT Library Country NEW Resources Date WND New Resources Expiry Date 53

54 Chapter 5: The Information Resources Database Record (IRD) Table 2. IRD Indexes Index Index Code Fields from IRD Record Sent to Index Grouping Index WGR Special index created for the A to Z list is based on the normalized display name. Any Words WRD Resource Names (full, display, alternative) Publisher Names Keywords Languages Resource Type Description Configuration Code Library Country Library State Library City Library System 54

55 6 MetaLib Resource Configuration This section includes: Introduction on page 55 Definition of Concepts Used in MetaLib Configurations on page 56 Creating a New Configuration on page 57 Types of Configurations on page 58 General Configuration Tab on page 75 Term Transformations Tab on page 82 Conversion Tab on page 88 OpenURL Tab on page 104 Sort Tab on page 113 Introduction The configuration record is accessed from the Resource List by clicking the Edit button <E>. If the /M user does not have authority to make changes to the configuration record, the /M user sees only the View button <V>. NOTE: Changes made in the resource configuration record may not be immediately visible in the user interface. It is recommended that you restart the MetaLib Search servers after applying a change to a MetaLib configuration. 55

56 Chapter 6: MetaLib Resource Configuration Definition of Concepts Used in MetaLib Configurations In general, MetaLib configurations define the following set of actions performed by the MetaLib application: Search MetaLib sends a search to a target resource and retrieves a number of hits. Retrieve MetaLib retrieves records. Conversion MetaLib converts the records to the MetaLib display format. The character set that MetaLib uses is UTF 8. The physical record format used is MARC exchange format. The record schema used is based on MARC 21, but includes additional tags/fields specific to the MetaLib display. OpenURL MetaLib extracts metadata from records to produce an OpenURL, used for linking by SFX. Record Manipulation and Set Manipulation It is important to note that the MetaLib application includes record manipulations for display, linking, and export. The MetaLib application also performs manipulations on sets of records retrieved from resources, including de duplication and relevance ranking. These manipulations are not controlled by the configuration. Access Methods The access method assigned to a configuration indicates the type of configuration. MetaLib currently contains the following access methods: Z39 Uses the Z39.50 protocol for search and retrieval of records. Z39/SUTRS A type of Z39 configuration that retrieves SUTRS data. The SUTRS configuration tabs differ from other types of Z39 resources. EXTERNAL This access method indicates that an external program has been written to search and retrieve records from a resource. External programs may use the HTTP protocol or other APIs. Many use XML gateways, sending XML searches and retrieving XML results using the HTTP protocol. EXTERNAL_JUMP This access method is used with external programs. In this case, MetaLib sends the search and retrieves only the number of hits. Records are not retrieved from the resource. That is, resources using EXTERNAL_JUMP configurations are the Search & Link resources in MetaLib. ALEPH_X This access method communicates with the Aleph X Server, an XML gateway that was introduced in Aleph Version

57 Chapter 6: MetaLib Resource Configuration EXTERNAL_JUMP (SIMPLE) This access method may be used to configure Search & Link resources. See WEBCONFIG_SIMPLE Configurations on page 59 for more information. (Previously known as WEBCONFIG_SIMPLE.) EXTERNAL_JUMP (COMPLETE) This access method is used in CKB configurations only. Resources using this configuration type are Search & Link only. (Previously known as WEBCONFIG_COMPLETE.) EXTERNAL_XML This access method is used in CKB configurations only. Resources using this configuration are Search & View. (Previously known as WEBCONFIG_XML.) Creating a New Configuration To add a new configuration or link the IRD to an existing configuration, click the Add button <A> in the Config Action column. The Create a New Configuration page allows you to perform the following options: Copy from an existing configuration Use an existing configuration as a template. Enter the configuration code for the configuration to copy and enter a configuration code for the new configuration. A copy of the configuration will be created for editing. It is important to choose a configuration to copy that uses the same access method as the new configuration. For example, if the goal is to create a Z39 configuration, choose a Z39 configuration to copy. The CKB includes template configurations for many publishers. These may be used as the configurations to copy. For example: TEMPLATE (OCLC). The new configuration code must start with L_. Standard practice is to follow L_ with a code for the publisher, another underscore, and a code for the database. For example, L_OVID_ETOH may be used for Alcohol and Alcohol Problems Science from Ovid. NOTE: Copy from an existing configuration should be used to make local changes to CKB configurations. To do this, first click the Delete button <D> to delete the CKB configuration from the local IRD. Then click the Add button <A> to add a new configuration to the local IRD, using the CKB configuration as the one to be copied. The local IRD will still be associated with the CKB IRD, enabling the Resource Configuration Notes, Search Hints for the User (CKB), and Resource Release Notes fields to be updated. To inform Ex Libris of such changes so they can be incorporated into the CKB, open a support incident via the CRM. Add a new configuration Use this option to create a configuration with a blank template. Enter the configuration code of the new configuration. This 57

58 Chapter 6: MetaLib Resource Configuration code must start with L_. Choose an access method from the drop down list to open the correct template. Link to an existing configuration Enter an existing configuration code and click Submit. You can click Browse to view a list of existing IRDs and their associated configuration codes. NOTE: When linking a locally created IRD resource to a CKB configuration (and the IRD already exists as a CKB IRD), it is recommended to use the Global Update process to ensure that the CKB IRD is added to the local IRD. This will allow the local IRD to retrieve (and update) the CKB updates to the following data fields: 1) Resource Configuration Notes 2) Search Hints for the User (CKB) and 3) Resource Release Notes. Types of Configurations Z39.50 Configurations The z39.50 protocol enables search and retrieval of data between Z39.50 clients and servers. The Z39.50 yaz_client tool, which is installed on MetaLib s server, should be used for troubleshooting. This is especially helpful when troubleshooting connection problems because it excludes the MetaLib application as the source of the problem. For more information, see Yaz Client on page 195. NOTE: The yaz_client tool uses Bib 1 z39.50 attributes, not MetaLib z39.50 attributes. Z39 Gate After updating or adding a new Z39 configuration, restart the Z39 gate to activate the change. This can be done from the Configuration header by clicking the Restart Z39 button in the configuration or the Restart Z39 link in the main menu of the Management Interface (/M). Specifically, changes to the following fields require a restart of the Z39 gate in order to take effect: General tab Z39 Record Type, Elementsname, Deactivate Setnames?, Retrieve only one record at a time? Term Transformations tab Z39 Attributes column Sort tab These field names appear in red in the Management interface. 58

59 Chapter 6: MetaLib Resource Configuration NOTE: To switch from a Z39 configuration to a Z39/SUTRS configuration, click the Delete action <D> to detach the Z39 configuration from the IRD, and click the Add action <A> to add a Z39/SUTRS configuration. WEBCONFIG_SIMPLE Configurations This access method may be used to configure Search & Link resources. The reason that this type of configuration is called simple is because all searches are done using the All Fields search type, rather than searching a variety of fields, and only one search box can be used. Resources that use any of the following to get to the retrieved records cannot be configured using WEBCONFIG_SIMPLE: Cookies Session IDs Authentication other than IP authentication or basic HTTP authentication (the type of authentication whereby a user types a username/password in a pop up box, rather than directly on a Web page) When a resource is configured with WEBCONFIG_SIMPLE, MetaLib creates an HTTP request in the form of a URL, containing the user s search term that is sent to the resource. The configuration also contains instructions that allow it to interpret the response from the resource. This is accomplished using the following steps: 1 Define the base URL of the resource. 2 Define the required parameters for the search. 3 Define how MetaLib should find the number of hits in the response from the resource. The following example uses Firstgov to illustrate how WEBCONFIG_SIMPLE works. The native interface of Firstgov is available at If a search is done in Firstgov s native interface using the search term capitol, the browser s address bar will change to reflect the search. It becomes this: %2Dsearch%2Dselect&v:project=firstgov&language=All%2Blanguage s&filetype=all&sitelimit=&siteexclude=&fedstates=all&inputform=advanced%2dfirstgov&query-quote=capitol This is the HTTP request (without URL encoding) that is sent to Firstgov to perform the search. 59

60 Chapter 6: MetaLib Resource Configuration NOTE: HTTP requests are sent with either the GET or the POST methods. If, after doing a search, the HTTP request (as in the above example) can be viewed in the browser address bar, the resource is using the GET method. If it cannot be seen, it is using the POST method. To determine what the HTTP request parameters are in POST resources, try using the Firefox browser with the Web Developer toolbar. Use forms to convert POSTs to GETs before sending a search. The HTTP request can be broken down into its constituent parts, BaseURL and request parameters: BaseURL Everything up to the question mark. This includes the server address ( and the module that is called to do the search (search). In the Firstgov example, the BaseURL is: Request parameters Everything after the question mark. These are linked together with ampersands. Each request parameter is stated in the format parameter=value. Request parameters may or may not be required. In the Firstgov example, the following request parameter pairs were used: v:sources=firstgov-search-select v:project=firstgov language=all+languages filetype=all sitelimit= siteexclude= fedstates=all input-form=advanced-firstgov query-quote=capitol Ampersands (&) in HTTP Requests The ampersands that link the request parameters together should not be interpreted to mean the AND operation. The way the & symbol is interpreted by the target search engine is determined by the target search engine. URL Encoding The value of each request parameter can include encoded characters. There are a number of ways in which characters can be encoded, such as the URL 60

61 Chapter 6: MetaLib Resource Configuration specification (RFC 1738). Spaces are frequently encoded as plus signs or can be encoded using hex coding (such as %20). In the Firstgov example, the URL encoded value of the language parameter would be All%2Blanguages. When URL encoded characters are entered in MetaLib s IRD/configuration, they must be decoded, so this parameter will be: All+languages Creating a WEBCONFIG_SIMPLE Configuration To create a WEBCONFIG_SIMPLE configuration: 1 Construct a WEBConfig_Simple HTTP request using the following: Hostname:Port The Hostname:port field in the IRD is the first part of the HTTP request. It can consist of just the BaseURL, or it can include request parameters. URL Mask The URL mask in the Configuration s Term Transformation tab is the remainder of the HTTP request. The URL mask must contain the request parameter that contains the search term. In the case of Firstgov, the values are: Hostname:Port: &filetype=all&sitelimit=&siteexclude=&fedstates=all&inp ut-form=advanced-firstgov& NOTE: Put as many request parameters into the Hostname:Port IRD field as possible. This allows the configuration to be used by multiple IRDs using the same search syntax. URL Mask: query-quote=term1 where TERM1 is a variable representing the user s search term. When MetaLib sends the HTTP request, the TERM1 variable is replaced by the user s search term. 2 Test that the HTTP request is constructed correctly by clicking the Search button. Enter a search term and click the Search button. The HTTP request, including the search term, will be presented. Click the second Submit button to send the HTTP request. A new browser window opens to send the request. The resulting Web page should be the same as one would see after doing a search directly on the target Web site. 3 To retrieve the number of hits, set up the following: 61

62 Chapter 6: MetaLib Resource Configuration HTML Hit Pattern One or more regular expressions to parse the number of hits from the HTML that the resource returns. Multiple regular expressions may be entered, separated by an underscore. They are read from left to right and the first match is used. In the case of Firstgov, the hit message for a search for lunar eclipse photography looks like this: Figure 12: HTML Hit Pattern In the page s HTML source, this message looks like this: <span class="intronum">101</span> results for <span class="introquery">lunar eclipse photography</span> out of at least <span class="intronum">838</span> To present the number 101 in the User Interface, we will use the following hit pattern: intronum..(\d+)..span where the (\d+) string is a regular expression that means present all digits. NOTE: All special characters (<, >, /, ) were replaced with full stops, which are used as wildcards. If the resource does not provide a number of hits, but indicates that hits were found, enter a regular expression that will find a letter, rather than a number (such as HT(.)L). This regular expression will find the letter M. MetaLib will translate any non numeric strings found by the regular expression to Hits were found. Zero Hit Pattern A piece of HTML returned when no hits are found. If this piece of HTML is found on the page returned from the resource, MetaLib will interpret this to mean that zero hits were found. Multiple regular expressions may be entered, separated by an underscore. They are read from left to right and the first match is used. In the case of Firstgov, the following message is presented when no results are found: Figure 13: Zero Hit Pattern 62

63 Chapter 6: MetaLib Resource Configuration This will look like the following in the page s HTML source: Sorry, no results found for "aehrthrjetyketkruk". Therefore, the following Zero Hit Pattern is used: no results found Truncation Enter the truncation symbol used by the resource. MetaLib will translate its own truncation symbol the question mark to the symbol used by the resource. Search & Link Resources The initial request is made either from the MetaLib server, with the resource seeing the MetaLib server address, or via the defined institutional proxy. When the user clicks the View button <V> to see the results, the same request is sent again this time from the user s browser which may require the user to go through a proxy server as well, depending on how it is implemented in individual institutions. ALEPH_X Configurations The ALEPH_X access method is used for configuring Aleph databases. This method is used by the majority of Aleph sites. The requirements within Aleph to allow MetaLib to search using Aleph s X Server include: For all Aleph versions: The Aleph OPAC s server is open to the MetaLib server s IP number. For Aleph Version 14 and 15 sites: The Aleph license must include an X server line. For Aleph Version 16 sites and later: A separate X server license (within Aleph) is required. A WWW X user must be available with appropriate privileges allowed in the bibliographic and password libraries. MetaLib Support highly recommends using the Aleph template configuration available in the CKB as a basis for any local ALEPH_X configuration. The ALEPH_X_VH access method is relevant to a limited number of sites that have a special setup of Aleph s Virtual Host. The ALEPH_X_VH access method will send the host address as part of the HTTP request, using the same address defined in the Hostname:port field in the MetaLib IRD. The setup of an ALEPH_X_VH configuration is the same as an ALEPH_X configuration. 63

64 Chapter 6: MetaLib Resource Configuration EXTERNAL and EXTERNAL_JUMP Configurations EXTERNAL and EXTERNAL_JUMP configurations interact with programs on the MetaLib server. EXTERNAL_JUMP configurations are used for Search & Link resources, whereas EXTERNAL configurations retrieve the records. MetaLib will convert the user s search, using the parameters available in the configuration. These are a subset of the parameters used in Z39 configurations. EXTERNAL configurations will include record parsing parameters, which are a subset of those used in Z39 configurations (see Z39.50 Configurations on page 58). The EXTERNAL and EXTERNAL_JUMP Term Transformation tabʹs contents are saved in a configuration file under./dat01/external_conf/ <configuration code>.conf. The programs and the configuration file are stored on the server, and may be written in any language (such as Perl, C++, and so forth). However, Ex Librisauthored external programs are written only in Perl, and it is recommended that customer s external programs also be written in Perl, according to the Ex Libris guidelines, in order to maintain a uniform standard of external programs within the KnowledgeBase. Writing external programs in Perl will also make these resources eligible for inclusion in the CKB. The communication between MetaLib and the resource may be one of the following types (as well as others): The program may be based on an API to the resource. The program may use HTTP queries and retrieve and parse HTML. In this case, the program is interacting with the resource s Web server. Parsing HTML is sometimes called screen scraping. The program may interact with a resource s XML gateway. XML gateways sometimes accept HTTP requests as queries and sometimes require the queries to be sent marked up in XML, often over HTTP. XML gateways return results over HTTP (usually) in XML. The XML may be sent using the SOAP protocol. For each target database, a separate program must be written for every MetaLib function. Currently, the following functions are supported: FIND a program for sending a search query to the target database. This is the only program required by EXTERNAL_JUMP. PRESENT a program for fetching records for display in MetaLib. PRESENT_SINGLE a program for fetching a single record. HTMLparsing programs use this function. The PRESENT program parses the HTML once for MetaLib s Brief Record Display, and the PRESENT_SINGLE program parses the HTML a second time for MetaLib s Full Record Display. 64

65 Chapter 6: MetaLib Resource Configuration The PRESENT_SINGLE program is also called when the end user clicks the SFX button in the Brief Record Display. The FIND Function The FIND function may use the following term transformation configuration file:./dat01/external_conf/<configuration code>.conf. If you choose to write a stand alone Perl program for the Find function, the program should be named with an extension _find. Ex Libris Support recommends that you use the configuration code as the program name for example, as pubmed_find. The FIND function will receive the following input parameter from MetaLib: FIND REQUEST This is the query entered by the user in the MetaLib user interface after it has been filtered by the various transformations defined for the resource in the configuration. A find request can have the following elements: Index to search. Unless these codes were changed in the configuration of the resource, these will be: WRD All Fields WAU Author WTI Title WSU Subject ISSN ISBN WYR Year Search Terms. The terms will be enclosed in brackets. Boolean operators: AND/OR/NOT. For example: FIND-REQUEST=WTI = ( cow ) AND WTI = ( mad ) The FIND function should return the following: SET RESULT (mandatory) This is the total number of records located by the target. For example: SET-RESULT=

66 Chapter 6: MetaLib Resource Configuration SET NUMBER This is the number of the set created by the target. Not all targets have a SET NUMBER. When a SET NUMBER is available, it can serve as the link between the FIND and PRESENT programs. For example: SET-NUMBER=34 FIND REQUEST (mandatory unless SET NUMBER is available) This is the format of the FIND REQUEST as sent by the external program to the target. This parameter is needed to serve as the link between the FIND and PRESENT programs. Each target requires a different format for the query. For example: FIND-REQUEST=searchtype=keyword&searchtype2=keyword& searcharg=cow&searcharg2=&operator=and&startnum=21&conf= ERROR Any relevant error messages. For example: ERROR=string The PRESENT Function The program should be named with an extension _present. We recommend using the configuration code as the program name. For example: pubmed_present The PRESENT function retrieves the records from the target and sends them to MetaLib. This function receives the following input parameters from MetaLib: SET NUMBER The number of the set returned by the FIND program. Not all targets have a SET NUMBER. For example: SET-NUMBER=34 FIND REQUEST The FIND REQUEST as returned by the FIND program. If a SET NUMBER is unavailable, this parameter serves as the link to the records located by the FIND program at the target. For example: FIND-REQUEST=searchtype=keyword&searchtype2=keyword& searcharg=cow&searcharg2=&operator=and&startnum=21&conf= SET ENTRY This is the number of the record in the set from which MetaLib requests records for display. The initial request will be for record 66

67 Chapter 6: MetaLib Resource Configuration number 1. Note that there is no connection between the SET-NUMBER and SET-ENTRY parameters. For example: SET-ENTRY=1 MAX RECORD This is the maximum number of records MetaLib wishes to receive. This is always 10. For example: MAX-RECORD=10 The PRESENT function should return the following: ERROR Relevant error messages. For example: ERROR=string RECORD FORMAT This parameter defines the format in which the records are sent. The format must be PLAIN. Records in PLAIN format must be sent in the format code blank text with a carriage return after each field. The code can be up to 5 characters. Text must be prefixed by $$a. Each record must start with RECORD and end with END- RECORD. For example: code $$atext The length of a field is limited to 2000 characters (including spaces and special characters). In the MetaLib resource configuration, use the following: In the General tab: Record Type = [blank] In the Conversion tab: Conversion Program = vir_fix_doc_standard, or leave it blank, which defaults to vir_fix_doc_standard. The Conversion tab may be used to convert the field tags to MetaLib s display format. END OF DATA An END-OF-DATA message must be added to the end of the output. 67

68 Chapter 6: MetaLib Resource Configuration Sample of PLAIN format: RECORD AU $$abruhn L AU $$afriedman N TI $$atissue Classification with Gene Expression Profiles. LA $$aeng PT $$ajournal ARTICLE DA $$a DP $$a2000 Nov IS $$a TA $$aj Comput Biol PG $$a IP $$a3 VI $$a7 JC $$acgw AB $$aconstantly improving gene expression profiling technologies are expected to provide understanding and insight into cancerrelated cellular processes. Gene expression data is also expected to significantly aid in the development of efficient cancer diagnosis and classification platforms. In this work we examine three sets of gene expression data measured across sets of tumor(s) and normal clinical samples: The first set consists of 2,000 genes, measured in 62 epithelial colon samples (Alonet al., 1999). We demonstrate success rate of at least 90% in tumor versus normal classification, using sets of selected genes, with, as well as without, cellularcontamination-related members. These results are insensitive to the exact selection mechanism, over a certain range. AD $$aagilent Laboratories, 3500 Deer Creek Road, Palo Alto, CA PMID $$a doi$$a / PST$$appublish SO $$aj Comput Biol 2000 Nov;7(3): END-RECORD 68

69 Chapter 6: MetaLib Resource Configuration RECORD UI $$a0 AU $$anakao M AU $$aogawa O AU $$ayoshida O TI $$aenhanced SENSITIVITY OF BLADDER CANCER CELLS TO TUMOR NECROSIS FACTOR RELATED APOPTOSIS INDUCING LIGAND MEDIATED APOPTOSIS BY CISPLATIN AND CARBOPLATIN. LA $$aeng PT $$ajournal ARTICLE DA $$a DP $$a2001 Jan IS $$a TA $$aj Urol PG $$a IP $$a1 VI $$a165 JC $$akc7 AD $$adepartment of Urology, Kyoto Prefectural University of Medicine and Department of Urology, Faculty of Medicine, Kyoto University, Kyoto, Japan, and Department of Microbiology and Immunology, University of California-Los Angeles School of Medicine, University of California at Los Angeles, Los Angeles, California. PMID $$a pst$$appublish SO $$aj Urol 2001 Jan;165(1): END-RECORD END-OF-DATA Having the FIND Program Perform the First PRESENT You can fetch records during the initial FIND request, reducing the need to perform a separate PRESENT request, whenever the target resource supports this. This ability boosts search performance. To fetch records in the FIND request: 1 Send an HTTP request for the actual search query. This should be already done in the current program, in order to parse the number of hits found. 2 Return the default output of the FIND program back to MetaLib. This should be already done. 3 Parse the records from the database s response (remote target). This is a new function that should be added to the current program. It already appears in the PRESENT program, and needs to be carefully copied and pasted into the FIND program. 4 Display the parsed records within MetaLib in MetaLib s standard format. This is a new function that should be added to the current program. Again, it is already part of the PRESENT program, and needs to be copied and pasted carefully into the FIND program. 69

70 Chapter 6: MetaLib Resource Configuration NOTE: Note that the PRESENT program is still needed for further records to be retrieved from the remote target. The FIND program should limit the parsing of records to the number of records fetched in the response from the remote target. This means that if the response includes 20 records, the FIND program can parse them all, but the FIND program should not invoke an additional HTTP search request for more records (technically, there is no limit for the number of records fetched). In MetaLib version 4.x, most external programs were fixed to support OOP (Object Oriented Programming) so that one central Perl module accommodates both the FIND and PRESENT functionalities. The _find and _present programs are now much smaller, and basically only call the main Perl module that is associated with the configuration (For more information regarding OOP, see General Configuration Tab on page 75). The following example desscribes the main function of the FIND program: # execute URL query for searching the native target ($response) = &executefindrequest($url_query); #Parse the # of hits from the native s response $result = &parsefindresult($response); #display the # of hits found and url_query back to MetaLib &displayfindresults($result,$url_query); # Parse the actual records from the native s = &presentparseresults($response); # Display the parsed records back to ML &presentdisplayresults(@docx_arr); } # end main 70

71 Chapter 6: MetaLib Resource Configuration SET-RESULT=1055 FIND-REQUEST=highwire.stanford.edu/cgi/ searchresults?pubdate_year=&volume=&firstpage=&author1=&author2= &title=leadership&andorexacttitle=phrase&fulltext=&andorexactfull text=phrase&src=hw&flag=&resultformat=3&hits=10&hitsbrief=10& sortspec=relevance&sortspecbrief=relevance&sendit=search& resourcetype=1record-format="plain" RECORD 245 $$aclinical leadership in hospital care: The right kind of clinical leadership $$awalmsley DATE $$a $$tbmj VOL $$a331 PAGES $$a $$uhttp://bmj.bmjjournals.com/cgi/content/extract/331/7509/162 END-RECORD RECORD. END-OF-DATA Figure 14: Find Program Example The PRESENT_SINGLE (optional) Function The PRESENT_SINGLE program is used to retrieve a single record. This is useful in programs that parse HTML, when the HTML of the resource displays records in two stages: a brief and then a full display. The PRESENT program is activated for MetaLib s Brief Results list. The PRESENT_SINGLE is activated when the user clicks the More button <M> to display the complete record or when the user clicks the SFX button from the Brief Results list. In order to activate the program, the initial PRESENT program must output a field with the tag MORE to the records retrieved from the target. The content of the tag should be: $$a<metalib target code> $$b<link to the record> (for example, system number). Subfield b serves as the input to the program. Example: MORE $$a AGRICOLA_CAT$$b

72 Chapter 6: MetaLib Resource Configuration The input parameters for the PRESENT_SINGLE function include: FIND REQUEST The only input to program_present_single is subfield b from the MORE field (exactly as it is with no prefix or suffix). The present_single program should be able to create the link from this input. For example, an agricola_present program might produce: MORE $$a AGRICOLA_CAT $$b FIND-REQUEST=bib= The input for agricola_present_single is: FIND-REQUEST=bib= " The output parameters for the PRESENT_SINGLE and PRESENT functions are the same. For more information, see The PRESENT Function on page 66. How PRESENT and PRESENT_SINGLE Functions Are Merged When a PRESENT_SINGLE program is used, the PRESENT program creates a record and then the PRESENT_SINGLE program creates a matching record with extra data. The MetaLib application overrides the PRESENT record with the PRESENT_SINGLE record by comparing each field. If a PRESENT_SINGLE program is going to be used, then the PRESENT program should output only one occurrence of each field used in the Table/Brief displays. For example: If the PRESENT program outputs the following: 100 $$a Aaa 100 $$a Bbb And the PRESENT_SINGLE program outputs this: 100 $$a Aaa 100 $$a Bbb 100 $$a Ccc Then, the full record, after the PRESENT_SINGLE program is called, will contain two 100 $$a Bbb entries as follows: 100 $$a Aaa [A match is found on this first occurrence of the 100 $$a field.] 100 $$a Bbb [From the PRESENT program.] 100 $$a Bbb [From the PRESENT_SINGLE program because the application does not look for a match to the second 100 $$a field from the PRESENT program.] 100 $$a Ccc [From the PRESENT_SINGLE program.] 72

73 Chapter 6: MetaLib Resource Configuration Troubleshooting External Programs If the program uses HTTP to communicate with the resource, check that the MetaLib server has an HTTP connection to the resource s server. This can be done using Perl. For example, to check that a connection can be made from the MetaLib server to Google, enter the following command at the command prompt: perl -MLWP::Simple -e "getprint The response should be the HTML (or XML if the database returns XML) from the resource. NOTE: The same command syntax can be used to test that the HTML response includes the number of hits in the expected format. To send the search without using the /M configuration: 1 On the server, enter the following commands to turn the ʺdebugʺ mode on, so details in MetaLibʹs logs can be viewed: setenv VIR_EXT_DEBUG Y start_w 2 Edit/create a text file (l_xxx_find_command) that includes the input parameters for the FIND program. dlib dat01 cd vir_ext cat l_xxx_find_command./l_xxx_find This activates the program, using the input parameters in the l_xxx_find_command file. The response is shown on the screen. URL in IRD Description MetaLib allows you to add URLs within specific descriptive IRD fields and to define a URL as part of a descriptive IRD field. To accomplish this, the following codes can be used in the IRD: before the link to recognize the subsequent URL entry. before the description to be displayed. after the URL to mark the end of the linked string. 73

74 Chapter 6: MetaLib Resource Configuration Tab This enhancement applies only to the following IRD tabs and fields: IRD Presentation: Primary IRD Presentation: Secondary IRD Presentation: Library Table 3. Adding URLs to Descriptive Fields Fields Description IRD Local Local fields 1 5 Alternative Name, Coverage, Time Span, Full text note, Notes, Publisher, Alternative publisher names, Publisher description, Creator, and Copyright Library address, city, state/province, Postal code, country, Telephone, fax, Transportation, Access for disabled, Access policy, Charging (Loaning) policy, Contact, and Note This feature can be implemented in the following ways: Display the URL within the text This option allows you to display the URL in the description. For example, if the following text is entered in the IRD: PubMed was developed by the National Library of Medicine (NLM) (@@Uhttp:// It was developed The following is displayed in the MetaLib user interface (/V): PubMed was developed by the National Library of Medicine (NLM) ( It was developed... Display linkable descriptive text This option allows you to display text that links to the specified URL. For example, if you want to make the publisher s name a link to the publisherʹs URL, enter the following text in the IRD: ʺ@@U States National Library of Medicine (NLM)@@Eʺ The following is displayed in the MetaLib user interface (/V): ʺUnited States National Library of Medicine (NLM)ʺ For example, if you want to display a URL within the description field, enter the following text in the IRD: ʺPubMed was developed by States National Library of Medicine (NLM)@@E. It was developed in ʺ 74

75 Chapter 6: MetaLib Resource Configuration The following is displayed in the MetaLib user interface (/V): ʺPubMed was developed by the United States National Library of Medicine (NLM). It was developed in ʺ General Configuration Tab The fields that display in the General Configuration tab are dependent on the access method chosen on the Create Configuration page: Version This field is used for CKB updates. It is only used in CKB configurations. Find Module Using Blocks This drop down list and the Present Module Using Blocks drop down list, which are part of the EXTERNAL and EXTERNAL_JUMP access method s configurationʹs General tab, are meant to support Object Oriented Programming (OOP). Currently, the following options are available: blank entry This option means that this configuration will handle external programs as it did in MetaLib version Enter the names of the relevant Find Module, Present Module, and Package Name program names (whichever is applicable) in the relevant fields, leaving the two drop down lists Find Module Using Blocks and Present Module Using Blocks empty. Clone This option enables the user to write a single Perl module to handle both the find and present (if applicable) search phases. To activate this type of configuration, use the following settings: Enter the name of the main Perl module in the Find Module and Present Module fields. Select Clone in both the Find Module Using Blocks and Present Module Using Blocks drop down lists. Note that EXTERNAL_JUMP configurations only require the Find Module Using Blocks dropdown list. For example, if the Perl module s name is hc_u_cabdirect.pm, the following values should be entered for an EXTERNAL OOP configuration s General tab: Find Module Using Blocks: Clone Find Module: hc_u_cabdirect Present Module Using Blocks: Clone 75

76 Chapter 6: MetaLib Resource Configuration Present Module: hc_u_cabdirect Saving this configuration will automatically create the find and present modules for this Perl program. The following options are currently unavailable and will be implemented in future MetaLib versions: Search N Link SearchRetrieve XML SearchRetrieve SOAP/WSDL SearchRetrieve Web (SRW) Find Module This field contains the program name of the _find program. This field is relevant to EXTERNAL and EXTERNAL_JUMP configurations. Present Module Using Blocks See the Find Module Using Blocks field on page 75 for more information. Present Module This field contains the program name of the _present program. This field is relevant to EXTERNAL and EXTERNAL_JUMP configurations. Note: The _present_single program is identified by this field as well. Authentication Module This field contains a separate program name of an authentication program if the authentication is not handled in the _find program. Currently, there are no authentication programs in the CKB, but some may be added in the future. Packaging Name This field is used in the CKB only. It is used to transfer a program that is used by the resource as part of the CKB update process. Outgoing Character Conversion Select an Outgoing Character Conversion from the following list. The user s searches will be converted from UTF 8 to the character set indicated by the conversion, and supported by the resource. UTF_TO_8859_1 UTF_TO_8859_2 UTF_TO_8859_5 UTF_TO_8859_7 UTF_TO_8859_8 UTF_TO_8859_15 UTF_TO_MAB UTF_TO_MARC8 UTF_TO_WIN

77 Chapter 6: MetaLib Resource Configuration UTF_TO_GBK UTF_TO_KSC UTF_TO_JPN_EUC (Japanese EUC) UTF_TO_LABT (for Lithuanian Aleph libraries) WORD FIX (converts special characters to standard Latin characters) WORD FIX CAPS (converts special characters to standard Latin characters, and converts upper case to lower case) Record Type This field defines the record format that MetaLib retrieved from the resource. The Record Type field may be one of the following: USMARC UKMARC UNIMARC DANMARC NORMARC MAB SUTRS [Note: MetaLib treats XML data as SUTRS. Enter SUTRS in this field for XML.] Format conversion program This parameter defines the program used for converting the incoming records to standard MetaLib format. The default program is vir_z00_z39_usmarc for ISO 2709 format. The following programs are available for standard formats: vir_z00_z39_mab for MAB format vir_z00_z39_usmarc for ISO 2709 (MARC) formats There are additional programs for non standard formats (SUTRS): vir_z00_z39_sutrs_a For use with SilverPlatter databases. This program works when the format of the incoming record is the tag+colon+space and the text. Continuation text must start on the next line, as follows: TAG: TEXT. TEXT.. TAG: TEXT TEXT 77

78 Chapter 6: MetaLib Resource Configuration vir_z00_z39_sutrs_b For use with CSA databases. This program works when the format of the incoming record is the tag+colon with the text starting on the following line, as follows: TAG: TEXT... TEXT... TAG: TEXT... TEXT... vir_z00_z39_sutrs_c This program works when the format of the incoming record is tag+colon with the text starting on the same line. Continuation lines are as follows: TAG: TEXT.. TAG: TEXT... TEXT... TEXT :... TEXT vir_z00_z39_sutrs_d and vir_z00_z39_sutrs_e For use with Ovid databases. These programs work when the format of the incoming record is tag + colon with the text starting on the following line, as follows. There are slight differences in the two programs and we recommend trying both with Ovid databases. TAG: TEXT.. TEXT... TEXT... TAG: TEXT :... TEXT 78

79 Chapter 6: MetaLib Resource Configuration vir_z00_z39_sutrs_copac This program works when the format of the incoming record is tag+colon with the text starting on the same line, as follows: TAG: TEXT... TAG TEXT... TEXT.. TEXT.. vir_z00_z39_sutrs_xml This program works to parse XML data. vir_z00_z39_zetoc This program works to parse data retrieved from the ZETOC resource. vir_z00_z39_sutrs_sabina This program converts the SUTRS format returned by Sabina catalogs. TAG: TEXT.. TEXT... TAG: TEXT... NOTE: The Split Character column in the SUTRS table is not supported with vir_z00_z39_sutrs_sabina. The previous programs convert the physical format of incoming records to MetaLib format. Fields within SUTRS records must be converted to MARC 21 tags, which is done in the Conversion tab of the configuration. See Conversion Tab on page 88 for more information. Incoming character conversion MetaLib converts all records to Unicode (UTF8). This field defines the character conversion routine to convert the character set used by the target to UTF, so that diacritics and foreign alphabets are displayed correctly. The available character conversion routines are: MARC8_TO_UTF MAB_TO_UTF 8859_1_TO_UTF 8859_2_TO_UTF 8859_5_TO_UTF 8859_7_TO_UTF 8859_8_TO_UTF 79

80 Chapter 6: MetaLib Resource Configuration 8859_15_TO_UTF WIN1250_TO_UTF GBK_TO_UTF KSC_TO_UTF (Korean 5601) JPN_EUC_TO_UTF (Japanese EUC) LABT_TO_UTF for Lithuanian Aleph 500 libraries Jump to native interface (from results list) This field indicates that links to the full record should go to the record in the native interface instead of being presented in the MetaLib interface. Holding method This field is used when you can construct a link to the library s holdings. If either of the two valid methods is entered in the Holding Method field, a field called Holdings will appear in the full display of the record in the MetaLib user interface. The value of the Holding Method field can be OPAC or JUMP. OPAC is used for a Z39 resource whose Z39 server supports the OPAC syntax for the retrieval of holdings information. If the method is OPAC, the system will send an OPAC format request and display the results in a window. JUMP can be used if there is a link to syntax that will link directly to the holdings page in the resource. In that case, the link to syntax should be entered in the Link to Holdings in Native Interface field of the IRD record. If the method is JUMP, the system invokes the link to syntax, and links to the Holdings display page at the resource. Direct Link Type This parameter and the Direct Link Field Tag field define which data element from the original record is used to create the SID field. The SID field may be used for creating a direct link from the record displayed in MetaLib to the record in the target database (see the IRD Link to Records in Native Interface field, explained in IRD Record Fields on page 30. There are three possible values for the Direct Link parameter: TAG-F indicates that a fixed field from the source record is used (examples provided below) TAG-V indicates that a regular (variable) field from the source record is used (examples provided below). TAG can be used in place of TAG V. SYSNO indicates that the system number is used. The SYSNO parameter can only be used for resources using the ALEPH protocol. Direct Link Field Tag This field defines which field from the source record is used. This parameter is relevant only if Direct Link Type is set to the following values: 80

81 Chapter 6: MetaLib Resource Configuration TAG-F For fixed fields, enter the tag and starting position and the number of characters to take. For example: 001 the whole text of field ,4,8 8 characters from the text of field 005 starting at position 4 001,3 all the text of field 001 starting at position 3 TAG-V For variable fields, enter the tag and the subfields to take. For example: 035,a the whole text of subfield a of field 035 Subfield a is the default. If only 035 is entered, the system still takes subfield a. The length of the tag entered in Direct Link Field Tag is up to 5 characters (the tag plus indicators). The SID field is created before the conversion to MetaLib format. This means that the tag that was entered in Direct Link Field Tag must be present in the original record. The SID field has the following subfields: a access method b resource code c ID of the record in the target database (the content of the field defined in Direct Link Field Tag or the Aleph system number). The content of subfield c is inserted in place of $0100 in the link to syntax defined in the Link to Records in Native Interface field in the IRD record. Z39 Record Type (Requires Z39_Gate Restart) The format of the records requested from the z39 server. The following record types are available: USMARC UNIMARC MAB DANMARC UKMARC NORMARC SUTRS XML SUTRS and XML are available only if the configuration is a Z39/SUTRS configuration. Elementsname (Requires Z39_Gate Restart) The type of record requested from the Z39 server. The following are standard types: 81

82 Chapter 6: MetaLib Resource Configuration F = Full record T = Full text B = Brief record Targets may also define their own element set names. If the Elementsname field is blank, the resource default will be used. Deactivate Setnames? (Requires Z39_Gate Restart) If the target Z39.50 server does not support setnames, change this field to Yes. The default is No. NOTE: This can be checked with the yaz_client. When using the yaz_client, an error message, result set naming not supported, will indicate that Yes needs to be selected. Retrieve Only One Record at a Time? (Requires Z39_Gate Restart) MetaLib s Z39.50 gate requests records from targets in groups of 10. When a target has problems returning one of the records, you may receive an error message, Error: target not returning record, and not just for the problematic record. In this case, change this parameter to Yes, so that MetaLib s Z39.50 gate will request one record at a time. Term Transformations Tab This tab contains the following sections: Search Transformations on page 82 Lateral Term Transformations on page 86 Search Transformations Term transformations are used to manipulate the user s search query. For example, the user s search may be limited to a certain number of words. Each term transformation is a program that manipulates text, based on parameters defined in the transformation itself. Numbers represent term transformations. A term transformation may have parameters, entered between two capital Ps. For example, the term transformation 2P P means that term transformation number 2 should be used, and that the hyphen is the parameter. The Search Transformation section consists of the following columns: Search Type Transformations Target Code or Z39 Attributes 82

83 Chapter 6: MetaLib Resource Configuration Each line in this section defines the parameters for searching when the user selects a search type. Search Type The Search Type column lists the search types supported in MetaLib s search syntax: Title Author Subject Year All Fields ISSN ISBN Transformations The Transformations column is used for search transformations. Multiple term transformations should be separated by underscores. NOTE: To use an underscore as a parameter, it must be preceded by a backslash to distinguish it from an underscore used as a separator between transformations. The most frequently used term transformations in Z39 searches are as follows: # Transformation Table 4. Frequently Used Z39 Search Transformations 9 Changes an author s name to the format Last, F or Last, FM where F is the first initial of the first name and M is the first initial of the middle name. If the term contains only one word, it is left unchanged. If the term contains two words and the second word is no longer than two characters, the term is left unchanged. 10 Adds truncation or a period to a term. The following parameters are valid: R add right truncation L add left truncation S add a period 21 Limits a term by a number of characters. Only complete words are left. If the last remaining word is a Boolean operator, it will be removed. 83

84 Chapter 6: MetaLib Resource Configuration # Transformation Table 4. Frequently Used Z39 Search Transformations 27 Deletes a character and compresses the remaining text at the beginning of the search string only, at the end of the search string only, or any place in the search string. 27P a3p is frequently used to remove hyphens from a user s ISBN search. 28 Adds quotation marks around the search term. 29 Uses a regular expression to transform the search term. See Term Transformation Programs on page 205 for the complete list of transformations and usage instructions. Target Code In ALEPH_X configurations, the Target Code column contains the Aleph index to which the search should be directed. The following codes are defaulted per search type: WTI Title WAU Author WSU Subject WYR Year WRD All Fields ISSN ISSN ISBN ISBN 84

85 Chapter 6: MetaLib Resource Configuration Z39.50 Attributes (Requires Z39_Gate Restart) This column defines the attributes that are used for Z39.50 searches: Figure 15: Z39.50 Attributes The following attributes may be assigned: u The Use attribute specifies the field to be searched. t The Truncation attribute. s The Structure attribute is usually used to determine a phrase or word search. c The Completeness attribute, indicated by c (complete field or sub field) p The Position attribute (anywhere in field or first in field). r The Relation attribute is usually not entered in the list. Equal is the default. NOTE: If no attribute is defined, the default set by the target system is used. For further information on BIB attributes, refer to the Library of Congress Z39.50 management site: Special Values for Truncation: If the standard Z39 attributes for truncation are used, the user s query will always be truncated. Therefore, we suggest using the special values we have developed for indicating truncation in the Z39 configuration file. If you use these values, the query will be truncated only when the user enters the standard symbol for truncation, which in MetaLib is?. This represents the addition of zero or more characters to the word being searched. Entering TITLE = export? should returns all records that have the word export in the title, as well as exports, exported, exportation, and so forth. 85

86 Chapter 6: MetaLib Resource Configuration The following special values for the truncation attributes can be defined: l left says that? is permitted from the left side of the term; r right says that? is permitted from the right side of the term; b both says that? is permitted from both sides of the term; NOTE: The MetaLib standard search syntax (see MetaLib Standard Search Syntax on page 201) supports truncation on the right side of the term. One or several types of truncation are permitted. For example: t=l only left truncation is permitted t=r,b right or left truncation is permitted t=l,r,b left, right, and both truncation is permitted How is the z39.50 Truncation Attribute sent with the query to the z39.50 server being queried? If the term does not contain a question mark, the z39.50 Truncation Attribute is undefined in the request. If the term has a question mark on the right side for example TITLE=export? and right truncation is permitted, then the Truncation Attribute gets a value of 1. If the term has a question mark on the left side for example TITLE=?port and left truncation is permitted, then the Truncation Attribute gets a value of 2. Using the z39.50 Truncation Attribute and value 5=1, in place of t=l,r,b, will create automatic right truncation of the search term, without the question mark being used. NOTE: If the resource accepts only an asterisk to indicate truncation, apply Term Transformation 26 in the form 26P?a*aP, which means: replace the question mark with an asterisk wherever it appears in the search string. Special Value for Structure: You can set the Structure attribute automatically to 1 (phrase) or 2 (word), depending on the query. To do this, set attribute s to pw (s=pw). If the term is a single word (for example, WTI=(snow)), the Structure attribute will get the value 2 (word); if the term contains several words (for example, WTI=(blue snow)), the Structure attribute in the request gets the value 1 (phrase). Lateral Term Transformations Lateral term transformations transform an author, title, or subject search launched from the full record display in the MetaSearch module of the user 86

87 Chapter 6: MetaLib Resource Configuration interface. When a user clicks a lateral link from the full record, the term is transformed and sent to the search screen. The intention is to transform the search into MetaLib s standard search syntax so it can be used as a search term in this or other resources. For lateral term transformations, the following columns are defined: In Field Tag and Subfield on page 87 Out Field Tag on page 87 Transformations on page 87 In-Field Tag and Subfield These codes represent the type of search the user selects on MetaLib s Search screen. For example: 1#### - Lateral links from the 1#### MARC tag (Author) 7#### - Lateral links from the 7#### MARC tag (Additional Author) 24### - Lateral links from the 24### MARC tag (Title) 6#### - Lateral links from the 6#### MARC tag (Subject) Out-Field Tag When the user clicks the title of a record, the search type in MetaLib s Search screen changes to Title. Transformations The transformations consist of a sequence of small changes to be performed sequentially on the term so that it matches MetaLib s standard search syntax (See MetaLib Standard Search Syntax on page 201). The transformation takes place after the user clicks the text and before the term appears in the search box on MetaLib s Search screen. Each transformation has a number. Transformations are separated by an underscore. A transformation may have parameters entered between two capital Ps. For example, 2P P removes the dash from the term. The most frequently used lateral transformations are as follows: # Transformation Table 5. Frequently Used Lateral Transformations 1 Deletes subfield indicators from the string being sent. 2 Replaces the characters listed as the parameters with spaces. 7 Removes part of the term starting from the characters defined by the parameter. If the term starts with a character in the parameter, the term is left unchanged. 8 Shortens a term by limiting the number of words. 87

88 Chapter 6: MetaLib Resource Configuration # Transformation Table 5. Frequently Used Lateral Transformations 29 Uses a regular expression to change the term. Most commonly applied to Author lateral searches. See Term Transformation Programs on page 205 for the complete list of transformations and usage instructions. Conversion Tab MetaLib converts all record formats to one standard format (based on MARC 21) for consistent display. Fields defined in MetaLib s standard record format will be displayed. In addition, local fields may be defined for MetaLib s Full Record display using the relevant./ins<nn>/tab/edit_doc_999.<lng> table or the IRD s Local tab. The following chart shows the MARC tags and subfields that are displayed in MetaLib s standard format. These fields should be mapped to the appropriate MARC tag so that text within them will be displayed in the MetaLib search results. In addition to the MARC 21 tags used for citations, the following fields are required by MetaLib: SID This field is created automatically by the system. It includes the name of the resource, the access method and the ID number of the record in the target. YR Year. This field should be created by the conversion. Table 6. MARC Conversion Table MARC/Input Tag MetaLib Standard Format Subfields (control subfields are stripped) SID## Resource b 245## Title a,b,c,h 1#### Author a,c,d,e 700## Add.Author/Editor a,c,d,e 71### Corp.Author a,c,d,e 773## Citation a,t,b,d,g YR### YEAR a 520## Abstract a 88

89 Chapter 6: MetaLib Resource Configuration Table 6. MARC Conversion Table MARC/Input Tag MetaLib Standard Format Subfields (control subfields are stripped) 6#### Subject all ASU Additional Subjects (intended for subjects that cannot be used for lateral searches from the full display) all 020## ISBN a,c 022## ISSN a,c 362## Publication Dates a 500## Note a 779## Reviewed Item all 024## IDNumber a,c 050## LC No. all 080## UDC No. all 082## Dewey No. all 088## Report No. a 013## Patent all 240## UniformTitle a,b,c,h 246## VaryingTitle a,b,c,h 250## Edition all 260## Imprint a,b,c 270## Address all 300## Description all 440## Series a,n,p,v,x 490## Series a,n,p,v,x 501## BoundWith a 502## Dissertn. a 504## Bibliogr. a 505## Contents a 510## Indexed in a 89

90 Chapter 6: MetaLib Resource Configuration Table 6. MARC Conversion Table MARC/Input Tag MetaLib Standard Format Subfields (control subfields are stripped) 513## Type a 540## Copyright a 545## Biograph. Note a 546## Language Note a 580## Link Note a 730## Add.Title all 740## Add.Title all 765## Original Language all 780## Continues all 785## Continued by all 811## Meeting all STAT Statute all COURT Court Cases all 852## Holdings all 856## External u,y The link should be entered in subfield u and display text or thumbnail entered in subfield y 900## Text a 540 Copyright all SC Scripture Citation all RW Related Work a ERIC ERIC Document # all THUMB Thumbnail a Conversion Program The default conversion program is called vir_fix_doc_standard, indicating that the fields listed in the Conversion tab will be used. (If no Conversion Program is defined, vir_fix_doc_standard is used.) In some cases, a special program has been written. 90

91 Chapter 6: MetaLib Resource Configuration Additional Available Programs This section describes each of the additional programs. vir_fix_doc_table In the Conversion tab, you can define up to 40 fields for conversion. If more are needed, enter vir_fix_doc_table in the conversion program field. In this case, the conversion table must be created on the server in the./dat01/ tab_conversion directory. The name of the table must be tab_conv_<config code in lowercase>. For example, if the MetaLib configuration code is MADISON, the name of the conversion table should be: tab_conv_madison. The table has the same columns as the Conversion tab in the Management interface. The table is limited to 150 lines. NOTE: If the vir_fix_doc_table is used, the lines in the Conversion tab will not be read. tab_conv_unimarc A generic Unimarc MARC 21, called tab_conv_unimarc, has been added to the tab_conversion directory. You may copy this table for a specific Unimarc resource and make any necessary changes. Conversion Parameters The Conversion to MetaLib Display Format section (see Figure 16) contains the following columns, which may be defined for the conversion of original data: In Tag The field tag in the original record. Tags are limited to 5 characters. Hashes/Number signs (#) can be used as wildcards. In Subfield The subfields in the original data. Up to 10 subfields can be defined and should be listed without delimiters. Program This parameter can be used if incoming text needs to be processed. Parameters This column includes the output tag and subfield and, if a program is selected, it includes the parameters for that program. Commas are used as delimiters between field tags and subfield tags. Action This column defines what should be done with the field as a whole. 91

92 Chapter 6: MetaLib Resource Configuration Condition This column is used to limit the conversion of a field if another field is already present. Figure 16: Conversion Tab The conversion works on the original record. The system first counts the number of fields in the original record because the conversion program will work only on this number of fields. It then takes each field based on the order of the original record (not the order of the conversion table) and performs all actions defined for the field in the conversion table. A field that is not defined in the table will remain unchanged. A field that has been defined with the action DELETE will be deleted. If the action ADDNEW is defined, the system will add the field that results from the conversion at the end of the record as new lines, and the original field will continue to be used. The MERGE action always includes an ADDNEW action. The MERGE action occurs at the end of the conversion. For example: Original Record Line 1 Field A Line 2 Field B Line 3 Field C Line 4 Field D Line 5 Field E Conversion Table Field B convert to Field Z Field C convert to Field Y ADDNEW Field D convert to Field NADDNEW Field D convert to Field M Field E DELETE 92

93 Chapter 6: MetaLib Resource Configuration The converted record will look like this: Line 1Field A Line 2Field Z Line 3Field C Line 4 Field M Line 5 DELETED Line 6 Field Y Line 7 Field N Explanation: Line 1 remains unchanged in the converted record because the conversion table does not specify any change. Line 2 has changed from Field B to Field Z based on the conversion table. Field B no longer exists because the conversion table did not specify that Field Z should be added as a new field (ADDNEW) and it replaced Field B. Line 3 has remained Field C because the conversion table specifies that Field C should be converted to Field Y as a new line. Since the conversion table has no further specifications for Field C, it remains unchanged in Line 3. Line 4 has changed to Field M. Field D was first converted to Field N as a new line because of the ADDNEW action. It was then converted to Field M without the ADDNEW action and so replaced the original Line 4. Line 5 was deleted due to the DELETE action. Lines 6 and 7 are new lines added during the conversion. NOTE: New fields created during the conversion cannot be used as the basis for new definitions in the conversion. For example, if a 260 field, subfield a, is created from a field in the original record, the 260 subfield a field cannot then be used to create the YR field. The following definition will not work: In tag In sub Program Param YEAR 260,a 260 a YR,a 93

94 Chapter 6: MetaLib Resource Configuration The following definition will work: In tag In sub Program Param YEAR 260,a ADDNEW YEAR YR,a Programs and Parameters The following is a list of programs that may be used to convert data in a field, along with the parameters that each program uses. Count from Start (formerly vir_fix_doc_first) The parameters for this program are the initial position and the length of string. For example: In tag In sub Program Parameters 008 Count from Start YR,a,8,4 This means that 4 characters starting from the eigth position from tag 008 should be used to create the YR field, subfield a: > s dcu------b eng-- NOTE: In the Count from Start program, the counting begins from one. Count from End (formerly vir_fix_doc_last) The parameters for this program are initial position and length of string from the end of the tag/subfield. For example: In tag In sub Program Parameters 510## b Count from End YR,a,3,4 This means that starting from the end of the subfield and counting back three characters, the following four characters from subfield b of tag 510 should be used to create the YR field, subfield a: 3210 < b Jan,

95 Chapter 6: MetaLib Resource Configuration NOTE: In the Count from End program, the counting begins from zero. Parser (vir_fix_doc_parser) This program is used to extract data from within a subfield. For example, if the original record contains the following field: 773 x ISSN ; paper Using the program to create an ISSN field (022) might look like this: In tag In sub Program Parameters 773## x Parser 022,a,Px\SISSN \G; This means that the data to be converted to field 022, subfield a, is found in subfield x, following the word ISSN and ending at the semicolon. The converted record will contain the following field: 022 a The Parser program has three required parameters: P Program parameter. If the data to be extracted is in a specific subfield, it should be defined here. \S Indicates the start of parsing \G Indicates the end of parsing. Use \G* to indicate all text to the end of the line. \G without an asterisk indicates that text should be taken to the first space or hyphen. Note that spaces do not have to be defined. Metacharacters may be used to indicate one of a set of characters: \A Used to indicate any non numeric character. For example, \S\A indicates that the parsing should start at the first alphabetic character. \N Used to indicate any numeric character. For example, \G\N indicates that parsing should stop at the first numeric character. For example, to extract the Year of Publication from an original record with the following field: 500 a Year of Publication: 1989 Use the following syntax: In tag In sub Program Param 500 a vir_fix_doc_parser YR,a,Pa\SPublication:\G 95

96 Chapter 6: MetaLib Resource Configuration This means that the YR field, subfield a, is created from text in subfield a of the 500 tag, starting from Publication and until the first space or hyphen. For example, if the field in the original record has additional text after the year with no spaces: 500 a Year of Publication: 1989newyork then the field could be parsed as follows: In tag In sub Program Param 500 a vir_fix_doc_parser YR,a,Pa\SYear ofpublication:\g\a This means that the field is parsed from the Year of Publication until the first alphabetic character. Note that if there were a space between the year and the text, it would be sufficient to use \G. NOTE: The \S\ expression may be used in the parameters to indicate that parsing begins at the start of the string. Remove Asterisk (vir_fix_doc_aster) This program removes asterisks from the text in the field. The parameters are the original record field, subfield, and a P to indicate a program. Example: In tag In sub Program Param 650 a Remove Asterisk 650,a,P Subfield Order (vir_fix_doc_sforder) This program rearranges the subfields from the original record field and outputs them to a new field in the converted record. The parameters for this program are the new tag and subfield that should be created and the subfields from the original record, listed in the order they should be output in the converted record. For example: In tag In sub Program Parameters 097## Subfield Order TST,a,ba This means that subfields a and b from field 097 will be converted to the field TST subfield a. The order of the converted subfields will be first subfield b and then subfield a. Note that the In Subfield column will be blank. 96

97 Chapter 6: MetaLib Resource Configuration ISSN or ISBN (vir_fix_doc_020or022) If the content of the original record field is an ISBN, the system will output the data to a 020 field in the converted record. If the content is an ISSN, the system will create a 022 field. No parameters are required. For example: In tag In sub Program Parameters 773## x ISSN or ISBN RegExp (vir_fix_doc_reg_exp) This program uses regular expressions to extract or substitute data. The parameters are the field and subfield for the converted record, P, and the regular expression. For example: Original record: 773 x ISSN Translation: In tag In sub Program Parameters 773## x RegExp 022,a,P/ISSN\s(\d{4}-[\dxX]{4})/ This trnslation extracts the data from the original record and output it to the converted record: 022 a It is important to remember to escape special characters that are designated in the regular expression mechanism, such as /?. and so on. Use a backslash if you wish to enter them as plain characters. For example, should be entered as NOTE: The vir_fix_doc_reg_exp program cannot be used in conjunction with the vir_fix_doc_table program. IS Zetoc (vir_fix_doc_is_zetoc) This program is used only in the ZETOC configuration. Translate Using Table (vir_fix_doc_table_translate) This program will use a table on the server in the./dat01/tab_conversion/ directory to translate the contents of a subfield. The program may be used with the conversion program vir_fix_doc_standard. The name of the table should 97

98 Chapter 6: MetaLib Resource Configuration be entered in the configurationʹs Conversion Parameters field. Each configuration may use one table only. The name of the table should include l_ to indicate that it is a local table. Otherwise, it might be overwritten by the CKB update. The table used for translating must have four columns. Columns are separated by a space. The first column contains the incoming field tag and is five characters. The second column contains the incoming subfield and is one character. The third column contains the data in the original record and is 10 characters. The fourth column, which starts at the 20th character and ends at a carriage return, is limited to 120 characters. The fourth column contains the translated data. Column 3 s data is translated to the corresponding data in Column 4. The parameter for the Translate Using Table program is the name of the incoming field to be converted. The incoming field tag (2 5 characters) should be followed by a comma and the incoming subfield tag. In the following example, the conversion program is named vir_fix_doc_standard and the conversion parameter file is tab_conv_l_lang: In tag In sub Program Parameters 903## a Translate using table 513.a,P903,aP The table must be stored on the server in the./dat01/tab_conversion/ directory. It is called tab_conv_l_lang. It looks like this: 903 a eng English 903 a fre French 903 a ger German If the original record contains the following field: 903 a fre The converted record will contain the following field: 513 a French Tables can include translations for more than one field. For example, to convert language codes and type codes in the same table, if the language code is in the incoming 903$a and the type code is in the incoming 904$a, the table might look like this: 903 a eng English 903 a fre French 903 a ger German 904 a art Journal Article 904 a mon Monograph 904 a jrn Journal 98

99 Chapter 6: MetaLib Resource Configuration One table has been provided. It is tab_conv_normarc. (Note that it does not contain the l_ prefix because it was provided by Ex Libris; it is not a local table.) The tab_conv_normarc table is an example of a table that converts data from more than one subfield. This table may be used to convert NORMARC dataʹs holding codes, using the following lines in the conversion: In tag In sub Program Param Action 850## f Translate using table 852,f,P850,fP MERGE 850## h Translate using table 852,h,P850,hP MERGE NOTE: The vir_fix_doc_table_translate program cannot be used in conjunction with the vir_fix_doc_table program. Actions The Action column defines what should be done with the field as a whole. The following actions are supported: blank If no action is defined, the field from the original record is not copied to the converted record. In other words, the original field is converted to the converted field and is not retained. ADDNEW indicates that the field should be added as a new field to the converted record, retaining the original field. There are two advantages to using this action: The original field is retained in the converted record. The original field may be used again in the conversion. DELETE indicates that the field or subfield should be deleted from the converted record. Up to 10 subfields can be deleted in one line. SPLIT splits a field with multiple subfields into separate fields for each subfield. SPLIT_CHAR splits a field or subfield into separate fields, based on a delimiter. The delimiter is entered in the Parameters column. MERGE merges several fields into one field with subfields. See the example below. MERGE, like ADDNEW, retains the original field. NOTE: The system reads the table from top to bottom. This means, for example, that if you want to use a field to create several fields and then delete the original field, the DELETE should be at the end. 99

100 Chapter 6: MetaLib Resource Configuration Example: In tag In sub Program Param Action 331## a 245,a 773# x 022,a ADDNEW 653## DELETE 650## a SPLIT 100## a ; SPLIT_CHAR This example performs the following actions: tag 331 subfield a is converted to 245 subfield a. The original 331 field is deleted. tag 773, subfield x is used to create 022 subfield a. The original 773 field is retained. tag 653 is deleted. tag 650 is split into multiple fields. For example: 650 $$asubject A $$asubject B $$asubject C becomes: 650 $$asubject A 650 $$asubject B 650 $$asubject C tag 100, subfield a, is split into multiple fields using the semicolon as a delimiter. For example: 100 $$achuck, Schulinder ; Richard, Christy ; Scott, Clendenin becomes: 100 $$achuck, Schulinder 100 $$arichard, Christy 100 $$ascott, Clendenin MERGE action example: In tag In sub Program Param Action PL 260,a MERGE PB 260,b MERGE YR 260,c MERGE 100

101 Chapter 6: MetaLib Resource Configuration In this example, the fields PB, PL and YR: PLNew York PBMacmillan YR1999 become one 260 field: $$anew York $$bmacmillan $$c1999 If the MERGE action had not been performed, the following would have been created: $$anew York $$bmacmillan $c1999 If you merge subfields coming from the same field, you will need to delete the original field. For example, if you want to merge 245 $$a and 246 $$a into 245 $$a $$b, you should define the following lines: 245a245,aMERGE 246b245,bMERGE 245 DELETE 246 DELETE That is, you merge 245 a and 246 b into 245 a,b. You need the DELETE at the end to delete the original 245 and 246. Keep in mind that the DELETE Action works on the original record field only. Fields created in the conversion cannot be acted upon. Conditions The Condition column is used to limit the conversion of a field if another field is already present. The format of the column is: NOTEXIST code,subfield For example: NOTEXIST 100##,a If there is no subfield or the field has only one subfield, it is not necessary to indicate the subfield. # is used as a wildcard for indicators. For example, if you want to create a YR field only if the field has not already been created from the 008 tag, then you would do the following: In tag In sub Program Param Action Condition 008 vir_fix_doc_first YR,a,8,4 ADDNEW 260 a YR,a ADDNEW NOTEXIST YR 101

102 Chapter 6: MetaLib Resource Configuration This means that the tag 260 is used to create the YR field only if the field has not already been created from the 008 tag that is, in some records the 008 tag is present, while in others it is missing. NOTE: The order of the fields is important in the NOTEXIST condition. The conversion program reads each field in the order in which it is displayed in the original format and then executes the conversion parameters defined for the field. For example: In tag In sub Program Parameters Condition 773## g YR,a 260## c YR,a NOTEXIST YR In the example above, we want to take the YR field from 773 $$g. However, since 260 normally comes before 773, we will get two YR fields, because when the system executes the line for 260 a YR field will still not have been created for 773. In this case, the following conversion is correct: In tag In sub Program Parameters Condition 260## c YR,a 773## g YR,a NOTEXIST YR SUTRS Conversion Table If the Z39 configuration requests SUTRS or XML data from the Z39 server (Record Type = SUTRS), then a SUTRS conversion table will appear in the Conversion tab. The SUTRS conversion table is used to convert SUTRS records to MetaLib s display format. Each relevant field in the SUTRS records is converted to a MARC tag/subfield to be displayed by MetaLib. NOTE: The SUTRS conversion table is processed by the system before the conversion to MARC. This means that the MARC tag/subfield output from the SUTRS conversion table may be used as input (In Tag/In Subfield) in the Conversion to MARC table. Incoming SUTRS Field Tag The Incoming SUTRS Field Tag column contains the field tags from the SUTRS record. To determine what the field tags are, use the database vendor s documentation and/or use the Yaz client to view SUTRS records. Each field tag may be up to 30 characters. If a database uses tags that are longer than 30 characters, enter the first 30 characters and MetaLib will do the match based on these characters. 102

103 Chapter 6: MetaLib Resource Configuration MARC Tag/Subfield These fields define the output tag and subfield. The output from the SUTRS conversion table is MetaLib s original record. The Original record is then processed by the Conversion to MARC table to create the converted record. Split Character To split the SUTRS field into separate MARC tags, enter a character on which to base the split. For example, if the incoming data contains subjects separated by semicolons, you can output each subject to a separate 600$a tag by entering a semicolon in the Split Character column. NOTE: If the vir_z00_z39_sutrs_d conversion program is defined in the General tab, non viewable characters may be entered using their decimal representations (such as \010 for a carriage return). For example, if the incoming SUTRS record contains the following fields: TITLE: Radiation sensitivity and recoverability of Listeria monocytogenes AUTHOR(S): Niemira,-B-A DESCRIPTORS: FOOD-SAFETY-PLANT-FOODS; IRRADIATION-; LETTUCES- The SUTRS conversion table would look like this: Incoming SUTRS Field Tag MARC Tag Subfield Split Character TITLE 245 a AUTHOR(S) 100 a DESCRIPTORS 650a ; MetaLib s Original record will look like this: a Radiation sensitivity and recoverability of Listeria monocytogenes a Niemira,-B-A a FOOD-SAFETY-PLANT-FOODS a IRRADIATION- 650 a LETTUCES- Additional manipulation of the Original record may be performed in the Conversion to MARC table. 103

104 Chapter 6: MetaLib Resource Configuration OpenURL Tab The OpenURL tab defines the routines used to create the OpenURL, the means by which metadata from records is sent to the SFX server. The goal is to extract the relevant metadata from MetaLib s converted record to be passed to the OpenURL. The MetaLib system automatically supplies the following pieces of information in the OpenURL: The BaseURL is taken from the SFX tab in the Management interface s Institutional Settings module. To indicate that MetaLib should send the OpenURL 1.0 (rather than 0.1), choose 1.0 from the OpenURL drop down list when editing the SFX parameters in that tab. The OpenURL SID is metalib:config_code The OpenURL PID contains the MetaLib system identifier. MetaLib s converted record s SID $$c tag (if present) is sent in the opid field. NOTE: You can display the OpenURL that MetaLib creates by viewing the SFX window s page source. The OpenURL link that has been created by MetaLib will be presented within the sfx.openurl tag. For example, an OpenURL link for the article: A stretching program increases the dynamic passive length and passive resistive properties of the calf muscle tendon unit of unconditioned younger women by Richard Gajdosik, taken from the European Journal of Applied 104

105 Chapter 6: MetaLib Resource Configuration Physiology (ISSN ) Vol. 144 s December 2006 issue, Page R103, DOI number /s would look like this: fmt:xml:xsd:ctx;url_ctx_val=%20%0d%0a%20%0d%0a%20%0d%0a%20%0d%0a <?xml version= 1.0 % encoding= UTF-8?> <ctx:context-objects xmlns:ctx= info:ofi/fmt:xml:xsd:ctx xmlns:xsi= 2001/XMLSchema-instance xsi:schemalocation= info:ofi/ fmt:xml:xsd:ctx fmt:xml:xsd:ctx > <ctx:context-object timestamp= T12:13:00Z version= Z identifier= 123 > <ctx:referent> <ctx:metadata-by-val> <ctx:format>info:ofi/ fmt:xml:xsd </ctx:format> <ctx:metadata> <rft:journal xmlns:rft= info:ofi/fmt:xml:xsd:journal xsi:schemalocation= info:ofi/fmt:xml:xsd:journal > <rft:author rank= 1 > <rft:aulast>gajdosik </rft:aulast> <rft:aufirst>richard </rft:aufirst> <rft:auinit> </rft:auinit> </ rft:author> <rft:atitle>a stretching program increases the dynamic passive length and passive resistive properties of the calf muscletendon unit of unconditioned younger women. </rft:atitle> <rft:stitle>eur J Appl Physiol </rft:stitle> <rft:date>2006 </ rft:date> <rft:volume>144 </rft:volume> <rft:issue>dec </rft:issue> <rft:spage>r103 </rft:spage> <rft:epage> </rft:epage> <rft:genre> </rft:genre> <rft:issn> </rft:issn> <rft:doi> / s </rft:doi> <rft:sici> </rft:sici> <rft:opid> </ rft:opid> </rft:journal> </ctx:metadata> </ctx:metadata-by-val> <ctx:metadata-by-ref> <ctx:format> </ctx:format> <ctx:location> ram9.corp.exlibrisgroup.com:8336/x?op=sfx-get-doc&docnumber= </ctx:location> </ctx:metadata-by-ref> </ctx:referent> <ctx:referrer> <ctx:identifier>info:sid/metalib.com:pubmed </ctx:identifier> </ ctx:referrer> </ctx:context-object> </ctx:context-objects> The program that creates the OpenURL link works according to the order of the commands listed in the OpenURL tab, not according to the order of the fields in 105

106 Chapter 6: MetaLib Resource Configuration the converted record. Reading from top to bottom, the first line in the table that finds an OpenURL element will be the one used for that element. Figure 17: OpenURL Tab If Field/If Field Contains These two columns work together to create an if condition statement to match to the contents of a specified field/subfield. This statement must be in the following format: If Field <YYYYY>,<s> If Field Contains <condition> where <YYYYY> is the field (the # character may be used as a wildcard), such as 022##,a), <s> is the subbfield, and the <condition> is the criteria in which the condition is met. If the condition is met in the converted record, the rest of the line is used. For example: If Field 513##,a If Field Contains Book* In this example, the if condition statement is true only if the 513,a field contains Book. If a record s 513,a tag does contain Book, then the rest of the line is used. Otherwise, the rest of this line is skipped. The following wildcards may be used for the If Field Contains column: a question mark (?) indicates one character an asterisk (*) indicates more than one character 106

107 Chapter 6: MetaLib Resource Configuration For example: If Field 513##,a If Field Contains Journal* In this example, the condition would be met if the field contains Journals, Journal articles, and so on. OpenURL Element This column contains the OpenURL element that is being defined. Choose from a drop down list of possible elements. NOTE: The same element may be listed in multiple lines in the OpenURL tab. The first line that finds a match will be used and subsequent lines will be ignored. Tag This column defines the field in the converted record from which the OpenURL element should be extracted. The format is YYYYY (# may be used as a wildcard). If no program is used, the subfield is defined in the Parameter column. For example: If Field If Field Contains OpenURL element Tag Program Parameter ISSN 022## a Program/Parameter The programs may be used to extract data from data in a field. If a program is selected, then the parameters are entered in the Parameter column, along with the subfields. Parser (vir_950_parser) This program extracts data from a field. The parameters define the start and end points, based on text in the field. The Parser program requires the following parameters: P Program parameter. If the data to be extracted is in a specific subfield, it should be defined here. \S Indicates the start of parsing 107

108 Chapter 6: MetaLib Resource Configuration \G Indicates the end of parsing. Use \G* to indicate all text to the end of the line. \G without an asterisk indicates that text should be taken to the first space or hyphen. Note that spaces do not have to be defined. Metacharacters may be used to indicate one of a set of characters: \A Used to indicate any non numeric character. For example, \S\A indicates that the parsing should start at the first alphabetic character. \N Used to indicate any numeric character. For example, \G\N indicates that parsing should stop at the first numeric character. For example, to create the START PAGE element from the following field in the converted record: 773t Journal of School Health g v69 n9 p Nov 1999 The line in the table should look like this: If Field If Field Contains OpenURL element Tag Program Parameter START-PAGE 773## Parser Pg\Sp\G The text in 773 subfield g is extracted starting at p and ending at the first space or hyphen. Reg Exp (vir_950_reg_exp) This program enables the use of regular expressions (based on C regular expressions). The parameters are P, the subfield to be used, and the regular expression itself. In order to use the entire field, without specifying a subfield, enter just the regular expression without P and the subfield. In other words, use the P only when specifying a subfield. The following list of metacharacters are supported:. Match any one character [a z] Match any lowercase letter [^a] Match anything but the letter a \w Match any letter (capital or lowercase) [0 9] or \d Match a number [ ] Match a space \s Match a space or a tab? Optional (preceding element may appear one time or not) * Optional (preceding element may appear zero or more times) + At least one (one or more instances of the preceding element) 108

109 Chapter 6: MetaLib Resource Configuration ^ Match the following expression at the start of the line $ Match the preceding expression at the end of the line ^ $ Match a string with exactly 3 characters \b Match a punctuation sign For example, to create the START PAGE element from the following field in the converted record: 773t Journal of School Health g v69 n9 p347-55, Nov 1999 The line in the table should look like this: If Field If Field Contains OpenURL element Tag Program Parameter START-PAGE 773## Reg Exp Pg/p(\d+)/ The expression to match (in the converted record) goes between forwardslashes. The data to be extracted from the matched expression is surrounded by parentheses. If pages are not always numeric and the start page is always followed by a hyphen or a comma, the line in the table may look like this: If Field If Field Contains OpenURL element Tag Program Parameter START-PAGE 773## Reg Exp Pg/p(.+)[-,]/ Square brackets are used to indicate characters allowed in a single position. NOTE: Regular expressions used in MetaLib are greedy, which means that the above regular expression will pick up all data between a p and the last hyphen or comma in the field. To extract the Genre element from the following field in the converted record: 513 a Journal-Article The OpenURL line should look like this: If Field If Field Contains OpenURL element Tag Program Parameter GENRE 513## Reg Exp Pas/.*Article.*/article/ 109

110 Chapter 6: MetaLib Resource Configuration The word article is assigned as the genre, if any subfield a contains the text Article anywhere in it. The expression is case sensitive. If a Genre cannot be defined based on fields in the record itself, it is also possible to define an overall default for the resource. Taking a field that will always appear in all records the SID is a good example and substituting everything in the field with the desired genre would produce a default genre: GENRESIDReg Exp s/.* /article/ In this example, the entire SID field is taken and no subfield has been defined. Counting Parser (vir_950_parser_n) The parameters for this program are the same as for the Parser program with the addition that the occurrence number of a character/punctuation may be used after the \S. For example, to parse text starting after the second colon, to the START PAGE element from the following converted record field: Enter: 773t Journal of School Health: Nov 1999, v69, n9: If Field If Field Contains OpenURL element Tag Program Parameter START-PAGE 773## Parser Pt\S:2\G In this example, the number 2 is located directly after the colon, indicating that the second colon should be used. The text after the second colon and until the first hyphen or space after that will be extracted for the START PAGE OpenURL element. Count from Start (vir_950_first) This program parses a string starting at a specific place and ending a number of places later. The parameters for this program are P and the subfield plus the initial position and the length of the string. For example: Pa,8,4. The program counts from 1, so the example will pick up the eight, ninth, tenth, and eleventh characters. If the field does not contain subfields, enter F in the subfield position. Do not follow it with a comma. For example: PF8,4. 110

111 Chapter 6: MetaLib Resource Configuration For example, to extract the Year element from the following converted record field: 260 a Year is 1999 If Field If Field Cont OpenURL element Tag Program Parameter YEAR 260## Count from Start Pa,8,4 An example using a fixed length field with no subfields: s dcu------b eng-- If Field If Field Cont. OpenURL element Tag Program Parameter YEAR 008 Count from Start PF8,4 Count from End (vir_950_last) This program parses a string of a specific length, starting at a specific place, (counting from the end, or right hand side, of the complete string). The parameters for this program are P and the subfield plus the initial position, counting from the end of the string, and the length of the string. For example: Pa,8,4. The first parameter s count starts from 0, so the example will pick up the ninth character from the right and take four characters. If the field does not contain subfields, enter L in the subfield position. For example: PL,8,4. For example, to extract the Year element from the following converted record field: 260 a Year is 1999 If Field If Field Cont OpenURL element Tag Program Parameter YEAR 260## Count from End Pa,5,4 Author First Last (vir_950_au_firlst) This program parses the author name into first/last, when the author s first name appears before his last name. The program may be used for the AUTHOR FIRST and the AUTHOR LAST OpenURL elements. The parameters are P and the subfields from which the author should be taken. For example (the If Field and If Field Contents columns are not shown in this example): OpenURL element Tag Program Parameter AUTHOR-FIRST 100## Author First LastPa AUTHOR-LAST 100## Author First LastPa 111

112 Chapter 6: MetaLib Resource Configuration This means that both the first and last names of the author will be taken from subfield a of tag100. The Author First Last program is used because the author is displayed with the first name appearing first: a Richard Lowry Author Last,First (vir_950_au_lstfir) This program parses the author name into first/last, when the author s last name appears before his last name. The program may be used for the AUTHOR FIRST and the AUTHOR LAST OpenURL elements. The parameters are P and the subfield/s from which the author should be taken. For example (the If Field and If Field Contents columns are not shown in this example): OpenURL element Tag Program Parameter AUTHOR-FIRST 100## Author Last,FirstPa AUTHOR-LAST 100## Author Last,FirstPa This means that both the first and last names of the author will be taken from subfield a of tag 100. The Author Last,First program is used because the author is displayed with the last name appearing first: a Lowry, Richard Perl (vir_950_perl) This program allows you to use Perl expressions to parse data. The parameters are P, the subfield from the field to be parsed, and the Perl expression. Examples (this example does not include the If Field and If Field Contains columns): OpenURL element Tag Program Parameter VOLUME 773## vir_950_perl Pt.*\((\d*).*$ The following elements are used in the example: Pt.*\((\d*).*$ meaning: from subfield t take all of the digits that come in sequence after the first left bracket. (.*) take all..*date:(.*)writers.*$ take everything after the word date, until the word writers. Pa.*\;(.*)\(.*$ extract the text that starts after the semicolon (;). 112

113 Chapter 6: MetaLib Resource Configuration Sort Tab The Sort tab contains the Z39.50 commands used for requesting sorting from a Z39.50 server that supports sort commands. Enable Sort If the Enable Sort check box is selected, MetaLib s Table view will enable the sorting of result sets from this resource. Year, Author, Title <Restart Z39> Enter the Z39.50 use attributes for sorting by year, author, and title. For example: Enable Sort Year u=31 Authoru=1003 Titleu=4 113

114 Chapter 6: MetaLib Resource Configuration 114

115 7 CKB Update Overview This section includes: Introduction on page 115 Working with Consortia on page 116 Setting Up CKB Update on page 116 CKB Update Steps on page 119 CKB Release Notes on page 121 Introduction The CKB update process is initiated from the MetaLib Administration module. The process will download new and updated resources from the MetaLib CKB and will install them on the local MetaLib server. The local MetaLib server sends an HTTP request to the MetaLib CKB server. This request includes information about the last time that the CKB update process was run and the version of the MetaLib software. The MetaLib CKB server locates new resources (IRDs, configurations, and external programs) and resources that have been updated since the last CKB update request and downloads them to an XML file. The MetaLib CKB server reports back to the local MetaLib server, telling it that the file is ready for pick up. The local server then retrieves the file, using sftp. The local server imports the new and updated records into the METALIB institution and will add new IRDs to the local institutions that have been configured to receive them. The CKB update does not change local IRDs. The Resource Configuration Notes and Search Hints for the User fields that appear under the <?> button are updated in the CKB/METALIB IRDs only. These fields are not stored in the local IRDs. Wwhenever a local IRD s <?> button is accessed, a link is created to the appropriate CKB IRD to pick up these fields. The link is based on the CKB ID, which can be seen in the Source ID field in the local IRD. 115

116 Chapter 7: CKB Update Overview NOTE: To run the CKB update, the MetaLib server must be able to send HTTP requests and SFTP get requests. Working with Consortia Whenever the CKB update is run from a consortia MetaLib server, new IRDs will be added to all institutions that are configured to receive them in the institutional settings module. It is recommended that a schedule/process is defined and communicated to all consortium members for running the CKB updates. Setting Up CKB Update There are four server tables that need to be confirmed or modified on the local MetaLib server. In addition, you must confirm that the Ex Libris CKB server will authorize updates to the local MetaLib server. Root Server Table to Modify /etc/services The program uses a perl module to perform the sftp (secure file transfer). This module relies on ssh being defined in the /etc/services file. The following line should be added to the file: ssh 22/tcp # SSH Remote Login Protocol Note that editing the /etc/services file should be done by a root user. MetaLib Server Tables to Modify tab_ckb_pull The tab_ckb_pull table must include the following information: IP address of CKB server Port of the CKB server User name for sftp ing Password for sftp ing. 116

117 Chapter 7: CKB Update Overview Contact the MetaLib Support representative for your region to obtain this information. To update the table: 1 Enter the following commands on the server to access the table: dlib dat01 dt vi tab_ckb_pull 2 To activate your changes: start_w Institutional Settings The institutional settings module in the Management interface defines which institutions will have new IRDs copied to them during the CKB update process. ckb_update_date The ckb_update_date table contains the date and MetaLib software version that were used the last time the CKB update was done. NOTE: After the first CKB update is run, the values in this table will automatically be changed to reflect the date and version on which the CKB update was run. Do not alter the values in this table manually after the initial CKB update is run. To update the table: 1 Enter the following commands on the server to access the table: dlib dat01 dt vi ckb_update_date 117

118 Chapter 7: CKB Update Overview 2 Modify the table, using the MetaLib version and date of the last CKB update. For sites that were installed on Version 3.13, use the following values for the initial CKB: For sites that were initially installed on Version 4.x, use the following values for the initial CKB: <x> 3 Enter the following command to activate the changes made to the table: start_w Confirm Local MetaLib Server IP Address with Ex Libris CKB Server In addition, the CKB server needs information about the local server s external IP address. To check whether the CKB server does have the required information, contact the local MetaLib Support representative. Testing the sftp Connection Once a MetaLib server is registered with the CKB update server, a test may be run to check that the local MetaLib server can connect, via sftp, to the CKB server. To test the sftp connection: 1 From the local server, enter the following commands to access the server: dlib dat01 dr cd import sftp [username for sftp]@[ip address of CKB Server] NOTE: Contact your local MetaLib Support representative for the IP address of the CKB server and for the user name and password. 2 Enter the following commands to copy the test file from the server: get test quit 118

119 Chapter 7: CKB Update Overview If successful, a file called test should be copied to the local server. NOTE: This test checks that the local server is authorized to perform a sftp get request to the CKB server, but it does not check that the local server is authorized to run a CKB update. CKB Update Steps Run a Backup of the DAT01 (KnowledgeBase Data) Confirm that a backup has been created recently. Enter the following command to run a backup: csh -f $aleph_proc/backup_metalib_no_product Initiating a CKB Update Manually The MetaLib Management interface (/M) allows you to run a CKB update manually. To initiate a CKB update: 1 Select Export Import Procedures from the Initial Main menu. 2 Select CKB Update. 3 If prompted, enter an e mail address in which to send a message indicating that a CKB update has been run. 4 Click Submit to start the update. Defining a Cron Job to Run the CKB Update From the MetaLib Management Interface (/M), you can define a cron job to run the CKB update process on a set schedule. To define a cron job to run the CKB update: 1 Select Export Import Procedures from the Initial Main menu. 2 Select CKB Update Cron Job Interface. 119

120 Chapter 7: CKB Update Overview 3 Use the following table to enter the times at which the CKB update should be run: Table 7. Cron Job Interface Fields Field Minutes Hour Day of Month Month Address Description The minute at which you want the procedure to start. The valid values are The hour at which you want the procedure to start. The valid values are The day of the month during which you want the procedure to start. The valid values are The month at which you want the procedure to start. The valid values are Specify an e mail address to send a message indicating that the CKB update has been run. NOTE: Each of the fields that are used for time may contain a single value or an asterisk (*), which indicates all possible values. For example, if you place an asterisk in the month field, the CKB update will run monthly. 4 Click Save to save the values. To delete the cron job, click Delete. The cron job automatically backs up the KnowledgeBase before running the CKB update. Output from the CKB Update The CKB update process places an XML file to your server. The XML file should contain resources that were added to or updated in the CKB since the last time you ran the CKB update. Occasionally, resource configurations that use a specific feature in the software will be added to the CKB. These configurations will not be downloaded to your server until your MetaLib server has been upgraded to the version/revision that contains that feature. The resources are loaded into the METALIB institution and new IRDs are copied to institutions that are defined to get new IRDs. In addition, the CKB update process will update the CKB release notes Excel file that is stored on the local MetaLib server and update the release notes for each CKB IRD. 120

121 Chapter 7: CKB Update Overview The following files are created on the server:. /dat01/import/ckb_update_log.txt This file contains the HTTP request sent to the CKB server and a summary of the response from the CKB server.. /dat01/import/ckbupdate_[ip address]_[date and time stamp].log If update is successful, this file contains a processing log of loading records into the KB, including the number of resources updated, imported and rejected. If any new external programs were downloaded during the update, these will also be listed.. /dat01/import/ckbupdate_[ip address]_[date and time stamp].tar The file that was initially placed on your server. This.tar file contains the XML update file and the CKB release notes.. /dat01/import/ckbupdate_[ip address]_[date and time stamp].xml The XML file that is used to import the resources into the KB.. /dat01/import/ckbupdate_[ip address]_[date and time stamp].xml.report The file contains a list of resources added to your KB, a list of resources updated in KB, and a list of resources rejected. NOTE: This file does not contain totals. For totals, see the log file../dat01/import/ckb_release_notes.xls The comprehensive release rotes../dat01/scratch/import_update List of resources that were updated. NOTE: The import_update file will be overridden by the next IMPORT, whether this is a subsequent CKB update, or a regular, non CKB IMPORT. CKB Release Notes The CKB update does not apply changes to existing local IRDs or local configurations. Local IRDs that are linked to CKB configurations may require manual changes after a CKB update is run. The CKB Release Notes is a guide to the changes that have been made in the CKB and to manual changes that need to be made locally. The CKB Release Notes also list the newly added resources. The release notes for the CKB are stored on the local MetaLib server as.\dat01\import\ckb_release_notes.xls and can be accessed via the 121

122 Chapter 7: CKB Update Overview MetaLib Management interface s Main Menu. This file is updated with every CKB update. The Management interface s main menu now includes links to two new lists: A list of all new resources added in the last CKB update A list of the CKB resources that are used by the institution and have been updated in the latest CKB update: Figure 18: CKB Update - View Options Updates of individual resources are documented under their IRDʹs INFO button ( ). A specific resource s update history and required manual changes can be viewed next to the resource s Configuration Notes and Search Hints. The CKB Release Notes contain the following information about each new resource added to the CKB and about each resource that has been changed in the CKB: Date moved to CKB: This field defines the date on which the updated/new resource was moved to the CKB and can be used to determine which changes have been made since the last time a CKB update was applied to a local server. Resource Title, Publisher, CKB ID, Configuration Code: Data from the CKB IRD to allow identification of the resource that was changed/added. New or Change: New means the resource was added to the CKB on the date indicated. Change means the resource was updated on the date indicated. MetaLib Access Method, MetaLib Type, Protocol, Record Format: Information describing the resource configuration. Software Version needed for this change/addition to be downloaded: This column contains a version.revision if the IRD/configuration will be downloaded only if your MetaLib system is running a specific software version (or later). For example, if MetaLib version 4.00 contains a software update for configuring a new access method, resource configurations using this access method that require the new development will have the value 4.00 in this column. If your MetaLib system is running MetaLib version 3.13, IRD/configurations needing MetaLib version 4.00 software will not be downloaded. These IRD/configurations will be downloaded in the first CKB update that is run after your system is upgraded to MetaLib version The version.revision is a minimum number, meaning that if your system 122

123 Chapter 7: CKB Update Overview is running a MetaLib version later than 4.00, it will also retrieve IRD/ configurations that require MetaLib version Version, this change/addition was done in the CKB that was installed with the software: The software version.revision in which this resource was first introduced. In general, software releases contain an updated CKB, so a site that is first installed with MetaLib version 4.00 will have all of the changes/new resources that contain 4.00 in this field already. In addition, the CKB Release Notes contain the following information about each resource that has been changed in the CKB: Note: The Note contains information about how the resource was changed. Manual Changes Needed: Changes that need to be made to local IRDs are listed here. NOTE: When using the full CKB release notes spreadsheet and not an individual resource s release notes, it is recommended that the spreadsheet is read in order, by date. Some resources may be listed more than once since the last time a CKB update was run. All manual changes or just the most recent manual change for such a resource may be relevant. 123

124 Chapter 7: CKB Update Overview 124

125 8 Activating Resources This section includes: Using the Activating Resources Page on page 125 Exporting Resources on page 127 Importing Resources on page 129 Using the Activating Resources Page Using the Activating Resources page (see Figure 19), administrators can perform the following functions: Activating Resources During the initial installation of an institution, it is necessary to activate an institution s IRDs. The following export/import procedure provides a quick method for activating all of an institution s IRDs at one time. To access the Activate Resources page, click Activate Resources from the Initial Main menu. Updating Resources After the initial installation of an institution, it may be necessary to update an institution s resources. The following export/ import procedure provides a quick method for updating an institution s IRDs on an ongoing basis. To access the Activate Resources page, click Activate Your Resources from the Ongoing Main menu. NOTE: Users that have administrative permissions can activate resources from either the Management Initial menu or the Management Ongoing menu. 125

126 Chapter 8: Activating Resources Figure 19: Activating Resources Page To activate/update resources, use the following import/export procedure: 1 Use the Activate Resources page to export a set of resources from an institution to an Excel file (.xls). For more information, see Exporting Resources on page Manually modify the contents of the Excel file by adding or changing values in the defined columns. 3 Use the Activate Resources page to load an import file into MetaLib. For more information, see Importing Resources on page

127 Chapter 8: Activating Resources Exporting Resources The Export section (see Figure 20) of the Activating Resources page allows you to copy resources per institution to an Excel file. This allows you to edit all of the resources from a single file. Figure 20: Export Section of the Activating Resources Page The system requires you to export the Resource Name and Resource ID fields, but you can perform the following operations to add or remove fields to export: add selected fields to the Selected Fields for Export column. add all of the fields to the Selected Fields for Export column. remove selected fields from the Selected Fields for Export column. remove all of the non required items from the Selected Fields for Export column. The system saves the selected fields per institution in the following file: /exlibris/metalib/m4_<n>/dat01/tab/ckb_import_table_<inst>.conf 127

128 Chapter 8: Activating Resources To export resources to an Excel file: 1 From either the Management Initial menu or the Management Ongoing menu, select Activate Resources or Activate Your Resources, respectively. The Activating Resources page displays (see Figure 20). 2 Select an institution from the Institution Code drop down list. 3 Add the fields you want to export to the Selected Fields for Export column. 4 Specify an e mail address to which to send the link for the Excel file. 5 Click Submit to export the resources and to send the Export Loader Report (see Figure 21) to the specified e mail address. Figure 1: The attached file contains the results of your query Institute name : METALIB To view the full results please click on the following link: m4_6/tmp/ckb_export_ xls This is an automated response. Please do not respond to this message. For questions concerning the report, please use the CRM application. Regards, The MetaLib Team Figure 21: Sample Export Loader Report 6 Click the link provided in the e mail message to open or save the Excel file (see Figure 22). 128

129 Chapter 8: Activating Resources Figure 2: Figure 22: Sample Excel File Importing Resources The import section (see Figure 23) of the Activating Resources page allows you to import IRDs from a tab delimited file to your institution s database. NOTE: Because this feature provides an update for existing resources, administrators cannot add new IRDs via the import. The import process will reject IRDs that do not have a matching resource ID in the database. Figure 23: Import Section of the Activating Resources Page To create a tab delimited file, open the Excel file that you created via the Activating Resources page, modify the file, and save it as a Unicode text file (see 129

130 Chapter 8: Activating Resources Figure 24). The first line of this file must specify the field columns, delimited by tabs. Figure 3: Resource Name<tab>Resource ID<tab>Status 19th Century Masterfile (Paratext)<tab>XXX00983<tab>ACTIVE 4Balance Newsletter (4Balance)<tab>XXX01853<tab>ACTIVE A-V Online (SP)<tab>XXX00666<tab>ACTIVE Figure 24: Sample Import File NOTES: The Resource Name and Resource ID fields are required to match records in the database. All of the other fields are optional. If you are using the Status field, the valid values are TEST, Active, and Inactive. To import resources to an Excel file: 1 From either the Management Initial menu or the Management Ongoing menu, select Activate Resources or Activate Your Resources, respectively. The Activating Resources page displays (see Figure 20). 2 Specify a text file (.txt) to import. NOTE: The file name must not include spaces. 3 Specify an e mail address to which to send the Import Loader Report. 4 Click Submit to import the resources and to send the Import Loader Report (see Figure 25) to the specified e mail address. Table2 Import Report TOTAL IRDs in input file: 1 TOTAL IRDs imported to XML format: 1 The following IRD records were rejected: LOADING STAGE: Total Records Loaded to local Institute : Total Records Rejected from Batch Load : Figure 25: Sample Import Loader Report 130

131 Chapter 8: Activating Resources 131

132 Chapter 8: Activating Resources 132

133 9 Exporting and Importing KnowledgeBase Records This section includes: Introduction on page 133 Exporting Records on page 134 Importing Records on page 139 Import Report on page 144 Introduction Records in the MetaLib KnowledgeBase may be exported and then imported into a different MetaLib system. This feature may be used to share resources with other MetaLib sites. Such sites must have a different resource prefix (for example, one site has the prefix ABC for all local resources, while another has the prefix BCD). These programs are not intended for the synchronization of resources between master (test) and production servers that consist of mirror instances using the same resource prefix. This section defines the technical requirements for EXPORT/IMPORT and describes the process and workflows. For information about replicating resources in a master/production environment or for information about KnowledgeBase backups, refer to the MetaLib System Configuration and Administration Guide, which includes an appendix on the MPSYNC tool. These procedures deal with the ability to share IRD maintenance between two MetaLib systems, where one system is the source of the IRD and the other system is the target. They are not intended to support a three step transfer from system A to system B to system C. If an IRD is created in system A, then copied to system B, and from there copied to system C, the IRD will not find a match if it is imported again into system A. 133

134 Chapter 9: Exporting and Importing KnowledgeBase Records NOTE: To export/import configurations, the MetaLib systems must be running the same version and revision of the MetaLib software. Exporting Records There are three ways to select the resources to be exported: In the MetaLib Management interface (/M), you can export all IRDs from a given institution. In the MetaLib Management interface (/M), you can select and gather specific IRDs for export by using the Global Update feature. From the command line, you can execute the $aleph_proc/p_export_b command. Exporting an Institution s Records The MetaLib Management interface (/M) allows you to export an institution s resources to a file. To export an institution s resources: 1 Click Export Import Procedures from the Ongoing Main menu. 2 Click Export Resources to access the Export Resources page (see Figure 26). Figure 26: Export Resources Page 134

135 Chapter 9: Exporting and Importing KnowledgeBase Records 3 Use the following table to fill in the relevant fields: Table 8. Export Resources Fields Field Institution Description Choose the institution that should be exported. The drop down list contains a list of institutions to which the Admin user has rights. All IRDs will be exported along with local configurations connected to those IRDs and category/subcategory pairs to which the IRDs are connected. E mail Address A message about the download will be sent to an e mail address that is entered. Delete Local Fields? (Y/N) Output File Name Selecting Y will export Subscription resource records without data in the following IRD fields: Authentication Hostname:Port Secondary Affiliation IP Filter Link to Native Interface URL Link to Records in Native Interface URL Link to Holdings Selecting Y will export free resource records without data in the following IRD fields: Authentication Secondary Affiliation IP Filter Enter the name of a file here. The file name must begin with a letter (not a number). Do not enter a file extension; the extension.xml.gz will be added when the file is created. For example, if export1 is entered, the export file will be named export1.xml.gz. 4 Click Submit to perform the export. NOTE: If a file with the same name exists on the server, it will be overwritten. The export files are created in./dat01/export. Check this directory to be sure the file name is unique before proceeding. 135

136 Chapter 9: Exporting and Importing KnowledgeBase Records Exporting Specific IRDs Using the Global Update Feature During a logged in session to the MetaLib Management interface (/M), resources may be gathered and exported using the following process. To perform a global update: 1 Click Find a Resource to locate resources. 2 Select the resources in the resulting list that you want to export. 3 Select the Create/Add to Export File item from the Global Update dropdown list. The following page displays: Figure 27: Create/Update Export File Page 4 If you want to add more resources to the list, click Resource List. Otherwise go to Step 7. 5 Select additional resources and then select the Create/Add to Export File item from the Global Update drop down list. 6 Select one of the following options: Figure 28: Append/Override Resource List Click Append to append the newly selected resources to the list. Click Override to replace the resources on the list with the newly selected resources. Again, you can choose to export or to return to the Resource List is available after making this selection (see Figure 27). 7 To export the resource list, click Export. 136

137 Chapter 9: Exporting and Importing KnowledgeBase Records 8 Use Table 8 on page 135 to fill in the fields. NOTE: If a file with the same name exists on the server, it will be overwritten. The export files are created in.\dat01\export. Check this directory to be sure the file name is unique before proceeding. The list of resources is kept for the Admin user s session and is deleted when the Admin user logs out. The export file itself is not deleted. Running the Export from Command Line You can run the export function from the command line on the MetaLib server. NOTE: If the intent is to synchronize resources on master/production servers, refer to the MetaLib System Configuration and Administration Guide, which includes an appendix on the MPSYNC tool. To run an export from the command line: 1 Create a file that includes a list of system IDs to export. This file should be stored in the./dat01/scratch directory. Each system ID should be entered on one line with a carriage return following it. For example: Enter the following command to export the list of system IDs: csh -f $aleph_proc/p_export_b DAT01,<outfile>,<local?>, <infile>,< > where the parameters are: <outfile> The name of the XML file. This is the file that will contain the XML export of the resources. The file will be created in the.\dat01\export\ directory. <local?> This flag indicates whether local fields should be deleted or not. The valid values are Y, meaning local fields will be deleted, and N, meaning local fields will not be deleted. <infile> This is the name of the file of system IDs. This file must be in the./dat01/scratch directory. < > The e mail address to which an e mail will be sent when the export file creation is complete. 137

138 Chapter 9: Exporting and Importing KnowledgeBase Records Converting Resource IDs to System IDs It is also possible to create a file with a list of resource IDs, which will then be converted to a file of system IDs. To convert a list of resource IDs to a list of system IDs: 1 The file of resource IDs must be placed in the.\dat01\export\ directory. Each resource ID must be separated by a carriage return. 2 Enter the following command, where <outfile> is the output file, which contains the list system IDs, and <infile> is the input file, which contains the list of resource IDs: csh f $aleph_proc/p_export_a dat01,<outfile>,file,<infile> The <outfile> is placed in the.\dat01\scratch\ directory. If you want to create a file with the system IDs of all IRDs in an institution, enter the following command, where <institution> is the institution code: csh f $aleph_proc/p_export_a dat01,<outfile>,db,<infile>, <institution>,,,,,,,,, NOTE: This command requires nine commas after the institution name. What is Exported? The Export procedure creates an XML file with the following data: IRDs Configurations linked to the IRDs Tables used by the configurations, including Z39 tables, SUTRS tables, and other data conversion tables. External programs that are referenced by the configurations Category/subcategory pairs to which the IRDs are connected The file is zipped, so the file name extension is.xml.gz. It is saved in the./dat01/export directory. NOTE: Up to 1000 IRDs may be exported at one time. 138

139 Chapter 9: Exporting and Importing KnowledgeBase Records Importing Records To import resources into a MetaLib system, a valid XML file should be copied to the./dat01/import directory of the system to which the resources will be imported and should have an.xml extension. The XML file must be compliant with the XML schema./dat01/www_x_eng/ird_schema.xsd. The XML import document contains records, each within a <knowledge_unit>. Each <knowledge_unit> represents one IRD and any configuration and/or category/subcategory pairs that contain links to it. The schema defines the XML elements used in the IRD <record> section and the <category> section of the XML. The import function itself does not validate incoming XML against the schema. Cleanup and validation of the XML should be handled locally before the XML is imported into MetaLib. MetaLib will ignore IRD XML elements that do not match the elements it is looking for. If the XML file was downloaded from another MetaLib system running the same version.revision of the MetaLib software, it will be compliant with the schema. NOTE: The import file should not contain any METALIB owned IRDs. The import will skip any IRDs or configurations belonging to the METALIB institution. METALIB institution IRDs and configurations should be maintained by running CKB updates on the server or by running the CKB update process on a master server and then moving the entire KnowledgeBase to a production server. See the MetaLib System Configuration and Administration Guide for more information about the MPSYNC tool. Running the Import from the MetaLib Admin Module (/M) The import may be performed from the MetaLib Management interface (/M). Note that there are more options available if the import is run from the command line. for details, see Running the Import from the Command Line on page

140 Chapter 9: Exporting and Importing KnowledgeBase Records From the MetaLib Management interface (/M), select Export Import Procedures and then click Import Resources. The following page displays: Figure 29: Import Knowledgebase Resources Page Fill in the following fields and then click SUBMIT to perform the import: Input file name: An XML file (or.gz file with only the XML file in it) to be used as input. The IRD and Categories sections of the XML file must be compliant with the XML schema. The file must be placed in the./dat01/ import directory on the server. Be sure to enter the full file name, including its extension. Load IRDs into this Institution: Select the institution into which the IRD records should be imported from the list of institutions to which the /M administrator has administrator rights. Should the ownership of the configurations be changed to the Institution selected above?: Yes means that the owner of the configurations in the XML import file should be switched to the selected institution. No means that the owners of the configurations should remain as they are in the import XML file. IRD status: Choose the status that the IRDs should have after they are imported. Mode: All IRDs will be imported. Choose whether the configurations should also be imported. See Running the Import from the Command Line on page 140. Running the Import from the Command Line The import command may be run from the command line. There are four modes in which the import may be run: Import without any checks Import IRDs and configurations Import without any checks Import IRDs only 140

141 Chapter 9: Exporting and Importing KnowledgeBase Records Import with checks only of the configurations Import with checks of each IRD and each configuration To run the import using mode 1 or 2, enter the following commands: dlib dat01 csh -f $aleph_proc/p_import_1 dat01,<imp_file>,<inst>,<status>, <sw_inst_to_conf>,<mode> > $data_scratch/p_import_1.log.$$ & To run the import using mode 3 or 4, enter the following commands: dlib dat01 csh -f $aleph_proc/p_import_1 dat01,<imp_file>,<inst>,<status>, <sw_inst_to_conf>,<mode> The difference is that modes 1 and 2 may be run in the background, whereas modes 3 and 4 require input from the user and must be run in the foreground. Command-Line Parameters: <imp_file name> An XML file (or.gz file with only the XML file in it) to be used as input. The IRD and Categories sections of the XML file should be compliant with the XML schema provided. <inst> The institution into which the IRD records should be input. <status> Resource Status. Valid entries are A, T, and I, meaning that the loaded IRDs will be Active, Test, and Inactive. If this parameter is empty, the IRDs will be loaded with the status defined in the XML input. <sw_inst_to_conf> Valid entries are Y and N. Y means that the owner of the configurations in the XML import file should be switched to the institution selected in <import to institution>. N means that the owner of the configurations should remain as they are in the import XML file. <mode> Valid entries are 1, 2, 3, and 4. See definitions above. What Happens During the Import? IRDs Before importing each resource, the system looks for a match to an existing IRD in the KnowledgeBase. The match is based on the resource ID (001) of the incoming record XML and the resource ID (001) and/or original ID (035) of the existing IRDs in the KnowledgeBase. If a match is found, the entire XML IRD is imported as is, replacing all fields in a matching KnowledgeBase IRD, with the following exceptions: If a status (A, T, or I) is defined in the <status> parameter, the status of the local IRD will be changed to match the parameter. 141

142 Chapter 9: Exporting and Importing KnowledgeBase Records The IRD will belong to the institution defined in the <inst> parameter. In addition, refer to Table 9 for matching algorithms and import behavior: Table 9. Import Scenarios # Check the XML Incoming Record via the Existing Record in the KB Outcome 1 No 001 (resource ID) in the XML. Import record as new with new XML 001 matches KB 001. Update/override the record. 3 XML 001 matches KB 035 (original ID). Update/override the record; the 001 and 035 in the KB record are kept. 4 XML 035 (original ID) matches KB 001 (resource ID). 5 XML has an 001, but does not find a match in the KB either in the 001 or the XML has an 001 with no match and an 035 with no match. 7 XML has a 001 matching the KB 001 but the institution in the XML does not match the selected import institution. 8 XML has a 001 matching the KB 035 but the institution in the XML does not match the selected import institution. 9 XML has a 035 matching the KB 001 but the institution in the XML does not match the selected import institution. Update/override the record; the 001 in the KB record is kept. The 001 of the XML record is moved to the 035 of the KB record, overriding any existing 035 tag. Import record as new with new 001; XML 001 tag is moved to the 035 of the KB record.. Import the record as new with new 001; XML 001 tag is moved to the 035 tag of the KB record; 035 from XML record is not imported. Import the record as new with new 001; XML 001 tag is moved to the 035 tag of the KB record; 035 from XML record is not imported. Import the record as new with new 001; XML 001 tag is moved to the 035 tag of the KB record; 035 from XML record is not imported. Import the record as new with new 001; XML 001 tag is moved to the 035 tag of the KB record; 035 from XML record is not imported. NOTE: When running the import in mode 4 (Import with checks on each IRD/ configuration), the scenario number as stated in Table 9 will be output as part of the menu, preceded by a colon and followed by a semicolon. For 142

143 Chapter 9: Exporting and Importing KnowledgeBase Records example, if the import finds a match based on scenario 2 above, the menu will contain this: Match result:02; Configurations The system looks for a match to an existing configuration code in the KnowledgeBase. During the Import procedure, the configuration, tables, and external programs are overwritten completely if a match is found to the configuration code. If a match is not found to the configuration code, the configuration is loaded as new. External programs written in Perl contain a path to the Perl directory on the server. The Import procedure changes the path to match the correct path on the server into which the records are imported. The only change made to configurations during the import is that the institution that owns the configuration may be changed. If the input parameter <sw_inst_to_conf> is set to Y, then the institutional owner of the configuration will be changed to the one selected in the input parameter <inst>. If the <sw_inst_to_conf> parameter is set to N or if the import is run in mode 1, then the configuration will be input with the configuration belonging to the institution defined in the XML import file. NOTES: When running the import in mode 1 with the <sw_inst_to_conf> set to N, it is important to understand that when the configurations are imported, the institution to which they belong becomes the institution defined in the import file. For example, if the server to which records are being imported has a configuration with a code of L_TEST owned by institution A, and the import file contains a configuration with a code of L_TEST owned by institution B, after the import, the L_TEST configuration will be owned by institution B even if there is no institution B defined on this server. The only check is on the configuration code. It is important to check that incoming configurations do not share a configuration code for different resources. This can be done by running the import in mode 3 or 4 or by thoroughly checking the XML input file before the import is run. Categories Categories are stored in an Oracle table. Each category/subcategory pair may have links to the IRDs to which it is connected. If the incoming <knowledge_unit> does not have a <category> section, the links from category/subcategories to the incoming IRD are not changed. 143

144 Chapter 9: Exporting and Importing KnowledgeBase Records If the incoming <knowledge_unit> does have a <category> section, all of the links from category/subcategory pairs are replaced by links from the category/ subcategory pairs in the incoming XML. NOTE: The names of the categories/subcategories in the incoming XML must match the names of the categories/subcategories that have been defined in the MetaLib system in order to find a match. The match is always performed on the category and subcategory. The export/import uses the master category/subcategory name, not the display name. If the incoming <knowledge_unit> has an empty <category> section, existing links from category/subcategory pairs to the IRD will be removed. In that case, if the category/subcategory pair is only linked to this IRD, the category/ subcategory pair will be deleted from the institution. If an incoming category/subcategory pair does not match an existing category/ subcategory already in the system, this is reported in the import report (see Import Report on page 144). Only newly added category/subcategories are reported in the import report. NOTE: The import file name is changed during the import process to differentiate between files that have been imported and those that have not. For example, an import file name called import1.xml will be changed to _import1.xml once imported, where is the import date. File names starting with a date will no longer appear in the drop down list of import file names. To import the same file into different institutions, the renamed file in the./dat01/import directory will need to be manually renamed. Import Report Each time records are imported, a report is created in the./dat01/import directory. The file name is import1.xml.report for an import file named import1.xml. It reports on new IRDs/configurations that were imported, updated, and rejected during the import procedure. The rejected list will include any IRDs and/or configurations that belonged to the METALIB institution in the input XML file. It also lists the new category/subcategory pairs that were created during the import. 144

145 Part II Reports and Statistics Part II contains the following: Section 10: Accessing MetaLib Reports and Statistics on page 147 Section 11: Reports on page 155 Section 12: Statistics on page 163

146 MetaLib Resource Management Guide Part II: Reports and Statistics 146

147 10 Accessing MetaLib Reports and Statistics This section includes: Introduction on page 147 The MetaLib Reports and Statistics Page on page 148 Date Format on page 149 Introduction This section describes how to view and use the MetaLib Reports & Statistics page. To access the MetaLib Reports and Statistics page, click the Reports & Statistics link on the MetaLib Ongoing Menu page (see Figure 30). Figure 30: MetaLib Management Main Menu 147

148 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics NOTE: From the MetaLib Logon page, staff users that are restricted to reports and statistics access only are directed automatically to the MetaLib Reports and Statistics page (see Figure 31). The MetaLib Reports and Statistics Page The Reports and Statistics page (see Figure 31) provides access to the various MetaLib reports and statistics. Figure 31: Reports & Statistics Sub-Menu NOTE: The Change Password section only displays for users that are provided with access to reports and statistics only. This page is divided into the following parts: 1 Reports: KnowledgeBase Report MetaLib Search Queries 2 Statistics: KnowledgeBase Resources MetaLib Search Statistics QuickSet Search Statistics Resource Categories/Resource Locate Usage Number of Daily Sessions 148

149 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics User Record Statistics Links to Native Interface This page also contains a note that indicates when the clear_vir01 utility last updated the vir00 library. This utility processes the session data in the temporary library and stores it in the permanent library. The following reports and statistics require the clear_vir01 utility to be executed to produce reports with the latest data: MetaLib Search Queries MetaLib Search Statistics QuickSearch Search Statistics Resource Categories/Resource Locator Usage Number of Daily Sessions Links to Native Interface The following reports and statistics do not require the clear_vir01 utility, since any changes in the database are reflected immediately: KnowledgeBase Report KnowledgeBase Resources User Record Statistics For each report, there is a dedicated input form that allows the user to specify the criteria needed to generate the report. The user can produce reports in either the Excel or HTML format. For more details on generating reports and statistics, refer to the following sections: Reports on page 155 Statistics on page 163 Date Format Dates must be entered according to the locally defined format. All the statistics forms that allow filtering by date display the format according to the local setting. Refer to Setting the Date Format on page 215 for details on how to change the local date setting. There are two possible formats: DD/MM/YYYY or MM/DD/YYYY. 149

150 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics Entering Values in a Date Field For the reports that allow filtering by date, there are two fields: Figure 32: Date Range for Input If a date is entered only in the From field, output returns for all dates from the specified date through the most recent date that vir00 was updated via the clear_vir01 utility. If a date is entered only in the To field, output returns for all dates up to the specified date. Date Validation In the input form, dates are validated before the report is generated. If an invalid date or date range is entered, a relevant error message displays. For example, entering 01/13/2007 displays a dialog box (see Figure 33): Figure 33: Example of Date Validation Message Action Icons Input Form Actions In all the reports: Click CANCEL to return to the Reports & Statistics page. Click SUBMIT to generate the report. Click Clear Form to clear all the values entered in the input form. 150

151 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics Output Form Actions If you choose to save a report to a file, a dialog box displays (see Figure 34), allowing you to select one of the following options: Click Cancel to return to the report input page. Click Open to display the report in an Excel spreadsheet. Click Save to store the Excel file on a local/network drive. Figure 34: File Download Dialog Box (Excel) NOTE: The dialog box is browser dependent. The above example is for Internet Explorer. Other browsers display a similar dialog box. 151

152 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics To save the report to an Excel file, perform the following steps: 1 Click Save from the File Download dialog box. The Save As dialog box displays (see Figure 35). Figure 35: Save As Dialog Box (Excel) 2 Populate the Save As dialog box as follows: a Select the folder from the Save in drop down list or create a new folder for this file. b Enter a value in the File name field (or use the default). 3 Click Save. The Download Complete dialog box displays (see Figure 36). 152

153 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics Figure 36: Download Complete Dialog Box 4 Click Open to activate Excel and open the newly saved file. To return to the input page after viewing an HTML report, click the Back link at the bottom of the page. To return to the input page after viewing an Excel report, click the Back button of the browser. 153

154 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 10: Accessing MetaLib Reports and Statistics 154

155 11 Reports This section includes: Introduction on page 155 KnowledgeBase Report on page 155 MetaLib Search Queries on page 159 Introduction MetaLib allows users to produce KnowledgeBase and MetaLib serach query reports. KnowledgeBase Report The KnowledgeBase Report displays information on KnowledgeBase resources. Options are provided for choosing which resources will be displayed in the report and for customizing the report format. 155

156 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports Figure 37: KnowledgeBase Input Form To create the KnowledgeBase Report, perform the following steps: 1 Select the resources for the report. This selection is based on the same functionality as Find Resource. You can choose to filter the report by one or more fields. NOTE: If you use Resource Categories as a filter, resources are assigned to subcategories, not (main) categories. To filter a report filtered by a (main) category, select <Category> ALL. If a category has only one subcategory, <Category> ALL does not display. 156

157 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports In the above example: Figure 38: Selecting Resource Categories Select Engineering - ALL to display all of the resources that are assigned to the Engineering category. Select -Civil to display resources that are assigned to the Civil subcategory under the Engineering category. Select either Education or -General under the Education category to display the resources that are assigned to the General subcategory under the Education category. 2 Select the report output file type. Two output formats are available: Excel or HTML. The default is Excel. Select the format from the following dropdown list: Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. NOTE: Save the Excel file to your hard drive to easily re format output as desired. 3 Select the report format. The report format defines which fields from the IRD and configuration records display in the report. The MetaLib standard installation includes the following formats: Brief Configuration Notes Subscription Information Refer to Table 13 on page 218 for more information on report formats. 157

158 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports Sample KnowledgeBase Reports Input: Filter by Active resources in the Art subcategory. Output: Brief Figure 39: KnowledgeBase Report - Sample Input Figure 40: KnowledgeBase Report - Sample Brief Output NOTE: If a resource is assigned to more than one category, all of the categories display in the Categories column. 158

159 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports Output: Configuration Notes Figure 41: KnowledgeBase Report - Sample Configuration Output Output: Subscription information Figure 42: KnowledgeBase Report - Sample Subscription Output MetaLib Search Queries The MetaLib Search Queries Report displays queries performed by users. The output of the report displays the following columns: Resource ID of resource searched. Resource name of resource searched. Search query entered. Number of hits found. Date. 159

160 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports Figure 43: MetaLib Search Queries Input Form To generate the MetaLib Search Queries Report, perform the following steps: 1 Limit your search by one or more of the following parameters: Date Range, Institution, User Group. NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Filter by User Group = leave blank to display queries performed by all users, including users who do not have a user group affiliation. 2 Sort results alphabetically by Resource Name or Search Query, or by Number of Hits or Date. The default is Resource Name. 3 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 4 Click Submit to generate report. 160

161 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports Sample Search Queries Reports Input: Date range, Institution, and sorted by Resource Name. Figure 44: MetaLib Search Queries Sample Input Output: HTML and sorted by Resource Name. Figure 45: MetaLib Search Queries Sample HTML Output 161

162 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 11: Reports Output: Save As and sorted by Date. Figure 46: MetaLib Search Queries Sample Excel Output To return to the MetaSearch Search Queries input page, click the Back button on the browser. 162

163 12 Statistics This section includes: Introduction on page 163 KnowledgeBase Resources on page 163 MetaLib Search Statistics on page 166 QuickSets Search Statistics on page 172 Resource Categories/Resource Locator Usage on page 175 User Records Statistics on page 184 Links to Native Interface on page 188 Introduction MetaLib allows users to produce the following statistical reports: KnowledgeBase Resources MetaLib Search Statistics QuickSet Search Statistics Resource Categories/Resource Locate Usage Number of Daily Sessions User Record Statistics Links to Native Interface KnowledgeBase Resources This statistical report counts the number of KnowledgeBase resources per institution according to resource status (Active or Testing). 163

164 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics NOTE: This is the only report that shows a breakdown of resources by status for all institutions in a consortium, regardless of the affiliation of the administrative user generating the report. The output of the report displays the following columns: Institution Status of the Resources (Active or Testing) Number of Resources Figure 47: KnowledgeBase Resources Input Form To generate the KnowledgeBase Resources Report: 1 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 2 Click Submit to generate the report. 164

165 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Sample Reports Input: Output: HTML Figure 48: KnowledgeBase Resources Sample Input Figure 49: KnowledgeBase Resources Sample HTML Output Output: Save As Excel file. Figure 50: KnowledgeBase Resources Sample Excel Output 165

166 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics To return to the KnowledgeBase Resources input page, click the Back button on the browser. MetaLib Search Statistics This statistical report counts the number of searches performed in an institutionʹs resources. In addition, for sites using the X Server options, this report counts the number of times the following X Services are called by a calling application: find search_my_sets search_quick_sets Figure 51: MetaLib Search Statistics Input Form 166

167 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics To generate the MetaLib Search Statistics Report: 1 Select a group of searches by one or more of the following fields: Date Range, Institution, User Group, and Filter Module By. NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Leave the User Group field blank to display queries performed by all of the users, including users who do not have a user group affiliation. The Filter Module By field allows you to narrow your search by the following modules: MetaLib UI, X Server, and All. 2 Break down the report by one of the following elements: Grouping Element: The report can count the number of searches performed in resources and classify the results according to the following elements: Resource ID produces reports with the following columns: Resource ID Resource Short Name Number of Searches Access Method produces reports with the following columns: Access Method Number of Searches Resource ID and Search Status produces reports with the following columns: Resource ID Resource Short Name Search Status Number of Searches Access Method and Search Status produces reports with the following columns: Access Method Search Status Number of Searches Search Module: While performing a search (QuickSearch, Find Database, MetaSearch, History, Alerts, X Server), you can limit reports to the module that was used. 167

168 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics NOTE: If the Filter Module By field is set to All, you can select only All from the Search Module field. 3 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 4 Click Submit to generate the report. Sample Reports Input: Filter by Date To, Institution, display according to Resource and Find Database module Figure 52: MetaLib Search Statistics Sample Input 168

169 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: Save As Excel Figure 53: MetaLib Search Statistics Sample Excel Output Input: Filter by Institution, display according to Access Method Figure 54: MetaLib Search Statistics Sample Input - Access Method 169

170 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Figure 55: MetaLib Search Statistics Sample HTML Output - Access Method Input: Filter by date, Institution, User Group, display according to Resource and Search Status Figure 56: MetaLib Search Statistics Sample Input - Resource, Search Status 170

171 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Figure 57: MetaLib Search Statistics Sample HTML Output - Resource, Search Status 171

172 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Search Status Table 10 describes the statuses that may display in the MetaLib Search Statistics: Table 10. Statuses for MetaLib Search Statistics Status FORK FIND FETCH DONE1 DONE2 DONE3 DONE STOP ERROR ALLOW CANCEL Description Before search Search Start the first fetch process 10 records fetched 20 records fetched 30 records fetched All records fetched A time out occurred An error occurred Not allowed to search on a resource User clicked the CANCEL button before search completed QuickSets Search Statistics This statistical report counts the number of searches performed in QuickSets, while using QuickSearch and MetaSearch. Figure 58: QuickSet Search Statistics Input Form 172

173 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics To create the QuickSets Search Statistics Report: 1 Limit the search to one or more of the following parameters: Date Range, Institution, User Group, and Filter Module By. NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Leave the User Group field blank to display queries performed by all of the users, including users who do not have a user group affiliation. The Filter Module By field allows you to narrow your search by the following modules: MetaLib UI, X Server, and All. 2 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 3 Click Submit to generate the report. Sample Reports Input: Filter by Date Range and Institution Figure 59: QuickSet Search Statistics Sample Input 173

174 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Output: ʺSave asʺ Figure 60: QuickSet Search Statistics Sample HTML Output Figure 61: QuickSet Search Statistics Sample Excel Output 174

175 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Resource Categories/Resource Locator Usage This statistical report counts the number of times a user has done the following actions in the user interface: Selected a specific resource category or used the Locate function in Find Database. Selected a specific resource category or used the Locate function in MetaSearch. In addition, for sites using the X Server options, this report counts the number of times the following X Services were called by a calling application: source_locate retrieve_resources_by_category Figure 62: Resource Categories/Resource Locator Input Form To generate the Resource Categories/Resource Locator Usage Report: 1 Enter the search criteria in the following fields: Date Range, Institution, User Group, Search Module (All Modules, Find Database, MetaSearch, X Server). NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Leave the User Group field blank to display queries performed by all of the users, including users who do not have a user group affiliation. 2 Choose one of the following report types: HTML (default) HTML output displays in the browser. 175

176 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Save As save report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 3 Click Submit to generate the report. Sample Reports Input: Filter by Date From and Find Database Module Figure 63: Resource Categories/Resource Locator Sample Input 176

177 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Figure 64: Resource Categories/Resource Locator Sample HTML Output 177

178 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: ʺSave asʺ Figure 65: Resource Categories/Resource Locator Sample Excel Output Number of Daily Sessions This statistical report counts the number of user sessions initiated in MetaLib per day. Figure 66: Number of Daily Sessions Input Form 178

179 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics To generate the Number of Daily Sessions Report: 1 Limit your search by one or more of the following fields: Date Range, Institution, and User Group. NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Leave the User Group field blank to display queries performed by all of the users, including users who do not have a user group affiliation. 2 Group results by the following criteria: Daily produces reports with the following columns: 1.Date 2.Number of Daily Sessions Hourly (breakdown is by two hour intervals) produces reports with the following columns: Date am am pm am Total Note that each column shows two hour increments, but a session may overlap increments. In such a case, the session will appear in both increments, but it will be counted only once in the Total column to display accurate statistical data. For example, if a user session begins at 15:45 and ends at 16:07, it will appear in the 14:00 16:00 and 16:00 18:00 columns, but it will appear only once in the Total column. This way it reflects both the correct number of user sessions per hour and the correct number of total user sessions per day. User Group produces reports with the following columns: Date Number of Daily Sessions 179

180 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics 3 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 4 Click Submit to generate the report. Sample Reports Input: Date Range for one week, Institution, Daily Figure 67: Number of Daily Sessions Sample Input - Daily Grouping 180

181 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Figure 68: Number of Daily Sessions Sample HTML Output - Daily Grouping Input: Date Range for one week, Institution, Hourly Figure 69: Number of Daily Sessions Sample Input - Hourly Grouping 181

182 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Figure 70: Number of Daily Sessions Sample HTML Output - Hourly Grouping Output: Save As Excel file Figure 71: Number of Daily Sessions Sample Excel Output - Hourly Grouping 182

183 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Input: Date Range for one week, Institution, group by User Group Output: HTML Figure 72: Number of Daily Sessions Sample Input - User Group Grouping Figure 73: Number of Daily Sessions Sample HTML Output - User Group Grouping 183

184 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics User Records Statistics This statistical report counts the number of registered users and their usage of personalization features in MetaLib. Figure 74: User Record Statistics Input Form To generate the User Records Statistics Report: 1 Limit the search by one or more of the following fields: Date Range The date field refers to the date the user record was last updated in the vir00 user table (z312). This is relevant to both users with local or remote authentication methods. NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Institution limits the search to a specific institution. User Group limits the search to a specific user group. If left blank, displays statistics for all logged in users, including users who do not have a user group affiliation. If set to Guest, displays statistics for all logged in users with only a guest affiliation. Users logged in as Guest may access personalized options in MetaLib, but can only access those resources available to Guest users. Report Options limits searches to the following options: Registered Users the number of users who have logged in with a user name and password 184

185 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Users with Personal Lists the number of users who have saved resources or e journals to their My Database or My e Journal list Users with Saved Items the number of users who have saved items to their eshelf, History (saved searches), or Alerts list HINT: The bottom line of the report is a summary of the number of items saved by the number of users reported. All of the Above Combined the number of users, including all the above mentioned entities, displayed in one table HINT: The bottom line of the report is a summary of the number of items saved by the number of users reported. 2 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 3 Click Submit to generate the report. Sample Reports Input: Registered graduate users created in January 2007 Figure 75: User Record Statistics Sample Input - Registered Users 185

186 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: HTML Figure 76: User Record Statistics Sample HTML Output - Registered Users Input: Users with Personal Lists Output: HTML Figure 77: User Record Statistics Sample Input - Users with Personal Lists Figure 78: User Record Statistics Sample HTML Output - Users with Personal Lists 186

187 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Input: Users with Saved Items Output: HTML Figure 79: User Record Statistics Sample Input - Users with Saved Items Figure 80: User Record Statistics Sample HTML Output - Users with Saved Items 187

188 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Input: Users with both Personal Lists and Saved Items Figure 81: User Record Statistics Sample Input - All of the Above Combined Output: HTML Figure 82: User Record Statistics Sample HTML Output - All of the Above Combined Links to Native Interface This statistical report counts the number of times users link to the native interface of a resource. This report includes links to the native interface of any resource presented in the user interface, including Link Only resources (that is, not searchable in MetaLib), links to the native interface to view the search results of a Search and Link resource, as well as links to the native interface to view full text documents, and so forth. that may be included as external links in the full records of search results. The display includes the database name and number of times linked. 188

189 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Figure 83: Links to Native Interface Input Form To generate the Links to Native Interface Report: 1 Limit your search by one or more of the following parameters (Date Range, Institution, User Group) NOTE: For more information on entering dates, refer to Entering Values in a Date Field on page 150. Leave the User Group field blank to display queries performed by all of the users, including users who do not have a user group affiliation. 2 Choose one of the following report types: HTML (default) HTML output displays in the browser. Save As saves report in Excel format to a file. Use the Excel dialog boxes to define the name and location of the output. Refer to Output Form Actions on page 151 for details on how to save the file in Excel format. 3 Click Submit to generate the report. 189

190 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Sample Reports Input: Date range and secondary affiliation GUEST Output: HTML Figure 84: Links to Native Interface Sample Input Figure 85: Links to Native Interface Sample HTML Output 190

191 MetaLib Resource Management Guide, Part II: Reports and Statistics Chapter 12: Statistics Output: Save As Figure 86: Links to Native Interface Sample Excel Output 191