You are previewing Oracle E-Business Suite R12 Integration and OA Framework Development and Extension Cookbook.
O'Reilly logo
Oracle E-Business Suite R12 Integration and OA Framework Development and Extension Cookbook

Book Description

A practical step-by-step guide to develop end-to-end extensions to Oracle E-Business Suite Release 12, with detailed illustrations and explanations

  • Gain key skills learning to extend Oracle E-Business Suite Release 12

  • Learn how to personalize Oracle Application Framework (OAF) pages and understand the structure of an OA Framework page

  • Set up a JDeveloper with OA Framework extension and configure a development environment

  • Develop OA Framework pages with advanced features such as a simple query page and master detail page

In Detail

Oracle’s suite of applications is used by many major businesses and public sector organizations throughout the world. Oracle E-Business Suite is the most comprehensive suite of integrated, global business applications that enable organizations to make better decisions, reduce costs, and increase performance. The book will show you how to build different types of extensions with different toolsets. It will take you from start to finish with fully working examples.

This book will show readers a wide variety of step-by-step examples of how to extend Oracle E-Business Suite Release 12 in a number of areas. The book focuses on OA Framework personalization and development, WebADI, and BI Publisher. It will take readers through the process of how to get started and what tools are needed. It will explain how to develop working examples and how to deploy them within Oracle E-Business Suite Release 12.

Learn how to extend Oracle E-Business Suite (EBS) Release 12, using detailed examples to work through how various components are configured and how we can extend standard functionality. The book focuses on OA Framework personalization and development, desktop integration (formerly WebADI), and BI Publisher and each chapter will introduce the topic before going through working examples from start to finish. There are plenty of detailed illustrations throughout each chapter giving clear instructions of what we are doing and why. Each topic will develop a solution that will utilize common core components of a subject area. It focuses on starting an extension right from the beginning to deploying it within E-Business Suite. At the end of each chapter the reader will have a good understanding of what they need to do for each area to take away and start using it in practice.

Each chapter will detail how to build an extension in the supported manner and also comes with complete, fully tested code and scripts that can be downloaded.

