R12 Extend Oracle

Applications: Building OA
Framework Applications
Student Guide Volume 1

D49185GC10
Edition 1.0
December 2007
D53744

Copyright 2007, Oracle. All rights reserved.

This document contains proprietary information and is protected by copyright and other intellectual property laws. You may copy and
print this document solely for your own use in an Oracle training course. The document may not be modified or altered in any way.
Except where your use constitutes "fair use" under copyright law, you may not use, share, download, upload, copy, print, display,
perform, reproduce, publish, license, post, transmit, or distribute this document in whole or in part without the express authorization
of Oracle.
The information contained in this document is subject to change without notice. If you find any problems in the document, please
report them in writing to: Oracle University, 500 Oracle Parkway, Redwood Shores, California 94065 USA. This document is not
warranted to be error-free.
If this documentation is delivered to the United States Government or anyone using the documentation on behalf of the United
States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS
The U.S. Governments rights to use, modify, reproduce, release, perform, display, or disclose these training materials are restricted
by the terms of the applicable Oracle license agreement and/or the applicable U.S. Government contract.
Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may
be trademarks of their respective owners.

Authors
Bill Sawyer, Lauren Cohn, Barbara Waddoups
Technical Contributors and Reviewers
John Zerbel, Jon Styles, Sara Woodhull, Suvarna Gadipatti, Liza Lyons, Vincent Thevenet
This book was published using:

oracletutor

Table of Contents
Introduction to OA Framework .....................................................................................................................1-1
R12 Building OA Framework Applications ..................................................................................................1-3
Course Objectives..........................................................................................................................................1-4
Lesson Objectives..........................................................................................................................................1-5
Agenda Day 1 .............................................................................................................................................1-6
Agenda Day 2 .............................................................................................................................................1-7
Agenda Day 3 .............................................................................................................................................1-8
Agenda Day 4 .............................................................................................................................................1-9
Agenda Day 5 .............................................................................................................................................1-10
Important Terminology..................................................................................................................................1-11
Personalization vs. Extension ........................................................................................................................1-13
Architectural Components of OA Framework...............................................................................................1-14
Why Java? .....................................................................................................................................................1-16
Foundations of Java Programming ................................................................................................................1-18
The Java Tech Stack for OA Framework ......................................................................................................1-20
Oracle JDeveloper 10g ..................................................................................................................................1-22
Oracle JDeveloper 10g Components .............................................................................................................1-24
What's in BC4J? ............................................................................................................................................1-26
What's in UIX? ..............................................................................................................................................1-27
What's in AOL/J? ..........................................................................................................................................1-28
What's in OA Framework? ............................................................................................................................1-29
What's in the Metadata Services? ..................................................................................................................1-30
What is the MVC Design Pattern?.................................................................................................................1-31
Why Do We Use MVC? ................................................................................................................................1-32
The OA Framework Architecture ..................................................................................................................1-33
Additional Resources.....................................................................................................................................1-34
Summary........................................................................................................................................................1-35
Concepts of the MVC Design Pattern ............................................................................................................2-1
R12 Building OA Framework Applications ..................................................................................................2-3
Lesson Objectives..........................................................................................................................................2-4
What is a JSP Page?.......................................................................................................................................2-5
Key JSP Application Components.................................................................................................................2-6
What Happens at Runtime? ...........................................................................................................................2-8
What Happens from the Start?.......................................................................................................................2-10
Behind the Scene ...........................................................................................................................................2-17
Logical Components of an OA Framework Page ..........................................................................................2-28
What is the MVC Design Pattern?.................................................................................................................2-29
Model: Business Components for Java..........................................................................................................2-30
Model: Application Modules.........................................................................................................................2-31
Model: Entity Objects....................................................................................................................................2-32
Model: View Objects.....................................................................................................................................2-33
View: OA Framework-Based Page................................................................................................................2-34
View: Java Objects in a Page.........................................................................................................................2-35
View: A Framework Example .......................................................................................................................2-36
View: Page Hierarchy....................................................................................................................................2-37
Controller: Controlling UI Behavior..............................................................................................................2-38
OA Framework MVC Summary ...................................................................................................................2-39
Summary........................................................................................................................................................2-40
Basics of the Model ..........................................................................................................................................3-1
R12 Building OA Framework Applications ..................................................................................................3-3
Lesson Objectives..........................................................................................................................................3-4
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

