Skip to main content
ExLibris
  • Subscribe by RSS
  •  

    Ex Libris Knowledge Center

    Summon: Administration Console: Integrating Springshare's Database APIs in Summon

    • Product: Summon

    How do I integrate Springshare's LibAnswers and LibGuides APIs in the Summon service?

    This is part of a larger set of documentation about using the Administration Console to configure your Summon service.

    The Recommender > Springshare page in the Administration Console allows you to integrate Springshare's LibAnswers content and A-Z Database Search widget in Summon. This page contains the following configuration sections:

    For information on how to integrate Springshare's LibChat API, see Summon: Administration Console: Chat Widgets

    Summon_RecommenderSettings_SpringsharePage2.png
    Springshare Page

    LibAnswers Settings

    This functionality allows you to harvest your FAQs from Springshare LibAnswers and import them into Best Bets automatically so that they can be shared with users in the Summon UI.

    Because harvesting does not replace any duplicate FAQs that may have been manually or automatically added to Best Bets, it is recommended that you perform a bulk delete of any duplicates in Best Bets after harvesting records from LibAnswers.

    If a LibAnwsers record exceeds the following size limitations, it will not be imported:

    • Question (title): 80 characters

    • Answer (description): 1000 characters (note that this includes possible HTML markup characters)

    • Tag (topic): 50 characters

    To harvest and load LibAnswers content into Best Bets:
    1. In the LibAnswers Settings section, specify the following fields, which are provided during the registration of the LibAnswers API for your library:

      • API URL – Specify the URL of your LibAnswers API.

      • Client ID – Specify the Client ID.

      • Client secret key – Specify the secret key for your client.

    2. Select Test credentials to see that you can access the LibAnswers service.

    3. Select Harvest LibAnswers. Depending on the number of FAQs, this may take up to a few minutes. The summary of the harvest will appear at the bottom of this section. For example:

      SMN_FAQ_HarvestErrors.png

      Partially Successful Harvest

      To enable the Harvest LibAnswers button, you must test your credentials.

    4. If you have not already done so and you want to save your credentials for another session, select Save settings.

    5. Check the imported records in Best Bets to make sure that there are not any duplicates. For more information, see Summon: Administration Console: Best Bets.

      SMN_FAQ_BestBets.png

      Example of a Harvested FAQ in Best Bets
    6. Select Save settings 

    A-Z Database Settings

    The Database Finder widget utilizes Springshare's A-Z List to allow users to search for databases in which your library has an active subscription.

    SMN_DatabaseFinder1.png

    Database Finder Widget in Summon UI

    After saving the API URL and access details for your library, it may up to 24 hours until the database recommendations are searchable in Summon since the Springshare API is run automatically every day. You can use the A-Z Database Search Tester to determine whether the search widget is ready to be enabled in Summon.

    To enable the A-Z Database Search widget in the Summon UI:
    1. In the A-Z Databases Settings section, specify the following fields, which are provided during the registration of the LibGuides API:

      • API URL – Specify the URL of your LibGuides API.

      • Client ID – Specify the Client ID.

      • Client secret key – Specify the secret key for your client.

      • AZ Widget Browse URL – (Optional) If you have created a page in Springshare that allows users to browse databases by subject, specify its URL. When configured, its link will appear at the bottom of the Database Finder widget as follows to provide another method for users to find the databases: Or click here to browse by subject.

      • AZ Widget Proxy URL – (Optional) If links for A-Z database results require a proxy, enter the the proxy URL, making sure that it ends with ?url=. For example: https://myproxy.institution.com/?url=

    2. Select Test credentials to see that you can access the LibGuides API.

    3. Select Save settings

    4. After 24 hours have passed, execute the A-Z Database Search Tester to see that you can retrieve databases from the API.

    5. If you are satisfied with your tests, specify the following fields to make this functionality visible to end users:

      • Show Search Widget – Set to On to enable the Database Finder widget in the Summon UI.

      • Enable A-Z database search for every Summon query – Set to On if you want to run the Database Finder widget automatically for users when they perform a search in Summon. To use this option, you must set the Show Search Widget field to On.

    6. Select Save settings

    A-Z Database Search Tester

    After you have added or modified your A-Z Database settings, it may take up to two days before the settings take effect. You can use this tool to make sure that the A-Z Database Search is working as expected.

    To test the A-Z Database Search:
    1. In the A-Z Database Search Tester section, type a search query.

    2. Select Test search endpoint. For example:

      SMN_A-Z_DatabaseSearchTesterSuccessful.png

      Successful Test

    • Date Created: 4-Dec-2020
    • Last Edited Date: 16-Dec-2020
    • Old Article Number: N/A