Uploaded image for project: 'Kuali Rice Development'
  1. Kuali Rice Development
  2. KULRICE-6018

Document the document search framework changes

    Details

    • Type: Task
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: Backlog
    • Component/s: Documentation
    • Labels:
    • Rice Module:
      KEW

      Description

      • Create a migration guide on how to convert from using old doc search stuff to new doc search stuff
      • Include impacting changes (see below)
      • Fully javadoc all public api and framework classes and methods
      • Document the new architecture and how it works, including justification on why it will make doc search more performant/faster
      • Document how to turn a custom result value into a link by specifying it's data type as MARKUP
      • Document how DataDictionaryDocumentSearchCustomizer works now
      • all methods are final
      • subclasses should override and set searchableattribute and customizer as needed
      • Document how support for "roles" as they existed for document security in 1.0.x is no longer supported
      • KIM role authorization was added though
      • Document valid query parameters that can be passed to document lookup
      • Document the fact that, after upgrading, all users saved and recent document searches will be gone

        Attachments

          Issue Links

            Activity

            Hide
            ewestfal Eric Westfall added a comment -

            would be useful to have this around the time the beta test starts for KFS and KC projects to use since they have extensive doc search functionality.

            Show
            ewestfal Eric Westfall added a comment - would be useful to have this around the time the beta test starts for KFS and KC projects to use since they have extensive doc search functionality.
            Hide
            ewestfal Eric Westfall added a comment -

            Also be sure to document the change in "BO" name for those wanting to integrate with doc search via url, new bo class is:

            org.kuali.rice.kew.impl.document.search.DocumentSearchCriteriaBo

            Show
            ewestfal Eric Westfall added a comment - Also be sure to document the change in "BO" name for those wanting to integrate with doc search via url, new bo class is: org.kuali.rice.kew.impl.document.search.DocumentSearchCriteriaBo
            Hide
            jcoltrin Jessica Coltrin (Inactive) added a comment -

            Per Leads meeting today, moving most documentation Jiras to 2.1.

            Show
            jcoltrin Jessica Coltrin (Inactive) added a comment - Per Leads meeting today, moving most documentation Jiras to 2.1.
            Hide
            gptrude Grant Trudel (Inactive) added a comment -

            Per Eric: "[This] changed in release 2.0. Not sure how useful this document is any more, this really needed to exist a long time ago. I probably wouldn't put it as part of the core documentation, but definitely we need docs on how to use the new doc search framework. That would be part of the [KEW] guide and would be fairly detailed on how to use the framework to customize doc search."

            Show
            gptrude Grant Trudel (Inactive) added a comment - Per Eric: " [This] changed in release 2.0. Not sure how useful this document is any more, this really needed to exist a long time ago. I probably wouldn't put it as part of the core documentation, but definitely we need docs on how to use the new doc search framework. That would be part of the [KEW] guide and would be fairly detailed on how to use the framework to customize doc search."

              People

              • Assignee:
                Unassigned
                Reporter:
                ewestfal Eric Westfall
              • Votes:
                1 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: