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

    Discovery Customer Settings

    For Alma-Summon environments, see Configuring Discovery Customer Settings.

    Return to menu

    Setting Discovery Customer Parameters

    The Discovery Customer Settings mapping table (Configuration Menu > Discovery > Other > Customer Settings) contains global settings that pertain to discovery. Each row of the table contains a parameter, which can be customized to change settings or enable/disable functionality.

    PVE_DiscoveryCustomerSettingsParameters.png

    Discovery Customer Settings Mapping Table

    Most of the linking templates for Central Index collections (CDI) are now configured in the Custom linking for Central Index databases mapping table (Configuration Menu > Discovery > Other > Custom linking for Central Index databases). For more details, see Configuring the Central Index Linking Templates for Primo VE.

    To customize a parameter:
    1. Select the Customize row option if you have not already done so. Otherwise, select the Edit row option.

      The following parameters are configurable:

      Discovery Customer Settings
      Parameter Key Description

      add_keywords_stemming_to_query

      When set to true, stemming is activated in queries to boost searches that return few results. The default setting is false. For more details, see Stemming.

      alphabetical_sort_pickup_inst_lib

      When set to true, the locations are listed alphabetically, starting with the available pickup locations in Get It.

      If the user is associated with specific campus in Alma, the campus appears first in the list of pickup locations, and all other locations are displayed after it in alphabetical order.

      Regardless of this setting, the user's associated campus appears first in the list of pickup locations.

      app_authorization_token

      The authorization token used to allow secured access between Primo VE and campusM. To complete the handshake, this same value must also be defined in campusM (App Manager> Product Integrations> Add Product Integration> Primo VE> Authorization Code). A valid token may contain any character except for whitespace (such as tabs, spaces, and line breaks) and must be at least 8 characters long (for example, q58151J4bD).

      For more information, see Integrating Primo VE with campusM.

      brief_results_journal_coverage

      When set to true, coverage information for electronic journals appears in the availability statement on the Brief Results page, reducing the need for users to view a journal's details to see the coverage information.

      broaden_availability_status

      When set to true, the system uses the enhanced availability statuses in the brief display of the search results instead of the Not available status: 

      • Not available - Acquisition
      • Not available - Claimed Returned
      • Not available - Hold Shelf
      • Not available - Loan
      • Not available - Lost
      • Not available - In Process
      • Not available - Missing
      • Not available - Resource Sharing Request
      • Not available - Technical - Migration
      • Not available - Transit
      • Not available - Requested

      The default value is false.

      You can use the Calculated Availability Text Labels code table (Configuration Menu > Discovery > Display Configuration > Labels) to customize or translate the display labels.

      cjk_segmentation

      This parameter configures the way that search strings with Chinese characters are divided into searchable tokens since words are not separated by spaces. The following search methods are supported:

      • OnegramWithBasis – ("A B C D") OR ("A B" "C D") OR (A B C D)

      • Basis – ("A B C D") OR ("A B" "C D")

      • Onegram – ("A B C D") OR (A B C D)

      db_results_by_institution_in_campus_view

      For multi-campus configurations, this parameter indicates whether the Database Search page displays results from the entire institution or the user's campus. When set to true, results are based on the entire institution. By default, this parameter is set to false so that results are based on the user's campus.

      Regardless of this setting, the category tree on the Database Search page displays categories at the institution level, not per campus.

      disable_link_for_empty_linking_parameter

      Disables links for empty linking parameter defined for Link to Request templates defined on the Discovery Import Profile page. For more details, see Configuring Import Profiles for Primo VE.

      disable_synonyms

      When set to true, this parameter disables the use of synonyms in search queries. By default, this parameter is set to false.

      For more information, see Linguistic Features for Primo VE.

      discovery_display_resource_sharing_when_electronic_available

      When set to false, resource sharing requests are enabled in the How to get it section on the record's Full Display page when the record has no electronic and physical holdings in the library.

      When set to true, resource sharing requests are enabled in the How to get it section on the record's Full Display page when the record has electronic holdings and no physical holdings in the library. If display logic rules in Alma prevent resource sharing requests, the How to get it section displays a message indicating that this item does not have any available services.

      discovery_facet_limit

      By default, facets in Primo VE return up to 20 facet values for local searches and up to 20 more facet values for CDI in blended searches. This parameter allows you to increase the maximum number of facet values to 50 for local searches only. The valid values are 20–50.

      CDI continues to display a maximum of 20 values in blended searches.

      display_856_in_the_holdings_as_viewit

      In order for a record to be considered as an online record, it should have electronic or digital inventory in Alma. Otherwise, the record is considered a print record by default. This functionality allows you to treat records with an 856 subfield u in the holdings as online records, even if they do not have electronic or digital inventory in Alma.

      This parameter configures the treatment of holdings records that have an 856 u field:

      • true – If the holdings record has an 8564 u field and the second indicator is not 2, the View It service appears and contains a link based on the 856 u field.

      • false – The View It service does not display for the holdings record, and these records are treated as physical items only.

      • IgnoreFirstIndicator – If the holdings record has an 856 u field and the second indicator is not 2, the View It service appears and contains a link based on the 856 u field.

      As a result, the availability status in brief display are displayed as Available online, and those records are included in the Available online facet.

      The online status and delivery are in addition to any physical availability indication.

      editions_eni_linking

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      enable_guest_user_for_dlr

      When set to true, display logic rules are applicable to guest users when service restrictions pertain to user groups.

      expanded_db_search

      When set to True (default value), searches on the Database Search page are expanded to match information in all fields instead of only the record's title.

      If you prefer searching by title only, set this parameter to false.

      For additional information, see Configuring Database Search for Primo VE.

      gale_linking

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      getit_group_by_library

      When set to true, the available libraries are listed in alphabetical order in Get It if there is more than one available library with holdings. Otherwise, Get It displays all available locations in alphabetical order as it does for the default setting.

      The default setting is false, which does not group locations by library.

      GetIT! Tab1 Labels code table (Configuration Menu > Discovery > Display Configuration > Labels) defines the Libraries group heading in Get It.

      holdings_fields_display_in_locations_list_view

      When set to true, holdings information displays in the location's brief display under Get It instead of having to open the location's full details. The default value is false.

      For more details about the configuration of holdings information, see Configuring Holdings Display Fields for Primo VE.

      ignore_ui_language_for_
      search_time_language_recognition

      This parameter allows you to disable language recognition during searches so that the same results are returned for every UI interface language.

      index_5XX_authorithy_fields

      When set to true, the system uses 5XX fields from your records to enrich the authority records. The default value is false.

      For new and updated records, this change is effective immediately, but for existing records, the change will not be completed until Ex Libris runs the next semi-annual indexing for Primo VE (see Release and Maintenance Schedule).

      infobase_linking

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      kanopy and kanopy_latest

      Kanopy is an on-demand streaming service that allows institutions to provide access to a large collection of films. During the activation of the these services, you must also configure the template that CDI uses to link users to these streams.

      To configure these templates, you must replace <INSTITUTIONID> with your site-specific base URL prefix.

      http://<INSTITUTIONID>.kanopystreaming.com/node/{{control/sourcerecordid}}

      For example, if the prefix for the University of Testing is unt, your template would look something like the following:

      http://unt.kanopystreaming.com/node/{{control/sourcerecordid}}

      max_holding_per_record

      In the Get It section of a record's full display, Primo VE displays a maximum of 10 holdings. If you set this parameter to a value from 11-100), the system displays the Show More Locations link under the list of holdings if there are more than 10 holdings. Users can select this link to view all the holdings. The valid values are 1-100.

      mendeley_application_id

      After you have registered your Primo VE server with the Mendeley application (see Registering Your Primo VE Institution), enter your Mendeley application ID to configure the connection between your Primo VE server and the Mendeley application.

      mendeley_redirect_uri

      After you have registered your Primo VE server with the Mendeley application (see Registering Your Primo VE Institution), enter the secret value for your Mendeley application to configure the connection between your Primo VE server and the Mendeley application.

      mendeley_secret

      After you have registered your Primo VE server with the Mendeley application (see Registering Your Primo VE Institution), enter the redirect URL for your Mendeley application to configure the connection between your Primo VE server and the Mendeley application. Use the following format for your Primo server: 

      <Primo_VE_host_name>/primaws/mendeleyPost?vid=<Primo_VE_view_code>

      For example:

      https://myInst.primo.exlibrisgroup.com/primaws/mendeleyPost?vid=01WRLC_INST:01WRLC_VIEW
       

      moazine_linking

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      naxos_jazz_library

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      naxos_music_library

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      naxos_spoken_word

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      naxos_video

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      nichigai_linking

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      number_of_representations_in_viewit

      The maximum number of representations that display by default in the View Online section of a record's full details. The default values is 5.

      If the number of representations exceeds this setting, the Show More button displays below the list of representations and allows users to view the remaining representations by selecting it.

      online_payment_link

      When set to true, the link to the WPM Education E-Pament System is enabled in My Library Card to allow patrons to pay fines and fees online. For more information, see Configuring the WPM Education E-Payment System.

      psychotherapynet_video_links

      Not used. For configuration information, see Configuring the Central Index Linking Templates for Primo VE.

      save_users_search_history

      When set to true, recent search suggestions are enabled for all your institution's views.

      show_recent_search

      When set to true, search history is saved between sessions and used for recent search suggestions. When set to false, existing search history is retained, but only current session entries are used for suggestions.

      At any time, end users can delete entries from the Search History by selecting the delete option.

      Syndetics_Unbound_Customer_ID

      Specify the license ID that was received during the registration of the Syndetics Unbound service. When this field is defined, you can enable this service at the view level (Configuration Menu > Discovery > Display Configuration > Configure Views).

      For more information regarding Syndetics Unbound, see Setting Up Syndetics Unbound in Primo VE.

      Use Controlled Vocabulary Search Expansion
      Select this field to enable controlled vocabulary search expansion. For more information, see Search Expansion With Controlled Vocabulary.

      use_facet_in_creator_hyperlink

      Out of the box, selecting the author's hypertext link in a record's details returns results based on the creator and the record's creator facets.

      PVE_CreatorDetails1.png

      Author Details on the Record's Full Display Page

      This parameter allows you to return all records associated with the selected creator and not filter by the record's creator facets. Out of the box, this functionality is disabled. The following values are valid:

      • true (default) – Indicates that the Author link includes the filter for the record's creator facets. For example: 

        https://myInst.alma.exlibrisgroup.com/discovery/search?
        query=creator%2Ccontains%2CRowling%2C%20J.%20K.%2CAND&tab=
        Online_Access&search_scope=Online_access&vid=PRIMO_OAP_INST%
        3AAlma&facet=creator%2Cexact%2CRowling%2C%20J.%20K.&lang=en&
        mode=advanced&offset=0

      • false – Indicates that the Author link excludes the filter for the record's creator facets. For example:

        https://myInst.alma.exlibrisgroup.com/discovery/search?query=creator%2Ccontains%2CRowling%2C%20J.%20K.%2CAND&tab=
        Online_Access&search_scope=Online_access&vid=PRIMO_OAP_INST%
        3AAlma&lang=en&mode=advanced&offset=0

      WestlawUK_linking

      Westlaw UK is an online legal information service. During the activation of this service,

      you must also configure the template that CDI uses to link users to this

      collection. To configure the template, replace <sponsorcode> with the sponsor

      code that is provided by Westlaw UK:

      http://login.westlaw.co.uk/maf/wluk/ext/app/document?crumb-
      action=reset&docguid={{control/sourceid}}&sp=<sponsorcode>
    2. Enter a value in the parameter value field.

    3. Click Save to save your changes to the table.

    Search Expansion with Controlled Vocabulary

    The Controlled Vocabulary service is an external Primo service (similar to AutoComplete) that expands user searches with words and phrases that constitute variations of the search term with the same meaning, thereby increasing the accuracy of the users' searches. This service is similar to the expansion with synonyms feature but is more robust. The expansions are visible on the screen and add, for example, variations of the search term with the same meaning (example ADHD and attention deficit disorder, or name variations such as assata shakur and asata shakur). Users are provided with an option to revert to using only their original search term. All customers see this expansion above the results in searches that include the CDI search scope or local search scopes. Over time, the controlled vocabulary repository are extended so that users see more expansions in their search results.

    For example, if the user enters heart attack in the query, Primo also returns results that include myocardial infarction. If the user is interested only in results that include heart attack, the user can select the link to the right of the recommendation.

    ControlledVocabulary_PrimoVE.png

    Vocabulary Expansion as Shown in a Simple Library Search within a CDI Scope

    If the query contains more than one term that can be expanded, the system expands only the longest term. For example, if a user searches for informatics heart attack, the system expands heart attack (12 characters), because it contains more characters than informatics (11 characters).

    • If the user's query contains Boolean operators (for example, heart attack AND surgery), the system does not provide an expansion for the term (for example, myocardial infarction is not included).

    • Regardless of the phrase's context, expansions are added.

    • Expansions are not usually bi-directional (for example, the term myocardial infarction is not expanded to the term heart attack).

    • This functionality is supported only for simple and advanced library searches within CDI scopes.

    • This functionality is disabled when search queries include Boolean operators or exact phrases.

    To enable this functionality, select the Use Controlled Vocabulary Search Expansion parameter.

    Additional Configuration Options

    Controlled vocabulary suggestions are realized through the Automatic Query Expansion feature in CDI, which utilizes mappings adopted from various controlled vocabularies including LCSH (Library of Congress Subject Headings) and MeSH (Medical Subject Headings). In general, CDI suggestions are more conservative. CDI maintains a curated synonym list that is regularly updated. Requests to add new controlled vocabulary terms are welcomed and evaluated on a case-by-case basis.

    The following codes in the Results Tile Labels code table allow you to modify or translate the labels for this service:

    • nui.results.controlVocabulary.includingIncluding {{equivalentTerm}}.
    • nui.results.controlVocabulary.searchOnlyJust search {{query}}