Develop Search Screen / Search Page using Oracle OAF

The search page we are going to create/ developing based upon view only, as we are not going to perform any database transaction. Therefore we don' t need to create an entity object. 

In order to create search page first we need to perform following tasks.

1. Creating an application module (AM)  
2. Creating a view object (VO) 
3. Linking VO to AM 
4. Testing AM 

Creating an application module (AM)

1. Right-click OAMujahidPacktProject project in the navigator and select New from the pop-up menu.
2. Navigate to Business Tier
3. ADF Components and select Application Module.
4. Click on Button OK. Welcome page will display, click Next Button.
5. In Step 1 of 4, enter the following details:                                                                 Package: oracle.apps.fnd.emp.server Name: EmpSearchAM
6. In Step 2 of 4, click Next Button. 
7. In Step 3 of 4, click Next Button. 
8. In Step 4 of 4, check the Generate Java File(s) checkbox in Application     Module  Class: EmpSearchAMImpl to generate the EmpSearchAMImpl java class. (It is already checked by default.)
9. In the Finish window, select the Finish Button. 
10. Click Save All Button from the toolbar.

Creating a view object (VO)

1. Right-click the OAMujahidPacktProject.jpr and select New from the pop-up menu. 
2. Navigate to Business Tier --> Adf Business Components And Select View Object. 
3. Click on OK. 
4. In Step 1 of 7, enter the following details:
   Package: oracle.apps.fnd.emp.server
   Name: EmpSearchVO
5. Select the Rows Populated by a SQL Query, with: radio button and select the
   Read-only Access radio button as shown in the following screenshot:

6. Click Next.
7. In Step 2 of 7, enter the following query in the Query Statement field:
    select * from XXHR_EMP_SEARCH_VL
    Note: if view does not exist then create it 
8. Click the Test button to test the query (click on OK when prompted for the
   username and password apps/<apps>).

9. Click on OK when the Query is valid message is displayed.
10. Click on Next.
11. In Step 3 of 7, click on Next.
12. In Step 4 of 7, click on Next.
13. In Step 5 of 7, click on Next.
14. In Step 6 of 7, select the Never radio button in Updatable as shown in the following
    screenshot, and then click Next:

15. In Step 7 of 7, uncheck the Generate Java File checkbox in View Object Class: EmpSearchVOImpl.
16. Check the checkbox View Row Class: EmpSearchVORowImpl for both the Generate Java File and Accessors checkboxes, as shown in the following screenshot:

17. After completing Step 7 of 7, click on Next.
18. In the summary page, click on Finish.
19. Click the Save All button from the toolbar.

Linking the view object to the application module(VO to AM)

   To link the view object to the application module, perform the following steps:

1. In the Application Navigator tab, double-click the EmpSearchAM application

module in the OAPacktProject --> Application Sources -->
oracle.apps.fnd.emp.server package.

2. In the Application Module Editor select the Data Model node. 
3. Expand the oracle.apps.xxhr.emp.server package, and click on the EmpSearchVO view object. 
4. Shift the EmpSearchVO from Available View Objects: to Data Model: by clicking on the > button as shown in the following screenshot:

5. Click on OK.
6. Click the Save All button from the toolbar.  

Testing the application module (AM)

1. In JDeveloper, right-click the EmpSearchAM application module.
2. Select Test from the pop-up menu.
3. Click on the Connect button when the following Oracle Business Component
4. Browser - Connect window appears:

5. After a short while, the Oracle Business Component Browser (Local) window will appear.
6. Double-click on the EmpSearchVO1 node and the browser will bring back data from the view object as shown in the following screenshot:

Creating the view layer for a query page

We have created our application module and successfully tested it, now we are going to create our user interface. We will create a page that allows us to query data based upon the attributes in our application module.

Creating Page

1. In the Application Navigator tab, right-click on OAMujahidPacktProject.
2. Select New from the pop-up menu.
3. In the New Gallery window, navigate to Web Tier | OA Components and select Page from the Items: list as shown in the following screenshot:
   

    

   
   
4. In the New Page window, set the following page details:
   Name: EmpSearchPG
   Package: oracle.apps.fnd.emp.webui
5. Click on the OK button.

Renaming the default region (PG)

1. In the Application Navigator tab, click on the EmpSearchPG.xml page
2. In the Structure pane, click on the item EmpSearchPG | region1 node.
3. Now in the Property Inspector, set the following properties                                      ID: PageLayoutRN
   AM Definition: oracle.apps.xxhr.emp.server.EmpSearchAM
   Window Title: Employee Search Window
   Title: Employee Search                                                                                                A summary of the steps is displayed in the following screenshot:
   
   
4. Click on the Save All button from the toolbar. Run the page

          In the Application Navigator tab, right click the EmpSearchPG.xml page and
          select Run from the pop-up menu.

The following page will appear with an empty Employee Search region, as we have not added  any items to the page just yet. You can see that the page automatically inherits the Oracle EBS branding, look, and feel of other OA Framework pages.

Adding a query region (RG)

1. Click the EmpSearchPG.xml in the Applications Manager and the page
   components will appear in the Structure pane.
2. In the Structure pane, right-click PageLayoutRN and select New | Region from
   the pop-up menu.
3. In the Property Inspector, set the following properties:
   ID: EmpQueryRN
   Region Style: query
   Construction Mode: resultsBasedSearch
   Include Simple Panel: True
   Include Views Panel: True
   Include Advanced Panel: True
4. Click on the Save All button from the toolbar.

