Kuali Rice 2.3.0 KRAD Guide Table of Contents 1. About KRAD ................................................................................................................. 1 Overview of the Rice Project ...................................................................................... 1 Rice Objectives .................................................................................................. 1 Rice Methodology .............................................................................................. 2 Rice Modules .................................................................................................... 3 Rice Deployments .............................................................................................. 4 User Experience 101 .................................................................................................. 5 Increasing skills in UI development ....................................................................... 6 KRAD - Common User Interface Artifacts .............................................................. 7 Accessibility with WCAG 2.0 and ARIA ....................................................................... 8 Introduction – What are WCAG 2.0 and ARIA? ...................................................... 8 WCAG 2.0 Overview .......................................................................................... 9 Accessibility Code Checkers ................................................................................. 9 What should developers pay attention to in creating accessible applications with KRAD? ............................................................................................................ 9 ARIA Overview ............................................................................................... 10 Adding ARIA to an application ........................................................................... 11 2. Getting Started .............................................................................................................. 14 KRAD Architecture ................................................................................................. 14 Spring Beans .......................................................................................................... 14 Configuration System ........................................................................................ 15 Bean Configuration ........................................................................................... 15 Primitive Properties ........................................................................................... 16 Collections ....................................................................................................... 17 Other Objects ................................................................................................... 18 Compound Property Names ................................................................................ 20 The P-Namespace ............................................................................................. 20 Bean Parents .................................................................................................... 21 Bean Containers ............................................................................................... 22 Bean Scope ...................................................................................................... 23 The Development Environment .................................................................................. 24 New Project Setup ................................................................................................... 27 Project Structure and Configuration Files .............................................................. 29 Configuring Your Rice Application ...................................................................... 30 Importing into Eclipse and Starting the App .......................................................... 30 Setup for KRAD Development ............................................................................ 32 Our Sample Application ............................................................................................ 33 3. Data Objects ................................................................................................................ 34 Data Objects and Business Objects ............................................................................. 34 Data Objects .................................................................................................... 34 Business Objects ............................................................................................... 35 Special Business Objects .................................................................................... 36 OJB Primer .............................................................................................................. 37 OJB XML METADATA .................................................................................. 38 CLASS DESCRIPTORS .................................................................................... 38 FIELD DESCRIPTORS ..................................................................................... 39 DATATYPE CONVERSION ............................................................................. 39 RICE CUSTOM DATATYPES ........................................................................... 40 OTHER FIELD DESCRIPTOR ATTRIBUTES ..................................................... 41 REFERENCE DESCRIPTORS .......................................................................... 42 Collection Descriptors ....................................................................................... 44 iii Kuali Rice 2.3.0 KRAD Guide 4. The Data Dictionary ...................................................................................................... 47 Introduction to the Data Dictionary ............................................................................. 47 Attribute Definitions ................................................................................................. 47 Data Object and Business Object Entries ..................................................................... 49 Relationship and Collection Definitions ....................................................................... 50 Constraints ............................................................................................................. 50 Simple Constraint Properties ............................................................................... 50 Validation Patterns ............................................................................................ 52 Custom Validation Patterns ................................................................................. 55 Prerequisite Constraints ...................................................................................... 55 Must Occur Constraints ..................................................................................... 56 Case Constraints ............................................................................................... 57 State-based Validation and Constraints ................................................................. 58 Data Dictionary Services ........................................................................................... 62 The DATAOBJECTMETADATASERVICE .................................................................. 62 Extending the Data Dictionary ................................................................................... 62 5. Introduction to the UIF .................................................................................................. 63 Overview of the UIF ................................................................................................. 63 UIF Goal: Rich UI Support ................................................................................ 63 UIF Goal: More Layout Flexibility ..................................................................... 63 UIF Goal: Easy to Customize and Extend ............................................................ 64 UIF Goal: Improved Configuration and Tooling ..................................................... 64 UIF Dictionary ................................................................................................. 64 The UIF and UIM ............................................................................................ 64 Component Design .................................................................................................... 65 Parts of a Component ....................................................................................... 65 Customizing and Extending the UIF ..................................................................... 67 Building Templates with FreeMarker ............................................................................ 70 Variable Markup ............................................................................................... 70 FreeMarker DataTypes ....................................................................................... 73 Control Statements ............................................................................................ 74 Context and Macros .......................................................................................... 75 Invoking Macros ............................................................................................... 77 Other