Connecting ILLiad and Alma using Z39.50

Follow

These instructions explain how some ILLiad users have been successful in setting up a Z39.50 connection with Alma through the ILLiad Customization Manager, allowing you to easily search your library's holdings within the ILLiad client interface.

Configuring Alma to ILLiad requires entering a URL and API key in the Customization Manager in addition to setting up the Z39.50 connection.

The Z39.50 server settings for Alma do not come standard in the default installation of ILLiad and may not work for all Alma users.

Setting up the Z39.50 connection

  1. Login to your ILLiad Customization Manager.
  2. Click the Z39.50 ribbon located near the top of the Customization Manager window.
  3. From the Z39.50 ribbon click on the New button and select Other from the drop-down menu that appears. A form will appear in the content frame of the Customization Manager.
  4. The Connection section of the form consists of values specific to your library's Alma database installation, including server address, port, database name, username, and password. If you do not know these values, you should contact your Alma system administrator. You can name the connection whatever you like.
  5. The Searching section of the form should contain the following values. Remember to input these values directly into the form, do not copy and paste. ILLiad recognizes variations in the font that can affect the performance of your Z39.50 connection.

    System Number Search

    @attr 1=1016 "<#SystemNumber>"

    Title Search

    @attr 1=4 "<#Title>"

    Author Search

    @attr 1=1 "<#Author>"

    ISBN Search

    @attr 1=7 "<#ISBN>"

    ISSN Search

    @attr 1=8 "<#ISSN>"

    Date Search

     

    Keyword Author Search

    @attr 1=1 @attr 4=1 @attr 3=3

    Keyword Title Search

    @attr 1=4 @attr 4=1 @attr 3=3

  6. The Result Mapping section of the form should contain the following values. Remember to input these values directing into the form, do not copy and paste. ILLiad recognizes variations in the font that can affect the performance of your Z39.50 connection.

Type

Select XML from the drop-down menu

Identifier

holdingsAndCirc

Call Number

callNumber+enumAndChron

Location

localLocation+shelvingLocation+availability

Availability

availableNow

Availability Type

Regular Expression

Regular Expression

[1]

Available Type

Replace

Available Text

Available

Not Available Type

Replace

Not Available Text

Not Available

7. Once all values have been input click the Save button located in the Z39.50 ribbon at the top of the Customization Manager window. Make sure the connection is active by selecting it from the Select Server button also located in the Z39.50 ribbon of the Customization Manager window.

8. Your Z39.50 connection to Alma is now complete. If your ILLiad client is open, close and re-open for the changes to take effect.

Configuring the ILLiad API key in the Customization Manager

ExteranlUserIDMappingField.png

  1. In the Customization Manager under System | Integration | WebPlatformConfig, click New Record to create a new ILLiad API key for the Alma integration.
  2. A table will appear in the window, on the APIKey row, click the ellipses (ellipsis.png) to generate a new API key.
  3. Fill out the remaining information in the WebPlatformConfig table, then click Save

As of ILLiad version 8.7, you will also be required to fill out an ExternalUserIDMapping field. This field should include the external user ID for the consumer, Alma, of the API.

For additional information on creating a record in the WebPlatformConfig table, see Configuring the ILLiad Web Platform.

Additional configuration may be required on Alma's side such as supplying the BaseWebServiceURL or ExternalUserIDMapping username.

The Web Platform cannot be protected by a remote authentication filter like Shibboleth. The web platform must be publicly accessible since consuming applications like Alma that will not be able to bypass through the remote authentication.

 

 

 

Questions?

If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation:

Feedback