In This Article

ILS Integration: Connect your ILS to LibApps

By connecting your integrated library system (ILS) to LibApps, you can take advantage of the following integrations -- with more to come in the future!

  • Pickup Manager: verify that a patron has holds ready for pickup when scheduling their pickup time. After entering their library ID/barcode and password on the secure LibCal booking page, Pickup Manager will check the ILS for holds that are ready to pick up for that patron. If holds are ready, the patron will proceed to selecting an available time slot. They'll also be able to see a list of holds they have to pick up, too!

To enable this integration, you must first add a connection to your ILS in LibApps. If you are not a LibApps admin user for your library, you will need to work with them and your ILS admin(s) to set this up. Currently, LibApps can connect with the following systems:

  • Ex Libris Alma
  • Innovative Interfaces Sierra
  • SirsiDynix Horizon & Symphony

If your ILS is not listed above, you also have the option of setting up a generic SIP2 connection with your ILS, if it supports the SIP2 protocol.

Springshare values the privacy of our users. To learn more about how we handle patron data, please see our privacy policy.

Access your ILS Integration settings

LibApps Admin users can access the ILS integration settings in LibApps by clicking on the Admin menu and selecting ILS Integration settings from the dropdown.

the ILS Integration option under the Admin menu

From here, you can add, edit, test, or delete your configuration. Please note that you can only have one ILS integration set up at a time.


Connect with Ex Libris Alma

Before you begin: to connect LibApps to your Alma system, you must have access to Alma's Web Services. Please contact Ex Libris if you need assistance obtaining your system's Region and an API Key, which are required for setting up the integration. The API Key must at least have read-write access to the Bibs and Users endpoints.
  1. On the Manage ILS Integration page, select Ex Libris Alma from the dropdown. Additional options will then appear on the page.

options for Ex Libris Alma

  1. Under Server Info & Parameters, select the geographic region for your Alma system from the Region dropdown.
  2. In the API Key field, enter your Alma API Key provided by Ex Libris.
  3. Click the Save Configuration button.

Connect with Innovative Sierra

Before you begin: to connect LibApps to your Sierra system, you must have access to the Sierra REST API. Please contact Innovative Interfaces if you need assistance obtaining your API URLKey, and Secret, which are required for setting up the integration.
  1. On the Manage ILS Integration page, select Innovative Sierra from the dropdown. Additional options will then appear on the page.

options for Innovative Sierra

  1. Under Server Info & Parameters, enter the URL for your Sierra REST API in the URL field. (Note: enter only the part of the URL before /v6, e.g., https://[your-domain].iii.com/iii/sierra-api.)
  2. In the Key field, enter the key for your Sierra REST API.
  3. In the Secret field, enter the secret for your Sierra REST API.
  4. Click the Save Configuration button.

Connect with SirsiDynix Horizon 

Before you begin: to connect LibApps to your Horizon system, you must have access to the Sirsi Horizon APIs. Please contact SirsiDynix if you need assistance obtaining your web services URL and client identifier, which are required for setting up the integration. You will also need to provide the username and password for a staff-level Horizon user account in order give your API full access to your Horizon system.
  1. On the Manage ILS Integration page, select SirsiDynix Horizon from the dropdown. Additional options will then appear on the page.

options for SirsiDynix Horizon

  1. Under Server Info & Parameters, enter the web services URL for your Horizon APIs in the Horizon Web Services URL field.
  2. In the Client Identifier field, enter your Horizon client identifier provided by Sirsi.
  3. In the Staff Username field, enter the username of the staff-level Horizon account to use for accessing the API.
  4. In the Staff Password field, enter the password of the staff-level Horizon account to use for accessing the API.
  5. Click the Save Configuration button.

Connect with SirsiDynix Symphony

Before you begin: to connect LibApps to your Symphony system, you must have access to the Sirsi Symphony APIs. Please contact SirsiDynix if you need assistance obtaining your web services URL and client identifier, which are required for setting up the integration. You will also need to provide the username and password for a staff-level Symphony user account in order give your API full access to your Symphony system.
  1. On the Manage ILS Integration page, select SirsiDynix Symphony from the dropdown. Additional options will then appear on the page.

options for SirsiDynix Symphony

  1. Under Server Info & Parameters, enter the web services URL for your Symphony APIs in the Symphony Web Services URL field.
  2. In the Client Identifier field, enter your Symphony client identifier provided by Sirsi.
  3. In the Staff Username field, enter the username of the staff-level Symphony account to use for accessing the API.
  4. In the Staff Password field, enter the password of the staff-level Symphony account to use for accessing the API.
  5. Click the Save Configuration button.

Connect using the SIP2 protocol

Before you begin: your ILS must support connections using the SIP2 protocol. Please contact your ILS vendor if you need assistance. If SIP2 is supported by your ILS, you will need to obtain the host name and port number for opening a SIP2 connection to your ILS. The port number you provide must be opened to your LibApps domain name (i.e. [your-library-name].libapps.com). If required by your ILS, you may also need to provide the username & password for a staff-level ILS user account and/or a location code.
  1. On the Manage ILS Integration page, select SIP2 from the dropdown. Additional options will then appear on the page.

options for SIP2 connections

  1. Under Server Info & Parameters, enter the host name for your ILS in the Host field.
  2. In the Port field, enter the port number your ILS uses for SIP2 connections. This port must be opened to your LibApps domain name (i.e. [your-library-name].libapps.com) in order to allow connections.
  3. In the SIP2 Username field, enter the username of the staff-level account to use for accessing your ILS.
  4. In the SIP2 Password field, enter the password of the staff-level account to use for accessing your ILS.
  5. If a location code is required by your ILS for SIP2 connections, enter it in the Location Code field.
  6. Click the Save Configuration button.

Test your configuration

After saving or modifying your ILS configuration, we recommend that you test retrieving contacts and holds. This allows you to confirm that LibApps is able to successfully connect to your ILS and retrieve contact and hold data.

  1. On the Manage ILS Configuration page, enter the card number and PIN (i.e. username & password) for a patron account in the Test This Configuration panel.

the Card Number and PIN fields

  1. Click the Test Contact Retrieval button. If LibApps was successfully able to retrieve account information about the patron, it will display below the button in green. Otherwise, an error message will display in red.

the Test Contact Retrieval button

  1. Click the Test Hold Retrieval button. If LibApps was successfully able to retrieve holds information for the patron, it will display below the button in green. Otherwise, an error message will display in red.
    • If the account is valid and has holds, they will be listed. For each, you'll see its Title, Author, Location, and Expiration.
    • If the account is valid but has no holds, a "No holds." message will display.

the Test Hold Retrieval button

If the contact or holds retrieval fails, ensure that you are entering a valid library ID and password, then try again. Otherwise, work with your ILS admin and vendor to ensure that your ILS is allowing the necessary access for your API, web services, or SIP2 services. If you are still having issues, contact the Springy Support team.

Delete your configuration

To disconnect LibApps from your ILS, click the Delete button at the bottom of the Manage ILS Integration page. This will remove the configuration information from LibApps and prevent apps such as Pickup Manager from connecting to your ILS. To reconnect to your ILS, you can return to this page at any time and set up a new configuration.

the Delete button

Related Articles