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

    Resource Recommender

    The Resource Recommender service allows you to recommend the following resources based on searchable tags that you configure in the Primo Back Office: database, website, person, library information, library guide.
    When a user performs a search in which the query exactly matches the searchable tag (which may be a word or phrase), the new Primo UI displays up to three associated recommendations at the top of the brief results. User's can see all of the recommendations by clicking the See all suggested resources link.
    ResourceRecommender_Example1.png
    Resource Recommender Service on the Brief Results Page
    Currently, partial searches are not supported by the Resource Recommender.

    Configuring the Resource Recommender Service

    The Resource Recommender page under the Advanced Configuration menu allows you to define resource recommendations (such as a librarian or a Website) that are based on searchable tags. The searchable tags are defined per resource type and recommendation.
    To configure the Resource Recommender service: 
    1. Open the Resource Recommender page (Primo Home > Advanced Configuration > Resource Recommender).
    2. Click Customize if the service has not already been customized. The Delete option returns the configuration to the installation level, which may not have a default configuration. The Reset option clears all configurations.
      ResourceRecommenderPage.png
      Customization Mode for Resource Recommender
    3. From the Resource Type drop-down list, select one of the following resources:
      • Database - Displays the database recommendations on the left side of the All Suggested Resources page.
      • Person - Displays the contact recommendations on the right side of the All Suggested Resources page.
      • Website - Displays the Website recommendations on the left side of the All Suggested Resources page.
      • Library Information - Displays the library information on the right side of the All Suggested Resources page.
      • Library Guide - Displays the library guide recommendations on the right side of the All Suggested Resources page.
      • Custom 1, 2, and 3 - Displays the custom recommendations on the left side of the All Suggested Resources page.
      • All (only display) - This option displays the full list of configured resources in read-only mode on this page.
    4. From the Language drop-down list, select the display language of the recommendation.
      Before you can create a translation for a language other than en_US, you must first create the base recommendation (which includes searchable tags for all languages) using the default language en_US.
    5. For each type of resource, you can configure the following fields:
      Resource Recommender Fields
      Field Description
      Display Name (required)
      The name that displays for the resource in the new UI.
      Searchable Tags (required)
      The search tags that trigger this resource recommendation. If you want to specify multiple tags for a recommendation, separate them with a semicolon.
      You must set the Language to en_US even when adding tags for languages other than en_US.
      Description
      The resource's description, which appears for the recommendation in the new UI.
      Image URL
      The URL used to display an image for the recommendation in the new UI.
      URL
      The URL that is used to redirect users after they click the display name in the recommendation.
      Not applicable to Person resource types.
      URL Text
      If the URL field is specified, the system displays this text in the new UI and redirects users to the specified URL when clicked.
      Not applicable to Person resource types.
      Email
      This field displays only for Person resource types. It provides the email address of the contact person. If no email text is provided, the system will display the email address in the new UI.
      Email Text
      This field displays only for Person resource types. If specified, this text displays instead of the user's email address. If left empty, the Email address of the person will be displayed.
      Internal Note
      Optional descriptive text to explain the use of this resource to staff members who may be configuring recommendations.
    6. Click Create to add a new recommendation for the specified resource type.
    7. Repeat steps 4 and 5 to add another recommendation for the specified resource type.
    8. Repeat steps 3 through 6 to define recommendations for other resource types.
    9. Define the order in which the resources will appear in the new UI:
      1. Click the Define the order of display for different types of resources field to display the list of resource types and their order. The highest ranked resources appear at the top of the list.
        ResourceRecommender_OrderResources.png
        Define the Highest Ranked Resource Types
      2. Use the up/down arrows to specify the order of the the recommendations per resource type. The new UI will display up to two recommendations for the highest ranked resource per searchable tag. For all other resources, a maximum of one recommendation will display at the top of the Brief Result page.
        For example, if the searchable tag has two recommendations for the Database resource type and it is the highest ranked resource type, both of its recommendations will display at the top of the Brief Result page.
        ResourceRecommender_HighestRankedRT.png
        Highest Ranked Resource Type Displays Two Recommendations
    10. Select the Enable Resource Recommender check box to enable the service in the new UI.
    11. Click Deploy.

    Importing Recommendations

    The Resource Recommender page allows you to import recommendations per resource and language using an Excel file. All recommendations must be first created in the default display language en_US and then translated for each language in subsequent imports.
    Depending on the resource type, some of the following columns must be included in the Excel file even if you do not plan on entering values:
    Resource Recommender Fields
    Field Description
    key
    The internal key, which is used to track the recommendations. This field is required for all resource types, but you can leave it blank when adding or replacing recommendations.
    When creating translations for languages other than the default en_US, you must specify an existing key, which must be created first using the default language en_US.
    name
    The name that displays for the resource in the new UI. You must specify a display name for all recommendations and resource types. This field is translatable.
    tags
    The search tags that trigger this resource recommendation. You must specify at least one tag per recommendation. If you want to specify multiple tags for a recommendation, separate them with a semicolon.
    description
    The resource's description, which appears for the recommendation in the new UI. This field is required for all resource types, but you can leave it blank. This field is translatable.
    image_url
    The URL used to display an image for the recommendation in the new UI. This field is required for all resource types, but you can leave it blank.
    url
    The URL that is used to redirect users after they click the display name in the recommendation. This field must be included for all resource types (except for Person), but you can leave it blank.
    url_text
    If the url field is specified, the system displays this text in the new UI and redirects users to the specified URL when clicked. This field must be included for all resource types (except for Person), but you can leave it blank.
    email
    This field is required only for Person resource types. It provides the email address of the contact person. If no email text is provided, the system will display the email address in the new UI.
    email_text
    This field is required only for Person resource types. If specified, this text displays instead of the user's email address. If left empty, the Email address of the person will be displayed.
    internal_note
    Descriptive text to explain the use of this resource to staff members who may be configuring recommendations. This field is required for all resource types, but it can be left blank.
    The following figure shows an example of an Excel file for a Database resource type:
    ResourceRecommenderExport_ImportExample.png
    Database Resource Recommendation
    To import recommendations:
    1. Open the Resource Recommender page (Primo Home > Advanced Configuration > Resource Recommender).
    2. Click Customize if the service has not already been customized. The Delete option returns the configuration to the installation level, which may not have a default configuration. The Reset option clears all configurations.
    3. In the Resources section, select the Resource Type and Language for which you want to import recommendations.
      ResourcesSection.png
      Select Resource Type
      Before you can create a translation for a language other than en_US, you must first create the base recommendation (which includes searchable tags for all languages) using the default language en_US.
    4. In the Add new resources via Excel file upload section, click Browse and select the Excel file that you created for this type of resource.
      ImportRecommendations.png
      en_US - Import New Recommendations or Replace All Recommendations
      TranslateRecommendations.png
      Not en_US - Translate Recommendation's Only
    5. Choose one of the following options:
      • add Resources – (en_US) Click this button if you want to add recommendations to the existing list of recommendations for this resource type.
      • Replace all resources – (en_US) Click this button if you want to replace all recommendations for this resource type.
      • Upload Translation – (not en_US) Click this button if you want to translate display information, URLs, and email information for use with another language. It may help to export the existing settings for a language, modify the Excel file, and then import updated file.
    6. Click Deploy to update the new Primo UI.

    Exporting Recommendations

    The Resource Recommender page allows you to export recommendations per resource and language to an Excel file. This allows you to modify many recommendations at once, create translations, and import the updated Excel file into the Resource Recommender page (see Importing Recommendations).
    To export recommendations:
    1. Open the Resource Recommender page (Primo Home > Advanced Configuration > Resource Recommender).
    2. Click Customize if the service has not already been customized. The Delete option returns the configuration to the installation level, which may not have a default configuration. The Reset option clears all configurations.
    3. In the Resources section, select the Resource Type and Language for which you want to export recommendations.
    4. Click Export to Excel.
    • Was this article helpful?