Table of Contents

  1. Oracle E-Business Suite R12 Integration and OA Framework Development and Extension Cookbook
    1. Table of Contents
    2. Oracle E-Business Suite R12 Integration and OA Framework Development and Extension Cookbook
    3. Credits
    4. About the Author
    5. About the Reviewers
    6. www.PacktPub.com
      1. Support files, eBooks, discount offers and more
        1. Why Subscribe?
        2. Free Access for Packt account holders
        3. Instant Updates on New Packt Books
    7. Preface
      1. Extending Oracle E-Business Suite
        1. Understanding the EBS architecture
        2. Before we start
      2. What this book covers
      3. What you need for this book
        1. Microsoft Word
        2. Developing code in EBS
        3. UNIX shell scripting
      4. Who this book is for
      5. Conventions
      6. Reader feedback
      7. Customer support
        1. Downloading the example code
        2. Errata
        3. Piracy
        4. Questions
    8. 1. Personalizing OA Framework Pages
      1. Introduction
      2. Getting started with personalizations
        1. Creating a custom responsibility
          1. How to do it...
          2. How it works...
        2. Creating a new user
          1. How to do it...
          2. How it works...
        3. Creating an employee record
          1. How to do it...
          2. How it works...
        4. Assigning a manager
          1. How to do it...
          2. How it works...
        5. Attaching an employee to a user record
          1. How to do it...
          2. How it works...
      3. Setting the personalization profile options
        1. How to do it...
        2. How it works...
      4. Discovering information about a page
        1. How to do it...
        2. How it works...
      5. Clearing the cache
        1. How to do it...
        2. How it works...
      6. Creating a user-level personalization
        1. How to do it...
        2. How it works...
      7. Adding tool tips
        1. Adding a tool tip to a page
          1. How to do it...
          2. How it works...
        2. Creating new messages
          1. How to do it...
          2. How it works...
        3. Adding a short tip type
          1. How to do it...
          2. How it works...
        4. Adding a long message tip type
          1. How to do it...
          2. How it works...
      8. Creating an item
        1. How to do it...
        2. How it works...
      9. Re-ordering items on a page
        1. How to do it...
        2. How it works...
      10. Adding a button to a page
        1. How to do it...
        2. How it works...
        3. There's more...
      11. Hiding a button on a page
        1. Getting ready
        2. How to do it...
        3. How it works...
      12. Making a field required
        1. How to do it...
        2. How it works...
      13. Adding a flexfield to a page
        1. How to do it...
          1. Getting the title of a descriptive flexfield
          2. Adding a DFF segment
          3. Enabling a flexfield on a self-service page
        2. How it works...
      14. Using SPEL to trigger personalizations
        1. Adding a SPEL statement
          1. How to do it...
          2. How it works...
        2. Creating a function
          1. How to do it...
        3. Adding a function to a menu
          1. How it works...
      15. Deactivating personalizations
        1. How to do it...
        2. How it works...
        3. There's more…
      16. Deleting personalizations
        1. How to do it...
        2. How it works...
    9. 2. Getting Started with OA Framework Pages
      1. Introduction
      2. Getting started with OA Framework
        1. OAF Architecture
          1. User interface XML (UIX)
          2. OA Controller (CO)
          3. Application module (AM)
          4. View object (VO)
          5. Entity object (EO)
        2. File locations
          1. Standard files
            1. UIX and CO
            2. VO and AM
            3. EO
          2. Custom files
            1. UIX and CO
            2. VO and AM
            3. EO
          3. MDS repository
          4. Bouncing apache
      3. Installing the database objects
        1. Getting ready
        2. How to do it...
        3. How it works...
      4. Setting up our development environment
        1. Downloading and installing JDeveloper with OA extension
          1. How to do it...
          2. How it works...
      5. Setting the environment variables
        1. How to do it...
        2. How it works...
      6. Transferring the DBC file from the application server
        1. How to do it...
        2. How it works...
      7. Creating a shortcut to JDeveloper
        1. How to do it...
        2. How it works...
      8. Creating an EBS user and assigning responsibilities
        1. How to do it...
        2. How it works...
      9. Adding database connections in JDeveloper
        1. How to do it...
        2. How it works...
      10. Setting the OC4J settings and project properties
        1. How to do it...
        2. How it works...
      11. Running a page
        1. How to do it...
        2. How it works...
      12. Creating a new project
        1. Creating a new workspace and project
          1. How to do it...
          2. How it works...
        2. Setting the project runtime parameters
          1. How to do it...
          2. How it works...
      13. Creating the model layer for a query page
        1. Creating the application module (AM)
          1. How to do it...
          2. How it works...
        2. Creating a view object (VO)
          1. How to do it...
          2. How it works...
        3. Linking the view object to the application module (VO to AM)
          1. How to do it...
          2. How it works...
        4. Testing the application module (AM)
          1. How to do it...
          2. How it works...
      14. Creating the view layer for a query page
        1. Adding a page (PG)
          1. How to do it...
          2. How it works...
        2. Renaming the default region (PG)
          1. How to do it...
          2. How it works...
        3. Adding a query region (RG)
          1. How to do it...
          2. How it works...
        4. Adding a results region (RG) using a wizard
          1. How to do it...
          2. How it works...
        5. Setting item properties
          1. How to do it...
          2. How it works...
        6. Testing the page
          1. How to do it...
          2. How it works...
    10. 3. Creating a Master Detail Page in OA Framework
      1. Introduction
      2. Creating the model layer for a master detail page
        1. Creating the entity object (EO)
          1. How to do it...
          2. How it works...
          3. There's more...
        2. Creating the application module (AM)
          1. How to do it...
          2. How it works...
        3. Creating the view object (VO)
          1. How to do it...
          2. How it works...
        4. Editing the view object (VO)
          1. How to do it...
          2. How it works...
        5. Linking the view object (VO) to the application module (AM)
          1. How to do it...
          2. How it works...
        6. Testing the application module (AM)
          1. How to do it...
          2. How it works...
        7. Creating the view link (VL)
          1. How to do it...
          2. How it works...
        8. Adding the view link (VL) to the application module (AM)
          1. How to do it...
          2. How it works...
        9. Testing the application module (AM)
          1. How to do it...
          2. How it works...
      3. Creating a master region
        1. Adding a master region (RN)
          1. How to do it...
          2. How it works...
        2. Creating the master region (RN) items
          1. How to do it...
            1. Creating columns
            2. Creating column items
            3. Creating column headers
          2. How it works...
        3. Creating the controller (CO)
          1. How to do it...
          2. How it works...
        4. Testing the page
          1. How to do it...
          2. How it works...
      4. Creating a detail region
        1. Adding a detail region (RN)
          1. How to do it...
          2. How it works...
        2. Creating the detail region (RN) items
          1. How to do it...
            1. Creating columns
            2. Creating column items
            3. Creating column headers
          2. How it works...
        3. Adding a show/hide attribute
          1. How to do it...
          2. How it works...
        4. Adding sortable headers
          1. How to do it...
          2. How it works...
      5. Deploying a page to EBS
        1. Copy the files to the application server
          1. How to do it...
          2. How it works...
        2. Set the permissions of the .class files on the application server
          1. How to do it...
          2. How it works...
        3. Importing the page definition
          1. How to do it...
          2. How it works...
        4. Creating a function
          1. How to do it...
          2. How it works...
        5. Configure a menu
          1. How to do it...
          2. How it works...
        6. Creating a custom responsibility
          1. How to do it...
          2. How it works...
        7. Adding our responsibility to a user
          1. How to do it...
          2. How it works...
        8. Run the OAF page
          1. How to do it...
          2. How it works...
    11. 4. Adding a Creation Page and LOV Region in OA Framework
      1. Introduction
      2. Creating a page to insert and update records
        1. Creating a view object
          1. How to do it...
          2. How it works...
        2. Linking the view object to an application module
          1. How to do it...
          2. How it works...
          3. There's more
        3. Creating a page to insert data
          1. How to do it...
          2. How it works...
        4. Adding a page status region
          1. How to do it...
          2. How it works...
        5. Creating a page buttons region
          1. How to do it...
          2. How it works...
        6. Creating and editing the page controller
          1. How to do it...
          2. How it works...
        7. Capturing an event
          1. How to do it...
          2. How it works...
        8. Editing the application module class
          1. How to do it...
          2. How it works...
        9. Editing the entity object class
          1. How to do it...
          2. How it works...
          3. There's more...
      3. Passing the parameters
        1. How to do it...
        2. How it works...
      4. Creating a list of values
        1. Creating the application module
          1. How to do it...
          2. How it works...
        2. Creating the view object
          1. How to do it...
          2. How it works...
        3. Linking the application module to the view object
          1. How to do it...
          2. How it works...
        4. Creating the region for the list of values
          1. How to do it...
          2. How it works...
        5. Linking the LOV region to an item
          1. How to do it...
          2. How it works...
      5. Adding a link to a region
        1. Creating a link item
          1. How to do it...
          2. How it works...
        2. Capturing the create item event
          1. How to do it...
          2. How it works...
      6. Running a page in the debug mode
        1. How to do it...
        2. How it works...
    12. 5. Advanced OA Framework
      1. Introduction
      2. Navigating between OA Framework pages
        1. Adding logic to navigate between pages and pass parameters
          1. How to do it...
          2. How it works...
        2. Adding code to the destination page to capture the parameters passed
          1. How to do it...
          2. How it works...
        3. Creating a dictionary message
          1. How to do it...
          2. How it works...
        4. Adding logic and calling a dictionary message
          1. How to do it...
          2. How it works...
        5. Adding logic for a Cancel button
          1. How to do it...
          2. How it works...
        6. Adding a method to roll back a transaction
          1. How to do it...
          2. How it works...
      3. Updating records
        1. Adding an update icon
          1. How to do it...
          2. How it works...
        2. Adding the logic when the update icon is clicked on
          1. How to do it…
          2. How it works...
        3. Adding the code to process the update in the createSocietyPG page
          1. How to do it...
          2. How it works...
        4. Adding the updateSociety method
          1. How to do it...
          2. How it works...
      4. Adding a validation to the page
        1. How to do it...
        2. How it works...
      5. Calling PL/SQL from the OAF page
        1. Adding a button to execute the SQL statement
          1. How to do it...
          2. How it works…
        2. Creating a method in the application module
          1. How to do it…
          2. How it works...
        3. Calling the method from the controller class
          1. How to do it…
          2. How it works…
      6. Adding a decision message
        1. How to do it...
        2. How it works...
      7. Partial Page Rendering
      8. Viewing a page from EBS
        1. How to do it...
        2. How it works...
      9. Transferring the files
        1. How to do it...
        2. How it works...
        3. There's more...
    13. 6. BI Publisher
      1. Introduction
      2. Generating XML output using a concurrent program
        1. Getting ready
        2. Create and compile a database package
          1. How to do it...
          2. How to do it...
        3. Create and run an executable
          1. How to do it...
          2. How it works...
        4. Configure a concurrent program
          1. How to do it...
          2. How it works...
      3. Making a concurrent program available to a user
        1. Configure a menu
          1. How to do it...
          2. How it works...
        2. Create a new request group
          1. How to do it...
          2. How it works...
        3. Create a new responsibility
          1. How to do it...
          2. How it works...
        4. Assign the responsibility to a user
          1. How to do it...
          2. How it works...
        5. Run the concurrent program
          1. How to do it...
          2. How it works...
        6. View the request
          1. How to do it...
          2. How it works...
      4. Using Oracle BI Publisher Desktop software to create a rich text format (RTF) template
        1. Download and install Oracle BI Publisher Desktop software
          1. How to do it...
          2. How it works...
        2. Create an RTF template
          1. How to do it...
          2. How it works...
        3. Remove XDO field codes
          1. How to do it...
          2. How it works...
        4. Save the template as an RTF document
          1. How to do it...
          2. How it works...
        5. Preview the RTF template
          1. How to do it...
          2. How it works...
      5. Creating a Data Definition
        1. How to do it...
        2. How it works...
      6. Defining a template
        1. How to do it...
        2. How it works...
      7. Running a BI Publisher report
        1. How to do it...
        2. How it works...
      8. Generating PDF and Excel output using an RTF template
        1. How to do it...
        2. How it works...
      9. Implementing BI Publisher Bursting (e-mail)
        1. Creating the bursting file
          1. How to do it...
          2. How it works...
        2. Running the Bursting concurrent program
          1. How to do it...
          2. How it works...
      10. Implementing BI Publisher Bursting (file system)
        1. How to do it...
        2. How it works...
    14. 7. Desktop Integration
      1. Introduction
      2. Installing the database objects
        1. How to do it...
      3. Getting started with desktop integration
        1. Configure a menu
          1. How to do it...
          2. How it works...
        2. Create a new request group
          1. How to do it...
          2. How it works...
        3. Create a new responsibility
          1. How to do it...
          2. How it works...
        4. Assign the desktop integration responsibilities to a user
          1. How to do it...
          2. How it works...
      4. Configuring the browser and MS Office settings
        1. Configure the browser
          1. How to do it...
          2. How it works...
        2. Configure MS Office security settings
          1. How to do it...
          2. How it works...
      5. Registering a table and its columns within Oracle E-Business Suite
        1. How to do it...
        2. How it works...
        3. Checking the table has been registered in Oracle
          1. How to do it...
          2. How it works...
      6. Creating a custom integrator
        1. Configure the integrator
          1. How to do it...
        2. Configure the interface
          1. How to do it...
        3. Create a layout for the integrator
          1. How to do it...
          2. How it works…
        4. Generate an integrator
          1. How to do it…
          2. How it works…
        5. Edit the attributes
          1. How to do it…
          2. How it works…
        6. Add the lists of values
          1. How to do it…
          2. How it works…
      7. Creating a function for an integrator
        1. How to do it…
        2. How it works…
      8. Adding an integrator to a menu
        1. Adding form functions to menu
          1. How to do it…
          2. How it works…
      9. Adding advanced features to an integrator
        1. How to do it…
        2. How it works…
      10. Defining the importer
        1. How to do it…
        2. How it works…
    15. 8. Utilities
      1. Introduction
      2. Setting the environment variables
        1. Setting the environment on the application server
          1. How to do it...
          2. How it works
        2. Setting the environment on the database server
          1. How to do it...
          2. How it works
      3. Starting and stopping an environment
        1. Starting an environment
          1. How to do it...
          2. How it works
        2. Stopping an environment
          1. How to do it...
          2. How it works
      4. Creating a custom schema
        1. Making a new environment parameter
          1. How to do it...
        2. Running AutoConfig (adautocfg.sh)
          1. How to do it...
          2. How it works
          3. There’s more
        3. Creating a CUSTOM schema directory structure
          1. How to do it...
          2. How it works
        4. Creating a new tablespace
          1. How to do it...
          2. How it works
        5. Creating a database user
          1. How to do it...
          2. How it works
        6. Registering an Oracle schema
          1. How to do it...
          2. How it works
        7. Registering an Oracle user
          1. How to do it...
          2. How it works
    16. Index