Oracle Application Framework

OA Framework Extension of Application Module

Extending AM is similar to extending a View Object or an Entity Object. But some of the steps are slightly different. Hence I would like to dedicate an article on Extending AM.

What is an Application Module in OA Framework?

Think of AM as a broker between your Client Activity and database activity.

Is extension of AM recommended by Oracle?

Not really, simple because doing so isn't upgrade safe.

But sometimes you are left with no choice, and also it is better to extend that customize.

Which example will I undertake to extend an Application Module?

In this instance, lets take an example of an iRecruitment Functionality.

iRecruitment [IRC] is a web facing application from Oracle. Let's say, that we wish to capture a record in some custom table when a invalid Logon attempt occurs on iRecruitment Login page. The validation for User Logon occurs in a class named VisitorAMImpl.class

This class can be found in $JAVA_TOP/oracle/apps/per/irc/candidateSelfService/server

If you decompile this class using jad, you will notice the below code

    public String validateLogin(String s, String s1)

    {

        String s2 = null;

        OracleCallableStatement oraclecallablestatement = null;

        try

        {

            String s3 = "begin :1 := fnd_web_sec.validate_login( p_user                => :2 ,p_pwd                 => :3  ); commit; end; ";

            OADBTransactionImpl oadbtransactionimpl = (OADBTransactionImpl)getDBTransaction();

            oraclecallablestatement = (OracleCallableStatement)oadbtransactionimpl.createCallableStatement(s3, 1);

We need to add extra logic, such that, if fnd_web_sec.validate_login returns N, then we either insert record into another table or raise a business event.

Note:- The new logic can be appended to the method of the parent class [as it is, without modifying original code, by using super.method() convention].

So we need to extend and substitute VisitorAMImpl.class?

Well, we can't substitute AM Implementation class, so we will need to substitute VisitorAM itself.

In the extend AM, do we need to write code for each and every method of AM Implementation class being extended?

Not really. You need to write the code for just that method for which you wish to incorporate new/additional logic.

What are the steps in brief, for doing so?

Step 1  [Optional].

           Get a jad utility. This can be downloaded free. Just search on java decompiler jad. This will help you example the standard Oracle code.

Step 2. FTP all the files from $JAVA_TOP/oracle/apps/per/* to your PC and configure your PC for OA Framework development

Step 3. Create a new BC4J package in which the extension will reside.

Step 4. Note down the path and the properties of existing AM that we wish to extend

Step 5. Create a new AM, and specify the original AM being extended.

Step 6. Ensure that the properties of original AM are applicable for new AM too.

Step 7. Perform substitution. This will create a jpx file.

Step 8. Upload the jpx file into Database.

Step 9. Deploy the custom BC4J to $JAVA_TOP by FTP'ing all files.

In the Part-1 of Application Module extension, we saw the business case for extending an Application Module. Here in the Part-2, I will display Steps with screenshots.

Step 1. Download the jad utility

Go to www.google.com

Step 2. In my case, I have <jdevhome>/jdev/myprojects included in my CLASSPATH. Hence I ftp'ed the files to <jdevhome>/jdev/myprojects/oracle/apps/per directory tree.

Step 3. ->Create a new BC4J Package, by right clicking on Project.

->The AM that we wish to extend resides in oracle.apps.per.irc.candidateSelfService.server

Hence, our package name will be oracle.apps.xxper.irc.candidateSelfService.server

Ensure that XXPER is valid Application short name.

select 'x' from fnd_application_vl where application_short_name = 'XXPER'

->Click on Finish.

Step 4. We can see that, for VisitorAM, the RETENTION_LEVEL is MANAGE_STATE.

Hence we will ensure that our new AM will have the same property too.

Step 5.

--> Right click on the new BC4J, and create a new AM.

-->Name of the new AM will be xxircVisitorAM

In the Extends field, click browse and select the AM as shown below.

-> Keep on clicking next until you see Finish. Click on Finish.

--> You will notice that class xxircVisitorAMImpl has been created. Add the below method to that class.

    public String validateLogin(String s, String s1)

    {

        String parentValidationResult = super.validateLogin(s,s1) ;

        if (parentValidationResult.compareTo("Y")==0)

          {

          //raise your event here, or insert into some bespoke table

          }

        return parentValidationResult;

    }

Step 6. Ensure that the properties and the same, and also ensure that your method being replaced is selected.

Double click on the newly created AM xxircVisitorAM and ensure that RETENTION_LEVEL is MANAGE_STATE.

Also, click on ClientMethods, and ensure that the method validateLogin has been selected.

Step 7. Perform Substitution. Right click on the project, and select "Edit Business Components Project"

Click on Substitution, and select xxIrcVisitorAM on left hand side, and VisitorAM on right hand side. Click on Add button.

Step 8. Your jpx file will look like below

<?xml version="1.0" encoding='windows-1252'?>

<!DOCTYPE JboProject SYSTEM "jbo_03_01.dtd">

<JboProject

   Name="xxircVisitorAM.jpr"

   SeparateXMLFiles="true"

   PackageName="" >

   <DesignTime>

      <Attr Name="_version" Value="9.0.3.13.75" />

      <Attr Name="_jprName" Value="xxircVisitorAM.jpr" />

      <Attr Name="_ejbPackage" Value="false" />

   </DesignTime>

   <Substitutes>

      <Substitute OldName ="oracle.apps.xxper.irc.candidateSelfService.server.xxircVisitorAM" NewName ="oracle.apps.per.irc.candidateSelfService.server.VisitorAM" />

   </Substitutes>

</JboProject>

Name this file as xxVisitorAM.jpx

Now, load this jpx into Database using a shell similar to below.

APPS_PWD=apps

export APPS_PWD

MACHINE_NAME=0

PORT_NUMBER=0

export MACHINE_NAME

export PORT_NUMBER

getPortMachine()

{

    MACHINE_NAME=`sqlplus -s apps/$APPS_PWD <<EOF

                       set pages 0

                       set lines 1023

                       select fnd_profile.value('CSF_EMAP_DS_HOST') || '.ad.ic.ac.uk' from dual ;

                       exit

                       EOF`

    PORT_NUMBER=`sqlplus -s apps/$APPS_PWD <<EOF

                        set pages 0

                        set feed off

                        select fnd_profile.value('CSF_MAP_DB_PORT') from dual ;

                        exit

                        EOF`

}

getPortMachine

adjava \

oracle.jrad.tools.xml.importer.JPXImporter ./xxVisitorAM.jpx \

-username apps \

-password $APPS_PWD \

-dbconnection "(description=(address_list=(address=(community=tcp.world)(protocol=tcp)(host=$MACHINE_NAME)(port=$PORT_NUMBER)))(connect_data=(sid=$TWO_TASK)))"

Step 9. FTP all the files from directory tree xxper to $JAVA_TOP/oracle/apps/xxper/..

Bounce apache, and you will notice that your custom logic is now being invoked.

Anil Passi

Add comment