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

    Configuring Request Forms for Primo VE

    For Alma-Summon environments, see Configuring Request Forms for Alma-Summon.

    Return to menu

    Introduction

    Alma enables users to fill out various request forms so that they can provide additional information when requesting an item with the Full Display or Services page in Primo VE. The displayed request types are based on the inventory type of the record and display logic rules. For more information, see Configuring Discovery Interface Display Logic for Primo VE.

    In the following example, the user may place the following types of requests on the book: Request and Digitization.

    PVE_RequestOptions_GetIt.png

    Request Options for Physical Inventory in Get It

    Selecting the Request link and then the Booking request type opens the Booking Request Form, which enables you to check the item's availability for the specified date and time and to send the request, which is handled by the library.

    PVE_BookingRequest_CheckAvailability.png

    Booking Request Form - Check Availability

    In addition, Primo VE enables you to create links in the Main Menu that open the following blank request forms: Resource Sharing and Purchase Request. For more information, see Configuring the Links Menu.

    PVE_BlankRequestForms.png

    Links to Blank Request Forms

    The following table lists the mapping tables that enable you to customize the various request forms:

    Request Configuration Mapping Tables
    Link in Alma Request Form
    Digitization Request Digitization Optional Parameters (see Configuring a Request Form) – This mapping table defines the optional fields that appear in digitization requests.

    Requests from Primo VE are handled in Alma. For information regarding Alma workflows and configuration, see Requests in Alma.

    Hold and Booking Request Request (Hold and Booking) Optional Parameters (see Configuring a Request Form) – This mapping table defines the optional fields that appear in hold and booking requests.

    Requests from Primo VE are handled in Alma. For information regarding Alma workflows and configuration, see Requests in Alma.

    Purchase Request Purchase Request Optional Parameters (see Configuring a Request Form) – This mapping table defines the optional fields that appear in purchase requests.

    Requests from Primo VE are handled in Alma. For information regarding Alma workflows and configuration, see Requests in Alma.

    Resource Sharing Request Resource Sharing Form Customization (see Configuring the Resource Sharing Request Form) – This page contains the following sections, which enable you to configure various aspects of the Resource Sharing Request form:
    • Resource sharing request fields – This section configures the general fields, which apply to book and article requests. This section enables you to specify the order of fields, show/hide fields, and indicate which fields users must populate.
    • Book request – This section configures the fields associated with book requests. This section enables you to specify the order of fields, show/hide fields, and indicate which fields users must populate.
    • Article request – This section configures the fields associated with article requests. This section enables you to specify the order of fields, show/hide fields, and indicate which fields users must populate.
    • Delivery fields – This section configures the fields associated with the delivery of the book or article. This section enables you to specify the order of fields, show/hide fields, and indicate which fields users must populate. In addition, some of the fields enable you to specify a default, which may be useful when hiding a field.
      The Copyrights field enables the Copyrights dialog box that appears after a user submits a resource sharing request. The following mapping codes are associated with the labels in the Copyrights dialog box: AlmaResourceSharing.copyright.title, AlmaResourceSharing.copyright.message, AlmaResourceSharing.cancel, and AlmaResource.agree.
    The Resource Sharing Labels code table (see Configuring Display Labels for Primo VE) enables you to modify the labels that display on the Resource Sharing Request form and the Copyrights dialog box.

    Requests from Primo VE are handled in Alma. For information regarding Alma workflows and configuration, see Requests in Alma.

    For consortia, configurations on this page cannot be managed and distributed centrally with the Network Zone (NZ) institution.

    Configuring Non-Resource Sharing Request Forms

    For requests other than resource sharing requests, you can decide which fields to display to the end users and provide a default value for each field.
    To configure a request form other than the Resource Sharing Request form:
    1. Open the request form that you want to configure:
      • Digitization Request Form – Configuration Menu > Discovery > GetIt Configuration > Digitization Request

        The following table shows which fields appear for digitization requests:

        Digitization Request Field Relevant for
        calculateQueueButton Digitization
        comment Digitization, General Digitization, Digitize Another Issue
        generalUseLabel –

        The General Use Label field enables you to add a free-text label to the Digitization Request Form. This label is undefined by default and will not display unless defined. To configure this label, modify the description and translation for the almaDigitization.generalUseLabel code in the Digitization Labels code table (Configuration Menu > Discovery > Display Configuration > Labels).

        Digitization, General Digitization, Digitize Another Issue
        manualDescription General Digitization, Digitize Another Issue
        notNeededAfter Digitization, General Digitization, Digitize Another Issue
        partial Digitization, General Digitization, Digitize Another Issue
        publicationDate General Digitization, Digitize Another Issue
        copyrightDeclaration

        To display this field, you must also define the content of the copyright declaration in Alma. For more details, see Configuring Copyright Declarations.

        Digitization, General Digitization, Digitize Another Issue

        Example:

        PVE_CopyrightDeclaration.png

        genericCheckBox – See Adding a Generic Field to a Form. Digitization, General Digitization, Digitize Another Issue
        formDescription – See Adding a Description to a Form. Digitization, General Digitization, Digitize Another Issue
        The following fields appear only after the user selects the Partial check box on the Digitization Request Form:
        chapterArticleAuthor Digitization, General Digitization, Digitize Another Issue
        chapterArticleTitle Digitization, General Digitization, Digitize Another Issue
        endPage Digitization, General Digitization, Digitize Another Issue
        fullChapter Digitization, General Digitization, Digitize Another Issue
        issue General Digitization, Digitize Another Issue
        part General Digitization, Digitize Another Issue
        startPage Digitization, General Digitization, Digitize Another Issue
        volume General Digitization, Digitize Another Issue
      • Hold and Booking Request Form – Configuration Menu > Discovery > GetIt Configuration > Hold and Booking Request

        The following table shows which fields appear for hold and booking requests:

        Hold Request Field Relevant for
        comment Hold, General Hold, Another Issue
        materialType Hold
        notNeededAfter Hold, General Hold, Another Issue
        termsOfUse Hold
        checkAvailability Hold
        calculateQueueButton Hold
        chapterArticleAuthor General Hold, Another Issue
        chapterArticleTitle General Hold, Another Issue
        startPage General Hold, Another Issue
        endPage General Hold, Another Issue
        volume General Hold, Another Issue
        issue General Hold, Another Issue
        part General Hold, Another Issue
        publicationDate General Hold, Another Issue
        manualDescription General Hold, Another Issue
        genericCheckBox – See Adding a Generic Field to a Form. General Hold, Another Issue
        formDescription – See Adding a Description to a Form. Hold, General Hold, Another Issue

        addressLine1 -  addressLine4

        Hold (future use)

        city

        Hold (future use)

        stateProvince

        Hold (future use)

        postalCode

        Hold (future use)

      • Purchase Request Form – Configuration Menu > Discovery > GetIt Configuration > Purchase Request

        The following table shows which fields appear for purchase requests:

        Purchase Request Field Notes
        author  
        edition  
        isbn  
        issn  
        lccNumber  
        oclcNumber  
        publisher  
        publication_year  
        place_of_publication  
        requesterNotes  
        volume  
        materialType  
        purchaseRequestLibrary  
        genericCheckBox For more information, see Adding a Generic Field to a Form.
        formDescription For more information, see Adding a Description to a Form.
    2. Select Customize to enable the form to be customized. You only need to do this the first time.
    3. In the Display to Public column, select Yes (viewable to users) or No (not viewable to users) for each field.
    4. In the Default column, specify a default value for the field if necessary. An empty field indicates that there is no default value for the field. For checkbox fields, enter true to select that field by default.

      For example, if you want the Partial checkbox selected by default on the Digitization Request Form, set Default to true for the partial field in the table.
    5. In the Mandatory column, select this checkbox if the user must enter this field on the form.
    6. Select Save to save your changes to the mapping table.

    Configuring Resource Sharing Request Forms

    For resource sharing requests, you can decide which fields to display to the end users, indicate whether a field is required, and provide a default value for some fields.
    To configure the Resource Sharing Request form:
    1. On the Resource Sharing Request Form page (Configuration Menu > Discovery > GetIt Configuration > Resource Sharing Request), select Customize to enable the form to be customized. You only need to do this the first time.

      You can set the Item Availability field to Mandatory to prevent requests from being submitted if the availability calculation does not find available copies. For more information, see the following:

    2. In the Resource sharing request fields section, select the following fields for each of the general request fields:
      • Mandatory – Select this checkbox if the user must specify this field on the request form.
      • Visible – Select this checkbox if you want this field to appear on the form.
    3. In the Book request section, select the following fields for each of the book-related fields:
      • Mandatory – Select this checkbox if the user must specify this field on the request form.
      • Visible – Select this checkbox if you want this field to appear on the form.
    4. In the Article request section, select the following fields for each of the article-related fields:
      • Mandatory – Select this checkbox if the user must specify this field on the request form.
      • Visible – Select this checkbox if you want this field to appear on the form.
    5. In the Delivery fields section, select the following fields for each of the delivery-related fields:
      • Mandatory – Select this checkbox if the user must specify this field on the request form.
      • Visible – Select this checkbox if you want this field to appear on the form.
      • Default – Specify a default value for the field if necessary. An empty field indicates that there is no default value for the field. Note that this field is not applicable to all fields.
    6. Select Save to save your changes to the mapping table.

    Book Chapter Requests

    Out of the box, book chapter and specific page range requests require users to select the digital fulfillment option to let the library staff know that this is not a request for the entire book from the lending library. If the Specific Chapter or Pages field is enabled and users select the I only need a specific chapter or pages checkbox, the Digital option is automatically selected in the Format field, and the Chapter and Pages fields are visible to enable users to specify the pages or chapter needed for digitization.

    PVE_RSS__BookChapter.png

    Specify Chapter Information 

    Adding a Description to a Form

    Each of the request forms enable you to add a message to the top of the form, which may include HTML formatting. If you add HTML formatting, you must let the system know by prefixing the text in the code's description with {include_HTML}. For example:

    {include_HTML}<p class="descText">This is demo content.</p>

    PVE_DigitizationRequest_FormDescription2.png

    Example Digitization Request Form with a Formatted Description

    Currently, the inline style attribute is not supported. We recommended adding CSS to your view's customization package.

    To add a message to the top of the form:
    1. Depending on the type of request form, open its associated code table and customize its description. 

      Code Table Code Default Description

      Purchase Request Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaPurchaseRequest.formDescription

      Form Description 

      Request Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      Request:
      almaRequest.formDescription

      Booking:
      almaBookingRequest.formDescription

      Form Description

      Digitization Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaDigitization.formDescription

      Form Description

      Resource Sharing Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaResourceSharing.formDescription

      Form Description

    2. Open the configuration page of the request form that you want to modify: 

      • Request Form – Configuration Menu > Discovery > GetIt Configuration > Hold and Booking Request

      • Digitization Request Form – Configuration Menu > Discovery > GetIt Configuration > Digitization Request

      • Purchase Request Form – Configuration Menu > Discovery > GetIt Configuration > Purchase Request

      • Resource Sharing Request Form – Configuration Menu > Discovery > GetIt Configuration > Resource Sharing Request

    3. Make the Form Description field visible to users and indicate whether it is mandatory.

    4. Save the changes to the form.

    Adding a Generic Field to a Form

    To each request form, you can add a generic checkbox that enables you to gather additional information from the user to pass to the library.

    PVE_GenericField.png

    Generic Checkbox (Default Text)

    This information is returned in Alma's Comment field using the following format:

    <generic checkbox label>: <true or false>
    • If Alma's Comment field already contains text, this field's information is appended to it.

    • For the Purchase Request Form, this information is returned in Alma's Requester Note field.

    To add a generic checkbox to a form:
    1. Depending on the type of request form, open its associated code table and customize the description of the genericCheckBox code. 

      Code Table Code Default Description

      Purchase Request Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaPurchaseRequest.genericCheckBox

      Generic Field 

      Request Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaRequest.genericCheckBox

      Generic Field

      Digitization Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaDigitization.genericCheckBox

      Generic Field

      Resource Sharing Labels (Configuration Menu > Discovery > Display Configuration > Labels)

      almaResourceSharing.genericCheckBox

      Generic Field

    2. Open the configuration page of the request form that you want to modify: 

      • Request Form – Configuration Menu > Discovery > GetIt Configuration > Hold and Booking Request

      • Digitization Request Form – Configuration Menu > Discovery > GetIt Configuration > Digitization Request

      • Purchase Request Form – Configuration Menu > Discovery > GetIt Configuration > Purchase Request

      • Resource Sharing Request Form – Configuration Menu > Discovery > GetIt Configuration > Resource Sharing Request

    3. Make the genericCheckBox field visible to users.

    4. Save the changes to the form.

    Adding Autofill for Blank Resource Sharing Requests

    When requesting articles with a blank Resource Sharing Request Form, users can automatically fill in the following fields based on a specified DOI or PMID: Article Title, Journal Title, Author, Volume, Issue, ISSN, Pages, Start Page, End Page, and Publication Year.

    If this functionality is enabled, the system will display an Auto fill button next to the DOI and PMID fields (if visible). Selecting a button automatically populates the fields associated with that DOI or PMID. If the user had already entered a field, it is not overwritten by the autofill action.

    PVE_RSR_Autofill.png

    Resource Sharing Request Form with Autofill Capability Enabled

    This functionality requires the Augmentation integration profile to be configured in Alma (see Alma Resolver Augmentation). In addition, you must enable the following field pairs in the Discovery configuration to make the buttons visible on the form: DOI / DOI Auto Fill and PMID / PMID Auto Fill.

    Setting Personal Delivery Locations from Hold Request Form

    When this functionality is enabled, users can select a personal delivery location (such as home or work) and either add or modify its details on the Request Form. After placing the request, the location information is updated in the user's account.

    In the following example, the user selected Work Address, but it had not been added to the user's account previously. 

    PVE_Add_Personal_Delivery_Location.png

    Add Address for User's Work Location from Request Form

    For more details on configuring personal delivery requests, see the following Alma pages:

    This functionality is disabled by default.

    To enable users to update or provide address information for personal delivery locations:
    1.  Open the Hold and Booking Request Form page (Configuration Menu > Discovery > GetIt Configuration > Hold and Booking Request).

    2. In the following rows, set the Display to Public column to true: addressLine1 –  addressLine4citystateProvincepostalCode.

    3. Select Save.

     Additional Configuration Options

    Refer to the following table for information on how to configure associated display labels for the request form and personal delivery location types.

    Element Description

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

    The following codes enable you to customize and translate the display labels for the address fields on the Request Form:

    • almaRequest.addressLine1 – Address Line 1

    • almaRequest.addressLine2 – Address Line 2

    • almaRequest.addressLine3 – Address Line 3

    • almaRequest.addressLine4 – Address Line 4

    • almaRequest.city – City

    • almaRequest.stateProvince – State/Province

    • almaRequest.postalCode – Postal Code

    ViewIt Labels code table (Configuration > Discovery > Display Configuration > Labels)

    The following codes enable you to customize and translate the display labels for the standard personal delivery location types on the Request Form:

    • personal_delivery.home_address – Home Address

    • personal_delivery.work_address – Work Address

    Additional Personal Delivery Address Types (Configuration > Fulfillment > Patron Configurations > Additional Personal Delivery Address Types)

    Other than the standard personal delivery location types for work and home addresses, this table enables you to define 10 additional personal delivery location types to which users can add or modify address information (such as their address and city).

    You can customize and translate the display values for each type by updating the Description and Translation columns for each of the following codes: 

    • P_DELIV_ADDRESS_1 – Personal delivery address type 1

    • P_DELIV_ADDRESS_2 – Personal delivery address type 2
      ...

    • P_DELIV_ADDRESS_10 – Personal delivery address type 10

    • Was this article helpful?