Skip to main content
  • Subscribe by RSS
  • ExLibris Dev

    Back Office Configuration for the New UI


    With the new UI, the goal was to use the existing configuration as much as possible to prevent a long, complex implementation process and to provide a smooth transition from the classic UI to the new UI. You will continue to use the Views Wizard, mapping tables, and code tables to configure your views. This document focuses on the changes that were made to the Back Office to support the new UI.

    Views Wizard

    In addition to the classic UI, the Views Wizard is used to configure views for the new UI. For more information, see Views Wizard. The following table indicates which fields in the Views Wizard are relevant to the new UI.
    Parameters Used for the New UI
    Configuration Option New UI? Comments
    General View Attributes:
    Default user institution
    Is template/Inherits
    Enable My Library Card
    Invoke automatic search when tabs are switched
    The automatic search is between scopes.
    Enable the “Personalize Your Results” service
    Personalization is planned for a later release.
    Enable Citation Trail
    Default Institution
    Session timeout URL
    In the new UI, the home page always displays after a timeout.
    Side bar (Tweak my results) position (New UI only)
    Allows you to configure which side the facets appear in the new UI.
    Layout Set (Classic UI only)
    Included with the customization package.
    CSS and Mobile CSS (Classic UI only)
    Included with the customization package.
    Mobile CSS (Classic UI only)
    Default interface language
    Search Scopes List:
    Search scopes
    Tabs List:
    Tabs list
    The tabs appear as follows in the new UI:
    • For simple searches, a drop-down list will appear in search boxes that display on the Brief Results page. On the Home page, users can select a specific tab from the search suggestions.
    • For advanced searches, the tabs will appear as radio buttons above the query lines.
    Basic Search Tile:
    Media type
    Pre-filters are available with advanced searches only.
    Search operators
    Search operators are available with advanced searches only.
    Search Target Fields
    Search targets are available with advanced searches only.
    Advanced Search Tile:
    Search pre-filters
    Display "Find Database" Link
    Main Menu Tile:
    Contents of Main Menu Tile
    Links should display as follow:
    Static HTML Tile:
    Contents of HTML Tile
    Included with customization package. For more information, see New UI Customization - Best Practices.
    Full Results Tile:
    Field to display in the full results
    Links to display in full results
    Send To Tile:
    SMS is planned for a later release.
    Brief Results Tile:
    Always appears, but it can be removed in the CSS.
    Define Sign-in message (in new UI)
    Yes (new parameter)
    Define link from title
    Clicking the title always opens the Full Display.
    The availability statement is a link to full text, Get It, or OvL. (See Availability Links in Brief Results.)
    Define FRBR (Primo Local) display
    Order of Tabs
    The tabs are now referred to as services and appears as sections in the Full Display only.
    Because the GetIt1 and locations are combined under the Get It section in the new UI, the order setting for Locations will be ignored.
    Links that display in the Details tab of the classic UI will now appear under the Links section in the Full Display of the new UI.
    Brief record display
    Sort Fields of the brief results
    Snippet Display Options
    Institution Boost
    Not planned for the new UI, yet.
    Number of records
    Constant bulk of 10 items are added after users scroll to the bottom of the results.
    Refine My Results (facets) Tile:
    Display "Show only" facets on the top of the brief results list
    Display "Show only" facets on top of "Refine My Results"
    There is an option to disable it and add ‘Top level’ facet in the facets list. In this way the customer can configure the number of values to display and sort option.
    Display "RSS", "Save Search" and "Add page to e-Shelf" on top of the facets options
    Add page to e-shelf will not be added since there are no pages in the new UI.
    Facets to display
    The tabs are also taken into account by checking the tab to which the scope is linked.
    Locations Tile:
    Real Time Availability
    Sort locations by user institution
    Include only locations belonging to the institution of the view
    Display Item list filters

    Mapping Tables

    Most of the existing mapping tables are still used for the new UI. The following changes have been made to the mapping tables to support the new UI:
    Table Description
    Mapping Table Changes for the New UI
    Actions List (modified)
    For information on the new Up-front Actions field, see Actions.
    Bulk Definition (modified)
    For My Library Card, the OVP loans paging parameter is ignored since the constant bulk size is 10.
    GetIT! Link 1 Configuration (modified)
    For information on the new Availability/Service field, see Availability Statement.
    My Account Menu Configuration - OvP (modified)
    Defines the existence of the My Library Card tabs, but does not control the order of the tabs. The new Overview tab always appears and cannot be hidden. You must use CSS to configure the order.
    Items Brief Display (new)
    User Login Links (new)
    More details on the changes to the mapping tables are described in the following sections.

    Code Tables

    Most of the existing code tables are still used for the new UI. The following changes have been made to the code tables to support the new UI:
    Table Description
    Code Table Changes for the New UI
    GetIT! Tab1 (modified)
    Added labels (such as the name displayed for the GetIT1 services) for the View It and Get It sections on the Full Display page in the new UI. Each of the new labels are prefixed with nui. For example, the following delivery codes display the View Online heading in the Full Display:
    • default.nui.getit.tab1_onl_norestrict
    • default.nui.getit.tab1_onl_mayrestrict
    • default.nui.getit.tab1_restrict
    • default.nui.getit.tab1_full
    • default.nui.getit.tab1_mayrestrict
    • default.nui.getit.tab1_norestrict
    GetIT! Tab2 (modified)
    Added the following codes to support the Click here for more options message that displays in the More section on the Full Display page in the new UI. Each of the new labels are prefixed with nui. For example:
    Get it service labels (new)
    This table defines labels for various subsections, messages, and back links in the Get It section on the Full Display page in the new UI. Each of the new codes are prefixed with nui. For example, the following code displays the Locations header:
    User Links (new)
    Library card Labels (new)
    See Brief Display of an Item.
    Suggestions labels (new)
    Defines the labels associated with the Suggestions area of the Full Display.
    Favorites Labels (new)
    Defines the labels used on the My Favorites page.
    More details on the changes to the mapping tables are described in the following sections.

    Brief Results Page

    The Brief Results page displays the search results. This section focuses on the changes that are relevant to the new UI.
    Brief Results Page

    Availability Statement

    The availability statement in the new UI is a link that directs users to either of the following pages:
    • An external page:
      • Alma directs to the item's full text.
      • SFX directs to the item's full text.
      • Primo directs to link to resource if there is a single link for the record. Otherwise, the link displays the record's full display to allow users to select a link.
      • Primo directs to OPAC via link.
      • Other scenarios configured in the new column as Out in GetIT! Link 1 Configuration mapping table. See Get It Service for more details.
    • The Full Display page on which attention is focused on the relevant GetIt1 service:
      • Get it (Alma) – Full display focusing on Get It service with Alma Get It mashup.
      • Get it (Aleph/Voyager) – Full display focusing on Get it service with Request & Locations.
      • View it (Alma) – Full display focusing on View It service with Alma View It mashup.
      • View Online – full display focusing on View Online service.
      • Other links scenarios configured in the new column as Full in GetIT! Link 1 Configuration mapping table. See GetIT 1 Services for more details.
    If the item has both an online and a physical copy, an availability statement will appear for each on separate rows.
    Multiple Availability Statements
    The out-of-the-box configuration covers all of the out-of-the-box delivery scenarios so there should be no need to make any changes. For more details, see GetIT 1 Services.
    To support the display of the availability statement in the new UI, an enrichment must be applied by either executing a pipe manually or running RTA. This means that existing customers who are not running RTA will need to reload their data to apply the enrichment.


    The Actions List mapping table will continue to configure the actions for the classic and new UIs, but the Up-front Actions field has been added to support the actions that appear without clicking the ellipsis icon Ellipsis_Icon.png in the new UI. The following figure highlights the up-front actions.
    Up-Front Actions
    From right to left, the e-Shelf action should be set to 1, the two up-front actions should be set 2 and 3, and all other actions should be left blank. The order of the actions for the complete list of actions is determined by the Order field, from right to left.
    • Settings for local send-to actions and Delicious will be ignored. In the November release, the customization package will be used to configure the local actions.
    • The SMS action will be added in a later release.

    Full Display Page

    The Full Display page displays the services for a selected item. This section focuses on the changes that are relevant to the new UI.
    Full Display Page

    GetIT 1 Services

    For OvP, the Get It section in the new UI takes the information in the Request and Locations tabs from the classic UI and displays it in the Requests and Locations subsections of the Get It section. The configuration is very similar to the classic UI. For Alma, the mashup for the Get It tab displays under the Get It section on the Full Display page. The following changes were made to support the new UI:
    • The Availability/Service links field has been added to the GetIT! Link 1 Configuration mapping table to define how the system handles the Getit1 links (including View It and View Online). For more details, see GetIT Links.
    • The Items Brief Display mapping table has been added to configure the details that appear in brief display of an item on the Full Display page. There is an option to define up to three parameters per field and the delimiter that displays between them.
    • The Get it service labels code table has been added to configure the labels for this service on the Full Display page. All other labels are taken from existing code tables.

    View Online Service

    The View Online section displays the links that link either to the resource or to the link resolver system. Clicking a link opens the link in a new page instead of in an i-frame (which was done in the classic UI). This is to prevent displaying external unresponsive or insecure HTTP content within an i-Frame in the new Primo UI. The text that displays for each type of link is determined as follows:
    • Link-to-resource link – the text is taken from the $$D value of the linktorsrc field in the PNX (which is the same as the classic UI).
    • For all the other cases or when there is no $$D value in the linktorsrc field – the text is taken from the new codes in the Tab 1 Label Code code table. The codes starts with default.nui.getit_full.* text. The relevant code is calculated based on the existing GetIT! Tab 1 Text Configuration mapping table with the combination of Delivery Category Code, Availability Status Code, and Data Source Code).
    For Alma-E and Alma-D records, the mashup for the View It tab displays under the View It section in the record's full display. In situations where an Alma-P record has links to an online resource in the MARC 85640 and 85641 tags, Primo uses the Online Resource delivery category and displays the links from the links/linkstorsrc PNX field under the View Online section in the record's full display. For information on changing the label for this service to View It, see Configuring Primo Delivery of Alma Data and Services.

    Links Service

    The links that display in the Links section of the new UI's Full Display are taken from the Links section in the classic UI's Details tab. No new configuration is necessary.
    Details Tab in the Classic UI

    More Service

    The More service displays additional links, which are configured with the GetIT 2 delivery mapping and code tables. To support the new UI, the Service Link field was added to the GetIT! Link 2 Configuration mapping table. This new field indicates whether to display Alma's mashups or the links to the external sites on the Full Display page. For more details on configuring links, see GetIT Links.

    Main Menu Links

    The links that display in the Main Menu are still configured in the Main Menu tile of the Views Wizard. The out-of-the-box links will continue to open the classic UI pages until new UI pages are ready. In addition, some of the out-of-the-box links do not currently display in the new UI. The following table describes each of the out-of-the-box links:
    Link Description
    Library search
    Displays and opens the new UI home page in the current window.
    Does not display currently.
    Displays and opens in a new tab/window.
    Citation linker
    Displays and opens in a new tab/window.
    Displays and opens in a new tab/window.


    The descriptions of the links display in the tooltip and links page (when clicking on ‘…’) are defined in the View labels code table. The codes of the out-of-the-box links are already defined, and the codes for other links should be defined in the table.
    Customer’s link descriptions should be created after May release. Until the description is created, the code will display.

    My Library Card

    The My Library Card page replaces the My Account page in the new UI. It includes a new Overview tab that allows users to see a summary of all tabs under My Library Card.
    My Library Card

    Brief Display of an Item

    The following mapping tables are used to configure the brief display of items in the Loans, Requests, and Fines tabs, respectively:
    • Loans Brief Display
    • Requests Brief Display
    • Fines Brief Display
    In each of the associated pages, the first row of the brief display contains the most important information and is not configurable. The second row, which is configurable, allows you to define up to three parameters per field and the delimiter that separates them.
    The new Library card Labels code table defines the labels for the brief display. Out of the box, only the fields that require text have been defined.

    Full Display of an Item

    The fields that display in the full display of an item in the Request, Loans, and Fines tabs are taken from the following existing mapping tables, respectively:
    • <type of request> Request Detailed Display
    • Loans Detailed Display
    • Fines Detailed Display
    To prevent duplication of information, do not include fields that already display in the brief display of the item.

    Personal Details

    The Personal Details page allows users to update their personal information, which is divided into the following sections:
    • Registration - Expiry date and patron group display under the Personal details heading.
    • Address - Includes the following address-related fields:
      • address_1 - address_5
      • city
      • state
      • zip
      • address_valid_from
      • address_valid_to
    • Contact - Includes the following contact information:
      • telephone_1 - telephone_4
      • sms_number
      • my_email
    • Actions -
      • mail_attachment (Aleph only)
      • sms_authorized
      • Library notices flags (Alma only)
    The Personal Setting Fields mapping table allows you to select which fields to display on the Personal Details page.

    Alert Notifications

    My Library Card will display alert notifications in various places to let users know that they may be required to perform an action due to a borrowing activity. These alerts will display in the following areas to make sure that the user is aware of a required action:
    • Next to a specific tab at the top of My Library Card
    • Next to an item in a borrowing activity tab (such as the Loans or Requests tabs)
    The following types of notifications are provide by the new UI:
    • Loan due or overdue LoanDueIcon.png – This notification indicates that a borrowed item is almost due or overdue. For additional configuration information, see Loan Alert Configuration.
    • Hold ready RequestReadyIcon.png – This notification appears when a requested item is ready for pickup.
    • Blocks or messages MessageBlockIcon.png – This notification may indicate that a particular activity has been blocked or that the library has sent a message.
    • Fines and fees FineFeeIcon.png – This notification indicates that the user has incurred a fine or a fee.

    Loan Alert Configuration

    The new Library card alerts mapping table allows you to configure the alert that displays for loan when a loan is due soon or is overdue. You can specify the number of days before a loan is due to display the alert.
    Library Card Alerts Mapping Table
    If you want display the loans with the alert at the top of the list, you will need to configure the ILS to retrieve the list by due-date ascending.

    Services Page

    With the new UI, you can use your institution's view as the basis for the Alma Services Page. This allows you to use the same configuration for both your institution's view and the Alma Services Page.
    New Services Page 
    The following elements on the new Services Page are suppressed either internally or through CSS:
    • Links menu
    • Search section
    • Details service – All of the open URL data displays in the brief display, see below.
    • Brief display – Consists of the following elements, which are not configurable:
      • Thumbnail appears on the left side.
      • Resource type above the title does not display.
      • First line – title
      • Second line – creator, creation date
      • Third line -  identifier
      • Forth line - is part of  
    If you want to test the Services Page in the new UI prior to enabling it, you can use the following base URL:
    To enable the new UI's Services Page:
    1. In the Primo Back Office, access the Institution Wizard (Primo Home > Ongoing Configuration Wizards > Institution Wizard).
    2. From the list of institutions, edit your institution.
    3. Select the New UI Enabled check box to redirect users to the new UI's Services Page. Because of this redirection, it will not be necessary to change the base URL in the source system (such as Google Scholar).
      Institution Wizard
    4. Select your institution's view from the Select View drop-down list.
      • If you do not select a view, Primo will use the view specified in the OpenURL request.
      • If you are receiving bX recommendations in the classic UI (which is indicated by the bX Token field), you must populate the Alma Services Page URL field to allow users to display the full record for titles clicked in the Related Reading section of the new UI.
    5. Save and deploy your changes to the Front End.

    Sign-In Page

    On the Primo Sign-In page (which displays for Alma and LDAP), you can add links (such as a link to retrieve forgotten passwords) and a description that will appear after clicking Need help. The following tables have been added to support this functionality:
    • User Login Links mapping table – Allows you to define up to four links that display on the Primo Sign-In page. If only a single link is defined, the link will appear without clicking Need help.
    • User Links code table – Defines the labels for the links and the description for the Primo Sign-In page.

    E-Shelf Migration to My Favorites

    The new UI uses labels rather than folders to categorize information in My Favorites. Signed-in users will create and then assign labels to items placed in My Favorites.The main difference is that there is no hierarchy between the labels as with the folders in the e-Shelf.
    Because folders will no longer exist in the new UI, users' folders must be migrated to the new UI as labels. The following rules will be applied to migrate users' e-Shelf folders and their associated items to the new UI:
    • Folder/subfolder names are converted to label names only if a folder/subfolder has items. All items directly under that folder/subfolder are assigned to that label name. If an item belongs to a subfolder, it will not be assigned to its higher-level folders as well.
    • Items stored directly under the Basket folder in the e-Shelf will not be assigned a label, but users can still list them by selecting the Unlabeled items filter in the new UI.
    For example, if an e-Shelf in the classic UI contains the following items and folders:
    Folders in e-Shelf
    My Favorites in the new UI will show labels for the folders/subfolders that had items. In addition, the item stored directly under the Basket folder was placed under the Unlabeled items filter:
    Labels in My Favorites
    • Was this article helpful?
    // feedback widged