i

Model-layer BC4J Objects ............................................................................................................................3-5

Encapsulation The "Reuse Onion". ...............................................................................................................3-6
General Reuse Rules......................................................................................................................................3-7
Recommended Build Approach.....................................................................................................................3-8
Business Component (BC4J) Packages .........................................................................................................3-9
BC4J Package Naming Standards .................................................................................................................3-10
Application Modules .....................................................................................................................................3-11
Transaction Object.........................................................................................................................................3-14
Application Module Files ..............................................................................................................................3-15
Entity Objects ................................................................................................................................................3-16
Entity Object Creation Standards ..................................................................................................................3-18
Entity Object Automatic Features .................................................................................................................3-19
Entity Object Files .........................................................................................................................................3-20
View Objects .................................................................................................................................................3-21
View Object Creation Methods .....................................................................................................................3-24
ExpertMode View Objects ............................................................................................................................3-25
View Objects with Entity Objects .................................................................................................................3-26
View Object Rows.........................................................................................................................................3-27
Creating View Objects...................................................................................................................................3-28
View Object Java Files ..................................................................................................................................3-29
View Object Files ..........................................................................................................................................3-30
BC4J Database Interactions...........................................................................................................................3-31
Non-BC4J Method.........................................................................................................................................3-32
Read-only Queries .........................................................................................................................................3-33
Step 1: Initial Query ......................................................................................................................................3-34
Step 2: Entity Object Population ...................................................................................................................3-35
Step 3: Entity Object Reuse...........................................................................................................................3-36
Step 4: Entity-derived Attributes ...................................................................................................................3-37
Step 5: Entity Object Fault-in ........................................................................................................................3-38
Step 6: Entity Object References ...................................................................................................................3-39
EO/VO Merge ...............................................................................................................................................3-40
Step 1: EO/VO Merge Resolution .................................................................................................................3-41
Step 2: EO/VO Merge Resolution .................................................................................................................3-42
Other Model-layer Objects ............................................................................................................................3-43
Association Objects .......................................................................................................................................3-44
Reference Association Objects ......................................................................................................................3-46
Composition Association Objects..................................................................................................................3-47
Composition Association Object Behavior....................................................................................................3-48
View Links ....................................................................................................................................................3-49
Entity Experts ................................................................................................................................................3-51
Validation AMs and Validation VOs.............................................................................................................3-52
Summary........................................................................................................................................................3-54
Basics of the View ............................................................................................................................................4-1
R12 Building OA Framework Applications ..................................................................................................4-3
Lesson Objectives..........................................................................................................................................4-4
Recommended Build Approach.....................................................................................................................4-5
View-layer Terminology ...............................................................................................................................4-6
Workspaces and Projects ...............................................................................................................................4-8
Step 1: Create a Page .....................................................................................................................................4-9
Step 2: Name Your New Page .......................................................................................................................4-10
Step 3: View Page's Initial Structure .............................................................................................................4-11
Step 4: Modify the Page's Structure...............................................................................................................4-12
Running the New Page ..................................................................................................................................4-13
What Can You Add to the Page? ...................................................................................................................4-14
Region Styles.................................................................................................................................................4-15
Sub-Region Styles .........................................................................................................................................4-16
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

ii

Named Children vs. Indexed Children ..........................................................................................................4-17

