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

    Configuring the Request Forms for Alma-Summon

    Return to menu

    Alma allows users to fill out various request forms so that they can provide additional information when requesting an item with the Services page. 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 allows 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

    The following table lists the mapping tables that allow 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.

    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.

    Purchase Request

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

    Resource Sharing Request

    Resource Sharing Form Customization (see Configuring the Resource Sharing Request Form) – This page contains the following sections, which allow 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 allows 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 allows 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 allows 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 allows you to specify the order of fields, show/hide fields, and indicate which fields users must populate. In addition, some of the fields allow 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 Modifying Labels on Request Forms) allows you to modify the labels that display on the Resource Sharing Request form and the Copyrights dialog box.

    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:
      • Configuration Menu > Discovery > GetIt Configuration > Digitization Request
      • Configuration Menu > Discovery > GetIt Configuration > Hold and Booking Request
      • Configuration Menu > Discovery > GetIt Configuration > Purchase Request
    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 also 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 allow the form to be customized. You only need to do this the first time.
    2. In the Resource sharing request fields section, select the following fields for each of the general request fields:
      • Mandatory – Select this check box if the user must specify this field on the request form.
      • Visible – Select this check box 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 check box if the user must specify this field on the request form.
      • Visible – Select this check box 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 check box if the user must specify this field on the request form.
      • Visible – Select this check box 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 check box if the user must specify this field on the request form.
      • Visible – Select this check box 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 check box, the Digital option is automatically selected in the Format field, and the Chapter and Pages fields are visible to allow 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 the description of the formDescription code. 

      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)

      almaRequest.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 librarian 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.

     

    • Was this article helpful?