Skip to main content
ExLibris

Knowledge Assistant

BETA
 
  • Subscribe by RSS
  • Back
    Leganto

     

    Ex Libris Knowledge Center
    1. Search site
      Go back to previous article
      1. Sign in
        • Sign in
        • Forgot password
    1. Home
    2. Leganto
    3. Product Documentation
    4. Leganto Online Help (English)
    5. Leganto Administration Guide
    6. Configuring Leganto UI Elements
    7. Configuring Other Services for Leganto

    Configuring Other Services for Leganto

    1. Last updated
    2. Save as PDF
    3. Share
      1. Share
      2. Tweet
      3. Share
    1. Configuring When the Instructor Role is Automatically Added to a User
    2. Configuring Syndetics Unbound (Classic UI)
    3. Configuring Recommendation Services
    4. Enabling and Configuring RefWorks
    5. Enabling the Rialto Search Scope
    6. Enabling Google Preview
    7. Enabling Google Analytics (Classic UI)
    8. Enabling Mendeley
    9. Configuring the Display of British CLA Copyright Information
    10. Configuring Useful Links
    11. Enabling General Electronic Services in Leganto
    12. Enabling Third Iron's LibKey Functionality
    13. Link to a Digitized Version of an Item in HathiTrust (Classic UI)
    14. Student Success Measurements
    15. Integrating with Caliper Analytics
    Translatable
    See also Configuring Leganto Integration Profiles, Integrating with the UK's Digital Content Store (DCS), and Integrating Leganto with the Copyright Clearance Center (CCC).
    Some external services used by Leganto are configured using Alma, such as LDAP and email. See Alma Administration for details.
    Other external services are configurable by the user in Leganto and do not require any specific administration by a Leganto administrator, including:
    • Analytics
    • Zotero citation manager
    • any others that appear in Leganto but are not listed in this guide
    The parameters ebook_central_secret and ebook_central_siteID on the Leganto Customer Settings page (Configuration Menu > Leganto > General > External Integrations) are reserved for future use.

    Configuring When the Instructor Role is Automatically Added to a User

    To enable or disable adding the instructor role to users loaded by the course loading integration profile, see Configuring Course Loading.
    Alma automatically assigns the Instructor role to users that are added as collaborators to a list, either manually in Alma or using the course loading integration profile. In Leganto, only users that already have the Instructor role can be added to a list.
    You can have Alma automatically add the Instructor role to users it identifies as instructors who log in from the CMS (LTI checks the roles parameter for "instructor"). See Mapping CMS Roles to Instructors in Leganto.

    Configuring Syndetics Unbound (Classic UI)

    You can enable Syndetics Unbound sections in Leganto by providing a syndetics ID number in the syndetics_id parameter value field (Configuration Menu > Leganto > External Integrations).
    URM-125192_1.png
    Enabling the Syndetics ID Feature
    When enabled, you can access and configure your section settings from the Syndetics Unbound mapping table (Configuration Menu > Leganto > Features > Syndetics Unbound).

    The Syndetics Unbound sections can be configured from the mapping table.

    URM-125192_5.png

    Syndetics Unbound Section Flags
    Turning sections off from the Syndetics Unbound platform hides them from the Leganto UI. Because the Syndetics Unbound platform settings overrides all Leganto settings, these sections will be hidden even if enabled in Leganto. These sections can only be enabled in Leganto if they are turned on from the Syndetics Unbound platform.

    Configuring Recommendation Services

    You can enable recommendation services in Leganto. For the bX Recommender Service, you also need a bX token from Ex Libris. List recommendations appear in the right pane beside the list; citation recommendations appear at the bottom of each citation or item page. Recommendations only appear for owners or collaborators of a reading list.
    To enable recommendation services in Leganto:
    On the Leganto Features page (Configuration Menu > Leganto > Features > Leganto Features), enter one or more values for recommendations. Separate multiple values by commas.
    • bX Recommendation Service (citation): bx. You must also set the bx_token parameter (Configuration Menu > Leganto > General > External Integration > BX_Token) to the token supplied by Ex Libris.
    • Video recommendations from Primo Central and Alexander Street Press (list): video. (Classic UI)
      Alexander Street Press is not supported for Summon customers.
    • Shelf recommendations (citation): shelf_browsing. This recommends other titles that are physically located on the same or adjacent shelves near the citation.

    Enabling and Configuring RefWorks

    You can enable RefWorks so that instructors can add citations to reading lists and/or Collection in Leganto. You can also enable instructors to select whether they are using new or old RefWorks.
    When enabled, students can export to RefWorks.
    To enable Leganto users to use SSO authentication with RefWorks:
    On the Leganto Customer Setting page (Configuration Menu > Leganto > General > External Integrations), set the parameter refworks_sso to true for end users to use the SSO authentication method. If either field is empty, end users see the regular RefWorks authentication.
    The following RefWorks settings are configured in Alma (Configuration Menu > Leganto > General > Labels):
    Code Description
    refworks.export.invalidCredentials Displays a message when invalid credentials have been entered.
    citation.exportToRefworks.falied Displays a message when a citation was not successfully exported to RefWorks.
    citation.exportToRefworks.succeeded Displays a message when a citation was successfully exported to RefWorks.
    refworks.folder.name.references Displays Citations as title of the automatically created destination folder for exported citations.
    list.exportToRefworks.falied Displays a message when a list was not successfully exported to RefWorks.
    list.exportToRefworks.succeeded Displays a message when a list was successfully exported to RefWorks.
    refworks.folder.name.reading.list Displays New Reading Lists as the title of the automatically created destination folder for exported reading lists.
    section.exportToRefworks.failed Displays a message when a section was not successfully exported to RefWorks.
    section.exportToRefworks.succeeded Displays a message when a section was successfully exported to RefWorks.

    Enabling the Rialto Search Scope

    You can enable the Rialto search scope so that librarians can search and add Rialto items to reading lists from within Leganto. This is done using the display_rialto_search parameter in the Leganto Features table (Configuration Menu > Leganto > Features > Leganto Features). 
    Display_Rialto_Search parameter.png
    Enabling Rialto Search Scope Item

    The following values may be entered for the parameter:

    • all - enables the Rialto searches for librarians and instructors

    • librarians - enables the Rialto search only for librarians

    • blank - disables the Rialto search

    When using the Rialto search scope, Leganto does not perform a resource locate.

    Enabling Google Preview

    You can enable Google Book Preview for citations.
    To enable Google Books Preview in Leganto:
    On the Leganto Features page (Configuration Menu > Leganto > Features > Leganto Features), set the parameter google_book_preview to true.

    Enabling Google Analytics (Classic UI)

    You can integrate Leganto with Google Analytics. Activity in Leganto is then tracked by Google Analytics. Leganto's product team views anonymized Google Analytics data about your institution’s users' usage in order to help them improve the Leganto UX; you can disable this feature.
    To integrate Leganto with Google Analytics:
    On the Leganto Customer Setting page (Configuration Menu > Leganto > General > External Integrations), enter your Google Analytics ID in the parameter google_analytic_id or google_ga4_id (for users using GA4). To prevent Leganto's product team from viewing anonymized Google Analytics data about your institution’s users' usage, set google_analytics_exlibris to false.

    More Leganto events appear in Google Analytics, including more actions performed in Leganto, distinguished between instructor and student.

    access_rights_and_license.png

    Google Analytics

    The events include:

    • Instructor - Add student discussion message
    • Instructor – Publish list
    • Instructor – Unpublish list
    • Instructor – Duplicate list
    • Instructor - View list as student
    • Instructor - Send list
    • Instructor - Add library discussion
    • Instructor – View List Advisor
    • Instructor – Add Creative Commons license to list
    • Instructor - Add tags
    • Instructor - Add public note
    • Instructor - Add private note
    • Instructor - Add due date
    • Instructor – View citation details
    • Instructor - Mark as read
    • Instructor - Filter list by tags
    • Instructor – Filter list by types
    • Instructor - Filter list by sections
    • Instructor - Filter list by other
    • Instructor - View link
    • Instructor – Download
    • Instructor – Like
    • Instructor - Disable List Advisor tips
    • Instructor - View the CiteIt! dialog box
    • Instructor – Drag CiteIt! button
    • Instructor - View Find Lists
    • Instructor - View Report tab
    • Student - Add student discussion message
    • Student - Add private note
    • Student – View citation details
    • Student - Mark as read
    • Student - Filter list by tags
    • Student – Filter the list by type
    • Student - Filter the list by section
    • Student - Filter the list by others
    • Student - View link
    • Student - Download
    • Student - Like
    • Student - View the CiteIt! dialog box
    • Student - Drag CiteIt!button
    • Student - View Find Lists

    Enabling Mendeley

    You can enable Mendeley, so that instructors and students add citations to reading lists and/or My Collection in Leganto.
    To enable Mendeley in Leganto:
    On the Leganto Customer Setting page (Configuration Menu > Leganto > General > External Integrations), set the parameters mendeley_client_id and mendeley_secret. After setting the parameters on the Leganto side, you need to configure the Mendeley app. For more information, see Mendeley in the developer's network documentation.

    Configuring the Display of British CLA Copyright Information

    CLA information appears in Leganto when the parameter copyright_region is set to UK, see Configuring Other Settings. Also see Integrating with the UK's Digital Content Store (DCS).
    To configure whether to display British copyright information (CLA) in a citation, when available:
    • Configure the customer parameter CLA_info_in_leganto to true or false (Configuration Menu > Leganto > Features > Leganto Features).

      Create a digitization request.

      Digitization request

    Configuring Useful Links

    On the Leganto Links mapping table (Configuration Menu > Leganto > Features > Links), you can configure a static list of links that appear in Leganto.
    Leganto Links Mapping Table.png
    Leganto Links Mapping Table
    You can add and remove links. For more information about mapping tables, see Mapping Tables.
    The maximum length for a label is 200 characters. While there is no limit to the number of links you can add, in order not to disrupt the layout on the Leganto screen, a limit of around seven is suggested.
    The Label that appears in the UI can be translated using the Customer Labels code table, as explained here.
    You can select which users can view your custom links by selecting All, Patron, or Staff from the Visibility dropdown list

    Enabling General Electronic Services in Leganto

    You enable general electronic services to appear in Leganto the same as they do in Primo. For more information see Adding a General Electronic Service and Configuring the Order of General Electronic Services.
    To enable general electronic services in Leganto:
    1. Set the customer parameter general_electronic_services to true (Configuration Menu > Leganto > Features > Leganto Features).
    2. Open the General Electronic Services Configuration page (Configuration Menu > Fulfillment > Discovery Interface Display Logic > General Electronic Services) and select Add Service.
    3. Set Is this a Document Delivery/ILL service to Yes.
    4. Set the Display Location to Viewit & How To Getit or Getit, viewit & How To Getit.

    The option to add a service.

    Add service

    (New UI) When configured, the links are displayed on the Links & availability tab.

    General Electronic Services links.

    General Electronic Services links

    Enabling Third Iron's LibKey Functionality

    Third Iron's LibKey functionality is enabled by inserting Third Iron's LibKey API key and Client ID into the browzine_api_key and browzine_client_id parameters found in the External Integrations table (Configuration Menu > Leganto > General > External Integrations).
    For citations that have a DOI, check Third Iron's LibKey whether it is supported. If supported, a new Download Article link is displayed in the classic UI and a Read article link is displayed in the new UI.

    BrowZine Flags Added to Configuration Only BrowZine Defined.png

    Citation Brief Display when Third Iron's LibKey Configured and a DOI Exists
    The option to read an article from the brief view.
    Read article from brief view
    When a Third Iron's LibKey link is displayed and the citation is attached with a file, the standard Download link will be renamed Download Attachment.
    The following figure shows the standard Download link.
    Standard Download Link.png
    Standard Download Link
    The following figure shows the Download link after being renamed Download Attachment.
    BrowZine Flags Added to Configuration Mapping.png
    Citation Brief Display when Third Iron's LibKey is configured, a DOI exists, and a File is uploaded
    The following figure shows a citation's full display when Third Iron's LibKey is configured, a DOI exists, and a file has been uploaded to the reading list.
    BrowZine Flags Added to Configuration Mapping Not Defined.png
    Citation Brief Display when Third Iron's LibKey is configured, a DOI exists, and a File is uploaded
    If you subscribe to the LibKey service and want to enable this feature, please contact Third Iron support to receive your Library ID and API Key, which then can be configured in Alma.

    Link to a Digitized Version of an Item in HathiTrust (Classic UI)

    A link to a digitized version of an item on HathiTrust is displayed on a Leganto citation, when relevant.
    Link to a Digitized Version of an Item in HathiTrust.
    HathiTrust link displayed on citation

    The HathiTrust link is displayed under the following conditions:

    • The citation has an OCLC Number value.
    • A digitized version of the item is available in HathiTrust.
      HathiTrust Link Displayed for Citations with OCLC Number Value.
      HathiTrust Link Displayed for Citations with OCLC Number Value

    This functionality is based on the Primo plugin developed by the University of Minnesota.

    To activate this functionality, set the display_hathitrust_availability parameter value (Configuration Menu > Leganto > Leganto Features) to true.

    Parameter Value for Displaying the Link to HathiTrust Set to True.png
    Parameter value for displaying the link to HathiTrust set to true

    If you are a HathiTrust partner institution and want the link to HathiTrust to use HathiTrust's automatic login, set the parameter value to your SAML IDP entity ID instead of true.

    The entity ID can either be a string, such as urn:mace:incommon:umn.edu, or it can be a URL, such as https://shibboleth.xxx.edu/idp/shibboleth.

    If you are not a Hathitrust member and the display_hathitrust_availability parameter is turned on, then in the Leganto Features table (Leganto Configuration > Features > Leganto Features) you need to turn the new display_hathitrust_ignore_copyright parameter off to restrict your access to copyrighted Hathitrust materials.

    Display Hathitrust Ignore Copyright.png

    Student Success Measurements

    Your institution can opt to save usage statistics for individual students, which is viewable in Leganto by instructors, as well as collect analytics on individual student engagement with the reading list in the analytics engine. Librarians can view this data in Alma's analytics. For more information on the analytics engine, see Leganto Student Usage.

    To opt in, the institution must sign the LEGANTO STUDENT SUCCESS MEASUREMENTS SERVICE Opt In form and send it to the Ex Libris support. Once the form is received, our support team enables this feature in our backend. You then receive an opt-in notice explaining the basic terms of this service. See Data Subject Rights for Leganto for information pertaining to your data subject rights.

    Once the feature is turned on by our support team, the unique identifier of each user is stored along with the existing data in Leganto's analytics engine (see Leganto Student Usage). Historical data is kept anonymized, and only new student usage is tracked per unique identifier.

    To enable usage statistics in Leganto, configure the list_analysis_student_usage parameter (Configuration > Leganto > Features > Leganto Features). The instructor can then select Per student in the list Analytics to view the usage data per student. 

    The View Lists Analysis Usage per Student report.

    View Lists Analysis - Per student

    The instructor only sees the tab list if both list_analysis and list_analysis_student_usage parameters are enabled in the Leganto Features table. If only the list_analysis parameter is configured, then selecting the View lists analysis icon activates the Cumulative Usage function. If only the list_analysis_student_usage parameter is configured, then selecting the View lists analysis icon opens the Usage per Student display.

    If Usage per Student is selected, then the Usage Per Student display opens with the following statistics per student:

    The Usage per Student report.

    Usage per Student
    • # of full text views of citations
    • # of likes on citations
    • # of citations marked as Done

    You can filter the usage by section and by citation.

    Once the Usage Per Student feature is enabled for the institution, any student has the right to be forgotten (according to GDPR guidelines). This means they can ask to delete their individual data. For this, the student needs to contact the library staff at the institution, who can then select Remove Leganto usage in the user screen in Alma:

    The option to Remove Leganto usage information.
    Remove Leganto usage

    Any user with a Patron role has this checkbox, but the Usage for Student is only recorded on actions that can be performed by students. Once this checkbox is checked, data is no longer collected on the student, and all past data on them is erased.

    If your institution opted into the service, you can open a support ticket with Ex Libris to opt out of it.

    Watch the Leganto Student Success Measurements video (1:25 minutes).

    Integrating with Caliper Analytics

    Caliper Analytics enables institutions to collect learning data from digital resources to better understand and visualize learning activity and product usage date. The data is then presented to students, instructors, and advisors effectively by providing the following information:

    • Student recruitment and retention plans
    • Program, curriculum, and course design
    • Student intervention measures

    To enable Caliper Analytics:

    Configure caliper_endpoint (Configuration > Leganto > General > External Integrations) with your Caliper domain and caliper_token with your Caliper token for performing API requests (example: bf2a8619a98965e0a1a9d9eba86aa7). The events are then available for the student profile for the following:

    • View list
    • Citation
    • Link

    The extracted data can be used for predicting student success.

    View article in the Exlibris Knowledge Center
    1. Back to top
      • Configuring Leganto UI Elements
      • Clearing Copyrights Through the Copyright Clearance Center (CCC)
    • Was this article helpful?

    Recommended articles

    1. Article type
      Topic
      Content Type
      Documentation
      Language
      English
      Product
      Leganto
    2. Tags
      This page has no tags.
    1. © Copyright 2025 Ex Libris Knowledge Center
    2. Powered by CXone Expert ®
    • Term of Use
    • Privacy Policy
    • Contact Us
    2025 Ex Libris. All rights reserved