Setup
Last updated on
30 April 2025
You need to follow these steps if you installed eXtensible Catalog Drupal Toolit manually. If you use the installation profile, you can skip these steps, because the profile has already done for you.
create storage
- goto Administer › eXtensible Catalog (XC) › Metadata Storage Configuration and Utilities › Storage locations › Add location (admin/xc/metadata/location/add)
- fill the form:
Name: default
Description: default location - click Continue
- accept everything as is if the Solr runs on the default host, port and path. Modify the default values, if your Solr instance in customized
- click Add storage location
setup NCIP
- goto Administer › eXtensible Catalog (XC) › ILS (NCIP) Servers › NCIP servers › Add NCIP provider (admin/xc/ncip/provider/add)
- fill the form:
Name: the library name, which provide the NCIP interface (like 'Rush Rhees Library')
Description: any convenient description about the service or the library
Host: the host IP or server name
Port: the port number
Path: the path part of NCIP (like '/NCIPToolkit_v0.3/')
To Agency Id
Scheme: an agency scheme's URL
Value: the name of the scheme owner (like 'University of Rochester') - click Add NCIP Toolkit
register an OAI-PMH repository
- goto Administer › eXtensible Catalog (XC) › Metadata Harvester › Repositories › Add Repository (admin/xc/harvester/repository/add)
- fill the form:
Name: the name of the OAI-PMH repository
Url: The base url of the OAI-PMH service - click Submit and validate
setup ILS (this connects NCIP instances to field in a metadata record)
- goto Administer › eXtensible Catalog (XC) › ILS (NCIP) Record Mapping Settings › Add (admin/xc/ils/add)
- fill the form:
NCIP server: select an NCIP server from the list
Bib identifier field: any field which identify the bib record (like 'xc:recordID|type=NRU' in the XC record XML schema)
create a scheduled harvest
- goto Administer › eXtensible Catalog (XC) › Metadata Harvester › Scheduled harvests › Add scheduled harvest (admin/xc/harvester/schedule/step1)
- fill the form:
Select repository: select from the list
Schedule: select hourly, daily, or weekly. - click Next
- fill the form:
Choose Metadata Format: any format the OAI data provider supports
Choose set: you can choose a given set, or select none, which will harvest all records
Choose Parsing Mode: Regular expression based if the response contains lots of records (hundreds). Otherwise you can choose the default DOM based process. Regex method is much more faster, but DOM is more reliable. Except extraordinary case regex is suggested. If you run into a problem with the regex method, please contact us, and choose DOM.
Do harvester cache responses? It is useful only in testing phase, but could be misleading in a production server, because it does not reflect the changes on the OAI-PMH server. If you don't want to use the cache more, set it to now, and delete the cache directory. It is the default file directory's oaiharvester_http_cache subdirectory.
Storage locations: these are the storages you set up as the first step in this list. Choose at least one location, if you would like our module handle records.
Run 'preparing metadata for search' step? Check this if you want to index records with Solr.
- Click Submit
Soon the Drupal Toolkit will provide you another options in this page. Since this page has its own hook function, other contributed modules may provide other options you can choose.
Help improve this page
Page status: Not set
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion