Kuali Rice Development
  1. Kuali Rice Development
  2. KULRICE-9525

Document best-practices for using JPA with Kuali Rice

    Details

    • Type: Task Task
    • Status: Closed Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.4.1
    • Component/s: Documentation, JPA, Roadmap
    • Security Level: Public (Public: Anyone can view)
    • Labels:
      None
    • Similar issues:
      KULRICE-10870Establish and document Jira best practices
      KULRICE-9613Document performance best practices in KRAD Guide
      KULRICE-9651Document performance best practices in KRAD Guide
      KULRICE-378Document proper service location and dependency injection practices that rice client devs should use (do this during KRA retreat week - June 11)
      KULRICE-6014JPA Conversion Guide
      KULRICE-3853JPA - Proof of concept with sequence / identity/ prePersist
      KULRICE-7905Create standard page for Javadocs
      KULRICE-13422QA Cross-training: AFT Gap Analysis
      KULRICE-13562QA Cross-training: AFT failure analysis
      KULRICE-13573QA Cross-training: IT Failure Analysis
    • Rice Module:
      KRAD
    • KRAD Feature Area:
      Persistence Framework
    • Sprint:
      2.4.0-m3 JPA Sprint 4, 2.4.0-m4 JPA Sprint 1
    • KAI Review Status:
      Not Required
    • KTI Review Status:
      Not Required
    • Code Review Status:
      Not Required
    • Include in Release Notes?:
      Yes

      Description

      This should include things like:

      1. How to use the built-in converters (for things like true/false, Y/N, encrypt/decrypt, etc.)
      2. How to handle sequences and identifier generation
      3. How to apply naming conventions for tables, columns, etc.
      4. How to set up persistence units (i.e. one persistence unit vs. multiple)
      5. Transaction management and transaction-scoped vs. resource local with JPA
      6. Caching and weaving (for lazy loading)
      7. Any other eclipselink properties we require and/or recommend
      8. Recommendations in terms of cascading settings that are done on relationships
      9. Recommendations on compound primary keys

      I'm sure there are others I am forgetting, but those are the ones off the top of my head.

        Activity

        Hide
        Eric Westfall added a comment -

        Assigning over to Allen since I think he's been working on some similar documentation.

        Show
        Eric Westfall added a comment - Assigning over to Allen since I think he's been working on some similar documentation.
        Hide
        Michael O'Cleirigh added a comment -

        Although there are no links on the jira I believe most of these items are now dealt with in the KRAD documentation:

        http://site.kuali.org/rice/2.4.1/reference/html/KRAD_Guide.html

        I don't see anything for #7 which is recommended eclipse link properties or #5 which is transaction scope and management (at least using the naming of the items in this jira).

        Show
        Michael O'Cleirigh added a comment - Although there are no links on the jira I believe most of these items are now dealt with in the KRAD documentation: http://site.kuali.org/rice/2.4.1/reference/html/KRAD_Guide.html I don't see anything for #7 which is recommended eclipse link properties or #5 which is transaction scope and management (at least using the naming of the items in this jira).

          People

          • Assignee:
            Allen Fox (Inactive)
            Reporter:
            Eric Westfall
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 2 days
              2d
              Remaining:
              Remaining Estimate - 2 days
              2d
              Logged:
              Time Spent - Not Specified
              Not Specified

                Agile

                  Structure Helper Panel