Tech Blog

Configure MarcEdit 7 to work with Alma (updated for MarcEdit 7.5.116, 12/17/2021)

These instructions are for setting up MarcEdit 7 to integrate with your PRODUCTION Alma. It is highly recommended that you configure MarcEdit to work against your SANDBOX environment to begin with. I have indicated in the instructions where you would substitute sandbox values. Be careful!

I have indicated changes below for MarcEdit 7.5.116

STEP 1: Set up SRU integration profile in Alma

Use the instructions here to configure a SRU integration  profile. At a minimum, you must check the “Active” checkbox to activate the profile. 7.5.116: No change.

[Note: There have been exchanges on the MARCEDIT-L list about how retrieving holdings — an 852 — in your bib can create problems if you try to reload the bib without removing the holdings field: Alma will create a second holdings record. I would suggest that you use MarcEdit for bib record edits only, and use Alma’s native tools to manage your holdings records, unless you’ve done extensive testing. 7.5.116: I am not aware of any change in this behavior. ]

STEP 2: Get Alma API key

Use these instructions (https://developers.exlibrisgroup.com/alma/apis#defining) to obtain an API key. The application needs both the Bibs API and the Users API. On the API management tab, select Production read/write [If setting up against your Alma sandbox, choose Sandbox read/write]. Remember to save. 7.5.116: No change.

STEP 3: Configure MarcEdit

THESE INSTRUCTIONS HAVE BEEN UPDATED FOR MARCEDIT 7.5.116!

Open MarcEdit, and click on the little configuration gear

In the left column, click on “ILS Integration”

7.5.116: Check the “Enable ILS Options” box

7.5.116: Click “New”

7.5.116: “Name” is whatever you want to call it, e.g. “UConn Alma”

7.5.116: In the “Type” pulldown, selesct “Alma”

Host name for the ExLibris API gateway is https://api-na.hosted.exlibrisgroup.com/ (for North America; adjust as necessary)

Username is blank

“Alma Token” is your API key

Check “Ignore SSL Certificate Errors”

Check “Use Z39.50 Settings”

7.5.116: Click “Select Server Settings” under the checkbox. “Select ILS” popup opens. Click “Create New” and select “New SRU Server”; the “Database Properties” popup opens

  • Name is whatever you want to call it (e.g., Our Alma)
  • URL is https://<your base Alma URL>/view/sru/<YOURDATABASENAME (e.g., https://na02.alma.exlibrisgroup.com/view/sru/01UCT_STORRS) — if setting up against your Alma sandbox, use the sandbox’s base URL
  • Version is 1.2
  • 7.5.116: Metadata schema is marcxml (must be lowercase)
  • Search Profile is Custom

Custom Profile Settings are as follows:

  • Title Index: alma.title
  • Author Index: alma.creator
  • Subject Index: alma.subject
  • ISBN Index: alma.isbn
  • ISSN index: alma.issn
  • Record # Index: alma.source_record_id
  • Keyword Index: alma.all_for_ui

Click Save

7.5.116: Highlight the name of the “SRU Database Properties” for Alma and click “Select”

7.5.116: Click “Save” on the “ILS Profile Information” popup

7.5.116: On the “MarcEdit Preferences: ILS Integration” popup, under “Defined Profiles”, select the Alma one and click “Select” underneath, then “OK”

7.5.116: On the “Settings Have Been Saved” popup, click “OK”

You should be ready to search in MarcEdit using the Z39.50/SRU tool!!

Contact me if these instructions need revision or clarification: janice.christopher@uconn.edu

N.B. Terry Reese has almost all of this SRU configuration information here: http://marcedit.reeset.net/configuring-an-sru-server

8 Replies to “Configure MarcEdit 7 to work with Alma (updated for MarcEdit 7.5.116, 12/17/2021)”

  1. When configuring MarcEdit there was no dropdown menu to select the metadata schema from, marcxml had to be typed into the field in lowercase.

    By Duncan Wilson on June 5, 2018 at 09:54 AM

  2. Just seconding the lowercase marcxml requirement. If you leave it as MARCXML, then you get a:
    1.2 200805 Unsupported recordSchema MARCXML
    error.

    It also requires a configured SRU integration in either the sandbox or production environment with the Bib/Active box ticked in order to retrieve the bib record. Otherwise the search fails with no useful error message.

  3. When I check “Use Z39.50 Settings” or click “Edit” under this line, it is NOT “SRU Database Properties” popup opens but “Z39.50 Database Settings”. How can I find the “SRU Database Properties” configuration page?

  4. With the latest MarcEdit 7 update, I’m also encountering the problem Ling Jiang reports. Please update the instructions to account for the new interface.

  5. The key with the latest MarcEdit update, 7.2.105, is to create your SRU database using the “Z39.50/SRU Client” icon. Select the “Actions | Add New SRU Server” menu option, enter the values as specified in the body of this blog post, and “Save” the SRU Database. Then when you click “ILS Integration”, click the “Select” link and pick the SRU database you defined.

  6. I’m using MarcEdit 7.5.98. is the note above about 852 still a current issue? I was about to configure the integration to do remove 852 from some records.

Leave a Reply