This chapter covers the following topics:
The technology of OA Framework consists of several components. In OA Framework 11.5.56 and earlier, one of those components was AK, an interface and repository that captures and stores the meta data that defines the HTML pages of the Oracle E-Business Suite. Specifically, the AK repository consists of the following tables: AK_REGIONS, AK_REGION_ITEMS, AK_ATTRIBUTES and AK_REGION_LOV_RELATIONS. When you make personalizations to these pages, the personalization meta data is stored in separate shadow tables called AK_CUSTOMIZATIONS, AK_CUSTOM_REGIONS, and AK_CUSTOM_REGION_ITEMS.
Starting with OA Framework 11.5.57, all the meta data stored previously in AK was rehosted in Oracle JDeveloper OA Extension. In OA Extension, the application meta data is stored either in XML files, in a format defined by MDS (Meta Data Services) Schemas, or in the MDS repository tables.
When you upgrade OA Framework from Release 11i to Release 12, if you still have pages stored in AK, the Automated Release Update (ARU) migrates the OA Framework-based pages from the AK repository to the MDS repository. The upgrade also migrates and loads any "Oracle-seeded user-level" personalizations from AK to the MDS repository. If you or your users have created personalizations in the past and your AK repository and MDS repository are in the same database instance, the upgrade also migrates your "customer personalizations" for you. You need only run the Personalization Migration tool to migrate customer personalizations if your AK and MDS repositories are in different database instances. To summarize:
When you upgrade to OA Framework Release 12, the upgrade automatically migrates customer personalizations from AK to MDS, if AK and MDS are both in the same database instance.
The OA Framework upgrade does not migrate customer personalizations if the AK and MDS repositories are in separate database instances. You need to run the Personalization Migration tool manually to migrate your customer personalizations in this case.
The Personalization Migration tool requires JDK version 1.5, although it can also run with JDK version 1.3. Before running the Personalization Migration tool, your classpath, path and environment should be set up similar to the environment required for applying the upgrade.
If you have created what are known as customer personalizations for your site or installation, and your AK and MDS repositories are in the same database instance, the OA Framework upgrade automatically migrates your customer personalizations for you. If your AK repository is in a different database instance than your MDS repository, you must run the Personalization Migration Tool yourself to migrate these personalizations from the AK to the MDS repository.
To use CustMigrationTool to migrate customer personalizations from the AK repository in one instance to the MDS repository in another instance, ensure your classpath, path and environment is set up similar to the environment required for applying an AD patch and call java -mx256m oracle.jrad.migration.cust.CustMigrationTool <ApplicationShortName> <RegionCode> with the appropriate parameters.
If you have Oracle JDeveloper OA Extension, you may alternatively use the migratecust.bat file that is packaged with the JDeveloper IDE, located in the jdevbin\jdev\bin directory of the JDeveloper install area. The batch file sets up the classpath, path and environment for you. Just typing migratecust without any parameters will give help about its usage.
The syntax for running CustMigrationTool is as follows:
java -mx256m oracle.jrad.migration.cust.CustMigrationTool <ApplicationShortName> <RegionCode> -customer_cust -username <username> -password <password> -dbconnection <database> -migrationdir <migration_dir> [-jrad_username <mds_username>] [-jrad_password <mds_password>] [-jrad_dbconnection <mds_database>] [-jrad_userid <mds_userid>] [-rootPackage <root_pkg>]
Replace <ApplicationShortName> with the application short name of the personalized pages you wish to migrate. Replace <RegionCode> with the region code of the page you wish to migrate. Specifying a percent sign (%) for the region code allows you to migrate personalizations for all the pages of the application short name specified, in one run. Be sure to specify the parameter -customer_cust when you migrate customer personalizations. The parameters enclosed in square brackets [ ] are optional, based on the assumptions described in the parameter value descriptions for P1 to P9 as follows.
<username> - (Required) Username for the AK database.
<password> - (Required) Password for the AK database.
<database> - (Required) Database connection details for the AK repository database in TNS format.
If you are migrating customer personalizations from a test instance to a production instance, this parameter should be used to specify the information for the test instance. Example: "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS = (PROTOCOL = TCP) (HOST = appdb.company.com)(PORT = 1521)))(CONNECT_DATA = (SID = testdb)))"
<migration_dir> - (Required) Directory where the migrated personalization meta data is output as xml files.
This directory should be the same as the output directory of the migration of base HTML pages from AK to MDS. The default value is ".".
<mds_username> - Username for the MDS database.
<mds_password> - Password for the MDS database.
<mds_database> - Database connection details for the MDS database in TNS format.
The syntax is similar to that described for P4, the DBconnection parameter. Note that if parameters P5, P6, and P7 are not specified, then the values for P1, P2, and P3 are used for the MDS repository and the Personalization Migration Tool assumes that the MDS meta data is stored in the same database instance as the AK meta data.
<mds_userid> - The user ID used by the tool to set the created_by and last_updated_by columns in the MDS repository tables.
<root_pkg> - Root package.
Set this to "/oracle/apps" when the directory specified for the migrationdir parameter contains /oracle/apps in the directory structure.
If you wish to migrate your customer personalizations of Oracle HRMS pages from the AK repository in your test database instance to the MDS repository in your production database instance, your syntax would look as follows:
java -mx256m oracle.jrad.mmigration.cust.CustMigrationTool PER % -customer_cust -username apps -password apps -dbconnection "(DESCRIPTION=(ADDRESS_LIST =(ADDRESS= (PROTOCOL=tcp)(HOST=sfosun) (PORT=1521))) (CONNECT_DATA=(SID=test2)))" -migrationdir D:\dev\jsmith\jdev\myprojects -jrad_username apps -jrad_password apps -jrad_dbconnection "(DESCRIPTION=(ADDRESS_LIST =(ADDRESS= (PROTOCOL=tcp)(HOST=laxsun) (PORT=1521))) (CONNECT_DATA=(SID=prod2)))" -jrad_userid jsmith -root_package "/oracle/apps"
See a summary of key Personalization Migration issues with suggested workarounds if available.
BLAF UI Guideline(s)
Javadoc File(s)
Lessons(s)
Sample Code