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

    Primo VE Customization - Best Practices

    1. Last updated
    2. Save as PDF

    Return to menu

    Introduction

    In order to provide users with the best experience in Primo VE, Ex Libris carried out an extensive user study that included the following tasks to help redesign the classic Primo user interface:
    • Analyzed search logs
    • Conducted surveys of librarians during workshops
    • Interviewed users at different academic levels and from various countries and disciplines 
    During the design and development of the new interface, accessibility was tested as well as its responsiveness on several devices to ensure that the new design met the goals based on the results of the user study.
    Because every library has its own needs and brand, we have implemented a new customization framework that enables customers to tap into predefined hooks for each UI component, thus enabling them to customize each component as needed.
    In order to ensure a quality user experience and optimal system performance, we encourage customers to test every change that they make for both accessibility and responsiveness in their staging environments before uploading any packages to their production environment.

    Additional Resources

    Refer to the following resources for further Primo VE customization options:

    Inspecting Web Elements with Your Browser

    Most Web browsers provide developer tools that enable you to inspect the currently-loaded HTML and find specific elements on a page. In most browsers, you can either click F12 or right-click the page and then select the Inspect Element option.

    In order to customize Primo VE, you should be familiar with the following: CSS, HTML, JavaScript, and AngularJS. Depending on your experience with each of these languages and frameworks, you can perform more complex customizations.

    AlmaCustomization.png

    Full Display Page - Get It Section

    The following procedure shows how to use the browser's inspect tool to locate the code table used to define a label in Primo VE.

    To locate a label on the page:

    1. On the page that you want to inspect, press F12.

    2. Select the inspect item button (#1) and then select the label (#2) that you want to modify. Each component highlights as you move the cursor over the item.

      InspectElementExample.png

      Inspection Brief Results Page

    3. In the HTML tab, you should see the label and its corresponding code (#3). If you do not see a translate parameter, you can instead search for the label’s description on the All Code Tables page.

    4. On the All Code Tables page (Configuration Menu > Discovery > Display Configuration > Labels), either search for the code or description (the actual display label).

      The following figure shows an example of a search for a code:

      PVE_AllCodeTables_Search_For_Code.png

      Code Search Example

      The following figure shows an example of a search for a label:

      PVE_AllCodeTables_Search_For_Label.png

      Label Search Example

    Using the UI Customization Package Manager

    The Customization Package Manager enables you to upload and manage customization packages, which enables you to brand and further customize Primo VE. If no packages are loaded, the system uses the out-of-the-box configurations.

    • Database files (.db) are not permitted in your customization package. If the following error occurs while uploading your ZIP file, remove all .db files:

      Validation error: File type db is not allowed in the zip file

    • Set Windows to display hidden files if you cannot see any .db files in your customization package folder.

    To ensure that a customization package integrates properly with Primo VE, ensure that its ZIP file is structured as follows:

    PVE_CP_Structure.png

    Customization Package Structure

    • <View_Code> – The top folder of your customization package. Ensure that you change the name of the top folder to your institution's view code, which must be in the following format: <institution_code>-<view_code>.

    • css – This subfolder contains the custom1.css file, which includes your CSS rules. These rules override corresponding rules in the default CSS.

    • img – This subfolder contains all customized images for Primo VE. To ensure that the correct image appears in Primo VE, ensure that you use the same file name as the original.

    • js – This subfolder contains the custom.js file, which includes your scripts.

    • html – This subfolder contains the following subfolders, which store all customized HTML files for Primo VE:

      • homepage – The homepage_en.html file enables you to customize the area of the page below the search box on the Primo VE Home page. To support other languages, you can create and upload new HTML files with the relevant language code. For example, homepage_fr.html. For more information, see Home Page.

        HomePage_Cust.png

        Primo VE Home Page

        • The system does not use content inside <script> tags.

        • Since this code is nested inside the main HTML code, wrap this code with a <div> tag (insets of the <html> tag).

      • email – The email_<2-character_language_code>.html template files (such as email_en.html) enable you to configure the layout and format of the emails (per supported UI languages) that are sent when users perform the Send To Email action. Note that the email folder is not created for you. For more information, see Customizing the Email Template.

      • help – The help_en.html file enables you to create a help page for your view. To support other languages, you can create and upload new HTML help files with the relevant language code. For example, help_fr.html. For more information, see Creating a Custom Help Page. Since a help page is not provided out of the box, you need to add the help directory to your customization package.

    You can create a customization package from either the View Configuration page or Primo Studio, but you need to use the View Configuration page to deploy the customization package for both methods. For more information, see the following sections:

    Accessing Primo Studio

    Primo Studio enables you to interactively customize some aspects of your view and create a customization package for deployment with the View Configuration page in Primo VE. For more information, see Primo Studio for Primo VE.

    To access Primo Studio:

    1. Edit your view on the View Configuration page (Configuration Menu > Discovery > Display Configuration > Configure Views).

    2. Select the Manage Customization Package tab.

    3. Select Go to Primo Studio in the Create a Customization Package section.

    Creating a Customization Package

    To create a customization package:

    1. On the Views List page (Configuration Menu > Discovery > Display Configuration > Configure Views), edit your view.

    2. Select the Manage Customization Package tab.

      PVE_PrimoStudio_ManageCustomizationPackageTab.png

      Manage Customization Package Tab

    3. Select Download to download the customization package. If this is the first time, download the template package. Otherwise, download the current package to ensure that you are using the latest version.

    4. Unzip the file.

    5. Ensure that the top folder of your package's zip file is the <View_Code> folder, which must have the following format: <institution_code>-<view_code>. For example, PRMO_OAP_INST-Alma.

    6. As needed, customize the configuration files and folders associated with the home page, images, and CSS. You must retain the file structure and names of files that you are overriding. Refer to the following sections for details on how to brand and make simple changes to your view:

    7. Zip the view code folder.

      PVE_CustomZippedPackage.png

      Zipped View Code Folder

      For Windows users, we recommend using a compression tool such as 7zip or Winrar instead of Windows Send to > Compress folder to avoid upload errors.

       

      For Mac users, use the following procedure to zip and remove any hidden .DS_Store files:

      1. Open the Terminal application under Applications > Utilities.

      2. Move to the parent directory of the folder that you want to compress. For example: 
        cd /Users/<user name>/<parent folder>

      3. Enter the following command to compress the file:
        zip –r <target file>.zip <My_View> -x "*.DS_Store"

    8. Specify the name of the zipped package and click Upload.

    9. Select Save to deploy the changes.

    10. Refresh your view in the Web browser and test your changes prior to uploading the changes to the production server.

    Adding a Clickable Logo

    The Manage Customization Package tab on the View Configuration page (Configuration Menu > Discovery > Display Configuration > Configure Views) enables you to upload a new logo and define a link that opens a page when users click the logo. The following image formats are supported: PNG and SVG.

    IE11 may not fully support the display of SVG images.

    To upload a new logo:

    1. Edit your view on the View Configuration page (Configuration Menu > Discovery > Display Configuration > Configure Views).

    2. Select the Manage Customization Package tab.

    3. In the Upload Logo section, perform the following steps:

      1. Select an image to upload in the Upload Logo File field.

        The system places the following restrictions on the logo file:

        • The file format of the image must be .png or .svg.

        • The height of the image cannot exceed 100 pixels.

        • The width of the image cannot exceed 300 pixels.

        • The size of the image cannot exceed 30 KB.

      2. Select Upload.

        If you want to remove the clickable logo, select Remove Logo.

      3. If you want the image to be clickable, specify the redirection URL in the Logo Clickable URL field.

    4. Select Save to save changes to the customization package.

    Customizing the Email Template

    Primo VE enables you to customize the format of emails sent to users after selecting the Send To Email action in Primo VE. You can customize the format with or without Primo Studio. With either method, you must upload the customized email templates with the View Configuration page. In addition, you can create separate email templates for each supported language in the UI.

    • The email template for Primo VE supports a maximum of 50 records. If a user sends more than 50 records, the system reverts to the classic email template, which was used in previous releases.

    • For security reasons, all links are removed from your email template.

    The following figure shows the sample output of the out-of-the-box Email template for Primo VE.

    Primo_SendEmailExample.png

    Example Email for Send To Email Actions in Primo VE

    The Email template is in HTML format and includes the following sections:

    • Logo – Displays the logo from your view's customization package.

    • Institution note – Displays the text configured with the following code in the Send Email and SMS code table: nui.email.institutionNote. By default, this field has no value and does not display if left empty.

    • List of records – For each record, the email displays the record's brief display and availability statement.

    • Disclaimer – Displays the text configured with the following code in the Send Email and SMS code table: nui.email.disclaimer. 

    Configuration Options 

    The email_<2-character_language_code>.html template files (such as email_en.html) enable you to configure the layout and format of the emails (per supported UI languages) that are sent when users perform the Send To Email action in Primo VE. For more details and examples of how to customize the email templates, see the following page on GitHub: 

    https://github.com/ExLibrisGroup/primo-explore-package/tree/master/VIEW_CODE/html#email-templates

    Note that the default email template file is called email_en_US.html on GitHub.

    • If you decide to customize the out-of-the-box email template and your view supports additional languages, you must create and upload a separate template file for each language (including the default email_en.html file).

    • The alignment of the email's text is based on the email client settings.

    After you have created or modified any email template files, edit your view (Configuration Menu > Discovery > Display Configuration > Configure Views), select the Manage Customization Package tab, and then use one of the following methods to upload the email template files to the UI:

    • Store the custom email template files under the html/email directory in your view's customization package and upload the entire customization package.

    • If you are not using a customization package, you can use the Upload Templates section to upload your email template files or choose to use the classic email template. By default, your view uses the new email template.

      PVE_MCP_UploadTemplates.png

      View Configuration Page - New Upload Templates Section

    If you want to delete an email template file, remove the email template file under the html directory in the view's customization package and upload the modified package to the UI. If you want to revert to the out-the-box email template, remove all email templates under the html directory in the view's customization package and upload the modified package to the UI.

    Customizing SVG Icons

    Primo VE enables you to replace icons that are used in various places of the UI (such as those used for resource types in the Resource Types Filter Bar). You can store the SVG ID definitions in the custom-ui.svg file, which is not provided by default and stored under the /img directory of your customization package.

    To replace an SVG icon:

    1. In the browser, inspect the icon that you want to replace and get its SVG ID, which is used later in this procedure.

      PVE_Inspect_Icon_Get_ID.png

      Inspect Icon in Browser

      Do not include the _cache32 suffix in the SVG ID, only use books.

    2. In the Manage Customization Package tab on the View Configuration page (Configuration > Discovery > Display Configuration > Configure Views), download your view's customization package. If it does not exist, download the template and use it to create your view's customization package.

    3. Under the /img folder, edit (if it already exists) or create the custom-ui.svg file (download example with replacement icons for articles and books).

    4. Edit the custom-ui.svg file and add the SVG definition of the replacement icon, remembering to change its ID to the ID of the icon that you inspected in step 1. For example:

      <svg version="1.0" id="books" xmlns="http://www.w3.org/2000/svg"
       width="800.000000pt" height="800.000000pt" viewBox="0 0 800.000000 800.000000"
       preserveAspectRatio="xMidYMid meet">

      <g transform="translate(0.000000,800.000000) scale(0.100000,-0.100000)"
      fill="#000000" stroke="none">
      <path d="M3885 7649 c-351 -34 -648 -172 -887 -412 -115 -116 -175 -204 -376
      -552 -79 -137 -178 -308 -220 -380 -41 -71 -116 -202 -167 -290 -51 -88 -142
      -245 -202 -350 -60 -104 -163 -282 -228 -395 -65 -113 -121 -209 -125 -215 -4
      -5 -19 -30 -32 -55 -14 -25 -60 -106 -103 -180 -43 -74 -120 -207 -170 -295
      -51 -88 -133 -230 -182 -315 -138 -238 -283 -489 -318 -550 -17 -30 -58 -100
      -90 -155 -32 -55 -108 -188 -170 -295 -62 -107 -144 -249 -182 -315 -186 -320
      -228 -395 -277 -493 -61 -123 -95 -223 -128 -372 -32 -150 -32 -381 0 -530 58
      -266 172 -494 344 -686 242 -271 558 -426 945 -464 131 -13 5225 -13 5356 0
      204 20 356 61 523 142 397 194 677 560 776 1018 32 151 32 381 -1 530 -49 222
      -97 329 -320 715 -74 127 -176 304 -229 395 -52 91 -98 170 -102 175 -4 6 -19
      30 -32 55 -14 25 -60 106 -103 180 -175 304 -266 462 -337 585 -42 72 -142
      245 -223 385 -81 140 -181 314 -223 385 -41 72 -116 202 -167 290 -51 88 -131
      227 -179 309 -47 82 -86 151 -86 153 0 2 -11 20 -23 41 -13 20 -76 127 -139
      237 -63 110 -141 245 -173 300 -32 55 -82 141 -110 190 -366 636 -386 666
      -531 810 -243 242 -518 368 -883 405 -112 11 -109 11 -226 -1z m350 -674 c207
      -69 342 -184 462 -393 28 -48 83 -143 123 -212 40 -69 83 -143 95 -165 13 -22
      55 -96 95 -165 79 -136 213 -367 240 -415 18 -32 92 -160 186 -323 31 -53 109
      -187 172 -297 63 -110 154 -267 202 -350 47 -82 133 -231 190 -330 57 -99 124
      -216 151 -260 26 -44 56 -96 67 -115 10 -19 54 -96 97 -170 43 -74 119 -207
      170 -295 157 -273 307 -531 430 -745 378 -652 402 -699 424 -824 15 -82 14
      -207 -3 -291 -62 -319 -327 -576 -646 -625 -89 -14 -5301 -14 -5390 0 -370 57
      -653 389 -653 765 1 178 31 268 172 513 43 75 88 153 99 172 37 66 205 355
      257 445 29 50 61 106 72 125 11 19 70 121 130 225 102 176 197 341 488 845 62
      107 138 240 170 295 90 154 305 525 330 570 13 22 56 96 95 165 40 69 114 197
      165 285 136 237 379 657 439 760 29 50 81 140 116 200 199 344 231 391 329
      469 162 131 305 178 521 172 103 -3 139 -8 205 -31z"/>
      <path d="M3859 5387 c-146 -61 -231 -167 -265 -328 -14 -67 -14 -94 0 -289 9
      -118 21 -303 26 -410 6 -107 15 -262 21 -345 5 -82 16 -276 24 -430 27 -510
      31 -548 58 -608 29 -64 86 -122 147 -150 69 -32 198 -30 265 5 72 38 126 99
      155 178 7 20 16 117 21 230 8 202 31 632 49 900 5 85 14 232 20 325 5 94 15
      252 21 352 10 157 9 191 -5 261 -28 138 -105 239 -226 296 -55 26 -79 31 -160
      34 -82 2 -103 -1 -151 -21z"/>
      <path d="M3874 2496 c-95 -31 -197 -123 -248 -223 -9 -18 -21 -65 -28 -106
      -37 -243 153 -467 397 -467 86 0 147 18 217 63 111 71 174 172 184 297 16 182
      -71 342 -225 418 -48 23 -70 27 -156 29 -63 2 -115 -2 -141 -11z"/>
      </g>
      </svg>

      Replacement for Books Icon

    5. Compress, upload, and save the customization package.

    Image File Customization

    Any of the out-of-the-box images can be customized by creating or modifying a view’s package, placing the customized image under the img folder, uploading the updated package to the server, and then deploying the package. Here are some of the commonly customized images for the purpose of branding:
    • library-logo.png – Contains the library logo.
    • favicon.ico – Contains the favicon.
    • icon_<resource_type_code>.png – Contains the image for the specified resource type <resource_type_code>. For example: icon_audio.png

    From your Home page (homepage_en.html), you can use the HTML img tag to load any image stored in the /img directory. For example:

    <img src="/discovery/custom/01INST-MyView/img/circdesk.png" alt="Circulation desk image">

    Customizing the Shortcut Icon for IOS/Android Devices 

    In addition, you can change the shortcut icon that displays on the Primo VE home page for IOS and Android devices.

    To change the shortcut icon:

    1. Create a 150x150 pixel image for the Primo VE shortcut and give it the following name: home-screen-icon.png.

    2. Edit your customization package and place the new shortcut image file under the img folder.

    3. Zip and upload your customization package.

    CSS Components and Customizations

    This section identifies the major CSS components for each page of Primo VE and provides an example of how to move the facets to the left side of the page using CSS.

    Home Page

    This section identifies the major components of the Home page.

    HomePage_CSS2.png

    Home Page Components
    1. .prm-primary-bg.prm-hue1, prm-search-bar.prm-hue1, prm-spinner.prm-hue1.overlay-cover.light-on-dark:after, prm-topbar .top-nav-bar{}
    2. .prm-primary-bg, prm-search-bar, prm-spinner.overlay-cover.light-on-dark:after{}
    3. view_code/html/homepage_en.html
    If you want to display drop-down lists for the view's default tab and search scope in the search box initially, include the tab parameter as follows in Primo VE's URL:
    http://<Primo_URL>/discovery/search?vid=<view_code>&tab=<default_tab_name>

    If you want to display a drop-down list for a specific search scope initially, include the search_scope parameter as follows in Primo VE's URL:

    http://<Primo_URL>/discovery/search?vid=<view_code>&tab=<default_tab_name>&search_scope=<scope_name>

    Brief Results Page

    This section identifies the CSS selectors of the major components on the Brief Results page.
    BriefResultsPage_CSS.png
    Brief Results Page Components
    1. .alert-bar{}
    2. md-content, md-content.md-primoExplore-theme{}
      1. .section-title {}
      2. .section-content .md-chips .md-chip strong{}
      3. .md-autocomplete-suggestions .suggestion-scope, .text-italic{}
      4. .link-alt-color, .section-title prm-icon {}
    3. prm-search-result-list .results-title {}
      BriefResultsItem_CSS.png
      Brief Result Item Components
    4. prm-brief-result-container .list-item-primary-content {}
      1. prm-brief-result .item-title{}
      2. prm-brief-result .item-detail{}
      3. .item-expanded .secondary-content-holder .md-tab:nth-child(2), .item-expanded .secondary-content-holder md-tab-item:nth-child(2){}
      4. .item-expanded .secondary-content-holder .md-tab:nth-child(3), .item-expanded .secondary-content-holder md-tab-item:nth-child(3) {}
      5. .item-expanded .secondary-content-holder .md-tab:nth-child(4), .item-expanded .secondary-content-holder md-tab-item:nth-child(4) {}
      6. .item-expanded .secondary-content-holder .md-tab:nth-child(5), .item-expanded .secondary-content-holder md-tab-item:nth-child(5) {}
      7. .item-expanded .secondary-content-holder .md-tab:nth-child(6), .item-expanded .secondary-content-holder md-tab-item:nth-child(6) {}
      8. .item-expanded .secondary-content-holder .md-tab:nth-child(7), .item-expanded .secondary-content-holder md-tab-item:nth-child(7) {}
      9. .item-expanded .secondary-content-holder .md-tab:nth-child(8), .item-expanded .secondary-content-holder md-tab-item:nth-child(8) {}

    Hiding the Sign-In Link

    To hide the "Sign in to get complete results and to request items" link:
    .alert-bar {
    display:none;
    }

    Changing the Color of the Versions Link

    To change the color of the "See all versions" link:

    1. Open the Discovery UI Labels code table (Configuration Menu > Discovery > Display Configuration > Labels).

    2. Edit the Results Tile Labels code table.
    3. Change the description of the nui.frbrversion.found.link code to include your color settings. For example:
      <font color="green">See all versions</font>

    Full Display Page

    This section identifies the CSS selectors of the major components on the Full Display page. For details on configuring Alma's View It and Get It services, see Branding the View for Primo VE.
    FullRecordPage_CSS.png
    Full Record Page Components
    1. prm-full-view prm-brief-result-container{}

    Upper Menu

    This section identifies the CSS selectors of the major components in the Upper Menu.
    UpperMenu.png
    Upper Menu Components
    1. view_code/img/library-logo.png
    2. .layout-align-end-center { }
    3. prm-topbar .md-button:not(.md-icon-button) {}

    Hiding the Language Menu

    To hide the language menu:
    prm-change-lang {
      display: none;
    }

    Disabling Automatic Capitalization of Main Menu Links

    To disable the automatic capitalization of all characters in the main menu links:
    prm-topbar .md-button {
    text-transform: none;
    }

    Library Search Bar

    This section identifies the CSS selectors of the major components in the Library Search Bar.
    PVE_LS_Components.png
    Library Search Bar Components
    1. prm-search-bar {}
    2. /* the text color in the search box */
      prm-search-bar input::-webkit-input-placeholder { }
      prm-search-bar input:-moz-placeholder { /* Firefox 18- */}
      prm-search-bar input::-moz-placeholder {  /* Firefox 19+ */}
      prm-search-bar input:-ms-input-placeholder {}
    3. prm-search-bar md-autocomplete-wrap input {}
    4. prm-search-bar .simple-search-wrapper .search-actions .md-button {}
    5. prm-search-bar .search-switch-buttons .md-button {}

    Database and Journal Search Bars

    This section identifies the major components of the Database and Journal Search Bars.
    PVE_DS_JS_Components.png
    Database and Journal Search Bar Components (Database Search)
    1. prm-atoz-search-bar {}
    2. prm-atoz-search-bar div.search-scope.layout-align-center-start.layout-column
    3. /* the text color in the search box */
      prm-atoz-search-bar input::-webkit-input-placeholder { }
      prm-atoz-search-bar input:-moz-placeholder { /* Firefox 18- */}
      prm-atoz-search-bar input::-moz-placeholder {  /* Firefox 19+ */}
      prm-atoz-search-bar input:-ms-input-placeholder {}
    4. prm-atoz-search-bar md-autocomplete-wrap input {}
    5. prm-atoz-search-bar .simple-search-wrapper .search-actions .md-button {}

    Browse Search Bar

    This section identifies the CSS selectors of the major components in the Browse Search Bar.
    PVE_Browse_Components.png
    Browse Search Bar Components
    1. prm-browse-search-bar {}
    2. prm-browse-search-bar div.search-scope.layout-align-center-start.layout-column
    3. /* the text color in the search box */
      prm-browse-search-bar input::-webkit-input-placeholder { }
      prm-browse-search-bar input:-moz-placeholder { /* Firefox 18- */}
      prm-browse-search-bar input::-moz-placeholder {  /* Firefox 19+ */}
      prm-browse-search-bar input:-ms-input-placeholder {}
    4. prm-browse-search-bar md-autocomplete-wrap input {}
    5. prm-browse-search-bar .simple-search-wrapper .search-actions .md-button {}

    NEWSPAPERS Search Bar

    This section identifies the CSS selectors of the major components in the NEWSPAPERS Search Bar.
    PVE_NS_Components.png
    NEWSPAPERS Search Bar Components
    1. prm-newspapers-search-bar{}
    2. prm-newspapers-search-bar div.search-scope.layout-align-center-start.layout-column
    3. /* the text color in the search box */
      prm-newspapers-search-bar input::-webkit-input-placeholder { }
      prm-newspapers-search-bar input:-moz-placeholder { /* Firefox 18- */}
      prm-newspapers-search-bar input::-moz-placeholder {  /* Firefox 19+ */}
      prm-newspapers-search-bar input:-ms-input-placeholder {}
    4. prm-newspapers-search-bar md-autocomplete-wrap input {}
    5. prm-newspapers-search-bar .simple-search-wrapper .search-actions .md-button {}

    TAGS Search Bar

    This section identifies the CSS selectors of the major components in the TAGS Search Bar.
    PVE_Tags_Components.png
    TAGS Search Bar Components
    1. prm-tags-search-bar{}
    2. prm-tags-search-bar div.search-scope.layout-align-center-start.layout-column
    3. /* the text color in the search box */
      prm-tags-search-bar input::-webkit-input-placeholder { }
      prm-tags-search-bar input:-moz-placeholder { /* Firefox 18- */}
      prm-tags-search-bar input::-moz-placeholder {  /* Firefox 19+ */}
      prm-tags-search-bar input:-ms-input-placeholder {}
    4. prm-tags-search-bar md-autocomplete-wrap input {}
    5. prm-tags-search-bar .simple-search-wrapper .search-actions .md-button {}

    Moving the Facets to the Left Side

    Out of the box, Primo VE displays the facets on the right side of the results page. Use the Side bar (tweak my results) position option in the General tab on the View Configuration page (Configuration Menu > Discovery > Display Configuration > Configure Views) to move the facets to either the left or the right side of the page.

    Creating a Search Box with Deep Links to Primo VE

    This example creates a search box that uses a deep link to search your institution's catalog. For more details on how to create a deep link, see Deep Links - New UI. 
    PVE_NewSearchBox.png
    Search Box
    To create a search box:
    1. Create an HTML file and include the following lines, ensuring that you fill in the host name and customizable parameters, such as view code and tab (search profile):
      <html>
      <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      <!-- Script that converts the query string into valid parameter -->
      <script type="text/javascript">
      function searchPrimo() {
      document.getElementById("primoQuery").value = "any,contains," + document.getElementById("primoQueryTemp").value;
      document.forms["searchForm"].submit();
      }
      </script>
      </head>
      <body>
      <!-- Fill in Highlighted Parameters -->
      <form id="simple" name="searchForm" method="get" target="_self" action="https://<host_name>/discovery/search" enctype="application/x-www-form-urlencoded; charset=utf-8" onsubmit="searchPrimo()">
      <input type="hidden" name="vid" value="<view_code>">
      <input type="hidden" name="tab" value="<tab_code>">
      <input type="hidden" name="search_scope" value="<scope_name>">
      <input type="hidden" name="lang" value="<2_char_lang_code>">
      <!-- Fixed parameters -->
      <input type="hidden" name="query" id="primoQuery">
      <input type="text" id="primoQueryTemp" value="" size="35">
      <!-- Search Button -->
      <input id="go" title="Search" onclick="searchPrimo()" type="button" value="Search" alt="Search" style="height: 22px; font-size: 12px; font-weight: bold; background: #DE6E17; color: #ffffff; border: 1px solid;">
      </form>
      </body>
      </html>

      Example search query:

      https://my-inst.primo.exlibrisgroup.com/discovery/search?query=any,contains,herring&tab=Everything&search_scope=MyInst_and_CI&vid=PRIMO_OAP_INST:MyInst&lang=en

      If you are displaying multiple search boxes on a page, you must define separate functions and forms for each search box, ensuring that the red names and IDs are unique for each search box.

    2. To test the search box, open the HTML file in a browser and perform a search. If you saved the HTML file on a Web server, use the following URL to access the search box:
      http://<web_server>/<path>/<filename.html>

    Creating a Twitter Feed

    This procedure creates a link on the home page, which opens your Twitter feed in a new tab.

    PVE_TwitterExample.png

    Link to Twitter Feed on Home Page
    To add a Twitter feed:

    1. Create an HTML link based on your Twitter feed. For details, see https://publish.twitter.com/.

    2. Edit the homepage_en.html file and embed the HTML link created in the previous step.

      For example:

      <div flex-xs flex="40" layout="column">
       <md-card class="default-card">
       <md-card-title>
       <md-card-title-text>
       <span class="md-headline">Twitter</span>
       </md-card-title-text>
       </md-card-title>
       <md-card-content>

      <a class="twitter-timeline" href="https://twitter.com/ExLibrisGroup?ref_src=twsrc%5Etfw">Tweets by ExLibrisGroup</a> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
       </md-card-content>
       </md-card>
       </div>

    3. Compress, upload, and deploy your updated customization package. For more information, see Using the UI Customization Package Manager.

    Creating a Custom Help Page

    Primo VE enables you to create and embed a custom help page, which contains information on how to utilize the interface to access services provided by your institution. To provide a custom help page, create the help file, upload the help file to the server, and add a link in Primo VE to enable users to access the help page.

    Creating and Uploading the Help File

    Primo VE enables you to provide help files for each language supported by your institution. The naming convention is help_<language>.html (such as help_en.html). All custom help files must be placed in the html/help directory of your view's customization package.
    To create and upload the help files:
    1. Download your view's customization package (see Modifying a View-Level Package).
    2. For each language supported, create an HTML help file (using the naming convention mentioned above).
    3. Save the help files under the html/help directory of your view's customization package. You may need to create the help directory first.
    4. Compress your view's package and upload it to the server (see Modifying a View-Level Package).

    Adding the Help Link to the UI

    The Links Menu tab on the Views Configuration page enables you to define the HELP link that appears at the top of the page in Primo VE.
    PVE_AddHelpLink_To_Menu.png
    HELP Link in the Main Menu
    To add the HELP link:
    1. On the View Configuration page (Configuration Menu > Discovery > Display Configuration > Configure Views), edit your view.
    2. Select the Links Menu tab.
    3. Select Customize > Add Link to open the Edit Link Menu page.
    4. Specify the following fields:
      • Code – Enter primo_help.
      • URL – Enter static-file/help.
      • Label – Enter the display label for the help link (such as Help). Select the Translate icon PVE_TranslateIcon2.png to define a language-specific label.
      • Description – Specify the text that displays when a users hover the cursor over the link. Select the Translate icon PVE_TranslateIcon2.png to define a language-specific description.
      PVE_EditMenuLink2.png
      Edit Link Menu Page
    5. Select Save.

    Disabling Short Permalinks in Primo VE 

    By default, the Send To action Permalink, which appears on both the Brief and Full Display pages, creates a shortened URL that includes the institution code, record ID, and a key:

    <Primo Domain>/permalink/<institution_code>/<key>/<record_ID>

    When the shortened URL is entered in a browser, Primo converts the URL to its full URL and displays the record's full details.

    • Short format –

      https://inst.primo.exlibrisgroup.com/permalink/11INST_INST/12345/alma991004075889705106

    • Long format –

      https://inst.primo.exlibrisgroup.com/discovery/fulldisplay?docid=alma991004075889705106&context=L&vid=11INST_INST:inst&search_scope=MyInstitution&tab=LibraryCatalog&lang=en

    To disable short permalinks:

    This enhancement is enabled by default. If you want to revert to the long format, add the following lines to the CSS file in your customization package:

    .__xs prm-permalink .layout-column>.long-permalink, prm-permalink .layout-column>.long-permalink {

        display: inherit;

    }

     

    .__xs prm-permalink .layout-column>.short-permalink, prm-permalink .layout-column>.short-permalink {

        display: none;

    }

    Improved Format of Saved Search Alert Emails

    URM-112191This enhancement provides an improved format of emails sent to users for Saved Search alerts. This format is configured with the Saved Searches Letter template on the Letter Configuration page (Configuration Menu > General > Letters > Letters Configuration). For information on how to configure email letters, see Configuring Alma Letters. The alerts are scheduled with the Saved Searches Alert job (Admin > Manage Jobs and Sets > Monitor Jobs > Discovery).

    Primo_SavedSearchEmail_NewFormat.png

    Example Alert Email in Primo VE

    • The logo is taken from your view's customization package.

    • The email displays a maximum of 25 items.

    Configuration Options

    The following table lists the changes to the Send Email and SMS Labels code table to support the display labels used for alert emails.

    Code Old Description New Description

    alert.from

    prima@exlibris.co.il

    No change.

    alert.subject

    New search results: {0}

    No change.

    alert.conditional.heading

    Note that {0} items are included in this email.

    Note that {0} items are included in this email:

    alert.heading

    There are new items in your saved search:

    No change.

    alert.headingNoResults

    There are no new items in your saved search.

    No change.

    alert.all.items.link

    All new records can be found via the following link:

    No longer in use.

    (new) alert.title

    		  

    List of New Items for your Saved Search.

    (new) alert.custom.subtitle

     

    Note that {0} items are included in this email.

    (new) alert.unsubscrib

    		  

    Click here to unsubscribe.

    (new) alert.headingNew

    		  

    {0} new items found for the search query: {search query}

    alert.disable

    To stop receiving emails with new records for this query, disable this alert by using the link below:

    No change.

    Customizing the RefWorks Link in the Primo User Area Menu

    When the RefWorks code is enabled in the Brief Record Display tab on the View Configuration page, the RefWorks link is enabled by default in the Primo User Area Menu.

    NUI_UserAreaMenu_RefWorks.png

    Primo User Area Menu - RefWorks Link

    You can perform the following configurations to customize it:

    • Update the eshelf.menu.refworks code in the User Tile Labels code table to modify the link's display label.

    • Hide the link in the Primo User Area menu by setting the following class selectors in your custom CSS file: 

      .my-refworks-ctm {

         display: none;

      }

       

      .my-refworks-separator-ctm {

         display: none;

      }

    Configuring the Page Title in Primo VE

    For accessibility, the page titles include the title of the specific page in Primo VE and additional information specific to the page's results. For example:

    PVE_PageTitle.png

    Enhanced Title on Newspaper Search Page

    The following table lists the expected title and configuration information for each page:

    Page Title Format and Code Table Information

    Library Search

    Title Format (before search):

    main.title

    Title Format (after search):

    main.title – <search term>

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    Full Display of Record

    Title Format (after selecting record):

    {{recordTitle}} - {{institutionName}}

    My Favorites > Saved Records

    Title Format:

    main.title - nui.favorites.header - nui.favorites.records.tabheader

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    Favorites Labels code table – 

    • nui.favorites.header: My Favorites
    • nui.favorites.records.tabheader: Saved records

    My Favorites > Search History

    Title Format:

    main.title - nui.favorites.header - nui.favorites.records.tabheader

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    Favorites Labels code table –

    • nui.favorites.header: My Favorites
    • nui.favorites.history.tabheader: Search history

    My Favorites > Saved Searches

    Title Format:

    main.title - nui.favorites.header - nui.favorites.records.tabheader

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    Favorites Labels code table –

    • nui.favorites.header: My Favorites
    • nui.favorites.search.tabheader: Saved searches

    Journal Search

    Title Format (before search):

    nui.mainmenu.label.journalsearch

    Title Format (after search):

    nui.mainmenu.label.journalsearch – <search term>

    View Labels code table –

    nui.mainmenu.label.journalsearch: Journal Search

    Browse Search

    Title Format (before search):

    nui.mainmenu.label.browse

    Title Format (after search):

    nui.mainmenu.label.browse – <search term>

    View Labels code table –

    nui.mainmenu.label.browse: Browse

    Tags

    Title Format (before search):

    nui.mainmenu.label.tags

    Title Format (after search):

    nui.mainmenu.label.tags – <search term>

    Tags Tile code table –

    nui.mainmenu.label.tags: TAGS

    Fetch Items (Citation Linker)

    Title Format:

    nui.mainmenu.label.citationlinker

    View Labels code table –

    nui.mainmenu.label.citationlinker: Fetch Item

    Database Search

    Title Format (before search):

    nui.mainmenu.label.databasesearch

    Title Format (after search):

    nui.mainmenu.label.databasesearch – <search term>

    View Labels code table –

    nui.mainmenu.label.databasesearch: Database Search

    Newspaper Search

    Title Format (before search):

    nui.mainmenu.label.newspapers_search

    Title Format (after search):

    nui.mainmenu.label.newspapers_search – <search term>

    View Labels code table –

    nui.mainmenu.label.newspapers_search: Newspapers

    Citation Path

    Title Format (after clicking a Cited or Cited by icon):

    nui.citation_trail.link.header - <search term>

    Results Tile code table –

    nui.citation_trail.link.header: Your current citation path

    My Library Card > Overview

    Title Format:

    main.title - menu.myaccount.my_library_card - nui.overview.header

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    User Space Menu code table –

    menu.myaccount.my_library_card: My Library Card

    Library Card Labels code table –

    nui.overview.header: Overview

    My Library Card > Loans

    Title Format:

    main.title - menu.myaccount.my_library_card - nui.loans.header

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    User Space Menu code table –

    menu.myaccount.my_library_card: My Library Card

    Library Card Labels code table –

    nui.loans.header: Loans

    My Library Card > Requests

    Title Format:

    main.title - menu.myaccount.my_library_card - nui.requests.header

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    User Space Menu code table –

    menu.myaccount.my_library_card: My Library Card

    Library Card Labels code table –

    nui.requests.header: Requests

    My Library Card > Fines & Fees

    Title Format:

    main.title - menu.myaccount.my_library_card - nui.fines.header

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    User Space Menu code table –

    menu.myaccount.my_library_card: My Library Card

    Library Card Labels code table –

    nui.fines.header: Fine + fees

    My Library Card > Blocks & Messages

    Title Format:

    main.title - menu.myaccount.my_library_card - nui.blocks.header

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    User Space Menu code table –

    menu.myaccount.my_library_card: My Library Card

    Library Card Labels code table –

    nui.blocks.header: Blocks + messages

    My Library Card > Personal Details

    Title Format:

    main.title - menu.myaccount.my_library_card - nui.details.header

    Header/Footer Tiles code table – 

    main.title: Ex Libris Discovery

    User Space Menu code table –

    menu.myaccount.my_library_card: My Library Card

    Library Card Labels code table –

    nui.details.header: Personal details
    1. Back to top
    • Was this article helpful?

    Recommended articles

    1. Article type
      Topic
      Content Type
      Documentation
      Language
      English
      Product
      Primo
    2. Tags
      1. primo studio