Item Styles .....................................................................................................................................................4-19
Item Style Details ..........................................................................................................................................4-20
Shared Regions ..............................................................................................................................................4-23
Attribute Sets .................................................................................................................................................4-25
Creating Attribute Sets ..................................................................................................................................4-26
Table Column Template ................................................................................................................................4-27
Button Template ............................................................................................................................................4-28
Region Header Template ...............................................................................................................................4-29
CSS Styles .....................................................................................................................................................4-30
Common CSS Styles .....................................................................................................................................4-31
Extending Other Objects ...............................................................................................................................4-33
Destinations and Links ..................................................................................................................................4-34
Mailto Links ..................................................................................................................................................4-35
Lists of Values (LOVs)..................................................................................................................................4-36
Defining an External LOV.............................................................................................................................4-38
Reading Model Data......................................................................................................................................4-40
Writing Model Data.......................................................................................................................................4-42
Binding Items to Data....................................................................................................................................4-44
General Naming Rules...................................................................................................................................4-45
Page and Object Naming Rules .....................................................................................................................4-48
Styles and Bean Names .................................................................................................................................4-49
Attribute Set Standards..................................................................................................................................4-50
Attribute Sets .................................................................................................................................................4-53
Attribute Set Naming Conventions................................................................................................................4-54
More Attribute Set Standards ........................................................................................................................4-55
Summary........................................................................................................................................................4-56
Basics of the Controller ...................................................................................................................................5-1
R12 Building OA Framework Applications ..................................................................................................5-3
Lesson Objectives..........................................................................................................................................5-4
Recommended Build Approach.....................................................................................................................5-5
Do You Need a Controller? ...........................................................................................................................5-6
Controller Basics ...........................................................................................................................................5-7
Common Logic to Code ................................................................................................................................5-8
Typical Locations for Code ...........................................................................................................................5-9
Handling Queries...........................................................................................................................................5-10
View Object initQuery Code .........................................................................................................................5-11
Dynamic WHERE Clauses ............................................................................................................................5-12
Using findByKey Instead of initQuery..........................................................................................................5-13
Processing a Button Press..............................................................................................................................5-14
Getting Parameters from Requests ................................................................................................................5-15
Example: Manually-built Search ...................................................................................................................5-16
The Process....................................................................................................................................................5-17
Example VOImpl Code .................................................................................................................................5-18
Example AMImpl Code.................................................................................................................................5-19
Example Controller Code ..............................................................................................................................5-20
Example Search: Controller...........................................................................................................................5-21
Forwarding to Another Page..........................................................................................................................5-22
Setting Titles with Message Dictionary.........................................................................................................5-23
Event Flow Overview....................................................................................................................................5-24
Initial Setup Flow ..........................................................................................................................................5-25
Controller Event Flows in OA Framework....................................................................................................5-26
GET Event Flow Overview ........................................................................................................................5-27
GET Event Flow (1-3)...................................................................................................................................5-28
GET Event Flow (4) Instantiate BC4J and UIX Classes .............................................................................5-30
Example Bean Hierarchy Structure ...............................................................................................................5-31
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

iii

GET Event Flow (5) processRequest...........................................................................................................5-32

