I Didn't Know You Could Do That in Alma!

Introduction

MarcEdit with Alma SRU Integration lets library staff connect MarcEdit — a tool used to edit and manage library records — directly to the Alma library system.

With this connection in place, staff can:

✅ Search Alma’s catalog records from inside MarcEdit

✅ Pull records into MarcEdit for cleanup or edits

✅ Send updated records back into Alma without extra steps

To make this work, Alma must be set up with an SRU integration profile that allows outside tools like MarcEdit to search its records. MarcEdit also needs permission (through an API key) and the correct connection settings. Once everything is set up, staff can work more smoothly between the two systems, saving time and reducing manual work.

Instructions

If you have a Mac computer, you must first install Homebrew and Yaz. See MarcEdit Mac: Enabling Z39.50 Support for instructions.

Generate an API key

1. Sign in to the Ex Libris Developer Network.

2. Go to the Build / My APIs tab.

3. Go to Manage Keys.

4. Click Add API Key.

5. Use the following parameters:

   1. Name: Use the school's two-digit code and a short description of the purpose of the API Key (e.g., NZ SRU MarcEdit integration).

   2. Description: Indicate who created the API key (e.g., Created by Kristen Fredericksen (OLS)).

   3. Click Add Permission.

      1. Bibs Production Read/Write

      2. Users Production Read/Write

6. Click Save.

Test the MarcEdit API key

A successful test will return an XML response in your browser or tool, showing bibliographic record details (for the bibs) or a user list (for the users); if you see an error or empty result, double-check the MMS ID or API key.

1. For a single bibliographic record: https://api-na.hosted.exlibrisgroup.com/almaws/v1/bibs/[MMS_ID]?apikey=[API_KEY]

   1. Replace [MMS_ID] with the actual MMS ID (remove the brackets).

   2. Replace [API_KEY] with your actual API key (remove the brackets).

2. For a list of users (limited to 10): https://api-na.hosted.exlibrisgroup.com/almaws/v1/users?limit=10&offset=0&order_by=last_name%2C%20first_name%2C%20primary_id&apikey=[API_KEY]

   1. Replace [API_KEY] with your actual API key (remove the brackets).

Create an SRU integration profile

1. In Alma, go to Configuration > General > "External Systems" > Integration Profiles.

2. Click Add Integration Profile.

3. Configure the "General Information" section with the following parameters:

   1. Code: Use a brief code (e.g., SRU_ME).

   2. Name: Write a brief indication of the integration profile (e.g., SRU for MarcEdit).

   3. Integration Type: SRU Server.

   4. Description: Write a longer indication of the integration profile and its purpose (e.g., The settings in this integration profile are for the search and retrieval of bibliographic records from the Network Zone via the MarcEdit client.).

4. Select Next.

5. Configure the "Actions" section with the following parameters:

   1. BIBLIOGRAPHIC OPTIONS

      1. Active: check this box.

      2. Add Availability: check this box.

      3. Enrich with Members Availability: check this box.

      4. Add Representations Information: check this box only if the institution has digital inventory.

      5. Add Remote Representations Information: check this box only if the institution has digital inventory.

      6. Apply Normalization: do not check this box.

      7. Username: leave blank.

      8. Password: leave blank.

      9. Suppress record/s from external search: check this box only if you want to exclude suppressed records.

      10. Click Test SRU to make sure it works properly. A successful test will return an XML response in your browser.

   2. HOLDING OPTIONS (ISO 20775)

      1. Active: check this box.

      2. Availability Calculation Options:

         1. Exclude Items Not On Shelf: do not check this box.

         2. Exclude Items Not Requestable For Resource Sharing: do not check this box.

         3. Exclude Electronics and Digital Resources: do not check this box.

6. Click Save.

Configure ILS integration in MarcEdit

1. Click the Settings icon.

2. Go to the "ILS Integration" tab.

3. Check the box next to "Enable ILS Options."

4. Under “Profiles,” select Alma.

5. Enter the following information:

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

   2. Username: (leave blank)

   3. Password: paste the MarcEdit API key.

Find the ISIL code

The ISIL code should already be entered in Alma.

1. Go to Configuration > General > "Libraries" > Add a Library or Edit Library Information.

2. Copy the text in the “ISIL Code” field (e.g., US-ZCY).

If the ISIL code is not in Alma, search the WorldCat Registry.

Set up the SRU server in MarcEdit

1. Check the “Use Z39.50 Settings” box.

2. Select New SRU Database.

3. Enter the following information:

   1. Name: Choose something descriptive.

   2. URL: https://na07.alma.exlibrisgroup.com/view/sru/[institutioncode] (e.g., 01CUNY_AL)

   3. Version: 1.2

   4. Metadata Schema: MARCXML

   5. Search Profile: Custom

   6. Title Index: alma.title

   7. Author Index: alma.creator

   8. Subject Index: alma.subjects

   9. ISBN Index: alma.isbn

   10. ISSN Index: alma.issn

   11. Record # Index: alma.mms_id

   12. Keyword Index: alma.all_for_ui

4. Click Save.

5. Click Apply.

6. Click Close.

Verify the Alma menu

1. Open MarcEditor to confirm that the Alma menu is now available.

References

• Ex Libris Developer Network > Tech Blog > Setting up the Alma MARCEdit integration for Bib Records

• Ex Libris Knowledge Center > Alma > Product Documentation > Integrations with External Systems > Resource Management SRU/SRW Search

• MarcEdit > Configuring an SRU Server