Additional Library Search - Custom set-up Instructions

Additional Library Search seamlessly brings your library to your patrons' workflow, displaying your discovery layer alongside Google or Google Scholar search results. If your discovery system is not listed here, then you will need to set up a custom Additional Library Search configuration in the dashboard.

Prerequisites

Additional Library Search connects with your custom knowledgebase over HTTP protocol, using the GET method. Setting this up will require input from your team. To complete this task, you will need to:

• Ensure your knowledgebase has a search endpoint route with responses that return data in either XML or JSON response types in the format documented below.

Preparing your links

The first step of setting up this integration is to format the endpoint route for your dashboard settings. An example of endpoint route example is as follow. The parameter [search_query] will be replaced with the actual search query.

https://your-endpoint.com/api/?q=[search_query]

Response Type and Tags

An example of JSON response

{
  "results": {
    "view_more_url": "https://your-endpoint.com/search?q=[search_query]",
    "view_more_documents_url": "https://your-endpoint.com/search?q=[search_query]&type=documents",
    "view_more_people_url": "https://your-endpoint.com/search?q=[search_query]&type=people",
    "result_set": [
      {
        "result_type": "document",
        "result_url": "https://your-endpoint.com/test-document",
        "result_title": "Test document",
        "result_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
      },
      {
        "result_type": "document",
        "result_url": "https://your-endpoint.com/test-document",
        "result_title": "Test document",
        "result_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
      }
    ]
  }
}

An example of XML response

  https://your-endpoint.com/search?q=[search_query]
  https://your-endpoint.com/search?q=[search_query]&type=people
  https://your-endpoint.com/search?q=[search_query]&type=docs
  
    document
    https://your-endpoint.com/test-document
    Test document
    Lorem ipsum dolor sit amet, consectetur adipiscing elit
  
  
    person
    https://your-endpoint.com/test-person
    Test person
    Lorem ipsum dolor sit amet, consectetur adipiscing elit
  

Tags

• view_more_url mandatory: The URL of your discovery layer where the user can perform a manual search with the search query parameters

• view_more_people_url optional: The URL of your site the user can perform a manual search with the search query parameters , but this link will search people en_als_custom_info_omitted

• view_more_documents_url optional: The URL of your site the user can perform a manual search with the search query parameters , but this link will search documents only. If ommited, the view_more_url will be used en_als_custom_info_omitted

• results_type mandatory: Supported values: document or person

• result_url mandatory: The page URL of the person/document

• result_title mandatory: The name of the person or the title of the document

• result_description optional: Something about the person or the description of the document

Dashboard Set-Up

Once you have set these up, please go to the Lean Library dashboard:

1. Go to Lean Library Futures
2. Click on Additional Library Search, then Add New
3. Fill in the Name of your library discovery
4. Choose Custom as your Source Type
5. Choose the Search Engine you want the Additional Library Search widget to appear on
6. Insert your endpoint route in Source URL
7. Choose the Resource Type, XML or JSON

After you have saved the settings, the Additional Library Search widget should appear on the Search Engine (Google or Google Scholar) within 24 hours. 

If you have any questions about the process, please open a ticket at support@leanlibrary.com.