GET Event Flow (6) Post-Processing..........................................................................................................5-33
GET Event Flow (7) UIX Renders the Page..................................................................................................5-34
POST Event Flow Overview ......................................................................................................................5-35
POST Event Flow (1 - 3) Submit, Client-Side Validation.............................................................................5-36
POST Event Flow (4 & 5) Validate User and Retrieve State ........................................................................5-37
POST Event Flow (6) Apply Form Data .......................................................................................................5-38
POST Event Flow (6) More of processFormData .........................................................................................5-39
POST Event Flow (7) processFormRequest..................................................................................................5-42
Summary........................................................................................................................................................5-43
Setting Up Your Development Environment ................................................................................................6-1
R12 Building OA Framework Applications ..................................................................................................6-3
Lesson Objectives..........................................................................................................................................6-4
Installing and Setting Up JDeveloper ............................................................................................................6-5
Configure Your Environment Variables........................................................................................................6-7
Get the DBC File ...........................................................................................................................................6-9
Create a Shortcut ...........................................................................................................................................6-10
Assign the E-Business Suite User..................................................................................................................6-11
Uncompress Tutorial.zip ...............................................................................................................................6-12
Launch JDeveloper 10g .................................................................................................................................6-13
Configure the Connections and Test..............................................................................................................6-14
Configure the Connection and User...............................................................................................................6-16
Summary........................................................................................................................................................6-18
OA Framework State Management ...............................................................................................................7-1
R12 Building OA Framework Applications ..................................................................................................7-3
Lesson Objectives..........................................................................................................................................7-4
Architectural Overview Session and Cookies.............................................................................................7-5
Architectural Overview JVM .....................................................................................................................7-6
State Caches in OA Framework ....................................................................................................................7-7
Root Application Modules.............................................................................................................................7-8
Default Root Application Module Retention.................................................................................................7-10
Retaining the Root Application Module........................................................................................................7-11
Recommendation: Multipage Flow ...............................................................................................................7-13
Recommendation: Multipage Flow with Side Trip .......................................................................................7-14
Recommendation: Side Trip with Extended Page .........................................................................................7-15
Recommendation: Unrelated Pages Flow......................................................................................................7-16
Servlet Session...............................................................................................................................................7-17
Applications User Session (ICX Session) .....................................................................................................7-18
Page Context..................................................................................................................................................7-19
Request and Page Boundaries........................................................................................................................7-20
Request ..........................................................................................................................................................7-23
Ways to Pass Parameters ...............................................................................................................................7-24
URL Parameters: Tokens, Encryption, Encoding..........................................................................................7-26
Passivation.....................................................................................................................................................7-28
Application Module Pooling..........................................................................................................................7-30
Application Module and Connection Pooling................................................................................................7-32
Application Module Pooling Process ............................................................................................................7-34
Monitoring the AM Pool ...............................................................................................................................7-38
JDBC Connection Pooling Process ...............................................................................................................7-39
Monitoring the JDBC Connection Pooling....................................................................................................7-44
Determining User Load .................................................................................................................................7-46
Back Button Usage Goals..............................................................................................................................7-47
Back Button Scenario #1 ...............................................................................................................................7-48
Back Button Scenario #2 ...............................................................................................................................7-49
Back Button Scenario #3 ...............................................................................................................................7-50
Addressing Consistent Behavior....................................................................................................................7-51
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

iv

Further Study of Back Button........................................................................................................................7-52

Summary........................................................................................................................................................7-53
Introduction to JDeveloper 10g with OA Extension.....................................................................................8-1
R12 Building OA Framework Applications ..................................................................................................8-3
Lesson Objectives..........................................................................................................................................8-4
Oracle JDeveloper 10g with OA Extension...................................................................................................8-5
Oracle JDeveloper 10g Components .............................................................................................................8-7
Applications and Workspaces........................................................................................................................8-9
Projects ..........................................................................................................................................................8-11
Creating JDeveloper Items ............................................................................................................................8-13
Creating a Workspace....................................................................................................................................8-14
Step 1: Creating a Project ..............................................................................................................................8-15
Step 2: Creating a Project ..............................................................................................................................8-16
Step 3: Creating a Project ..............................................................................................................................8-17
Step 4: Creating a Project ..............................................................................................................................8-18
Step 1: Establish a Database Connection.......................................................................................................8-19
Step 2: Establish a Database Connection.......................................................................................................8-20
Step 3: Establish a Database Connection.......................................................................................................8-21
Step 4: Establish a Database Connection.......................................................................................................8-22
Step 5: Establish a Database Connection.......................................................................................................8-23
Step 6: Establish a Database Connection.......................................................................................................8-24
Step 7: Establish a Database Connection.......................................................................................................8-25
Project Properties...........................................................................................................................................8-26
Project Properties Oracle Applications.......................................................................................................8-27
Directory Structure ........................................................................................................................................8-28
Exploring Java Files ......................................................................................................................................8-29
Exploring Other Objects - Wizards ...............................................................................................................8-30
Exploring Other Objects UI Objects...........................................................................................................8-31
Finding Methods and Fields ..........................................................................................................................8-32
Supporting Code Development with Profiler and Code Coach ....................................................................8-34
New Code Editor Features.............................................................................................................................8-36
Customizing JDeveloper 10g with OA Extension .........................................................................................8-38
Refactoring ....................................................................................................................................................8-40
JDeveloper Help System ...............................................................................................................................8-43
Obtaining Help on a Topic ............................................................................................................................8-44
Oracle JDeveloper Debugger.........................................................................................................................8-45
Breakpoints....................................................................................................................................................8-47
Breaking on Exceptions.................................................................................................................................8-49
Debugger Windows .......................................................................................................................................8-50
Stepping Through a Program.........................................................................................................................8-52
Watching Data and Variables ........................................................................................................................8-53
Debugging Declarative Applications.............................................................................................................8-54
More Debugging Tips....................................................................................................................................8-55
Understand BC4J Interactions .......................................................................................................................8-56
Debugging Validation and Commits .............................................................................................................8-58
Summary........................................................................................................................................................8-59
Implementing a Query and Drill-down .........................................................................................................9-1
R12 Building OA Framework Applications ..................................................................................................9-3
Lesson Objectives..........................................................................................................................................9-4
Course Methodology .....................................................................................................................................9-5
Finished Page Before Search .........................................................................................................................9-7
Finished Page After Search ...........................................................................................................................9-8
Finished List of Values Page .........................................................................................................................9-9
Finished Drilldown-to-Details Page ..............................................................................................................9-10
Summary........................................................................................................................................................9-11
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

