Transcription of Oracle Application Framework Developer’s Guide
1 Oracle Application Framework developer 's Guide Release RUP5. April, 2007. 2. Table of Contents Oracle Application Framework developer 'S 9. 9. Oracle Application Framework Support Guidelines for 11. CHAPTER 1: GETTING STARTED .. 15. Introduction to OA Framework .. 15. Setting Up Your Development 21. Customer, Consultant or Support Representative Using JDeveloper on Windows .. 21. Customer, Consultant or Support Representative Using JDeveloper on Linux .. 23. Building and Running 'Hello, World!' .. 26. OA Framework Development Runtime Configuration .. 55. CHAPTER 2: OA Framework ESSENTIALS .. 57. JSP Application Primer .. 57. Anatomy of an OA Framework Page .. 65. Page 65. The 66. The 70. The Controller .. 75. Web Bean 77. Guide to OA Framework Javadoc .. 79. OA Framework State Management .. 82. Architectural 82. Root Application Modules (Database Session and Transaction State).. 83. Servlet 87. Oracle applications User Session .. 87. Page Context .. 88. Request .. 91.
2 State Persistence Model ('Passivation') .. 92. Application Module Pooling .. 92. CHAPTER 3: BUILDING AN OA Framework Application (THE BASICS)95. Implementing the Model .. 95. Designing Model 95. Recommended Build 97. Business Components 97. Entity 97. Entity Associations (Association Objects) .. 104. View Objects and View 106. View 112. Application Modules .. 115. Entity Objects, Entity Experts, 'Validation' Application Modules and 'Validation' View Objects124. Validation View Objects (VVOs) .. 125. 3. Validation Application Modules (VAMs) .. 125. Entity Experts .. 125. Reusing Business 126. Implementing the View .. 128. Designing the User Interface .. 128. 128. Reusable Components .. 130. Attribute Sets .. 133. URL Parameters: Tokens, Encryption, 135. Style 136. Accessibility .. 137. Internationalization .. 137. Model Interaction .. 138. Menus and Page Security .. 142. Implementing the 146. Designing an OA 146. Creating an OA Controller .. 148. Handling an HTTP 149.
3 Modifying Bean 151. Creating Beans Programmatically .. 152. Handling an HTTP POST (Form Submit) .. 153. Model Interaction .. 155. Disabling Validation .. 157. 158. Error Handling .. 160. Creating Attribute Sets .. 171. Designing Attribute Sets .. 171. Creating Attribute Set Packages 171. Creating Attribute Sets Manually .. 172. Generating Attribute Sets Automatically (Only on Linux) .. 172. Internationalization .. 176. User 176. 176. Timezone .. 177. Date and Time .. 178. 179. Text and Component Alignment .. 180. Localized Layouts .. 180. Files in a Typical OA Framework 181. CHAPTER 4: IMPLEMENTING SPECIFIC UI 185. Accelerator Keys ('Hot Keys') .. 185. Attachments .. 187. Auto-Repeating Layouts .. 204. Bound Values .. 207. 213. 4. Bulleted 218. Buttons (Action/Navigation) .. 220. Buttons (Global) .. 228. Charts and Graphs .. 234. Component-Level Function Security (Dynamic User Interface).. 255. Concurrent Processing: Request Submission and 271. Content Containers in 276.
4 Contextual Information .. 279. Controlling UIX Rendering Output (Look-and-Feel / Facets).. 281. Custom HTML .. 283. Daily Business Intelligence (DBI) / OA Framework Integration .. 285. Data Export .. 288. Date 293. Declarative Page 297. Dialog Pages .. 307. Dynamic User Interface .. 255. File Upload and 310. Flexfields .. 313. Forms / OA Framework Page Integration .. 332. Headers and 335. 340. Hide/Show .. 352. Image Cache 359. Images in Your Pages .. 364. Include Content (URL and Servlet) .. 369. Inline Messaging, Tips, Hints and Bubble Text .. 371. Instruction 375. 377. List of Values (LOV) .. 380. Locator Element: Breadcrumbs .. 396. Locator Element: Page/Record Navigation .. 405. Locator Element: Train .. 411. Message 414. Notifications (Workflow Worklist) .. 417. Page Access 420. Page Contents Bottom 422. Page 423. Page Layout (How to Place Content).. 425. 5. Page Security .. 440. Page 446. Partial Page Rendering (Dynamic User Interface) .. 255. Personalizable 449.
5 Creating a Configurable Page .. 449. Creating an End-User Personalizable 460. Considering for Admin-Level 461. Personalization Caveats .. 464. Portlets .. 465. Printable 469. Processing Page .. 471. Quick 474. Related Links / 476. Rich Text 478. Save Model ('Warn About Changes') .. 486. Separator 490. 491. Shuttle .. 523. Standard Web 528. Submitting the Form .. 539. SubTab Navigation .. 543. Switchers ( Application and Context) .. 548. Tables - 551. Tables - 591. Tabs / 627. 642. CHAPTER 5: IMPLEMENTING SERVER-SIDE FEATURES .. 653. Java Entity 653. About Entity Objects .. 653. Create .. 653. Update / Validate .. 659. Delete .. 663. Lock .. 665. Rollback .. 666. Transaction Undo .. 668. Object Version Number 670. WHO Column Support .. 672. Error 672. Entity Experts, Validation applications Modules and Validation View Objects .. 673. Calling PL/SQL Functions and Procedures .. 675. Entity Objects for Translatable (_TL) Tables .. 676. 6. Standard Validation Patterns and 677.
6 PL/SQL Entity 681. Create .. 681. 682. Lock .. 683. Update .. 686. Delete .. 686. Rollback .. 688. WHO Column Support .. 688. Error 688. PL/SQL Entity Objects for _TL Tables .. 688. View Objects in 690. Application Modules in 703. Entity Object and View Object Attribute Setters .. 708. CHAPTER 6: ADVANCED OA Framework DEVELOPMENT TOPICS .. 715. Supporting the Browser Back Button .. 715. Browser Back Button Support Use Cases .. 729. OA Framework State Persistence Model (Passivation).. 758. Advanced Java Entity Object Development 777. Controlling UIX Rendering Output (Look-and-Feel / Facets).. 281. OA Framework and AOL/J 784. Application Module and Connection 785. Advanced View Object Development Topics .. 798. JTT/OA Framework Interoperability .. 810. CHAPTER 7: TESTING AND DEBUGGING .. 815. Discovering Page, Technology Stack and Session Information .. 815. Inspecting the MDS Repository Content .. 826. Debugging OA Framework applications .. 833. JDeveloper Debugging.
7 833. Remote Debugging w/ Apache Installation .. 835. Remote Debugging w/ Quik Apache .. 836. Examining Page 836. Logging .. 837. Testing .. 839. Running in 'Test' Modes .. 839. Using the Business Component Browser (BC4J Tester) .. 844. Verifying Page Size .. 845. Verifying SQL 845. Monitoring the Application Monitor .. 846. Running Oracle Accessibility Checker (OAC) .. 846. CHAPTER 8: STANDARDS AND GUIDELINES .. 847. 7. Oracle applications Java Coding Standards .. 847. OA Framework File Standards (Naming, Package Structure and Standard Content)855. OA Framework Model Coding Standards .. 871. OA Framework View Coding Standards .. 884. OA Framework Controller Coding 893. CHAPTER 9: EXTENDING AND DEPLOYING OA Framework applications 901. Extending OA Framework 901. Deploying Customer 908. Deploying Customer Personalizations .. 912. APPENDICES .. 925. OA Framework Profile Options .. 925. OA Framework ToolBox Technical Reference Manual (TRM) .. 941. OA Framework Development Frequently Asked Questions (FAQ).
8 948. OA Framework Issues .. 971. OA Framework Installation Troubleshooting .. 976. OA Framework URL Parameters .. 990. OA Framework Extensible Regions .. 995. 997. 8. Oracle Application Framework developer 's Guide Preface This manual describes how to set up your development environment, build, test and deploy Oracle applications (OA) Framework applications . It also includes the coding standards followed by the Oracle applications development staff, instructions for creating pages that comply with the Oracle Browser Look and Feel (BLAF) UI Guidelines, and information on extending the products shipped by Oracle applications development. Contents Audience Related Publications Typographic Conventions Send Us Your Comments Audience This documentation is written for the Application developer and assumes familiarity with Java and SQL. Related Publications Additional Oracle9i JDeveloper helpsets that apply to OA Framework Application development include: OA Framework ToolBox Tutorial OA Component Reference Getting Started with the OA Extension Getting Started with JDeveloper Developing Business Components As an Application designer, you should also be familiar with the Oracle Browser Look and Feel (BLAF) UI.
9 Guidelines and the documentation for the Oracle9i Database. Typographic Conventions This manual uses the following typographic conventions to distinguish important elements from the body of the manual. Command and Example Syntax Commands and examples appear in a monotype font, as follows: Syntax: ("<parameterName>");. Example: /*. ** Creates a SupplierEOImpl entity object and a corresponding row in the SuppliersVO. */. public void createSupplier(). {. OAViewObject vo = getSuppliersVO();. ( ());. }. Command and example syntax adhere to the following conventions: 9. Convention Explanation plain monotype Used for code fragments and examples. < Italic monotype in angle brackets > Indicates developer -supplied values.. An ellipsis indicates that the actual code extends beyond the example shown. /* A C-style comment. */. /** A Javadoc comment. */. // A Java comment. Indentation Oracle standard indentation helps to show code structure. Send Us Your Comments Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this manual.
10 Your input is an important part of the information used for revisions. Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most? If you find any errors or have any other suggestions for improvement, please indicate the document title, and the chapter, section, and page number (if available). You can send comments to us in the following ways: Electronic mail: FAX: (650) 506-7200 Attn: Oracle applications Documentation Manager Postal service: Oracle Corporation Oracle applications Documentation Manager 500 Oracle Parkway Redwood Shores, CA 94065 USA. If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address. If you have problems with the software, please contact your local Oracle Support Services. 10. Oracle Application Framework Support Guidelines for Customers Overview The Oracle Application Framework developer 's Guide documents the extensive set of features and capabilities made available by the Oracle Application Framework .