Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Restricting Access to Deep Search Plugins

    This information is not applicable to Primo VE environments. For more details on Primo VE configuration, see Primo VE.
    This functionality enables customers to prevent users that belong to specific user groups from searching restricted Primo Central collections, EBSCO, or any other restricted deep search plug-ins if defined. This may be necessary if a user group (for example, alumni who have user accounts and sign-in off campus) is not permitted access, but the institution as a whole is permitted access.
    This functionality requires customers to pass the user group from the PDS.


    If a signed-in user is not on campus, Primo will check to see if the user belongs to one of the restricted user groups defined in the User Groups with restricted access to PC/DS mapping table before sending a request to the deep search plug-in (such as Primo Central and EBSCO). If the user belongs to a restricted group, the user will not have access to restricted collections provided by the specified adaptor (PC, EBSCO, or any other defined deep search plug-in) unless the user is on campus.

    For customer-defined deep search plug-ins, additional configuration is required to use this functionality. For more information, see Deep Search on the Ex Libris Developer Network.

    Back Office Configuration

    The User Groups with restricted access to PC/DS mapping table defines the restricted user groups. In addition, the following codes in the Error Messages code table define the error messages that are displayed for searches in restricted collections:
    • – displays the following error message when the user is off campus and not signed in:
      You must be signed-in or on campus to search in this resource. Sign in
    • – displays the following error message when the user is signed and belongs to a restricted user group:
      You must be on campus to search in this resource.
    To restrict a user group:
    1. Configure the PDS so that it returns the restricted user groups in the bor_info response. For more information, see the Patron Directory Services Guide.
    2. Define the user group in the User Group code table, making sure that the code matches the user group returned by the PDS.
    3. Add the restricted user group to the new User Groups with restricted access to PC/DS mapping table under the Front End subsystem. This table contains the following columns and is defined at the institution level only:
      • Third Node Adaptor – Select the deep search plug-in that requires user group restrictions (such as PC, or EBSCO).
      • User group – Select the restricted user group (which is defined in the User Groups code table).
      You can create multiple rows per deep search plug-in.
    4. Deploy the All Code Tables and Mapping Tables (Front End labels and more) option on the Deploy All page.
    • Was this article helpful?