v

Implementing a Create....................................................................................................................................10-1
R12 Building OA Framework Applications ..................................................................................................10-3
Lesson Objectives..........................................................................................................................................10-4
Implementing a Poplist..................................................................................................................................10-5
Extending a Shared Region ...........................................................................................................................10-6
Creating a New Row......................................................................................................................................10-7
Initializing a View Object..............................................................................................................................10-8
Creating and Initializing a VO Row ..............................................................................................................10-9
Getting the Data.............................................................................................................................................10-10
Saving a Row to the Database .......................................................................................................................10-11
Lab After Create Basics..............................................................................................................................10-12
Lab After Validations .................................................................................................................................10-13
Lab After Partial Page Rendering...............................................................................................................10-15
Summary........................................................................................................................................................10-17
Implementing a Delete.....................................................................................................................................11-1
R12 Building OA Framework Applications ..................................................................................................11-3
Lesson Objectives..........................................................................................................................................11-4
Error Handling Overview ..............................................................................................................................11-5
Exception Types ............................................................................................................................................11-6
Exception Classes ..........................................................................................................................................11-8
Message Types ..............................................................................................................................................11-9
Message Dictionary .......................................................................................................................................11-10
Implementing Message Dictionary................................................................................................................11-11
Instantiating Attribute-level Exceptions ........................................................................................................11-12
Instantiating Row-level Exceptions ...............................................................................................................11-13
Attribute Value - EO Example ......................................................................................................................11-14
Attribute Value - VO Example ......................................................................................................................11-15
Row Value - EO Example .............................................................................................................................11-16
Row Value - VO Example.............................................................................................................................11-17
Messaging Flows ...........................................................................................................................................11-18
Inline Messages .............................................................................................................................................11-19
Dialog Pages..................................................................................................................................................11-20
Switchers .......................................................................................................................................................11-22
Table Content Switcher Abilities and Limits.................................................................................................11-23
Implementing Table Content Switchers ........................................................................................................11-24
Query Page with Non-Deleteable Employee .................................................................................................11-25
Query Page with Deleteable Employee .........................................................................................................11-26
Warning Dialog .............................................................................................................................................11-27
Confirmation Message...................................................................................................................................11-28
Summary........................................................................................................................................................11-29
Implementing an Update.................................................................................................................................12-1
R12 Building OA Framework Applications ..................................................................................................12-3
Lesson Objectives..........................................................................................................................................12-4
Locator Elements...........................................................................................................................................12-5
Breadcrumbs..................................................................................................................................................12-6
Page Navigators.............................................................................................................................................12-7
Record Navigators .........................................................................................................................................12-8
Trains.............................................................................................................................................................12-9
Implementing Trains......................................................................................................................................12-10
Single-Page Update .......................................................................................................................................12-11
Update Confirmation .....................................................................................................................................12-13
Multi-Page Update.........................................................................................................................................12-14
Multi-Page Update Confirmation ..................................................................................................................12-17
Summary........................................................................................................................................................12-18
OA Framework Development Concepts and Standards ..............................................................................13-1
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

