Complete Guide to Installing Oracle JDeveloper (JDev) for OAF Development

Introduction

Oracle JDeveloper (JDev) is the primary integrated development environment (IDE) used for creating and extending Oracle Application Framework (OAF) pages. Before you can begin developing custom OAF pages or extending standard Oracle E-Business Suite pages, you must install and configure JDev properly. This guide provides a comprehensive, step-by-step walkthrough of the JDev installation process, including all necessary configurations to connect JDev to your Oracle E-Business Suite environment.

Prerequisites

Before beginning the installation, ensure the following:

Access to My Oracle Support (formerly Oracle MetaLink) to download required patches
Sufficient disk space on your local machine (D:\ drive recommended)
Oracle E-Business Suite user account with the following responsibilities:
- OA Framework ToolBox Tutorial
- OA Framework ToolBox Tutorial Labs
Access to the Oracle E-Business Suite server to retrieve the DBC file
Database connection details (IP address, port, SID)
Database username and password

Step-by-Step Installation Guide

Step 1: Download and Extract the JDeveloper Patch

Download the Patch:

Log in to My Oracle Support
Search for and download patch p9879989_R12_GENERIC

Create Installation Directory:
- Create a new folder named OAF in the **D:** drive
- Example: D:\OAF
Extract the Patch:
- Extract the downloaded patch to the D:\OAF directory
- After extraction, three folders will be created:
  - jdevbin — Contains JDeveloper binaries and executable files
  - jdevhome — Contains workspace and project files
  - jdevdoc — Contains documentation files

Note: Your workspace (myworkspace) and projects (myprojects) will be created under the jdevhome folder.

Step 2: Create the JDEV_USER_HOME Environment Variable

Setting up the environment variable is critical for JDev to locate its home directory.

Navigate to the JDev Home Path:
- Browse to D:\OAF\jdevhome\jdev
- Copy this path
Open System Properties:
- Right-click on My Computer (or This PC)
- Select Properties
Access Environment Variables:
- Click on the Advanced tab
- Click on the Environment Variables button
Create the Variable:
- Under System Variables, click New
- Variable Name: JDEV_USER_HOME
- Variable Value: D:\OAF\jdevhome\jdev
- Click OK to save

Step 3: Launch JDeveloper

Navigate to the JDev Bin Directory:
- Go to D:\OAF\jdevbin\jdev\bin
Start JDeveloper:
- Double-click on jdevW (the JDeveloper executable for Windows)
Verify Launch:
- JDeveloper should now open successfully

Step 4: Test the Installation

To verify that your installation is successful, open the predefined workspace provided by Oracle.

Open the Workspace:
- In JDeveloper, click File → Open
- Navigate to D:\OAF\jdevhome\jdev\myprojects
- Open the workspace named toolbox.jws
Explore the Workspace:
- The workspace contains four projects
- Click on the Tutorial project to select it
Access Project Properties:
- Right-click on the Tutorial project
- Select Properties

Step 5: Configure the Runtime Connection

The Runtime Connection allows JDeveloper to connect to your Oracle E-Business Suite instance.

Navigate to Runtime Connection:
- In the Project Properties window, click on Oracle Applications
- Select Runtime Connection
Obtain the DBC File:
- The DBC (Database Connection) file is used to connect JDev to the E-Business Suite application
- Locate the DBC file on the Oracle Server at:
  text
```
$INST_TOP/appl/fnd/12.0.0/secure
```
- Copy the DBC file from the Oracle server to your local directory:
  text
```
D:\OAF\jdevhome\jdev\dbc_files\secure
```
Enter Runtime Connection Details:
- DBC File Name: Browse and select the DBC file you copied
- Username: Enter your Oracle E-Business Suite username (must have the required responsibilities)
- Password: Enter your application password
- Responsibility: Leave unchanged (no modification needed)

Step 6: Create the Required EBS User

Before proceeding, ensure you have created a user in Oracle E-Business Suite with the following responsibilities:

OA Framework ToolBox Tutorial
OA Framework ToolBox Tutorial Labs

Enter this username in the Runtime Connection settings of JDeveloper and provide the application password.

Important: Do not change anything in the Responsibility section—the default settings are correct.

Step 7: Configure the Database Connection

After setting up the Runtime Connection, you must configure the database connection.

Open Connection Navigator:
- In JDeveloper, click on the Connection Navigator tab
Access Database Connections:
- Click on Database
- Right-click on fwk12dev
- Select Properties
Enter Database Credentials:
- Username: Enter your database username
- Password: Enter your database password
Enter Connection Details:
- Database IP Address: Enter the IP address of your database server
- Port Number: Enter the database port (e.g., 1521)
- SID: Enter the database SID
Save the Connection:
- Click OK to save the database connection settings
Return to Application Navigator:
- Click on the Application Navigator tab to return to your project view
Extract the Tutorial Project:
- Expand the Tutorial project to view its contents

Step 8: Launch a Standard Page

Now you are ready to test your installation by running a standard OAF page.

Locate the Page:
- In the Application Navigator, navigate to HelloWorldPG
Run the Page:
- Right-click on HelloWorldPG
- Select Run
Verify:
- The page should launch in your default web browser
- If the page loads successfully, your JDeveloper installation and configuration are complete

Troubleshooting Common Issues

Issue	Possible Cause	Solution
JDeveloper won't start	Incorrect JDEV_USER_HOME	Verify the environment variable path is correct
Cannot connect to EBS	Invalid DBC file	Ensure the DBC file is copied correctly from the server
Database connection fails	Wrong credentials or connection details	Verify IP, port, SID, username, and password
Runtime connection error	Missing responsibilities	Ensure the EBS user has the required responsibilities
Page won't run	Project not configured properly	Verify Runtime Connection and Database Connection settings

Summary

Installing and configuring Oracle JDeveloper for OAF development involves several critical steps:

Download and Extract: Obtain patch p9879989_R12_GENERIC and extract it to the OAF folder
Environment Setup: Create the JDEV_USER_HOME environment variable
Launch: Start JDeveloper using the jdevW executable
Test: Open the toolbox.jws workspace to verify installation
Runtime Connection: Configure the DBC file and EBS user credentials
Database Connection: Set up the database connection with proper credentials
Validation: Run a standard page (HelloWorldPG) to confirm everything works

Once these steps are completed, your JDeveloper environment is ready for OAF development. You can now create custom OAF pages, extend standard Oracle E-Business Suite pages, and develop sophisticated web applications that integrate seamlessly with your EBS environment.

Best Practices

Backup Your Workspace: Regularly back up your myprojects folder to prevent loss of work
Use Version Control: Integrate JDeveloper with a version control system (e.g., Git, Subversion)
Keep Patches Updated: Periodically check for JDeveloper updates and patches
Document Configurations: Maintain a record of your connection settings for future reference
Test in Development First: Always test OAF customizations in a development environment before deploying to production

References

Oracle JDeveloper Documentation: Available in the jdevdoc folder
My Oracle Support: Patch p9879989_R12_GENERIC
Oracle E-Business Suite Documentation: OA Framework Developer's Guide
Oracle Application Framework: Official Oracle documentation for OAF development

This comprehensive guide ensures that developers can successfully install and configure JDeveloper for OAF development, enabling them to create custom pages and extend Oracle E-Business Suite functionality effectively.

Oracle Apps/DBA

Pages

2. JDeveloper Installation