-
Notifications
You must be signed in to change notification settings - Fork 6
Home
The Alma Integrations ArchivesSpace plugin allows a user to push metadata describing collections, their physical locations, and their containers from ArchivesSpace to the Ex Libris Alma library management system. It was developed at the University of Denver Libraries, and continues to be developed by Kevin Clair.
To use the plugin, you will need to know the URL for your Alma Bibliographic API, as well as the key to access it (this will be institution-specific). You may need to work with your IT department to access this information. These can be assigned in your ArchivesSpace configuration (config/config.rb). You will need to add two new configuration settings:
-
AppConfig[:alma_api_url]contains the Alma API URL -
AppConfig[:alma_apikey]contains the API key
The Alma API uses MMS IDs as identifiers for bibliographic resources; the API calls assume it is present. You will need to assign a user-defined string field to MMS IDs in your ArchivesSpace instance. This may be assigned in the plugin controller (frontend/controllers/alma_integrations_controller.rb). You will need to find the mms_field method and set your assigned string field there.
Finally, the plugin is prescriptive as to how it creates Holdings records. Your building and location codes will need to be defined in the AppConfig[:alma_holdings] configuration setting, formatted as an array of arrays with two elements: the first is the building code (entered in 852‡b), the second is the location code (entered in 852‡c). For example, the University of Denver implements the follow alma_holdings settings:
[['h', 'hscol'], ['p', 'pscol'], ['p', 'psfol'], ['p', 'psovz'], ['p', 'psmap']]
More information may be found in the Holdings section of the wiki.
Pull requests are welcome, as well as assistance with testing and contribution of development issues and use cases. This wiki provides documentation about functionality of and design decisions for the plugin.
Questions about the plugin and how to use it may be directed to Kevin Clair: kmc35 [at] psu.edu.