vi

R12 Building OA Framework Applications ..................................................................................................13-3

Lesson Objectives..........................................................................................................................................13-4
General Coding Standards .............................................................................................................................13-5
Coding Terminology......................................................................................................................................13-6
OA Framework Standard Considerations ......................................................................................................13-7
E-Business Suite Standard Considerations ....................................................................................................13-8
E-Business Suite Standard DB Objects .........................................................................................................13-11
Oracle BLAF Standards.................................................................................................................................13-13
E-Business Suite Java Standards ...................................................................................................................13-14
OA Framework File Standards ......................................................................................................................13-15
Files in a Typical OA Framework Application..............................................................................................13-16
Standard File Suffix Abbreviations ...............................................................................................................13-18
Package Names..............................................................................................................................................13-20
File Names.....................................................................................................................................................13-23
Region and Item Names ................................................................................................................................13-24
OA Framework Model Standards ..................................................................................................................13-25
OA Framework View Standards....................................................................................................................13-26
OA Framework Controller Standards ............................................................................................................13-27
Summary........................................................................................................................................................13-28
OA Framework and E-Business Suite Security ............................................................................................14-1
R12 Building OA Framework Applications ..................................................................................................14-3
Lesson Objectives..........................................................................................................................................14-4
Key E-Business Suite Security Terms ...........................................................................................................14-5
Successive Layers of Access Control ............................................................................................................14-10
Increasing Flexibility and Scalability ............................................................................................................14-11
Function Security...........................................................................................................................................14-13
Data Security .................................................................................................................................................14-14
Oracle User Management Layers of Access Control.....................................................................................14-16
Role Based Access Control (RBAC) .............................................................................................................14-17
Delegated Administration..............................................................................................................................14-19
Registration Processes ...................................................................................................................................14-21
Self Service and Approvals ...........................................................................................................................14-23
Introduction to Function Security ..................................................................................................................14-24
Securing Functions ........................................................................................................................................14-25
Defining a Menu............................................................................................................................................14-26
Menu Guidelines ...........................................................................................................................................14-28
Creating a Menu ............................................................................................................................................14-29
Modifying an Existing Menu Definition ......................................................................................................14-30
Using Responsibilities ...................................................................................................................................14-31
Responsibility Components ...........................................................................................................................14-33
Defining a New Responsibility......................................................................................................................14-34
Sample Menu.................................................................................................................................................14-35
Dissecting Security Users ...........................................................................................................................14-36
Dissecting Security Responsibilities...........................................................................................................14-37
Dissecting Security Project Settings ...........................................................................................................14-38
Dissecting Security Menus .........................................................................................................................14-39
Key E-Business Suite Menu Terms ...............................................................................................................14-44
Dissecting Security Standard Menus ..........................................................................................................14-46
Menu: Global Menu.......................................................................................................................................14-47
Menu: Tabs....................................................................................................................................................14-48
Menu: Subtabs ...............................................................................................................................................14-49
Menu: Side Navigation..................................................................................................................................14-50
Menu: Task/Property Menu...........................................................................................................................14-51
Menu Structures.............................................................................................................................................14-52
Creating Menus .............................................................................................................................................14-53
Navigation and Security Separate..................................................................................................................14-54
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

vii

Introduction to Data Security.........................................................................................................................14-55

