Setting up the Alma MARCEdit integration for Bib Records

MARCEdit Integration with Alma.

Note from the author (July, 2019).  There are several other MarcEdit-related blog posts related to Alma in the Ex Libris Developer Network that are more recent than this blog post.  I still believe everything is correct but the Alma UI in relation to APIs may have changed. 

The examples below utilize the Alma Sandbox.  It is usually preferable to test in your Sandbox, first.  Once you are certain it works, you can change the configuration to point to your Production Alma.

Note that this document presumes you have a basic understanding of working with APIs.

Also note that you can right click on images and click on “View Image” to see the screenshots clearly.

The author is not a a cataloger.  Use of this integration is dependent upon cataloging skills and knowledge of your bibliographic data.

Consult the MarcEdit web site::  http://blog.reeset.net/archives/1950

Before you start you need to know:

• Your Sandbox URL
• Your Sandbox Database
• Your Sandbox Z39.50 port (probably 1921)

You need to work in two areas. First set up the APIs.  Next, configure MARCEdit.

You should test that your Z39.50 is working.  Yaz can help you do that.  For example in Yaz:

Z> open sandbox01-na.alma.exlibrisgroup.com:1921/01MYSCHOOL_INST

In the Developer Network API Dashboard:

• Created a new Application for MARCEdit that uses the Bibs and Users APIs.
• Under API Management for that application, change the Plan to “Sandbox read/write” and Save.
• Copy the API key for the MARCEdit application as you will need it for MARCEdit.

API Key will be a long string that looks something like (below is not a real key):

l7xxb23a320666c247c784a6a1751ab25c27

Test of Bib (plug your own MMS ID and your own API key into this URL <example not a real API key>):

https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/991547950000541?apikey=l7xxb23a320666c247c784a6a1751ab25c27

Test of Users (Plug your own API key into this URL <below is not a real API key>):

https://api-na.hosted.exlibrisgroup.com/almaws/v1/users?limit=10&offset=0&order_by=last_name%2C%20first_name%2C%20primary_id&apikey=l7xxb23a320666c247c784a6a1751ab25c27

On the main ILS Integration screen in MARCEDIT (Preferences Icon – note this may not be current version of MARCEdit — your version may be different!)

Please note that several customers have been confused by the following:

Make sure you understand and know the URL for your API gateway

Host Name: https://api-na.hosted.exlibrisgroup.com

– This should be the same for all North American customers, regardless of sandbox vs. production.

– https:// is required here.

– As Terry’s instructions indicate, there is no username, and the password is your API key for the MARCEdit application.

These setting work as of 3/4/2017

I suggest you name it “Alma” – Set it up as above. Once this done, Click on Edit under use Z39.50 settings

Create this for your Z39.50 settings and save.

Then go back to main settings and select your setting.

On the Z39.50 Database Properties tab use this URL:

Host: sandbox01-na.alma.exlibrisgroup.com

After logging in to our Alma sandbox, I copied this domain from the URL. (Correct for Mines as well)

Login and pw are blank.

I did receive an error the first time I tried to search from the MARC Editor, because my Z39.50 config had been dropped from Settings. I re-entered the config, saved, and the changes remained after that.

Using the integration

In the MARCEDIT EDITOR if you have set this up right you’ll see an Alma option (or whatever you called your integration):

See my Alma option above.

Select Search and do your search

Results retrieved.

Download all items results.

Test of editing and changing a record

I have added these screenshots after getting questions from other customers.  They show selecting a record and then saving it.

Above shows one change made to the abstract. Click on the Alma menu item to resave. Note that it can be slow.

After clicking on save menu option you receive confirmation.

<