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

    Additional Library Card Configurations for Primo VE

    This page describes the Alma configurations that enable additional functionality in My Library Card.

    PVE_MLC_Overview.png

    Overview Page in My Library Card

    Configuring the Personal Details Tab

    The Personal Details tab in My Library Card displays account information associated with each user. If available from Alma, the following information displays by default for signed-in users: mailing address, email address, expiration date, patron group, and default interface language. When enabled, you can also display the following sections on the Personal Details tab:

    • Additional Email Addresses – This section displays additional email addresses that are included when an email is sent to the user's primary email address. If there are more than five additional email addresses, users see the Show All option to enable them to display all the additional emails. If enabled, users can add additional email addresses while editing their personal information in Primo VE.

    • User Identifiers – This section displays the user's identifiers (such as social media, institution, and barcode). If there are more than five identifiers, users can select the Show All option to see all identifiers.

    • User Roles – This section displays the user's roles (such as Patron or User Administrator). For each user role, the following information displays: scope of the role and expiration date (if defined). If there are more than five roles, users can select the Show All option to see all roles.

    For information on how to display the above sections, see Configuring Personal Details Settings for Primo VE. For information on how to configure additional personal settings, see Configuring the Personal Details and Settings Tab.

    Personal Details Tab in My Library Card

    Personal Details Tab in My Library Card 

    Allowing Users to Update Personal Information

    If permitted by Alma, the My Library Card > Personal Details page allows patrons to update their personal information. Depending on the type of information, additional configurations may be necessary to allow customers to view the information (see Configuring Personal Details Settings for Primo VE).

    To allow users to update their patron information from Primo VE:

    Set the primo_patron_info_updatable parameter to Y in the Customer Parameters table (Configuration Menu > General > General Configuration > Other Settings) in Alma.

    Allowing Users to Add Additional Email Addresses

    If users are permitted to view their additional email addresses, you can also permit them to add additional email addresses. Primo VE users must first select Edit to add email addresses.

    To allow users to add additional email addresses from Primo VE:
    1. Set the primo_patron_info_updatable parameter to Y in the Customer Parameters table (Configuration Menu > General > General Configuration > Other Settings) in Alma. This is required since users must be able to edit their personal information.

    2. Select the Allow add/edit internal emails field on the Personal Details Configuration mapping table (Configuration Menu > Discovery > Library Card Configurations > Personal Details Configuration).

    Disabling the Display of the Expiration Date

    By default, the expiration date appears at the top of the Personal Details tab.

    To disable the display of the expiration date:

    Clear the User Expiration Date field on the Personal Details Configuration mapping table (Configuration Menu > Discovery > Library Card Configurations > Personal Details Configuration).

    Configuring the Labels on the Personal Details Tab

    The Personal Settings Labels code table (Configuration Menu > Discovery > Display Configuration > Labels) enables you to customize and translate the display labels that appear on the Personal Details tab. For more details, see Configuring Display Labels for Primo VE.

    Configuring the Personal Details and Settings Tab

    The Personal Details and Settings tab replaces the Personal Details tab in My Library Card when you permit users to change the following additional settings:

    • Allow saving my search history – When enabled, this option enables signed-in users to save their search history between sessions.

    • Use my search history for the recent search suggestions – When enabled, your saved search history is used to provide search suggestions for subsequent searches in Primo VE.

    • Automatically extend my session – When enabled, the user's session is automatically extended without being prompted to extend the session.

     PVE_MLC_PersonalSettings_Extension.png

    Additional Settings Enabled in Primo VE

    This functionality is disabled by default and requires configuration at the institution level. The following table lists the required and optional configurations associated with this functionality.

    Configuration Element Description

    Discovery Customer Settings mapping table (Configuration Menu > Discovery > Other > Customer Settings)

    Configure the following settings to enable persistent functionality in the UI:

    • display_user_settings – Set this field to true to allow users to enable/disable the additional personal settings under My Library Card > Personal Details and Settings. This capability is disabled by default.

      In addition, this setting enables the My Personal details and settings link in the User Area menu.

    • save_users_search_history – Set this field to true to display the Allow saving my search history option in the Personal details section and to allow signed-in users to save search history between sessions.

    • show_recent_search – Set this field to true to display the Use my search history for the recent search suggestions option in the Personal details section and to allow a user's search history to be used to provide recent search suggestions.

    • default_user_search_history_off – Set this field to true to disable the following additional personal settings in My Library Card by default:

      • Allow saving my search history

      • Use my search history for the recent search suggestions

      When not specified or set to false, the above settings are enabled by default unless overridden by the user.

    For more details, see Discovery Customer Settings.

    User Authentication page (Configuration > Discovery > Authentication > User Authentication)

    Select the Enable user setting for extending the session parameter to display the Automatically extend my session option to the My Library Card > Personal Details and Settings tab, which enables users to automatically extend their sessions without being prompted to extend the session. By default, this parameter is disabled. For more details, see Configuring the Login Links for Primo VE.

    When set to true, the display_user_settings parameter must also be set to true in the Discovery Customer Settings mapping table (Configuration > Discovery > Other > Customer Settings). For more details, see Discovery Customer Settings.

    User Tile code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following code defines the label for the new option in the User Area menu:

    nui.eshelf.menu.userSettings – My Personal details and settings

    My preferences Tile code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following codes define the labels for the new options in the Personal settings section on the Personal Details tab:

    • nui.mypref.label.save_history – Allow saving my search history

    • nui.mypref.label.save_history_suggestions – Use my search history for the recent search suggestions

    • nui.mypref.label.extendMySession – Automatically extend my session

    • nui.mypref.label.extendMySessionShowMore – (Show more info)

    • nui.mypref.label.extendMySessionInfo – When enabling this setting, your session will be automatically extended and won't be timed out from any device you are logged in from. In order for this setting to take effect you must log out and login again or refresh the page

    Error messages code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following code defines the label for the error message that displays if the user settings cannot be saved for any reason:

    nui.mypref.label.errorSavingSettings – Settings were not saved due to an internal server error; Please try again later

    Aria Labels code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following codes support the use of screen readers for this functionality:

    • nui.aria.allowSavingHistory – Allow saving my search history

    • nui.aria.useHistoryForRecent – Use my search history for the recent search suggestions

    • nui.aria.myPersonalDetails – My Personal details and settings

    Library card Labels code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following codes define the labels for the new sections in My Library Card:

    • nui.detailsAndSettings.header – Personal details and settings

    • nui.userSettings.header – Personal settings

    Enabling Library Notices

    When enabled, the Library Notices area under Personal Details enables users to enable/disable the following library notices: Activity Report, Courtesy letter, Overdue Notice, Loan Status letter, Recall letter, and Recall Cancellation letter. As with other personal details, users must first select Edit Details to select/clear the notices.

    PVE_MyLibraryCard_LibraryNoticesArea.png

     Library Notices Area in My Library Card

    This functionality is disabled by default. To enable the display of the library notices, set the new display_actions_personal_settings parameter to true in the Discovery Customer Settings mapping table (Configuration > Discovery > Other > Customer Settings). For more information, see Discovery Customer Settings.

    When enabled, you can use the Library Notices Opt In mapping table (Configuration > User Management > User Details > Library Notices Opt In) to configure the possible opt-in notices and their default opt-in setting. For more information, see Configuring Library Notices Opt-In in Alma.

    Updating Self-Check Machine PINs 

    The Update Login Credentials section on the My Library Card > Personal Details page enables Alma users to retrieve, display, and modify their PIN and password.

    The following restrictions apply:

    • Password updates are limited to collaborative network users (patrons who are not associated with the institution but can receive fulfillment services from it).

    • PIN updates are only allowed for Alma environments that use PINs (Authentication required is set to Yes in the self-check machine integration profile - see Self-Check Machines) and have the use_pincode_for_selfcheck_machine parameter set to true in the Customer Parameters table (Configuration Menu > User Management > General > Other Settings) in Alma.

    If not permitted by Alma, some or all of the login credential fields may not display in My Account > Personal Settings.

    Configuring the Sort Direction for List of Loans 

    The primo_loan_list_sorting customer parameter enables you to configure the direction in which loans are sorted on the My Library Card > Loans page. By default, the loans are listed in descending order by due date. You may sort them in ascending order by due date if you prefer.

    To configure other settings, you must have one of the following roles:

    • General System Administrator
    • Fulfillment Administrator
    To change the sort direction of the loans in My Library Card:

    Set primo_loan_list_sorting to ascending or descending in the Customer Parameters mapping (Configuration Menu > Fulfillment > General > Other Settings). By default, the loans in the list are sorted in descending order by due date. For more information, see Configuring Other Settings.

    Viewing Digitized Content in My Library Card

    When digital content is requested via a resource sharing request and received as an email link, the following occurs:

    • The request entry is retained on the Requests tab for a specified duration based on a configurable parameter.

    • The description includes the Delivered status and a message indicating the maximum number of times the digital file can be downloaded.

    • Download link is placed next to the entry so that the user can download the item from the Requests tab. If the maximum number of downloads is reached, the following message appears after clicking the Download link: Maximum number of views exceeded.

    PVE_DownloadDigitalContent3_July2021_RNs.png

    Requests Tab in My Library Card

    Configuration Options

    The following table lists the required and optional configuration settings associated with this enhancement:

    Configuration Page Description

    Scheduled tab of the Monitor Jobs page (Admin > Manage Jobs and Sets > Monitor Jobs)

    The Document Delivery Files Cleanup job must be active to enable this functionality in Primo VE. This job is responsible for deleting the digital files from the cloud and removing entries from the Requests tab when the digital files are no longer permitted to be downloaded. For more details, see Viewing Scheduled Jobs in Alma.

    Customer Parameters Mapping Table page (Configuration Menu > Fulfillment > General > Other Settings)

    The following Alma Fulfillment customer parameters are associated with this functionality:

    • The document_delivery_cleanup_days parameter determines how long the file is available in the lender's/borrower's cloud. The default is 30 days.

    • The borrower_document_delivery_maximum_views parameter determines the maximum number of times the user may view this file. The default is 2 views.

    For more details, see Configuring Other Settings in Alma.

    Library Card Labels code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following code enables you to customize the description of the entry on the Requests tab in My Library Card:

    nui.request.max_num_of_views – The maximum number of views of the resource is: {0}

    Request Lists Labels code table (Configuration Menu > Discovery > Display Configuration > Labels)

    The following code enables you to customize the label for the download link on the Requests tab in My Library Card:

    nui.requests.download – Download

    • Was this article helpful?