Data Security Components - Objects.............................................................................................................14-57
Grants ............................................................................................................................................................14-58
Permissions and Permission Sets...................................................................................................................14-59
Data Security Policies....................................................................................................................................14-60
Summary........................................................................................................................................................14-61
Deploying OA Framework Applications .......................................................................................................15-1
R12 Building OA Framework Applications ..................................................................................................15-3
Objectives ......................................................................................................................................................15-4
Storing Personalizations ................................................................................................................................15-5
Directory Structure ........................................................................................................................................15-6
Directory Structure - Layer Values................................................................................................................15-7
Toolset ...........................................................................................................................................................15-8
Functional Administrator Personalization UI ...............................................................................................15-9
export.bat / import.bat- Syntax ......................................................................................................................15-10
export.bat/import.bat - Example ....................................................................................................................15-11
Command Line XMLExporter/XMLImporter............................................................................................15-12
export.bat vs. XMLExporter..........................................................................................................................15-13
Import Substitutions JPXImport.bat ...........................................................................................................15-14
JPXImport.bat - Syntax .................................................................................................................................15-15
Import Substitutions JPXImporter ..............................................................................................................15-16
Inspecting the MDS Repository.....................................................................................................................15-17
JDR_UTILS PL/SQL package APIs..............................................................................................................15-18
List the Personalizations Done on a Page.....................................................................................................15-25
Inspect Personalizations ................................................................................................................................15-26
Deploying Personalizations ...........................................................................................................................15-28
Extract the Personalizations Functional Administrator Page......................................................................15-29
Set Personalization Document Root Path ......................................................................................................15-30
Import/Export Personalizations .....................................................................................................................15-31
Extract the Personalizations Select the Page ..............................................................................................15-32
Extract the Personalizations Export to File System ....................................................................................15-33
Upload Personalizations into Production Instance Functional Administrator Page....................................15-34
Upload Personalizations into Production Instance Exported Personalizations ...........................................15-35
Upload Personalizations into Production Instance Import from File System .............................................15-36
Extensions......................................................................................................................................................15-37
OA Page Extensions ......................................................................................................................................15-38
Deployment of Page Extensions....................................................................................................................15-39
1.Copy .java Classes......................................................................................................................................15-40
2. Import Substitutions ..................................................................................................................................15-41
3. Import OA Component Definitions ...........................................................................................................15-42
View The Deployed Extensions ....................................................................................................................15-43
BC4J Extensions............................................................................................................................................15-44
Deployment of Business Logic Extensions ...................................................................................................15-45
Summary........................................................................................................................................................15-46
Course Labs .....................................................................................................................................................16-1
R12 Building OA Framework Applications ..................................................................................................16-3
Lab 1..............................................................................................................................................................16-4
Lab - Learning More About the Page ........................................................................................................16-5
Task 1: Login to Your E-Business Suite Instance .....................................................................................16-6
Task 2: About This Page Link ...................................................................................................................16-9
Lab - Learning More About the Page ........................................................................................................16-15
Lab 2..............................................................................................................................................................16-26
Lab: JDeveloper and E-Business Suite Set-up...........................................................................................16-27
Task 1: Modify the FWKTEST User.........................................................................................................16-28
Task 2: Set-up the NX Client on Your Classroom PC...............................................................................16-30
Task 3: Open the NX Client on Your Classroom PC ................................................................................16-33
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

viii

Task 4: Unzip Tutorial.zip.........................................................................................................................16-35

