Tuesday, December 13, 2016

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:

  1. Click Next.
  2. 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 
  3. Click the Test button to test the query (click on OK when prompted for the
    username and password apps/<apps>).

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


  1. In Step 7 of 7, uncheck the Generate Java File checkbox in View Object Class: EmpSearchVOImpl.
  2. Check the checkbox View Row Class: EmpSearchVORowImpl for both the Generate Java File and Accessors checkboxes, as shown in the following screenshot:
  1. After completing Step 7 of 7, click on Next.
  2. In the summary page, click on Finish.
  3. 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.
  1. In the Application Module Editor select the Data Model node. 
  2. Expand the oracle.apps.xxhr.emp.server package, and click on the EmpSearchVO view object. 
  3. Shift the EmpSearchVO from Available View Objects: to Data Model: by clicking on the > button as shown in the following screenshot:
  1. Click on OK.
  2. 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:


  1. After a short while, the Oracle Business Component Browser (Local) window will appear.
  2. 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:
  2. Search Allowed: True
    Sort Allowed: yes
  3. In the Structure pane, click on the EmployeeNumber attribute and set the following properties:
  4. Search Allowed: True
    Sort Allowed: yes
    Initial Sort Sequence: first
  5. In the Structure pane, click on the MgrFullName attribute and set the following properties:
  6. Search Allowed: True
    Sort Allowed: yes
  7. In the Structure pane, click on the MgrEmployeeNumber attribute and set the following properties:
  8. Search Allowed: True
    Sort Allowed: yes
  9. 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.