Configuring the WebValidation Table to Enforce the Appointment Requirement (Aeon 5.2+)

Print Friendly and PDF Follow

As of Aeon v5.2, the Appointment Required setting for reading room calendars configured in the Aeon Customization Manager will apply the appointment requirement only to the individual reading rooms and user statuses for which the Appointment Required setting is enabled instead of applying to all reading rooms on the site. To supplement this functionality, additional web validation options must be configured in the Aeon Customization Manager to ensure that the appointment requirement is properly enforced across the Aeon web pages after updating to Aeon 5.2 (if appointment scheduling features had been previously configured in Aeon 5.1) or when implementing the appointment scheduling features at Aeon 5.2 or later.

These web validation options will require the user to select a reading room when submitting requests so that Aeon can properly check the selected reading room's settings and apply the appointment requirement, if applicable. If this functionality is configured, users must select a reading room when placing requests on the Aeon web interface. This requirement will apply to both the request forms on which the appointment scheduling fields are configured and to the Saved Requests page. 

Configuration Instructions

Configuring this feature will require configuring settings in several different interfaces in the Aeon Customization Manager. The steps for configuring web validation will vary based on whether a photoduplication toggle has been added to the request form(s) containing the appointment scheduling fields.

Appointment Scheduling Calendar Configuration | Web Validation Configuration Instructions for Request Forms Not Using a Photoduplication Toggle | Web Validation Configuration Instructions for Request Forms Using a Photoduplication Toggle

Appointment Scheduling Calendar Configuration

First, ensure that each reading room for which you'd like to require appointments is properly configured in the Aeon Customization Manager:

  1. Open the Aeon Customization Manager
  2. Click on the Appointment Scheduling tab
  3. Review each reading room appointment calendar you have configured using the Reading Rooms navigation pane on the left side of the screen
  4. Ensure that the Appointment Required option is configured for each specific user status that should be required to book appointments in the room and/or as a default setting for the room in the Status-Specific Policies table:

    This requirement can be configured as a default setting/policy for the room or limited to only apply to certain user statuses. Each reading room can contain different requirements/policies for each user status (e.g., faculty users can be required to book appointments in one reading room but not required to do so in another). See Configuring Reading Room Calendars for more information on configuring these settings.

Appointment Required Setting in the Aeon Customization Manager

Web Validation Configuration Instructions for Request Forms Not Using a Photoduplication Toggle

If you have not enabledphotoduplication toggle on the request form(s) containing the appointment scheduling fields, web validation is configured using the WebValidation and WebFormValidationLinks tables following the instructions below.

WebValidation Table Configuration

Next, new entries must be created in the WebValidation table that will require the ReadingRoomID field on the requests form on which the appointment fields are configured:

  1. Click on the Customization tab in the Aeon Customization Manager
  2. Navigate to the WebValidation table (located under Web Interface | Validation)
  3. Click New Record
  4. Create a validation rule for the ReadingRoomID field that will apply to the web validation rule sets you have configured for your non-photoduplication request forms (i.e., the request forms on which the appointment scheduling fields are configured). The default non-photoduplication request forms will be covered by the ReadingRoomRequests rule set in a default Aeon configuration. To create a new validation rule for ReadingRoomID that will apply to the ReadingRoomRequests rule set, enter the following information:

    Rule Set ReadingRoomRequests
    Fieldname ReadingRoomID
    Validation .+
    Error You must select a reading room
    Error Tag ERRORReadingRoomID
    Your Aeon configuration may vary from the default and may use a different rule set to apply validation rules to your request forms. You may also have different rule sets configured for different request forms. You can check which rule sets have been applied on each request form and/or create new links between rule sets and request forms in the WebFormValidationLinks table. For more information on the two web validation tables, see Field Validation and Required Fields. To add the ReadingRoomID WebValidation table entry for additional rule sets, use the same configuration information above and change the Rule Set field to match the name of those additional rule set(s).
    Warning! If you are using a photoduplication toggle on any of your request forms, do not use a rule set that will apply the ReadingRoomID requirement to these forms and instead follow the configuration instructions for request forms using the photoduplication toggle below to configure web validation for these forms separately. 
  5. Click Save
  6. Repeat steps 3-5 for additional rule sets, if necessary
  7. Click New Record
  8. Create a new ruleset called ViewUserReviewRequests by entering the following information:

    Rule Set ViewUserReviewRequests
    Fieldname ReadingRoomID
    Validation .+
    Error You must select a reading room
    Error Tag ERRORReadingRoomID
    This rule will enforce the reading room selection requirement for requests submitted from the Saved Requests web page.
    The Saved Requests web page will only enforce the reading room requirement for requests that were created using a request form that has also been configured in the WebValidation table to require the ReadingRoomID field (see step 4 above for instructions).
  9. Click Save