Adding a results region (RG) using a wizard

1. Right-click on EmpQueryRN in the Structure pane, and select New | Region
   Using Wizard from the pop-up menu.
2. In Step 1 of 4, select the oracle.apps.fnd.emp.server.EmpSearchAM
   application module from the drop-down list.
3. Click on EmpSearchVO1 from the Available View Usages pane, and click on Next.
4. In Step 2 of 4, set the values as required (No need to add WHO columns)
5. In Step 3 of 4, shift the following attributes from the Available View Attributes to
   the Selected View Attributes pane by clicking on the > button:
6. In Step 4 of 4, set the following values
7. Click on Next and then Finish.
8. In the Structure pane, click on the EmpResultsRN and set the following properties
   in the Property Inspector

          Width: 100%
          User Personalization: True
          Additional Text: Employee Search Results

Setting item properties

1. In the Structure pane, click on the FullName attribute and set the following properties:
Search Allowed: True
Sort Allowed: yes
2. In the Structure pane, click on the EmployeeNumber attribute and set the following properties:
Search Allowed: True
Sort Allowed: yes
Initial Sort Sequence: first
3. In the Structure pane, click on the MgrFullName attribute and set the following properties:
Search Allowed: True
Sort Allowed: yes
4. In the Structure pane, click on the MgrEmployeeNumber attribute and set the following properties:
Search Allowed: True
Sort Allowed: yes
5. Click the Save All button from the toolbar.

Testing the page

1. Right-click on the EmpSearchPG.xml page and select Run from the pop-up menu.
   
2. Enter some search criteria in the Simple Search parameters region, and click on
   the Go Button.
   

Step by Step OAF Setup for development environment

In our first step we will download correct version of Jdeveloper with OA Extension. To get the correct version, we will first establish the version of E-Business Suite (EBS) we are on  then download JDeveloper from Oracle Support and install it.

1. Log on to EBS and click on the About this Page link.
   
2. Click on the Technology Components tab
   
3. Version will display to you
   
4. We will download to support support.oracle.com
5. Find the note How to find the correct version of JDeveloper to use with eBusiness Suite 11i or Release 12.x [ID 416708.1]. Type 416708.1 in the search box, and click the search icon.
6. Click on the version we require to download
   
7. Click on the Download button to download the correct version to your PC
   
8. Unzip the file into a local directory called C:\Jdev
   

Note :

You will notice that JDeveloper has created the following three directories under the C:\Jdev directory (or the directory you chose to unzip it in): jdevhome—All pages and code we develop. Also, contains the .dbc file to connect to the database instances. jdevbin—All Jars, executables for Jdev and FND classes. jdevdoc—Contains all of the Oracle OAF tutorials, the Developer Guide (HTML), and an explanation of all the classes, methods, and parameters.

Setup Environment Variable

1.  Right-click on My Computer or Computer, and select Properties from the menu.
2.  Click on Advanced System Settings to open the System Properties window.
3.  Click on the Advanced tab.
4.  Click on the Environment Variables button.
5.  Select the New button for user variables.
6.  In the Variable name field, enter JDEV_USER_HOME.
7.  In the Variable value field, enter the directory of the jdevhome\jdev directory, for example, C:\oaf\jdevhome\jdev as shown in the following screenshot
   
8. Press Button OK.

Transferring DBC from Application Server

In order to connect Jdeveloper to database we need DBC file, now we will transfer DBC file to our local directory for creating database connections with JDeveloper.

1. Open WinSCP and connect to the application server.
2. FTP the .dbc file to your local PC from the $INST_TOP/appl/fnd/12.0.0.0/secure directory on the application server to the jdevhome\jdev\dbc_files\secure directory as shown in the following screenshot
   

   

   
   

Creating Shortcut to Desktop.

1. Navigate to the directory, C:\oaf\jdevbin\jdev\bin.
2. Right-click on the jdevw.exe and select Send To | Desktop (create shortcut).
3. Rename the shortcut on the desktop if desired, for example, Jdev R12.  

Creating database connections in JDeveloper

To add a database connection, perform the following steps:

1. Start JDeveloper. 
2. Click on the Connections tab in Applications Navigator. 
3. Right-click on the Database node, and select New Database Connection.
   

The new database connection wizard will now be displayed.

4. Click on Next on the welcome page  and check Skip this Page Next Time if

desired.

5. In the Connection Name field, type VISR12 (this is just a name for the connection

and can be anything relevant), and click on Next.

6. When prompted, enter apps in the username field and the <apps password> in the

password field, that is, apps/apps and click on Next.

7. Enter the following connection details:

8. Click on the Next button.

9. Click the Test Connection button and then Finish as shown in the following

screenshot:

 

Setting up OC4J and project properties

1. Open JDeveloper. 
2. Check the OC4J Settings in Tools | Embedded OC4J Preferences Global Startup. 
3. Check if the Host Name or IP Address Used to Refer to Embedded OC4J is set to Default Local IP Address, as shown in the following screenshot: 
   
4. Press Button OK

Setting up OAF runtime connection

1.  Open JDeveloper.
2. Navigate Tools --> Project Properties --> Oracle Applications --> Runtime Connection 
3. Set the following fields:

                 DBC File Name: C:\Jdev\jdevhome\jdev\dbc_files\secure\VISR12.dbc

                 User Name: sysadmin

                 Password: sysadmin

                 Application Short Name: ICX

                 Responsibility Key: FWK_TBX_TUTORIAL

        4. Press Button OK