Skip to Main Content

Brown University Scholarly Resources

Alma Integration


You can setup Metadata Editor to pull and update records from either Sandbox or Production via API.

Set Up Z39.50 Database

  1. In MarcEdit, Select 'Z39.50/SRU Client'
    • Usually available as a shortcut on the main window
    • Otherwise Navigate to Tools > Utilities > Z39.50/SRU Client
  2. Actions > Add New Z39.50 Server
  3. Under Database Properties tab
  4. Name the Databse (Suggested 'Alma Production' and 'Alma Sandbox')
  5. Host:
    • Production Host: brown.alma.exlibrisgroup.com
    • Sandbox Host: sandbox02-na.alma.exlibrisgroup.com
  6. Database: 01BU_INST
  7. Port: 1921
  8. Syntax: MARC21
  9. Leave Username and Password blank
  10. Save
Screenshot of the z39.50 setup for sandbox

Set Up ILS Integration

  1. At the top of the MarcEdit main window there are three buttons
    • MARC Tools (Hammer and Wrench)
    • MarcEditor (Pencil and Paper)
    • MarcEdit Preferences (Gear)
  2. Open MarcEdit Preferences
  3. Navigate to ILS Integration
  4. Select 'New'
  5. Name the ILS (Suggested 'Alma Production' and 'Alma Sandbox')
  6. Set 'Type' to 'Alma'
  7. Host should automatically fill, and Username greyed out
  8. Enter the Alma Token (See Head of Technical Services or the Digital Technologies Department for this token)
  9. Select Server Settings
  10. Select the appropriate Z39.50 server you created above (Production for Production, Sandbox for Sandbox)
  11. Save
  12. Under 'Defined Profiles' select either the Production or Sandbox profile, then press 'Select' to set which profile is active.
Screenshot of the ILS integration setup for Sandbox

Using ILS Integration

  1. In MarcEditor there should now be a menu option next to 'Tools' called 'Alma'
  2. Select Alma > Search
    1. You can Search by:
      • Title
      • Author
      • Subject
      • ISBN
      • ISSN
      • Record Number - this searches for the mmsid
      • Keywords
      • Raw (Advanced) - This uses Z39.50 code to search (Slides Introducing the Topic)
    2. You can perform a batch search and search for multiple phrases in a single search.
      1. Create a text file with each search term on a new line
        • (Note: You can only search by one type at a time - e.g. record number, title, etc.)
      2. In the Search box, Select the 'Batch Search' Checkbox
      3. Set Search Type (Tile, Author, Record Number, etc) from the drop down.
      4. Select the folder button and open your text file
      5. Select Search
    3. Searches will take a few seconds to a few minutes depending on the search size
    4. Once Search completes, the Results will appear in the Results box
    5. Select Individual Bibs by double clicking on them, or download all results by selecting 'Download All Items' below the Results box
    6. Alternatively you can download the holdings of the bib results by selecting 'Download All Holdings' below the Results box
  3. Select Alma > Update/Create to update or create new records.
    • Records will overlay on mmsid or holdings id
    • If neither id exists in the record, or the record id does not match a record in our system, a new bib will be created.
    • Updated records will completely overlay, so please test in Sandbox first.
  4. Select Alma > Process Settings in order to run a normalization process on imports or exports
    1. Under either the 'Tasks to Run on Import' or 'Tasks to Run on Export' select 'Select Task'
    2. In the new window, select the Normalization Process you would like to run on the records before they are imported into or as they are exported out of Alma (See Normalization Rules or Current Normalization Processes for more information)