WebFormValidationLinks Table Configuration

Finally, a new entry must be created in the WebFormValidationLinks table that will link the ViewUserReviewRequests form (i.e., the Saved Requests web page) to the new rule requiring the ReadingRoomID field:

  1. Navigate to the WebFormValidationLinks table (located under Web Interface | Validation)
  2. Click New Record
  3. Link the ViewUserReviewRequests form to the rule created in the WebValidation table by entering the following information:
    Form Name ViewUserReviewRequests
    Rule Set ViewUserReviewRequests
  4. Click Save
  5. Review the rest of the entries in the WebFormValidationLinks table to ensure that your non-photoduplication request forms have been linked to the rule set(s) indicated in the new validation rule(s) requiring the ReadingRoomID field that you created in steps 4-6 of the WebValidation table configuration instructions above

Web Validation Configuration Instructions for Request Forms Using a Photoduplication Toggle

If you have enabled the photoduplication toggle on a request form using the <#PHOTOTOGGLE> tag and the PhotoduplicationEnabled key in the Aeon Customization Manager, web validation for the ReadingRoomID field must be configured separately for this form following the steps below:

  1. Open the Aeon Customization Manager
  2. From the Customization tab, navigate to the WebValidation table (located under Web Interface | Validation)
  3. Click New Record
  4. Create a validation rule for the ReadingRoomID field as follows:

    Rule Set

    ReadingRoomToggle

    Note: The rule set name does not have to match "ReadingRoomToggle" and can be any unique value not previously used for a rule set in the WebValidation table.

    Fieldname ReadingRoomID
    Validation .+
    Error You must select a reading room
    Error Tag ERRORReadingRoomID
  5. Click Save
  6. Edit the include_photodup_toggle_enabled.html file in your web directory and add the following line for the FormValidationOverride hidden input under the <input type="hidden" name="RequestType" value="Loan"> line (default line 20):

    <input type="hidden" name="FormValidationOverride" value="ReadingRoomToggle">
    The value used in the value attribute must match the Rule Set value for the ReadingRoomID entry in the WebValidation table you configured in step 4 above. If you used a rule set name other than "ReadingRoomToggle" in step 4, please ensure that you update the code to reflect this name.
  7. Save the file
  8. Validation is now configured for the ReadingRoomID field on the form.

    Web Page Changes (Aeon 5.1 Web Pages Only)

    If you have not yet updated to the Aeon v5.2 Appointment Scheduling web pages, your existing web pages must be edited to mark the Reading Room dropdown as a required field on all web forms using the appointment scheduling fields. Please add the "(required)" text and 'required' attribute to the Reading Room field as shown below within the files listed below the example:

    <div class="form-group col-md-5 appointments-enabled">
    <label for="ReadingRoomID">
    <span class="<#ERROR name='ERRORReadingRoomID'>">
    Reading Room
    <span class="req">(required)</span>
    </span>
    </label>
    <select class="custom-select mr-sm-2" id="ReadingRoomID" name="ReadingRoomID"
    data-persisted-value="<#PARAM name='ReadingRoomID'>" size="1" required></select>
    </div>

    Use the code above to mark the Reading Room dropdown as required on the following web pages:

    • include_appointment_info.html
    • EADRequest.html (if your appointment scheduling fields are hardcoded in this file) OR include_appointment_info_ead.html (if your appointment scheduling fields are not hardcoded in this file and were implemented on EADRequest.html using a separate include file)

     

Questions?

If this article didn’t resolve your issue, please contact Atlas Support for assistance:

Contact Support