Task 5: Set Your JDeveloper Environment ...............................................................................................16-36
Task 6: Start JDeveloper............................................................................................................................16-37
Task 7: Get the DBC File ..........................................................................................................................16-39
Task 8: Test Your JDeveloper Workspace and Project .............................................................................16-40
Task 9: Set-up Your Database Connection................................................................................................16-43
Task 10: Set Your Project Properties.........................................................................................................16-49
Task 11: Test Your JDeveloper Set-up......................................................................................................16-55
Task 12: Optional Personal Set-up .........................................................................................................16-58
Lab 3..............................................................................................................................................................16-59
Overview ...................................................................................................................................................16-60
Step 1. Setup your environment for OA Framework development............................................................16-61
Step 2. Create the Model-layer Components .............................................................................................16-63
Step 3. Create the View-layer Components...............................................................................................16-69
Lab 4..............................................................................................................................................................16-76
Overview ...................................................................................................................................................16-77
Task 1: Create Your Model-layer Components .........................................................................................16-78
Task 2: Create Your View-layer Components...........................................................................................16-83
Task 3: Configure Your Search .................................................................................................................16-85
Task 4: Add a List of Values (LOV) to Query ..........................................................................................16-91
Task 5: Create Your Model-layer Components .........................................................................................16-96
Task 6: Create Your View-layer Components...........................................................................................16-100
Task 7: Write Your Model-layer Programmatic Elements ........................................................................16-103
Task 8: Modify Your Existing View-layer Components ...........................................................................16-105
Task 9: Write Your Controller-layer Programmatic Elements ..................................................................16-106
Lab 5..............................................................................................................................................................16-109
Part 1: Basic Create Overview...................................................................................................................16-110
Task 1: Build Your Model-layer Components...........................................................................................16-111
Task 2: Build Your View-layer Components ............................................................................................16-112
Task 3: Implement the Poplist ...................................................................................................................16-118
Task 4: Write Your Model-layer Programmatic Elements ........................................................................16-121
Task 5: Write Your Controller-layer Programmatic Elements ..................................................................16-123
Task 6: Revise Your QueryPG ..................................................................................................................16-128
(OPTIONAL) Part 2: Validation Overview...............................................................................................16-130
Task 1: Handle the Back Button ................................................................................................................16-131
Task 2: Implement Declarative Validations ..............................................................................................16-139
Task 3: Implement Programmatic Validations ..........................................................................................16-141
Task 4: Creating Entity-Layer Validation Objects ....................................................................................16-155
(OPTIONAL) Part 3: Partial Page Rendering Overview...........................................................................16-163
Task 1: Create Your Model-layer Components .........................................................................................16-164
Task 2: Configure Your View-layer Components .....................................................................................16-166
Task 3: Implement the Programmatic Elements ........................................................................................16-168
Lab 6..............................................................................................................................................................16-173
Overview ...................................................................................................................................................16-174
Task 1: Build Your Model-layer Components...........................................................................................16-175
Task 2: Build Your View-layer Components ............................................................................................16-177
Task 3: Write Your Model-layer Programmatic Elements ........................................................................16-180
Task 4: Write Your Controller-layer Programmatic Elements ..................................................................16-182
Lab 7..............................................................................................................................................................16-188
Overview ...................................................................................................................................................16-189
Task 1: Initial Set-up .................................................................................................................................16-190
Task 2: Modify the QueryPG View-layer Components.............................................................................16-193
Task 3: Modify the Controller-layer Components.....................................................................................16-194
Task 4: Create Your View-layer Components...........................................................................................16-200
Task 5: Create Your Controller-layer Components ...................................................................................16-206
Guided Demo 1..............................................................................................................................................16-213
Task 1: Allow Personalizations .................................................................................................................16-214
Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

ix

Task 2: Personalize the Expenses Home Page...........................................................................................16-215

Task 3: Create folders on the server ..........................................................................................................16-218
Task 4: Set the Personalization Document Root Path Profile....................................................................16-220
Task 5: Export the Personalizations to File System...................................................................................16-221
Task 6: Edit the Personalizations...............................................................................................................16-224
Task 7: Change the Personalization Document Root Path Profile.............................................................16-226
Task 8: Import the Personalizations into the MDS repository...................................................................16-227
Guided Demo 2..............................................................................................................................................16-229
Pre-requisites: ............................................................................................................................................16-230
Task 1: Copy all .class files to $JAVA_TOP ...........................................................................................16-232
Task 2: Import the Page and Region into the MDS ...................................................................................16-233
Task 3: Register the Page within E-Business Suite ...................................................................................16-234
Task 4: Bounce the E-Business Suite Instance ..........................................................................................16-235
Task 5: Test Your New Page .....................................................................................................................16-236

Copyright Oracle Corporation, 2007. All rights reserved.

R12 Extend Oracle Applications: Building OA Framework Applications Table of Contents

x