Extracting Oracle Custom Code
  • 3 Minutes to read
  • Dark
  • PDF

Extracting Oracle Custom Code

  • Dark
  • PDF

Article summary

Panaya solution requires running JavaScript on your Oracle Apps Server.
This script extracts custom-developed code and retrieves custom objects usage in Oracle Apps.
This article is for extracting custom code for upgrade projects.

For a list of objects extracted by Panaya, click here

Verify that you meet the requirements in this article
Good to Know!
You can automate this process by implementing our API.
Learn more

Oracle Extraction Tool

  1. Click on the Settings button to open up the Settings panel, then select Code Box
  2. Before you continue, check that the relevant system appears on the top left corner of the screen.
  3. Download the Oracle extraction tool (jar file)
    Always download the newest extraction code from Panaya's Code Box. It is not recommended to use older versions of the extraction.

Extracting the Code and Usage 

For complete usage statistics, define the following - 

  • Form Usage - Set the system profile option Sign-On: Audit Level to Form for the highest auditing level
  • Framework -  To activate tracking, set Page Access Tracking in Oracle Applications 11i [ID 278881.1] or Page Access Tracking in Oracle Applications Release 12 [ID 402116.1]

For more information, click here

Upload panaya-extractor.jar to your Oracle Application Server. Then, change your working directory to the location of the panaya-extractor.jar.
Using your Oracle Apps OS user, execute the following command -  

java -jar panaya-extractor.jar -prompt [<ETL type>] [-customJavaTop=<Custom Java Top>]
If you wish to expedite the extraction process when upgrading to Oracle EBS version 12.2 and above, click here.


[<ETL type>] - What data to extract during the ETL

[-customJavaTop=<Custom Java Top>] - Path(s) to your framework projects other than $JAVA_TOP.
If more than one path is defined in the classpath, use ':' as a delimiter - If -customJavaTop is not specified, will use only $JAVA_TOP.

[-prompt] - this will open a dialog box for the user to enter the APPS and SYSTEM password. This will mask the password for cases where other users attempt to sign in to the system and execute the command ps -ef.

The prompt will request the APPS password for the Oracle EBS target version up to 12.1.3 (including).
The prompt will request both APPS and SYSTEM passwords for Oracle EBS target version above 12.2 (including).

F - Full ETL (Customizations & Usage data) Please use this for the first extraction.
C - Customizations only
U - Usage only

If no ETL type is specified, a Full ETL will be executed

During the extraction process, an output directory will automatically will be created for you.
The name of the directory will be output_<date>_<time>.

If during the extraction process, you will get an error message of 'Unable to Connect to DB':

You may need to use a connection string as in this article.

At the end of the process, one ZIP File will be created in your output directory, which you will need to upload to Panaya Code Box.

If you do not have access from your Application server to the Panaya web site, please copy the file from there.
It is not recommended to use the CustomJavaTop parameter for the $Java_Top path itself.
Instead, use the Custom Java Top Parameter if it points to a different path than the JavaTop you are using. 
Good to Know!
If you run the Concurrent Manager on a different server than the Oracle Application server, a separate extraction must be done from each server.
If you have shared APPL_TOP with your Concurrent Manager server, you do not need to do a separate extraction.

Upload the Extract File

  1. Upload the ZIP file to Panaya Code Box
  2. Click on the Upload button
  3. Users with the following permissions will be notified by email once the analysis is available (this usually takes 48 hours or less) - 
    - Code Box - Upload ETL and/or Upload PTL permissions
    - Users - Create and Edit permission

If you encounter issues while performing the following steps, check the suggested solutions in this article.