Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: 2.2
    • Fix Version/s: 2.3.0-m1, 2.3
    • Component/s: Development, Roadmap
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • Similar issues:
      KULRICE-6743Document the UI Framework - State-based Validation
      KULRICE-6680UI Framework - Data Dictionary Validation
      KULRICE-6678UI Framework - State-based Validation
      KULRICE-6738Document the UI Framework - Tooltip construct
      KULRICE-6754Document the UI Framework - Keyboard Support
      KULRICE-6736Document the UI Framework code improvements
      KULRICE-6671UI Framework - Framework code improvements
      KULRICE-6737Document the UI Framework - Error Messaging Architecture
      KULRICE-6739Document the UI Framework - Online Help architecture
      KULRICE-6741Document the UI Framework - Central Message Repository
    • Rice Module:
      KRAD
    • KRAD Feature Area:
      Authorization and Presentation
    • Application Requirement:
      KS
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required
    • Include in Release Notes?:
      Yes

      Description

      Summary of Validation Changes Needed:

      Initial Error State

      • Change "This form has errors" dialog to growl error message.
        • Page should scroll to the top of the page
      • Make configurable the behavior that scrolls users to the top of the page when doing any server-side validation
        • Rationale: The adding of the collection item, since it writes to the server, can come back with a serverside error.
      • For collections that have a server-side error at the time of add-line, don't scroll the page and put focus on first field of the add line with the error.

      Window Title

      Page Title

      • Add flag to turn off Page Title summary (e.g. 9 errors)
        • Have off by default

      Page-Level Summaries

      • Add flag to turn off page summary text (e.g. This page/section has 9 errors & 18 other messages), or to make text configurable.
        • Have on by default
      • If the page has only one field with an error, it would be best to simply show the error icon and the error message text (which is a link to field). In this case no page summary text or section-level summary text should be shown within the page-level summary.
      • When section-level summaries are turned off, remove the section summary link (i.e. "The "Section 1" section has 7 errors & 14 other messages') and simply display the collection of field messages. The same should be true in the Section-SubSection relationship.

      Section-Level Summaries

      • Sections that have validation messages should be expanded by default.
      • Section summary links within the page-level summary should put focus on the first field that has an error in that section. As an alternative, focus can be placed on the link within the section-level summary for the first field with an error.

      All Summaries

      • Resolve page "jumping" when client-side errors are fixed.
        • Keep client-side errors and error summaries, but grey out and strikethrough once resolved.
        • After changing all errors in a section, the page-level summary will reduce the error count to zero, but not strike through the link to the section.

      Visual Design Changes

      • Remove pinstripe background.
      • Add flag to turn off validation icons that displays next to field.
        • Have validation icons hidden by default.
      • Use background color for the summary with actual error text.
        • If section-messages are on, use backgrond color on Section Summaries.
        • If section-messages are off, then use background color on Page summary.
      • Use a 24x24px icon for the page-level summary.
      • Adjust size page-level summary to be closer to icon size.

      Text Changes

      • Revise the summary link labeling. For example:
        • Remove brackets around the header message summary. So revise from "[! 7 Warnings]" to "! 7 warnings".
        • Revise the text from "The 'Section 2 Title' section has 2 warnings" to "Section 2 Title: 2 warnings"
        • Revise the text from "4 warnings before the 'SubSection 3.1 Title' section" to "4 warnings before SubSection 3.1 Title"

      Miscellaneous

      Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit

        Issue Links

          Activity

          Matt Sargent made changes -
          Field Original Value New Value
          Rice Lead gilesp
          Matt Sargent made changes -
          Fix Version/s 2.3.0-m1 [ 16756 ]
          Affects Version/s 2.2 [ 16411 ]
          Component/s Roadmap [ 13903 ]
          Hide
          Brian Smith (Inactive) added a comment -

          Need to talk to William before beginning work to make we have 100% clarity before beginning work

          Show
          Brian Smith (Inactive) added a comment - Need to talk to William before beginning work to make we have 100% clarity before beginning work
          William Washington (Inactive) made changes -
          Description Summary of Validation Changes Needed:
          - Change "This form has errors" dialog to growl error message.
          Background?: Alert box that shows that the user has errors
          should navigate to the top of the page
          should have a "close" icon
          Jerry changed from js alert to lightbox/

          - Don't scroll users to the top of the page when doing a server-side validation (or make it configurable
          Validation Summary links only give focus but don't scroll to Section

          - Turn off Page Title appendage by default

          - The HTML Page Title (view title) functionality wasn't built out.

          - Revise message colors & style
          Use message color near the item, but likely not at the top of the page.
          Explore use of larger icon near top of page, rather than many small icons.
          Remove pinstripes

          - Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages)

          - Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.
          Summary of Validation Changes Needed:
          - Change "This form has errors" dialog to growl error message.
          Background?: Alert box that shows that the user has errors
          should navigate to the top of the page
          should have a "close" icon
          Jerry changed from js alert to lightbox/

          - Don't scroll users to the top of the page when doing a server-side validation (or make it configurable
          Validation Summary links only give focus but don't scroll to Section

          - Turn off Page Title appendage by default

          - The HTML Window Title functionality from 2.2 wasn't built out and is still needed. See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          - Revise message colors & style
          Use message color near the item, but likely not at the top of the page.
          Explore use of larger icon near top of page, rather than many small icons.
          Remove pinstripes

          - Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages)

          - Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.

          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          William Washington (Inactive) made changes -
          Description Summary of Validation Changes Needed:
          - Change "This form has errors" dialog to growl error message.
          Background?: Alert box that shows that the user has errors
          should navigate to the top of the page
          should have a "close" icon
          Jerry changed from js alert to lightbox/

          - Don't scroll users to the top of the page when doing a server-side validation (or make it configurable
          Validation Summary links only give focus but don't scroll to Section

          - Turn off Page Title appendage by default

          - The HTML Window Title functionality from 2.2 wasn't built out and is still needed. See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          - Revise message colors & style
          Use message color near the item, but likely not at the top of the page.
          Explore use of larger icon near top of page, rather than many small icons.
          Remove pinstripes

          - Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages)

          - Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.

          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          Summary of Validation Changes Needed:

          * Change "This form has errors" dialog to growl error message.
          ** Page should scroll to the top of the page

          * Complete HTML Window Title functionality from 2.2
          ** See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          * Add flag to turn off Page Title summary
          ** Have off by default

          * Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages), or to make text configurable.
          ** Have on by default and use "This page has errors" by default

          * Make configurable behavior that scrolls users to the top of the page when doing any server-side validation
          ** Rationale: The adding of the collection item, since it writes to the server, can come back with a serverside error.

          * Revise message colors & visual style
          ** Use message color near the item, but likely not at the top of the page.
          ** Explore use of larger icon near top of page, rather than many small icons. (assign to Tom Clark?)
          ** Remove pinstripes


          - Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.

          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          Brian Smith (Inactive) made changes -
          Assignee Brian Smith [ bsmith ]
          William Washington (Inactive) made changes -
          Description Summary of Validation Changes Needed:

          * Change "This form has errors" dialog to growl error message.
          ** Page should scroll to the top of the page

          * Complete HTML Window Title functionality from 2.2
          ** See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          * Add flag to turn off Page Title summary
          ** Have off by default

          * Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages), or to make text configurable.
          ** Have on by default and use "This page has errors" by default

          * Make configurable behavior that scrolls users to the top of the page when doing any server-side validation
          ** Rationale: The adding of the collection item, since it writes to the server, can come back with a serverside error.

          * Revise message colors & visual style
          ** Use message color near the item, but likely not at the top of the page.
          ** Explore use of larger icon near top of page, rather than many small icons. (assign to Tom Clark?)
          ** Remove pinstripes


          - Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.

          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          Summary of Validation Changes Needed:

          * Change "This form has errors" dialog to growl error message.
          ** Page should scroll to the top of the page

          * Complete HTML Window Title functionality from 2.2
          ** See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          * Add flag to turn off Page Title summary (e.g. 9 errors)
          ** Have off by default

          * Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages), or to make text configurable.
          ** Have on by default and use "This page has errors" by default

          * Make configurable behavior that scrolls users to the top of the page when doing any server-side validation
          ** Rationale: The adding of the collection item, since it writes to the server, can come back with a serverside error.

          * Revise message colors & visual style
          ** Remove pinstripes
          ** Use background color for the summary with actual error text.
          *** If section-messages are on, use backgrond color on Section Summaries.
          *** If section-messages are off, then use background color on Page summary.
          ** UX to explore use of larger icon near top of page.


          * Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.

          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          Assignee Brian Smith [ bsmith ]
          William Washington (Inactive) made changes -
          Description Summary of Validation Changes Needed:

          * Change "This form has errors" dialog to growl error message.
          ** Page should scroll to the top of the page

          * Complete HTML Window Title functionality from 2.2
          ** See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          * Add flag to turn off Page Title summary (e.g. 9 errors)
          ** Have off by default

          * Add flag to turn off page & section validation summary text (e.g. This page/section has 9 errors & 18 other messages), or to make text configurable.
          ** Have on by default and use "This page has errors" by default

          * Make configurable behavior that scrolls users to the top of the page when doing any server-side validation
          ** Rationale: The adding of the collection item, since it writes to the server, can come back with a serverside error.

          * Revise message colors & visual style
          ** Remove pinstripes
          ** Use background color for the summary with actual error text.
          *** If section-messages are on, use backgrond color on Section Summaries.
          *** If section-messages are off, then use background color on Page summary.
          ** UX to explore use of larger icon near top of page.


          * Resolve page "jumping" when client-side errors are fixed.
          Need: change behavior to not add client-side errors to summaries.
          Solution: turn flag off that tells client-side errors where to display.
          Issue: the user won't know which errors are fixed. when an input becomes valid, the system won't know which error condition became valid
          Need/Solution: keep client-side errors and error summaries, but grey out and strikethrough
          Need: Grey out they section and page level icons once those are fixed.
          Possible solution?: Replacing client-side text with new message.

          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          Summary of Validation Changes Needed:

          Initial Error State
          * Change "This form has errors" dialog to growl error message.
          ** Page should scroll to the top of the page
          * Make configurable the behavior that scrolls users to the top of the page when doing any server-side validation
          ** Rationale: The adding of the collection item, since it writes to the server, can come back with a serverside error.
          * For collections that have a server-side error at the time of add-line, don't scroll the page and put focus on first field of the add line with the error.

          Window Title
          * Complete HTML Window Title functionality from 2.2
          ** See "The browser window title (e.g. HTML "Page Title")" on https://wiki.kuali.org/pages/viewpage.action?pageId=313868814

          Page Title
          * Add flag to turn off Page Title summary (e.g. 9 errors)
          ** Have off by default

          Page-Level Summaries
          * Add flag to turn off page summary text (e.g. This page/section has 9 errors & 18 other messages), or to make text configurable.
          ** Have on by default
          * If the page has only one field with an error, it would be best to simply show the error icon and the error message text (which is a link to field). In this case no page summary text or section-level summary text should be shown within the page-level summary.
          * When section-level summaries are turned off, remove the section summary link (i.e. "The "Section 1" section has 7 errors & 14 other messages') and simply display the collection of field messages. The same should be true in the Section-SubSection relationship.

          Section-Level Summaries
          * Sections that have validation messages should be expanded by default.
          * Section summary links within the page-level summary should put focus on the first field that has an error in that section. As an alternative, focus can be placed on the link within the section-level summary for the first field with an error.

          All Summaries
          * Resolve page "jumping" when client-side errors are fixed.
          ** Keep client-side errors and error summaries, but grey out and strikethrough once resolved.
          ** After changing all errors in a section, the page-level summary will reduce the error count to zero, but not strike through the link to the section.

          Visual Design Changes
          * Remove pinstripe background.
          * Add flag to turn off validation icons that displays next to field.
          ** Have validation icons hidden by default.
          * Use background color for the summary with actual error text.
          ** If section-messages are on, use backgrond color on Section Summaries.
          ** If section-messages are off, then use background color on Page summary.
          * Use a 24x24px icon for the page-level summary.
          * Adjust size page-level summary to be closer to icon size.

          Text Changes
          * Revise the summary link labeling. For example:
          ** Remove brackets around the header message summary. So revise from "[! 7 Warnings]" to "! 7 warnings".
          ** Revise the text from "The 'Section 2 Title' section has 2 warnings" to "Section 2 Title: 2 warnings"
          ** Revise the text from "4 warnings before the 'SubSection 3.1 Title' section" to "4 warnings before SubSection 3.1 Title"

          Miscellaneous
          * Fix the counting error shown on the Sections/Subsections page: http://env1.rice.kuali.org/kr-krad/uicomponents?viewId=Demo-ValidationLayout&methodToCall=start
          * After fixing Field Groups/Tabs validation page, check with William to confirm that behavior is as desired.
          * Test accessibility functionality of the validation framework with screen reader.


          Notes from previous discussions: https://docs.google.com/a/kuali.org/document/d/1bLdzBM14lbxGGUS4RsHWYT41Ce3OEviLW4XBl3m6IEY/edit
          William Washington (Inactive) made changes -
          Assignee Brian Smith [ bsmith ]
          Matt Sargent made changes -
          Documentation Review Status Pending Review [ 14643 ] Not Required [ 14642 ]
          Hide
          Brian Smith (Inactive) added a comment -

          Everything was changed to as listed except for "Test accessibility functionality of the validation framework with screen reader" since this is out of scope. A new jira needs to be created for this work/enhancement.

          Show
          Brian Smith (Inactive) added a comment - Everything was changed to as listed except for "Test accessibility functionality of the validation framework with screen reader" since this is out of scope. A new jira needs to be created for this work/enhancement.
          Brian Smith (Inactive) made changes -
          Status Open [ 1 ] Resolved [ 5 ]
          Fix Version/s 2.3.0-m1 [ 16756 ]
          Resolution Fixed [ 1 ]
          Brian Smith (Inactive) made changes -
          Documentation Review Status Not Required [ 14642 ] Pending Review [ 14643 ]
          Grant Trudel (Inactive) made changes -
          Include in Release Notes? Yes [ 14658 ]
          Hide
          Brian Smith (Inactive) added a comment -

          Looking at this list again, I cant remember if I verified/fixed "Sections that have validation messages should be expanded by default." Need to double check this.

          Show
          Brian Smith (Inactive) added a comment - Looking at this list again, I cant remember if I verified/fixed "Sections that have validation messages should be expanded by default." Need to double check this.
          Matt Sargent made changes -
          Link This issue discovered KULRICE-9452 [ KULRICE-9452 ]
          Erik Meade made changes -
          Link This issue is tested by KULRICE-9703 [ KULRICE-9703 ]
          Jessica Coltrin (Inactive) made changes -
          Status Resolved [ 5 ] Closed [ 6 ]
          Shem Patterson (Inactive) made changes -
          Workflow custom [ 163370 ] Copy of custom for rice [ 215463 ]
          Shem Patterson (Inactive) made changes -
          Workflow Copy of custom for rice [ 215463 ] custom [ 225211 ]
          Shem Patterson (Inactive) made changes -
          Workflow custom [ 225211 ] Rice Workflow [ 234959 ]

            People

            • Assignee:
              Brian Smith (Inactive)
              Reporter:
              William Washington (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Structure Helper Panel